{ "openapi": "3.1.0", "info": { "title": "SocialQuery API", "version": "2026-10-09", "description": "Public social data API. The catalog describes the compatibility target; consult endpoint readiness before using an operation." }, "servers": [ { "url": "https://socialquery.dev/v1" } ], "security": [ { "apiKey": [] } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "SocialQueryResponse": { "type": "object", "required": [ "success", "platform", "endpoint", "credits_used", "credits_remaining", "request_id", "cached", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "platform": { "type": "string" }, "endpoint": { "type": "string" }, "credits_used": { "type": "integer", "minimum": 0 }, "credits_remaining": { "type": [ "integer", "null" ] }, "request_id": { "type": "string" }, "cached": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true, "description": "Operation-specific data. Fields depend on the endpoint and upstream response; unavailable metrics may be null." } } }, "SocialQueryError": { "type": "object", "required": [ "success", "platform", "endpoint", "credits_used", "credits_remaining", "request_id", "cached", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "platform": { "type": "string" }, "endpoint": { "type": "string" }, "credits_used": { "type": "integer", "minimum": 0 }, "credits_remaining": { "type": [ "integer", "null" ] }, "request_id": { "type": "string" }, "cached": { "type": "boolean" }, "error": { "type": "object", "required": [ "code", "type", "message", "status", "doc_url" ], "properties": { "code": { "type": "string" }, "type": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" }, "doc_url": { "type": "string", "format": "uri" } } } } } }, "responses": { "Success": { "description": "Successful response. data is specific to this operation.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryResponse" } } } }, "Error400": { "description": "Upstream rejected the request.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error401": { "description": "Missing, expired, invalid, or revoked API key.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error402": { "description": "Insufficient SocialQuery credits.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error403": { "description": "Key scope or provider policy denied access.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error404": { "description": "Endpoint or upstream resource not found.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error405": { "description": "HTTP method is not supported.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error409": { "description": "Idempotency conflict or request in progress.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error422": { "description": "Invalid parameters.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error429": { "description": "Request limit reached.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error500": { "description": "Request processing failed.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error502": { "description": "Upstream service failed.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error503": { "description": "Provider or required service is unavailable.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } }, "Error504": { "description": "Upstream service timed out.", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "X-Credits-Used": { "schema": { "type": "integer" } }, "X-Credits-Remaining": { "schema": { "type": "string" } }, "X-Cache": { "schema": { "type": "string", "enum": [ "HIT", "MISS", "BYPASS" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialQueryError" } } } } } }, "paths": { "/web/scrape": { "get": { "operationId": "get_web_scrape", "summary": "Web Scrape", "description": "Web scrape. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://example.com", "schema": { "type": "string" } }, { "name": "formats", "in": "query", "required": false, "example": "markdown", "schema": { "type": "string" } }, { "name": "only_main_content", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "wait_for", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "max_age", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "location_country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "screenshot_full_page", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_tags", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_tags", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "proxy", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "basic", "auto", "enhanced" ] } }, { "name": "pdf_parse", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "block_ads", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "remove_base64_images", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/search": { "get": { "operationId": "get_web_search", "summary": "Web Search", "description": "Web search. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "social media data api", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "categories", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "time_range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_by_date", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include_content", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/map": { "get": { "operationId": "get_web_map", "summary": "Web Map", "description": "Web map. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://example.com", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 100, "schema": { "type": "integer" } }, { "name": "sitemap", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "include", "skip", "only" ] } }, { "name": "include_subdomains", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "ignore_query_parameters", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "fresh", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/extract": { "get": { "operationId": "get_web_extract", "summary": "Web Extract", "description": "Web extract. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://example.com/pricing", "schema": { "type": "string" } }, { "name": "schema", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "prompt", "in": "query", "required": false, "example": "Extract plan names and prices.", "schema": { "type": "string" } }, { "name": "only_main_content", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "max_age", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "proxy", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "basic", "auto", "enhanced" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "schema", "prompt" ] ], "tags": [ "Web" ] } }, "/web/crawl": { "post": { "operationId": "post_web_crawl", "summary": "Web Crawl", "description": "Web crawl. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "limit": { "type": "integer" }, "max_depth": { "type": "integer" }, "allow_backward_links": { "type": "boolean" }, "allow_external_links": { "type": "boolean" }, "include_paths": { "type": "string" }, "exclude_paths": { "type": "string" }, "webhook_url": { "type": "string" }, "formats": { "type": "string" }, "goal": { "type": "string" } } } } } }, "tags": [ "Web" ] } }, "/web/batch-scrape": { "post": { "operationId": "post_web_batch_scrape", "summary": "Web Batch Scrape", "description": "Web batch scrape. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "urls" ], "properties": { "urls": { "type": "array", "items": { "type": "string" } }, "ignore_invalid_urls": { "type": "boolean" }, "formats": { "type": "string" }, "only_main_content": { "type": "boolean" }, "proxy": { "type": "string", "enum": [ "basic", "auto", "enhanced" ] }, "webhook_url": { "type": "string" } } } } } }, "tags": [ "Web" ] } }, "/web/jobs": { "get": { "operationId": "get_web_jobs", "summary": "Web Jobs", "description": "Web jobs. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "limit", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/jobs/{job_id}": { "get": { "operationId": "get_web_jobs_job_id", "summary": "Web Jobs {Job Id}", "description": "Web jobs {job id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "job_id", "in": "path", "required": true, "example": "job_9f3k2n8d1", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] }, "delete": { "operationId": "delete_web_jobs_job_id", "summary": "Web Jobs {Job Id}", "description": "Web jobs {job id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "job_id", "in": "path", "required": true, "example": "job_9f3k2n8d1", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/agent": { "post": { "operationId": "post_web_agent", "summary": "Web Agent", "description": "Web agent. Availability depends on the configured provider route.", "x-credit-cost": 25, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "prompt" ], "properties": { "url": { "type": "string" }, "prompt": { "type": "string" }, "model": { "type": "string", "enum": [ "spark-1-mini", "spark-1-pro" ] } } } } } }, "tags": [ "Web" ] } }, "/web/monitors": { "post": { "operationId": "post_web_monitors", "summary": "Web Monitors", "description": "Web monitors. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "mode": { "type": "string", "enum": [ "scrape", "search" ] }, "cadence_minutes": { "type": "integer" }, "schedule_text": { "type": "string" }, "schedule_cron": { "type": "string" }, "timezone": { "type": "string" }, "webhook_url": { "type": "string" }, "query": { "type": "string" }, "goal": { "type": "string" }, "retention_days": { "type": "integer" }, "judge_enabled": { "type": "boolean" } } } } } }, "tags": [ "Web" ] }, "get": { "operationId": "get_web_monitors", "summary": "Web Monitors", "description": "Web monitors. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/monitors/{monitor_id}": { "get": { "operationId": "get_web_monitors_monitor_id", "summary": "Web Monitors {Monitor Id}", "description": "Web monitors {monitor id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "monitor_id", "in": "path", "required": true, "example": "wm_5d1p8s3k7", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] }, "patch": { "operationId": "patch_web_monitors_monitor_id", "summary": "Web Monitors {Monitor Id}", "description": "Web monitors {monitor id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "monitor_id", "in": "path", "required": true, "example": "wm_5d1p8s3k7", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "status": { "type": "string", "enum": [ "active", "paused" ] }, "cadence_minutes": { "type": "integer" }, "schedule_text": { "type": "string" }, "schedule_cron": { "type": "string" }, "timezone": { "type": "string" } } } } } }, "tags": [ "Web" ] }, "delete": { "operationId": "delete_web_monitors_monitor_id", "summary": "Web Monitors {Monitor Id}", "description": "Web monitors {monitor id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "monitor_id", "in": "path", "required": true, "example": "wm_5d1p8s3k7", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/monitors/{monitor_id}/checks": { "get": { "operationId": "get_web_monitors_monitor_id_checks", "summary": "Web Monitors {Monitor Id} Checks", "description": "Web monitors {monitor id} checks. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "monitor_id", "in": "path", "required": true, "example": "wm_5d1p8s3k7", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/sessions": { "post": { "operationId": "post_web_sessions", "summary": "Web Sessions", "description": "Web sessions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "ttl_seconds": { "type": "integer" }, "activity_ttl_seconds": { "type": "integer" }, "stream_web_view": { "type": "boolean" } } } } } }, "tags": [ "Web" ] }, "get": { "operationId": "get_web_sessions", "summary": "Web Sessions", "description": "Web sessions. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "limit", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/sessions/{session_id}": { "get": { "operationId": "get_web_sessions_session_id", "summary": "Web Sessions {Session Id}", "description": "Web sessions {session id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "session_id", "in": "path", "required": true, "example": "ws_3g7x1v5m2", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] }, "delete": { "operationId": "delete_web_sessions_session_id", "summary": "Web Sessions {Session Id}", "description": "Web sessions {session id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "session_id", "in": "path", "required": true, "example": "ws_3g7x1v5m2", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Web" ] } }, "/web/sessions/{session_id}/execute": { "post": { "operationId": "post_web_sessions_session_id_execute", "summary": "Web Sessions {Session Id} Execute", "description": "Web sessions {session id} execute. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "session_id", "in": "path", "required": true, "example": "ws_3g7x1v5m2", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "language": { "type": "string", "enum": [ "node", "python", "bash" ] }, "timeout": { "type": "integer" } } } } } }, "tags": [ "Web" ] } }, "/web/parse": { "post": { "operationId": "post_web_parse", "summary": "Web Parse", "description": "Web parse. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string" }, "filename": { "type": "string" }, "mime_type": { "type": "string" }, "url": { "type": "string" } } } } } }, "tags": [ "Web" ] } }, "/tiktok/profile": { "get": { "operationId": "get_tiktok_profile", "summary": "TikTok Profile", "description": "Tiktok profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "charlidamelio", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/profile/videos": { "get": { "operationId": "get_tiktok_profile_videos", "summary": "TikTok Profile Videos", "description": "Tiktok profile videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "charlidamelio", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "popular" ] } }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "stationery" ] } }, { "name": "brief", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/post": { "get": { "operationId": "get_tiktok_post", "summary": "TikTok Post", "description": "Tiktok post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/@charlidamelio/video/7321485815660738859", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "download_media", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/post/comments": { "get": { "operationId": "get_tiktok_post_comments", "summary": "TikTok Post Comments", "description": "Tiktok post comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/@stoolpresidente/video/7623818255903329566", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "top", "recent" ] } }, { "name": "scan_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/video/comment/replies": { "get": { "operationId": "get_tiktok_video_comment_replies", "summary": "TikTok Video Comment Replies", "description": "Tiktok video comment replies. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "comment_id", "in": "query", "required": true, "example": "7623828115408274207", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/@stoolpresidente/video/7623818255903329566", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/comment": { "get": { "operationId": "get_tiktok_comment", "summary": "TikTok Comment", "description": "Tiktok comment. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "comment_url", "in": "query", "required": false, "example": "https://www.tiktok.com/@mrbeast/video/7654638524729216287?comment_id=7654640784985211670", "schema": { "type": "string" } }, { "name": "post_url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "comment_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "parent_comment_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "author_username", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "text_contains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "deep_scan", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "position_hint", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "comment_url", "post_url" ] ], "tags": [ "TikTok" ] } }, "/tiktok/search": { "get": { "operationId": "get_tiktok_search", "summary": "TikTok Search", "description": "Tiktok search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "cooking recipes", "schema": { "type": "string" } }, { "name": "date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "yesterday", "this-week", "this-month", "last-3-months", "last-6-months", "all-time" ] } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "most-liked", "date-posted" ] } }, { "name": "region", "in": "query", "required": false, "example": "ES", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "example": 120, "schema": { "type": "integer", "minimum": 1, "maximum": 120 } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/instagram/profile": { "get": { "operationId": "get_instagram_profile", "summary": "Instagram Profile", "description": "Instagram profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "instagram", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "contact_email", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/profile/about": { "get": { "operationId": "get_instagram_profile_about", "summary": "Instagram Profile About", "description": "Instagram profile about. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "instagram", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/profile/posts": { "get": { "operationId": "get_instagram_profile_posts", "summary": "Instagram Profile Posts", "description": "Instagram profile posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "instagram", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "next_max_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_pinned", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "recent_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "audio" ] } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/post": { "get": { "operationId": "get_instagram_post", "summary": "Instagram Post", "description": "Instagram post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.instagram.com/p/DcCH2ZygIiP/", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "download_media", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/post/comments": { "get": { "operationId": "get_instagram_post_comments", "summary": "Instagram Post Comments", "description": "Instagram post comments. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.instagram.com/p/DXidPIVDU6M/", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "top", "recent" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "scan_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/comment": { "get": { "operationId": "get_instagram_comment", "summary": "Instagram Comment", "description": "Instagram comment. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "comment_url", "in": "query", "required": false, "example": "https://www.instagram.com/p/CnpPou9hWqq/c/18007013966365752/", "schema": { "type": "string" } }, { "name": "post_url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "comment_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "author_username", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "text_contains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "deep_scan", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "position_hint", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/youtube/channel": { "get": { "operationId": "get_youtube_channel", "summary": "YouTube Channel", "description": "Youtube channel. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "MrBeast", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "forUsername", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "contact_email", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "channelId", "handle", "url" ] ], "tags": [ "YouTube" ] } }, "/youtube/channel/about": { "get": { "operationId": "get_youtube_channel_about", "summary": "YouTube Channel About", "description": "Youtube channel about. Availability depends on the configured provider route.", "x-credit-cost": 25, "x-launch-status": "beta", "parameters": [ { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "mkbhd", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "contact_email", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "channelId", "handle", "url" ] ], "tags": [ "YouTube" ] } }, "/youtube/channel/videos": { "get": { "operationId": "get_youtube_channel_videos", "summary": "YouTube Channel Videos", "description": "Youtube channel videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "MrBeast", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "popular" ] } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeExtras", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "is_paid_promotions", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "channel" ] } }, { "name": "exact_dates", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "channelId", "handle" ] ], "tags": [ "YouTube" ] } }, "/youtube/video": { "get": { "operationId": "get_youtube_video", "summary": "YouTube Video", "description": "Youtube video. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/videos": { "post": { "operationId": "post_youtube_videos", "summary": "YouTube Videos", "description": "Youtube videos. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "hl", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "include_localizations": { "type": "boolean" } } } } } }, "tags": [ "YouTube" ] } }, "/youtube/channels": { "post": { "operationId": "post_youtube_channels", "summary": "YouTube Channels", "description": "Youtube channels. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "hl", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "include_localizations": { "type": "boolean" } } } } } }, "tags": [ "YouTube" ] } }, "/youtube/transcripts": { "post": { "operationId": "post_youtube_transcripts", "summary": "YouTube Transcripts", "description": "Youtube transcripts. Availability depends on the configured provider route.", "x-credit-cost": 3, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "language": { "type": "string" }, "format": { "type": "string" } } } } } }, "tags": [ "YouTube" ] } }, "/youtube/video/sponsors": { "get": { "operationId": "get_youtube_video_sponsors", "summary": "YouTube Video Sponsors", "description": "Youtube video sponsors. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=AVO0ifle-OU", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/video/comments": { "get": { "operationId": "get_youtube_video_comments", "summary": "YouTube Video Comments", "description": "Youtube video comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "top", "newest" ] } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "html", "plainText" ] } }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/video/comment/replies": { "get": { "operationId": "get_youtube_video_comment_replies", "summary": "YouTube Video Comment Replies", "description": "Youtube video comment replies. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "continuationToken", "in": "query", "required": true, "example": "Ugzge340dBgB75hWBm54AaABAg", "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "html", "plainText" ] } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/search": { "get": { "operationId": "get_youtube_search", "summary": "YouTube Search", "description": "Youtube search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "javascript tutorial", "schema": { "type": "string" } }, { "name": "uploadDate", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "today", "this_week", "this_month", "this_year" ] } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "popular" ] } }, { "name": "type", "in": "query", "required": false, "example": "videos", "schema": { "type": "string", "enum": [ "videos", "shorts", "channels", "playlists" ] } }, { "name": "duration", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "under_3_min", "between_3_and_20_min", "over_20_min" ] } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeExtras", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exact_dates", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/twitter/profile": { "get": { "operationId": "get_twitter_profile", "summary": "X (Twitter) Profile", "description": "Twitter profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "elonmusk", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/user/tweets": { "get": { "operationId": "get_twitter_user_tweets", "summary": "X (Twitter) User Tweets", "description": "Twitter user tweets. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "elonmusk", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/tweet": { "get": { "operationId": "get_twitter_tweet", "summary": "X (Twitter) Tweet", "description": "Twitter tweet. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://x.com/NASA/status/2073078061499617543", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/linkedin/profile": { "get": { "operationId": "get_linkedin_profile", "summary": "LinkedIn Profile", "description": "Linkedin profile. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company": { "get": { "operationId": "get_linkedin_company", "summary": "LinkedIn Company", "description": "Linkedin company. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/company/microsoft/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company/by-domain": { "get": { "operationId": "get_linkedin_company_by_domain", "summary": "LinkedIn Company By Domain", "description": "Linkedin company by domain. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "domain", "in": "query", "required": true, "example": "microsoft.com", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/similar": { "get": { "operationId": "get_linkedin_profile_similar", "summary": "LinkedIn Profile Similar", "description": "Linkedin profile similar. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/companies": { "get": { "operationId": "get_linkedin_search_companies", "summary": "LinkedIn Search Companies", "description": "Linkedin search companies. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "microsoft", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "company_size", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10001+" ] } }, { "name": "has_jobs", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "industry_ids", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "geocode", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/posted-jobs": { "get": { "operationId": "get_linkedin_profile_posted_jobs", "summary": "LinkedIn Profile Posted Jobs", "description": "Linkedin profile posted jobs. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/jipeng-han/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/job/hiring-team": { "get": { "operationId": "get_linkedin_job_hiring_team", "summary": "LinkedIn Job Hiring Team", "description": "Linkedin job hiring team. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "4463963538", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "LinkedIn" ] } }, "/linkedin/profile/articles": { "get": { "operationId": "get_linkedin_profile_articles", "summary": "LinkedIn Profile Articles", "description": "Linkedin profile articles. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/article": { "get": { "operationId": "get_linkedin_article", "summary": "LinkedIn Article", "description": "Linkedin article. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/pulse/hidden-costs-unreliable-electricity-bill-gates/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/article/comments": { "get": { "operationId": "get_linkedin_article_comments", "summary": "LinkedIn Article Comments", "description": "Linkedin article comments. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/pulse/2024-corporate-climate-pivot-bill-gates-u89mc/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/article/reactions": { "get": { "operationId": "get_linkedin_article_reactions", "summary": "LinkedIn Article Reactions", "description": "Linkedin article reactions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/pulse/2024-corporate-climate-pivot-bill-gates-u89mc/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/hashtag": { "get": { "operationId": "get_linkedin_search_hashtag", "summary": "LinkedIn Search Hashtag", "description": "Linkedin search hashtag. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "hiring", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recent", "oldest", "relevance" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/activity": { "get": { "operationId": "get_linkedin_profile_activity", "summary": "LinkedIn Profile Activity", "description": "Linkedin profile activity. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/adamselipsky/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company/also-viewed": { "get": { "operationId": "get_linkedin_company_also_viewed", "summary": "LinkedIn Company Also Viewed", "description": "Linkedin company also viewed. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": false, "example": "1441", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "company_id", "url" ] ], "tags": [ "LinkedIn" ] } }, "/linkedin/company/employees-count": { "get": { "operationId": "get_linkedin_company_employees_count", "summary": "LinkedIn Company Employees Count", "description": "Linkedin company employees count. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": true, "example": "1441", "schema": { "type": "string" } }, { "name": "geocode", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/interests/schools": { "get": { "operationId": "get_linkedin_profile_interests_schools", "summary": "LinkedIn Profile Interests Schools", "description": "Linkedin profile interests schools. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/interests/newsletters": { "get": { "operationId": "get_linkedin_profile_interests_newsletters", "summary": "LinkedIn Profile Interests Newsletters", "description": "Linkedin profile interests newsletters. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/interests/top-voices": { "get": { "operationId": "get_linkedin_profile_interests_top_voices", "summary": "LinkedIn Profile Interests Top Voices", "description": "Linkedin profile interests top voices. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/position-skills": { "get": { "operationId": "get_linkedin_profile_position_skills", "summary": "LinkedIn Profile Position Skills", "description": "Linkedin profile position skills. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/tedgaubert/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/top-position": { "get": { "operationId": "get_linkedin_profile_top_position", "summary": "LinkedIn Profile Top Position", "description": "Linkedin profile top position. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/adamselipsky/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/people/by-url": { "get": { "operationId": "get_linkedin_search_people_by_url", "summary": "LinkedIn Search People By Url", "description": "Linkedin search people by url. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/search/results/people/?keywords=kyc", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/all": { "get": { "operationId": "get_linkedin_profile_all", "summary": "LinkedIn Profile All", "description": "Linkedin profile all. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "urls", "in": "query", "required": false, "example": "https://www.linkedin.com/in/williamhgates,https://www.linkedin.com/in/jeffweiner08", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "urls" ] ], "tags": [ "LinkedIn" ] } }, "/linkedin/profile/complete": { "get": { "operationId": "get_linkedin_profile_complete", "summary": "LinkedIn Profile Complete", "description": "Linkedin profile complete. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/ryanroslansky/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/with-posts": { "get": { "operationId": "get_linkedin_profile_with_posts", "summary": "LinkedIn Profile With Posts", "description": "Linkedin profile with posts. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/adamselipsky/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/post/with-comments": { "get": { "operationId": "get_linkedin_post_with_comments", "summary": "LinkedIn Post With Comments", "description": "Linkedin post with comments. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/post": { "get": { "operationId": "get_linkedin_post", "summary": "LinkedIn Post", "description": "Linkedin post. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/people": { "get": { "operationId": "get_linkedin_search_people", "summary": "LinkedIn Search People", "description": "Linkedin search people. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Bill Gates", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "first_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "current_company", "in": "query", "required": false, "example": "1035", "schema": { "type": "string" } }, { "name": "past_company", "in": "query", "required": false, "example": "1035", "schema": { "type": "string" } }, { "name": "school", "in": "query", "required": false, "example": "1792", "schema": { "type": "string" } }, { "name": "industry", "in": "query", "required": false, "example": "4", "schema": { "type": "string" } }, { "name": "geocode_location", "in": "query", "required": false, "example": "103644278", "schema": { "type": "string" } }, { "name": "profile_language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "service_category", "in": "query", "required": false, "example": "1", "schema": { "type": "string" } }, { "name": "follower_of", "in": "query", "required": false, "example": "ACoAAA8BYqEBCGLg_vT_ca6mMEqkpp9nVffJ3hc", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "profile" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company/people": { "get": { "operationId": "get_linkedin_company_people", "summary": "LinkedIn Company People", "description": "Linkedin company people. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": true, "example": "1035", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "profile" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/post/comments": { "get": { "operationId": "get_linkedin_post_comments", "summary": "LinkedIn Post Comments", "description": "Linkedin post comments. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/feed/update/urn:li:activity:7244804629786419202", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "post_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "activity", "ugc" ] } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recent", "relevance" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/posts": { "get": { "operationId": "get_linkedin_profile_posts", "summary": "LinkedIn Profile Posts", "description": "Linkedin profile posts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/reactions": { "get": { "operationId": "get_linkedin_profile_reactions", "summary": "LinkedIn Profile Reactions", "description": "Linkedin profile reactions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/post/reposts": { "get": { "operationId": "get_linkedin_post_reposts", "summary": "LinkedIn Post Reposts", "description": "Linkedin post reposts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/group/posts": { "get": { "operationId": "get_linkedin_group_posts", "summary": "LinkedIn Group Posts", "description": "Linkedin group posts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "group_id", "in": "query", "required": true, "example": "62438", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company/affiliated-pages": { "get": { "operationId": "get_linkedin_company_affiliated_pages", "summary": "LinkedIn Company Affiliated Pages", "description": "Linkedin company affiliated pages. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": true, "example": "1035", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/post/comments/replies": { "get": { "operationId": "get_linkedin_post_comments_replies", "summary": "LinkedIn Post Comments Replies", "description": "Linkedin post comments replies. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928", "schema": { "type": "string" } }, { "name": "comment_id", "in": "query", "required": true, "example": "7501480403283886080", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/experiences": { "get": { "operationId": "get_linkedin_profile_experiences", "summary": "LinkedIn Profile Experiences", "description": "Linkedin profile experiences. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/educations": { "get": { "operationId": "get_linkedin_profile_educations", "summary": "LinkedIn Profile Educations", "description": "Linkedin profile educations. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/skills": { "get": { "operationId": "get_linkedin_profile_skills", "summary": "LinkedIn Profile Skills", "description": "Linkedin profile skills. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/honors": { "get": { "operationId": "get_linkedin_profile_honors", "summary": "LinkedIn Profile Honors", "description": "Linkedin profile honors. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/certifications": { "get": { "operationId": "get_linkedin_profile_certifications", "summary": "LinkedIn Profile Certifications", "description": "Linkedin profile certifications. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/publications": { "get": { "operationId": "get_linkedin_profile_publications", "summary": "LinkedIn Profile Publications", "description": "Linkedin profile publications. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/volunteers": { "get": { "operationId": "get_linkedin_profile_volunteers", "summary": "LinkedIn Profile Volunteers", "description": "Linkedin profile volunteers. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/recommendations": { "get": { "operationId": "get_linkedin_profile_recommendations", "summary": "LinkedIn Profile Recommendations", "description": "Linkedin profile recommendations. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "received", "given" ] } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/interests/companies": { "get": { "operationId": "get_linkedin_profile_interests_companies", "summary": "LinkedIn Profile Interests Companies", "description": "Linkedin profile interests companies. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/interests/groups": { "get": { "operationId": "get_linkedin_profile_interests_groups", "summary": "LinkedIn Profile Interests Groups", "description": "Linkedin profile interests groups. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/images": { "get": { "operationId": "get_linkedin_profile_images", "summary": "LinkedIn Profile Images", "description": "Linkedin profile images. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/videos": { "get": { "operationId": "get_linkedin_profile_videos", "summary": "LinkedIn Profile Videos", "description": "Linkedin profile videos. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/comments": { "get": { "operationId": "get_linkedin_profile_comments", "summary": "LinkedIn Profile Comments", "description": "Linkedin profile comments. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/post/reactions": { "get": { "operationId": "get_linkedin_post_reactions", "summary": "LinkedIn Post Reactions", "description": "Linkedin post reactions. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/feed/update/urn:li:activity:7501466755261820928", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "like", "praise", "empathy", "appreciation", "interest" ] } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "profile" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company/jobs": { "get": { "operationId": "get_linkedin_company_jobs", "summary": "LinkedIn Company Jobs", "description": "Linkedin company jobs. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": true, "example": "1035", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anytime", "past_24_hours", "past_week", "past_month" ] } }, { "name": "experience_level", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "internship", "entry_level", "associate", "mid_senior", "director", "executive" ] } }, { "name": "job_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "full_time", "part_time", "contract", "temporary", "volunteer", "internship", "other" ] } }, { "name": "remote", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "onsite", "remote", "hybrid" ] } }, { "name": "easy_apply", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recent", "relevant" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/jobs": { "get": { "operationId": "get_linkedin_search_jobs", "summary": "LinkedIn Search Jobs", "description": "Linkedin search jobs. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "marketing", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anytime", "past_24_hours", "past_week", "past_month" ] } }, { "name": "experience_level", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "internship", "entry_level", "associate", "mid_senior", "director", "executive" ] } }, { "name": "job_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "full_time", "part_time", "contract", "temporary", "volunteer", "internship", "other" ] } }, { "name": "remote", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "onsite", "remote", "hybrid" ] } }, { "name": "easy_apply", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recent", "relevant" ] } }, { "name": "company", "in": "query", "required": false, "example": "1035", "schema": { "type": "string" } }, { "name": "geocode", "in": "query", "required": false, "example": "103644278", "schema": { "type": "string" } }, { "name": "industry_ids", "in": "query", "required": false, "example": "4", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/location": { "get": { "operationId": "get_linkedin_search_location", "summary": "LinkedIn Search Location", "description": "Linkedin search location. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "London", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/schools": { "get": { "operationId": "get_linkedin_search_schools", "summary": "LinkedIn Search Schools", "description": "Linkedin search schools. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Stanford", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/industry": { "get": { "operationId": "get_linkedin_search_industry", "summary": "LinkedIn Search Industry", "description": "Linkedin search industry. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Software", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/about": { "get": { "operationId": "get_linkedin_profile_about", "summary": "LinkedIn Profile About", "description": "Linkedin profile about. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "urn", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/contact": { "get": { "operationId": "get_linkedin_profile_contact", "summary": "LinkedIn Profile Contact", "description": "Linkedin profile contact. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/profile/stats": { "get": { "operationId": "get_linkedin_profile_stats", "summary": "LinkedIn Profile Stats", "description": "Linkedin profile stats. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company/job-count": { "get": { "operationId": "get_linkedin_company_job_count", "summary": "LinkedIn Company Job Count", "description": "Linkedin company job count. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": true, "example": "1035", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/company/insights": { "get": { "operationId": "get_linkedin_company_insights", "summary": "LinkedIn Company Insights", "description": "Linkedin company insights. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": true, "example": "1035", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/group": { "get": { "operationId": "get_linkedin_group", "summary": "LinkedIn Group", "description": "Linkedin group. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "group_id", "in": "query", "required": true, "example": "62438", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/job": { "get": { "operationId": "get_linkedin_job", "summary": "LinkedIn Job", "description": "Linkedin job. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "4462185352", "schema": { "type": "string" } }, { "name": "include_skills", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/facebook/profile": { "get": { "operationId": "get_facebook_profile", "summary": "Facebook Profile", "description": "Facebook profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/Meta", "schema": { "type": "string" } }, { "name": "get_business_hours", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/profile/posts": { "get": { "operationId": "get_facebook_profile_posts", "summary": "Facebook Profile Posts", "description": "Facebook profile posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/Meta", "schema": { "type": "string" } }, { "name": "pageId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "engagement" ] } }, { "name": "recent_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "pageId" ] ], "tags": [ "Facebook" ] } }, "/facebook/post": { "get": { "operationId": "get_facebook_post", "summary": "Facebook Post", "description": "Facebook post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/Meta/posts/1234567890", "schema": { "type": "string" } }, { "name": "get_comments", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "get_transcript", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/post/comments": { "get": { "operationId": "get_facebook_post_comments", "summary": "Facebook Post Comments", "description": "Facebook post comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/Meta/videos/a-slightly-life-changing-story/1459847961114516/", "schema": { "type": "string" } }, { "name": "feedback_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "feedback_id" ] ], "tags": [ "Facebook" ] } }, "/reddit/subreddit": { "get": { "operationId": "get_reddit_subreddit", "summary": "Reddit Subreddit", "description": "Reddit subreddit. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "subreddit", "in": "query", "required": true, "example": "technology", "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ] } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best", "hot", "new", "top", "rising" ] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/subreddit/details": { "get": { "operationId": "get_reddit_subreddit_details", "summary": "Reddit Subreddit Details", "description": "Reddit subreddit details. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "subreddit", "in": "query", "required": false, "example": "AskReddit", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "subreddit", "url" ] ], "tags": [ "Reddit" ] } }, "/reddit/search": { "get": { "operationId": "get_reddit_search", "summary": "Reddit Search", "description": "Reddit search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "\"claude code\"", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "new", "top", "comment_count" ] } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_body", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/post": { "get": { "operationId": "get_reddit_post", "summary": "Reddit Post", "description": "Reddit post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.reddit.com/r/NoteTaking/comments/1o9s55r/i_tried_all_popular_ai_notetaking_apps_so_you/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/post/comments": { "get": { "operationId": "get_reddit_post_comments", "summary": "Reddit Post Comments", "description": "Reddit post comments. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.reddit.com/r/NoteTaking/comments/1o9s55r/i_tried_all_popular_ai_notetaking_apps_so_you/", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/threads/profile": { "get": { "operationId": "get_threads_profile", "summary": "Threads Profile", "description": "Threads profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "zuck", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Threads" ] } }, "/threads/user/posts": { "get": { "operationId": "get_threads_user_posts", "summary": "Threads User Posts", "description": "Threads user posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "zuck", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "engagement" ] } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Threads" ] } }, "/threads/post": { "get": { "operationId": "get_threads_post", "summary": "Threads Post", "description": "Threads post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.threads.com/@zuck/post/DZpPDXbCeTt", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Threads" ] } }, "/threads/search": { "get": { "operationId": "get_threads_search", "summary": "Threads Search", "description": "Threads search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "artificial intelligence", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "expand", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "engagement" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Threads" ] } }, "/threads/post/comments": { "get": { "operationId": "get_threads_post_comments", "summary": "Threads Post Comments", "description": "Threads post comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.threads.com/@zuck/post/DZpPDXbCeTt", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "example": 50, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Threads" ] } }, "/pinterest/search": { "get": { "operationId": "get_pinterest_search", "summary": "Pinterest Search", "description": "Pinterest search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "home decor ideas", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "engagement" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Pinterest" ] } }, "/pinterest/pin": { "get": { "operationId": "get_pinterest_pin", "summary": "Pinterest Pin", "description": "Pinterest pin. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.pinterest.com/pin/1234567890/", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Pinterest" ] } }, "/twitch/profile": { "get": { "operationId": "get_twitch_profile", "summary": "Twitch Profile", "description": "Twitch profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "ninja", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Twitch" ] } }, "/twitch/clip": { "get": { "operationId": "get_twitch_clip", "summary": "Twitch Clip", "description": "Twitch clip. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.twitch.tv/ninja/clip/ExampleClipSlug", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Twitch" ] } }, "/twitch/user/videos": { "get": { "operationId": "get_twitch_user_videos", "summary": "Twitch User Videos", "description": "Twitch user videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "ishowspeed", "schema": { "type": "string" } }, { "name": "filter_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "HIGHLIGHT", "UPLOAD" ] } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "TIME", "VIEWS" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Twitch" ] } }, "/twitch/user/schedule": { "get": { "operationId": "get_twitch_user_schedule", "summary": "Twitch User Schedule", "description": "Twitch user schedule. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "kaicenat", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Twitch" ] } }, "/snapchat/profile": { "get": { "operationId": "get_snapchat_profile", "summary": "Snapchat Profile", "description": "Snapchat profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "djkhaled305", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Snapchat" ] } }, "/snapchat/spotlight/comments": { "get": { "operationId": "get_snapchat_spotlight_comments", "summary": "Snapchat Spotlight Comments", "description": "Snapchat spotlight comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.snapchat.com/@lilah4823/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYY2pvZnd0ZXVmAZ8fgG8pAZ8ff-_IAAAAAQ", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Snapchat" ] } }, "/truthsocial/profile": { "get": { "operationId": "get_truthsocial_profile", "summary": "Truthsocial Profile", "description": "Truthsocial profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "realDonaldTrump", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Truthsocial" ] } }, "/truthsocial/user/posts": { "get": { "operationId": "get_truthsocial_user_posts", "summary": "Truthsocial User Posts", "description": "Truthsocial user posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "realDonaldTrump", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "next_max_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Truthsocial" ] } }, "/truthsocial/post": { "get": { "operationId": "get_truthsocial_post", "summary": "Truthsocial Post", "description": "Truthsocial post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://truthsocial.com/@realDonaldTrump/posts/123456789", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Truthsocial" ] } }, "/telegram/profile": { "get": { "operationId": "get_telegram_profile", "summary": "Telegram Profile", "description": "Telegram profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "telegram", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Telegram" ] } }, "/telegram/profile/posts": { "get": { "operationId": "get_telegram_profile_posts", "summary": "Telegram Profile Posts", "description": "Telegram profile posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "telegram", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Telegram" ] } }, "/telegram/post": { "get": { "operationId": "get_telegram_post", "summary": "Telegram Post", "description": "Telegram post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://t.me/durov/546", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Telegram" ] } }, "/kick/clip": { "get": { "operationId": "get_kick_clip", "summary": "Kick Clip", "description": "Kick clip. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://kick.com/xqc/clips/clip_abc123", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Kick" ] } }, "/kwai/profile": { "get": { "operationId": "get_kwai_profile", "summary": "Kwai Profile", "description": "Kwai profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "KwaiBrasilOficial", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "url" ] ], "tags": [ "Kwai" ] } }, "/kwai/user/posts": { "get": { "operationId": "get_kwai_user_posts", "summary": "Kwai User Posts", "description": "Kwai user posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "KwaiBrasilOficial", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "url" ] ], "tags": [ "Kwai" ] } }, "/kwai/post": { "get": { "operationId": "get_kwai_post", "summary": "Kwai Post", "description": "Kwai post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.kwai.com/@KwaiBrasilOficial/photo/5193363430624671876", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Kwai" ] } }, "/tiktok/trending": { "get": { "operationId": "get_tiktok_trending", "summary": "TikTok Trending", "description": "Tiktok trending. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "region", "in": "query", "required": true, "example": "US", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "feed", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "global", "local" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/search/hashtag": { "get": { "operationId": "get_tiktok_search_hashtag", "summary": "TikTok Search Hashtag", "description": "Tiktok search hashtag. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "hashtag", "in": "query", "required": true, "example": "fyp", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/search/top": { "get": { "operationId": "get_tiktok_search_top", "summary": "TikTok Search Top", "description": "Tiktok search top. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "dance challenge", "schema": { "type": "string" } }, { "name": "publish_time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "yesterday", "this-week", "this-month", "last-3-months", "last-6-months", "all-time" ] } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "most-liked", "date-posted" ] } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/search/users": { "get": { "operationId": "get_tiktok_search_users", "summary": "TikTok Search Users", "description": "Tiktok search users. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "cooking", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "profile" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 30 } }, { "name": "country", "in": "query", "required": false, "example": "KR", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "AU", "NZ", "IE", "DE", "FR", "ES", "IT", "PT", "NL", "BE", "CH", "AT", "SE", "NO", "DK", "FI", "IS", "PL", "CZ", "SK", "HU", "RO", "BG", "GR", "HR", "RS", "SI", "UA", "RU", "TR", "IL", "AE", "SA", "QA", "KW", "EG", "MA", "ZA", "NG", "KE", "GH", "TZ", "ET", "BR", "MX", "AR", "CO", "CL", "PE", "VE", "EC", "UY", "PY", "BO", "CR", "PA", "DO", "JM", "JP", "KR", "CN", "TW", "HK", "MO", "SG", "MY", "ID", "TH", "VN", "PH", "IN", "PK", "BD", "LK", "NP", "MM", "KH" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/similar": { "get": { "operationId": "get_tiktok_similar", "summary": "TikTok Similar", "description": "Tiktok similar. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "gordonramsayofficial", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/user/audience": { "get": { "operationId": "get_tiktok_user_audience", "summary": "TikTok User Audience", "description": "Tiktok user audience. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "charlidamelio", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/user/followers": { "get": { "operationId": "get_tiktok_user_followers", "summary": "TikTok User Followers", "description": "Tiktok user followers. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "stoolpresidente", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_time", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/user/following": { "get": { "operationId": "get_tiktok_user_following", "summary": "TikTok User Following", "description": "Tiktok user following. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "stoolpresidente", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_time", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/user/live": { "get": { "operationId": "get_tiktok_user_live", "summary": "TikTok User Live", "description": "Tiktok user live. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "charlidamelio", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/post/transcript": { "get": { "operationId": "get_tiktok_post_transcript", "summary": "TikTok Post Transcript", "description": "Tiktok post transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/@stoolpresidente/video/7499229683859426602", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "use_ai_as_fallback", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "moments", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/video/screen-text": { "get": { "operationId": "get_tiktok_video_screen_text", "summary": "TikTok Video Screen Text", "description": "Tiktok video screen text. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/@stoolpresidente/video/7499229683859426602", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/song": { "get": { "operationId": "get_tiktok_song", "summary": "TikTok Song", "description": "Tiktok song. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "clipId", "in": "query", "required": true, "example": "7439295283975702544", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/song/videos": { "get": { "operationId": "get_tiktok_song_videos", "summary": "TikTok Song Videos", "description": "Tiktok song videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "clipId", "in": "query", "required": false, "example": "7439295283975702544", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "use", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "clipId" ] ], "tags": [ "TikTok" ] } }, "/tiktok/hashtags/popular": { "get": { "operationId": "get_tiktok_hashtags_popular", "summary": "TikTok Hashtags Popular", "description": "Tiktok hashtags popular. Availability depends on the configured provider route.", "x-credit-cost": 6, "x-launch-status": "beta", "parameters": [ { "name": "countryCode", "in": "query", "required": false, "example": "DE", "schema": { "type": "string", "enum": [ "US", "FR", "DE", "IT", "ES", "GB", "AR", "AU", "BR", "CA", "CO", "EG", "ID", "IL", "JP", "KR", "MY", "MX", "PH", "SA", "SG", "ZA", "TW", "TH", "TR", "AE", "VN" ] } }, { "name": "period", "in": "query", "required": false, "example": "7", "schema": { "type": "string", "enum": [ "7", "30", "90" ] } }, { "name": "industry", "in": "query", "required": false, "example": "all", "schema": { "type": "string", "enum": [ "all", "education", "vehicle-and-transportation", "baby-kids-and-maternity", "beauty-and-personal-care", "tech-and-electronics", "travel", "household-products", "pets", "home-improvement", "apparel-and-accessories", "news-and-entertainment", "games", "food-and-beverage", "sports-and-outdoor", "health" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/videos/popular": { "get": { "operationId": "get_tiktok_videos_popular", "summary": "TikTok Videos Popular", "description": "Tiktok videos popular. Availability depends on the configured provider route.", "x-credit-cost": 26, "x-launch-status": "beta", "parameters": [ { "name": "countryCode", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "JP", "VN", "TH", "ID" ] } }, { "name": "period", "in": "query", "required": false, "example": "7", "schema": { "type": "string", "enum": [ "7", "30" ] } }, { "name": "orderBy", "in": "query", "required": false, "example": "views", "schema": { "type": "string", "enum": [ "views", "engagement", "six_second_views" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/profile/region": { "get": { "operationId": "get_tiktok_profile_region", "summary": "TikTok Profile Region", "description": "Tiktok profile region. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "stoolpresidente", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/adlibrary/search": { "get": { "operationId": "get_tiktok_adlibrary_search", "summary": "TikTok Adlibrary Search", "description": "Tiktok adlibrary search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "advertiser_name", "in": "query", "required": false, "example": "Gymshark", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ad" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 12 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "advertiser_name" ] ], "tags": [ "TikTok" ] } }, "/tiktok/adlibrary/ad": { "get": { "operationId": "get_tiktok_adlibrary_ad", "summary": "TikTok Adlibrary Ad", "description": "Tiktok adlibrary ad. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "ad_id", "in": "query", "required": false, "example": "1869335220395266", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "ad_id", "url" ] ], "tags": [ "TikTok" ] } }, "/tiktok/search/suggestions": { "get": { "operationId": "get_tiktok_search_suggestions", "summary": "TikTok Search Suggestions", "description": "Tiktok search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "dogs", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/collection/videos": { "get": { "operationId": "get_tiktok_collection_videos", "summary": "TikTok Collection Videos", "description": "Tiktok collection videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/@kibblemaster808/collection/Want-to-go-7665668414573546258", "schema": { "type": "string" } }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/profile/playlists": { "get": { "operationId": "get_tiktok_profile_playlists", "summary": "TikTok Profile Playlists", "description": "Tiktok profile playlists. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "chipotle", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/playlist/videos": { "get": { "operationId": "get_tiktok_playlist_videos", "summary": "TikTok Playlist Videos", "description": "Tiktok playlist videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "playlist_id", "in": "query", "required": true, "example": "7229371484127382314", "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "chipotle", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/user/liked": { "get": { "operationId": "get_tiktok_user_liked", "summary": "TikTok User Liked", "description": "Tiktok user liked. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "chipotle", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/location/posts": { "get": { "operationId": "get_tiktok_location_posts", "summary": "TikTok Location Posts", "description": "Tiktok location posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "location_id", "in": "query", "required": true, "example": "22535865202815278", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/effects": { "get": { "operationId": "get_tiktok_effects", "summary": "TikTok Effects", "description": "Tiktok effects. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "ids", "in": "query", "required": true, "example": "1108584,1109028", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/effect/videos": { "get": { "operationId": "get_tiktok_effect_videos", "summary": "TikTok Effect Videos", "description": "Tiktok effect videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "effect_id", "in": "query", "required": true, "example": "1108584", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/search/music": { "get": { "operationId": "get_tiktok_search_music", "summary": "TikTok Search Music", "description": "Tiktok search music. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "espresso", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "most-used", "most-recent", "shortest", "longest" ] } }, { "name": "filter_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "title", "creators" ] } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktok/hashtag": { "get": { "operationId": "get_tiktok_hashtag", "summary": "TikTok Hashtag", "description": "Tiktok hashtag. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "hashtag", "in": "query", "required": false, "example": "kpop", "schema": { "type": "string" } }, { "name": "hashtag_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "hashtag", "hashtag_id" ] ], "tags": [ "TikTok" ] } }, "/tiktok/ads/top": { "get": { "operationId": "get_tiktok_ads_top", "summary": "TikTok Ads Top", "description": "Tiktok ads top. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "CA", "MX", "BR", "GB", "DE", "FR", "IT", "ES", "NL", "PL", "SE", "TR", "SA", "AE", "AU", "JP", "KR", "ID", "TH", "VN", "MY", "PH", "SG" ] } }, { "name": "period", "in": "query", "required": false, "example": "30", "schema": { "type": "string", "enum": [ "7", "30", "180" ] } }, { "name": "order_by", "in": "query", "required": false, "example": "ctr", "schema": { "type": "string", "enum": [ "for_you", "impression", "ctr", "play_2s_rate", "play_6s_rate", "cvr", "like" ] } }, { "name": "ad_format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "All ad types", "Spark ads", "Non-Spark ads" ] } }, { "name": "ad_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "en", "ja", "zh", "vi", "th", "pt", "id" ] } }, { "name": "like_tier", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ] } }, { "name": "industry", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok" ] } }, "/tiktokshop/product": { "get": { "operationId": "get_tiktokshop_product", "summary": "TikTok Shop Product", "description": "Tiktokshop product. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.tiktok.com/shop/pdp/goli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo/1729587769570529799", "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "required": false, "example": "1729587769570529799", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "GB", "ID", "MY", "TH", "SG", "VN", "PH" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "product_id" ] ], "tags": [ "TikTok Shop" ] } }, "/tiktokshop/product/reviews": { "get": { "operationId": "get_tiktokshop_product_reviews", "summary": "TikTok Shop Product Reviews", "description": "Tiktokshop product reviews. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.tiktok.com/shop/pdp/cat-nail-clipper-by-potaroma-adjustable-sizes-built-in-file-safe-for-kittens-cats/1731578642912612516", "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "GB", "DE", "FR", "IT", "ID", "MY", "MX", "PH", "SG", "ES", "TH", "VN", "BR", "JP", "IE" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "product_id" ] ], "tags": [ "TikTok Shop" ] } }, "/tiktokshop/products": { "get": { "operationId": "get_tiktokshop_products", "summary": "TikTok Shop Products", "description": "Tiktokshop products. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "top", "new_releases" ] } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "GB", "DE", "FR", "IT", "ID", "MY", "MX", "PH", "SG", "ES", "TH", "VN", "BR", "JP", "IE" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok Shop" ] } }, "/tiktokshop/search": { "get": { "operationId": "get_tiktokshop_search", "summary": "TikTok Shop Search", "description": "Tiktokshop search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "phone case", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "GB", "DE", "FR", "IT", "ID", "MY", "MX", "PH", "SG", "ES", "TH", "VN", "BR", "JP", "IE" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok Shop" ] } }, "/tiktokshop/user/showcase": { "get": { "operationId": "get_tiktokshop_user_showcase", "summary": "TikTok Shop User Showcase", "description": "Tiktokshop user showcase. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "mrtiktokreviews", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok Shop" ] } }, "/tiktokshop/sales": { "get": { "operationId": "get_tiktokshop_sales", "summary": "TikTok Shop Sales", "description": "Tiktokshop sales. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "lip gloss", "schema": { "type": "string" } }, { "name": "regions", "in": "query", "required": false, "example": "US,GB,MY", "schema": { "type": "string" } }, { "name": "top", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "TikTok Shop" ] } }, "/instagram/basic-profile": { "get": { "operationId": "get_instagram_basic_profile", "summary": "Instagram Basic Profile", "description": "Instagram basic profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "userId", "in": "query", "required": false, "example": "314216", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/profile/reels": { "get": { "operationId": "get_instagram_profile_reels", "summary": "Instagram Profile Reels", "description": "Instagram profile reels. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "exclude_pinned", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "recent_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "user_id", "handle" ] ], "tags": [ "Instagram" ] } }, "/instagram/highlights": { "get": { "operationId": "get_instagram_highlights", "summary": "Instagram Highlights", "description": "Instagram highlights. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "instagram", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "user_id", "handle" ] ], "tags": [ "Instagram" ] } }, "/instagram/highlight/detail": { "get": { "operationId": "get_instagram_highlight_detail", "summary": "Instagram Highlight Detail", "description": "Instagram highlight detail. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "18067016518767507", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/search/reels": { "get": { "operationId": "get_instagram_search_reels", "summary": "Instagram Search Reels", "description": "Instagram search reels. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "workout routine", "schema": { "type": "string" } }, { "name": "date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "last-week", "last-month", "last-year" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ES", "MX", "DE", "BR", "KR", "FR" ] } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "creator" ] } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ES", "MX", "DE", "BR", "KR", "FR" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/media/transcript": { "get": { "operationId": "get_instagram_media_transcript", "summary": "Instagram Media Transcript", "description": "Instagram media transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.instagram.com/reel/DHsD6HGqJhp/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/media/screen-text": { "get": { "operationId": "get_instagram_media_screen_text", "summary": "Instagram Media Screen Text", "description": "Instagram media screen text. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.instagram.com/p/DdEqEl5Dl-S/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/user/embed": { "get": { "operationId": "get_instagram_user_embed", "summary": "Instagram User Embed", "description": "Instagram user embed. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "instagram", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/audio/reels": { "get": { "operationId": "get_instagram_audio_reels", "summary": "Instagram Audio Reels", "description": "Instagram audio reels. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "audio_id", "in": "query", "required": true, "example": "1392969992841787", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/search/hashtag": { "get": { "operationId": "get_instagram_search_hashtag", "summary": "Instagram Search Hashtag", "description": "Instagram search hashtag. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "hashtag", "in": "query", "required": true, "example": "makeup", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "top", "recent", "clips" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/search/profiles": { "get": { "operationId": "get_instagram_search_profiles", "summary": "Instagram Search Profiles", "description": "Instagram search profiles. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "yoga", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "about" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 12 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/reels/trending": { "get": { "operationId": "get_instagram_reels_trending", "summary": "Instagram Reels Trending", "description": "Instagram reels trending. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/followers": { "get": { "operationId": "get_instagram_followers", "summary": "Instagram Followers", "description": "Instagram followers. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "coverage", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "full" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Instagram" ] } }, "/instagram/following": { "get": { "operationId": "get_instagram_following", "summary": "Instagram Following", "description": "Instagram following. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "coverage", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "full" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Instagram" ] } }, "/instagram/similar": { "get": { "operationId": "get_instagram_similar", "summary": "Instagram Similar", "description": "Instagram similar. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "profile" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 80 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Instagram" ] } }, "/instagram/post/likers": { "get": { "operationId": "get_instagram_post_likers", "summary": "Instagram Post Likers", "description": "Instagram post likers. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.instagram.com/p/CnpPou9hWqq/", "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/post/stats": { "get": { "operationId": "get_instagram_post_stats", "summary": "Instagram Post Stats", "description": "Instagram post stats. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.instagram.com/p/CnpPou9hWqq/", "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "saves" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/tagged": { "get": { "operationId": "get_instagram_tagged", "summary": "Instagram Tagged", "description": "Instagram tagged. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Instagram" ] } }, "/instagram/location/posts": { "get": { "operationId": "get_instagram_location_posts", "summary": "Instagram Location Posts", "description": "Instagram location posts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "location_id", "in": "query", "required": true, "example": "331004901", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/engagement": { "get": { "operationId": "get_instagram_engagement", "summary": "Instagram Engagement", "description": "Instagram engagement. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/search/location": { "get": { "operationId": "get_instagram_search_location", "summary": "Instagram Search Location", "description": "Instagram search location. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Paris", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/search": { "get": { "operationId": "get_instagram_search", "summary": "Instagram Search", "description": "Instagram search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "nike", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/search/popular": { "get": { "operationId": "get_instagram_search_popular", "summary": "Instagram Search Popular", "description": "Instagram search popular. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "basketball", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "engagement" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 12 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/post/comment/replies": { "get": { "operationId": "get_instagram_post_comment_replies", "summary": "Instagram Post Comment Replies", "description": "Instagram post comment replies. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.instagram.com/reel/C8rKmYvsrck", "schema": { "type": "string" } }, { "name": "comment_id", "in": "query", "required": true, "example": "18038110327814211", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/username-suggestions": { "get": { "operationId": "get_instagram_username_suggestions", "summary": "Instagram Username Suggestions", "description": "Instagram username suggestions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/search/music": { "get": { "operationId": "get_instagram_search_music", "summary": "Instagram Search Music", "description": "Instagram search music. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "beyonce", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/instagram/stories": { "get": { "operationId": "get_instagram_stories", "summary": "Instagram Stories", "description": "Instagram stories. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "instagram", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Instagram" ] } }, "/instagram/story/download": { "get": { "operationId": "get_instagram_story_download", "summary": "Instagram Story Download", "description": "Instagram story download. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "user_id", "in": "query", "required": false, "example": "25025320", "schema": { "type": "string" } }, { "name": "story_id", "in": "query", "required": false, "example": "3926693776893966474", "schema": { "type": "string" } }, { "name": "safe_url", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "user_id" ], [ "story_id" ] ], "tags": [ "Instagram" ] } }, "/instagram/music/trending": { "get": { "operationId": "get_instagram_music_trending", "summary": "Instagram Music Trending", "description": "Instagram music trending. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Instagram" ] } }, "/youtube/channel/shorts": { "get": { "operationId": "get_youtube_channel_shorts", "summary": "YouTube Channel Shorts", "description": "Youtube channel shorts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "stop_at_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "MrBeast", "schema": { "type": "string" } }, { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "newest", "popular" ] } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "channel" ] } }, { "name": "exact_dates", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "channelId", "handle" ] ], "tags": [ "YouTube" ] } }, "/youtube/community-post": { "get": { "operationId": "get_youtube_community_post", "summary": "YouTube Community Post", "description": "Youtube community post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/post/Ugkxvj2KoApYAXoqLWnKVr6zZe5JjeHrQeP8", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/playlist": { "get": { "operationId": "get_youtube_playlist", "summary": "YouTube Playlist", "description": "Youtube playlist. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "playlist_id", "in": "query", "required": true, "example": "PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/search/hashtag": { "get": { "operationId": "get_youtube_search_hashtag", "summary": "YouTube Search Hashtag", "description": "Youtube search hashtag. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "hashtag", "in": "query", "required": true, "example": "shorts", "schema": { "type": "string" } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "shorts" ] } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exact_dates", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/shorts/trending": { "get": { "operationId": "get_youtube_shorts_trending", "summary": "YouTube Shorts Trending", "description": "Youtube shorts trending. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "channel" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/video/transcript": { "get": { "operationId": "get_youtube_video_transcript", "summary": "YouTube Video Transcript", "description": "Youtube video transcript. Availability depends on the configured provider route.", "x-credit-cost": 3, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "moments", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/channel/playlists": { "get": { "operationId": "get_youtube_channel_playlists", "summary": "YouTube Channel Playlists", "description": "Youtube channel playlists. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "MrBeast", "schema": { "type": "string" } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "channelId", "handle" ] ], "tags": [ "YouTube" ] } }, "/youtube/channel/lives": { "get": { "operationId": "get_youtube_channel_lives", "summary": "YouTube Channel Lives", "description": "Youtube channel lives. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "IShowSpeed", "schema": { "type": "string" } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exact_dates", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "channelId", "handle" ] ], "tags": [ "YouTube" ] } }, "/youtube/channel/community-posts": { "get": { "operationId": "get_youtube_channel_community_posts", "summary": "YouTube Channel Community Posts", "description": "Youtube channel community posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "example": "MrBeast", "schema": { "type": "string" } }, { "name": "continuationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "channelId", "handle" ] ], "tags": [ "YouTube" ] } }, "/youtube/videos/trending": { "get": { "operationId": "get_youtube_videos_trending", "summary": "YouTube Videos Trending", "description": "Youtube videos trending. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "region", "in": "query", "required": false, "example": "US", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "example": "10", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "channel" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/playlist/items": { "get": { "operationId": "get_youtube_playlist_items", "summary": "YouTube Playlist Items", "description": "Youtube playlist items. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "playlist_id", "in": "query", "required": true, "example": "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/search/advanced": { "get": { "operationId": "get_youtube_search_advanced", "summary": "YouTube Search Advanced", "description": "Youtube search advanced. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "lofi hip hop", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "duration", "in": "query", "required": false, "example": "long", "schema": { "type": "string" } }, { "name": "event_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "license", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "published_after", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "published_before", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "safe_search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "video_caption", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "video_definition", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "video_dimension", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "video_embeddable", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "video_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "topic_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_radius", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeExtras", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "channel" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/search/suggestions": { "get": { "operationId": "get_youtube_search_suggestions", "summary": "YouTube Search Suggestions", "description": "Youtube search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "lofi", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/video/audio": { "get": { "operationId": "get_youtube_video_audio", "summary": "YouTube Video Audio", "description": "Youtube video audio. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/video/files": { "get": { "operationId": "get_youtube_video_files", "summary": "YouTube Video Files", "description": "Youtube video files. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/video/subtitles": { "get": { "operationId": "get_youtube_video_subtitles", "summary": "YouTube Video Subtitles", "description": "Youtube video subtitles. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/youtube/video/thumbnails": { "get": { "operationId": "get_youtube_video_thumbnails", "summary": "YouTube Video Thumbnails", "description": "Youtube video thumbnails. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "YouTube" ] } }, "/twitter/community": { "get": { "operationId": "get_twitter_community", "summary": "X (Twitter) Community", "description": "Twitter community. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://x.com/i/communities/1926186499399139650", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/community/tweets": { "get": { "operationId": "get_twitter_community_tweets", "summary": "X (Twitter) Community Tweets", "description": "Twitter community tweets. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://x.com/i/communities/1926186499399139650", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/tweet/transcript": { "get": { "operationId": "get_twitter_tweet_transcript", "summary": "X (Twitter) Tweet Transcript", "description": "Twitter tweet transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://x.com/TheoVon/status/1916982720317821050", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/ai-search": { "get": { "operationId": "get_twitter_ai_search", "summary": "X (Twitter) Ai Search", "description": "Twitter ai search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "What is @elonmusk saying about xAI this week?", "schema": { "type": "string" } }, { "name": "from_handles", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_handles", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/search/tweets": { "get": { "operationId": "get_twitter_search_tweets", "summary": "X (Twitter) Search Tweets", "description": "Twitter search tweets. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "nike running shoes", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "top" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "switch_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_views", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "sort_rows", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "views" ] } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/tweet/replies": { "get": { "operationId": "get_twitter_tweet_replies", "summary": "X (Twitter) Tweet Replies", "description": "Twitter tweet replies. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://x.com/News24/status/2093257170653483101", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/user/media": { "get": { "operationId": "get_twitter_user_media", "summary": "X (Twitter) User Media", "description": "Twitter user media. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "News24", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/user/followers": { "get": { "operationId": "get_twitter_user_followers", "summary": "X (Twitter) User Followers", "description": "Twitter user followers. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "News24", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/user/following": { "get": { "operationId": "get_twitter_user_following", "summary": "X (Twitter) User Following", "description": "Twitter user following. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "News24", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/tweet/retweeters": { "get": { "operationId": "get_twitter_tweet_retweeters", "summary": "X (Twitter) Tweet Retweeters", "description": "Twitter tweet retweeters. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://x.com/News24/status/2093257170653483101", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/twitter/search/users": { "get": { "operationId": "get_twitter_search_users", "summary": "X (Twitter) Search Users", "description": "Twitter search users. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "news24", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "X (Twitter)" ] } }, "/perplexity/research": { "get": { "operationId": "get_perplexity_research", "summary": "Perplexity Research", "description": "Perplexity research. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "What is the capital of France?", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Perplexity" ] } }, "/linkedin/company/posts": { "get": { "operationId": "get_linkedin_company_posts", "summary": "LinkedIn Company Posts", "description": "Linkedin company posts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "company_id", "in": "query", "required": true, "example": "1035", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "top", "recent" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/ad": { "get": { "operationId": "get_linkedin_ad", "summary": "LinkedIn Ad", "description": "Linkedin ad. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/ad-library/detail/1515437353", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/ads/search": { "get": { "operationId": "get_linkedin_ads_search", "summary": "LinkedIn Ads Search", "description": "Linkedin ads search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "company", "in": "query", "required": false, "example": "microsoft", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "countries", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "company", "keyword", "companyId" ] ], "tags": [ "LinkedIn" ] } }, "/linkedin/profile/posts/archive": { "get": { "operationId": "get_linkedin_profile_posts_archive", "summary": "LinkedIn Profile Posts Archive", "description": "Linkedin profile posts archive. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/in/williamhgates/", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 100, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/linkedin/search/posts": { "get": { "operationId": "get_linkedin_search_posts", "summary": "LinkedIn Search Posts", "description": "Linkedin search posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "date_posted", "relevance" ] } }, { "name": "date_posted", "in": "query", "required": false, "example": "past_week", "schema": { "type": "string", "enum": [ "past_24h", "past_week", "past_month" ] } }, { "name": "content_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "videos", "photos", "jobs", "live_videos", "documents", "collaborative_articles" ] } }, { "name": "from_company", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_member", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "example": "ai agents", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "from_member", "from_company" ] ], "tags": [ "LinkedIn" ] } }, "/linkedin/post/transcript": { "get": { "operationId": "get_linkedin_post_transcript", "summary": "LinkedIn Post Transcript", "description": "Linkedin post transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.linkedin.com/posts/gemini-35-flash-is-a-step-forward-for-google-ugcPost-7465082215316525056-MHBd/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "LinkedIn" ] } }, "/facebook/group/posts": { "get": { "operationId": "get_facebook_group_posts", "summary": "Facebook Group Posts", "description": "Facebook group posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/groups/2204685680", "schema": { "type": "string" } }, { "name": "group_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "TOP_POSTS", "RECENT_ACTIVITY", "CHRONOLOGICAL", "CHRONOLOGICAL_LISTINGS" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "group_id" ] ], "tags": [ "Facebook" ] } }, "/facebook/group": { "get": { "operationId": "get_facebook_group", "summary": "Facebook Group", "description": "Facebook group. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/groups/2204685680", "schema": { "type": "string" } }, { "name": "group_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "group_id" ] ], "tags": [ "Facebook" ] } }, "/facebook/post/transcript": { "get": { "operationId": "get_facebook_post_transcript", "summary": "Facebook Post Transcript", "description": "Facebook post transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/Meta/videos/a-slightly-life-changing-story/1459847961114516/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/profile/photos": { "get": { "operationId": "get_facebook_profile_photos", "summary": "Facebook Profile Photos", "description": "Facebook profile photos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/Meta", "schema": { "type": "string" } }, { "name": "next_page_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "details" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/profile/reels": { "get": { "operationId": "get_facebook_profile_reels", "summary": "Facebook Profile Reels", "description": "Facebook profile reels. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/Meta", "schema": { "type": "string" } }, { "name": "next_page_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "recent_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/adlibrary/ad": { "get": { "operationId": "get_facebook_adlibrary_ad", "summary": "Facebook Adlibrary Ad", "description": "Facebook adlibrary ad. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "1702938977100376", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Facebook" ] } }, "/facebook/adlibrary/company/ads": { "get": { "operationId": "get_facebook_adlibrary_company_ads", "summary": "Facebook Adlibrary Company Ads", "description": "Facebook adlibrary company ads. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "pageId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "companyName", "in": "query", "required": false, "example": "Lululemon", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ALL", "ACTIVE", "INACTIVE" ] } }, { "name": "media_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ALL", "IMAGE", "VIDEO", "MEME", "IMAGE_AND_MEME", "NONE" ] } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "total_impressions", "relevancy_monthly_grouped" ] } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "audience" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "pageId", "companyName" ] ], "tags": [ "Facebook" ] } }, "/facebook/adlibrary/search/ads": { "get": { "operationId": "get_facebook_adlibrary_search_ads", "summary": "Facebook Adlibrary Search Ads", "description": "Facebook adlibrary search ads. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "artificial intelligence", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "total_impressions", "relevancy_monthly_grouped" ] } }, { "name": "search_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "keyword_unordered", "keyword_exact_phrase" ] } }, { "name": "ad_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "political_and_issue_ads" ] } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ALL", "ACTIVE", "INACTIVE" ] } }, { "name": "media_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ALL", "IMAGE", "VIDEO", "MEME", "IMAGE_AND_MEME", "NONE" ] } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/adlibrary/search/companies": { "get": { "operationId": "get_facebook_adlibrary_search_companies", "summary": "Facebook Adlibrary Search Companies", "description": "Facebook adlibrary search companies. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Nike", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/profile/events": { "get": { "operationId": "get_facebook_profile_events", "summary": "Facebook Profile Events", "description": "Facebook profile events. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/brickyardoldtown", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "details" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/post/comment/replies": { "get": { "operationId": "get_facebook_post_comment_replies", "summary": "Facebook Post Comment Replies", "description": "Facebook post comment replies. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "feedback_id", "in": "query", "required": true, "example": "ZmVlZGJhY2s6MzM3MzYxMzI5OTQ4Nzc1NV8xOTI5NTk0OTE3Njg3MTcz", "schema": { "type": "string" } }, { "name": "expansion_token", "in": "query", "required": true, "example": "MjoxNzc4NjM1MDM3OgF_JaMa3kMP9RIWC", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/marketplace/location/search": { "get": { "operationId": "get_facebook_marketplace_location_search", "summary": "Facebook Marketplace Location Search", "description": "Facebook marketplace location search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Los Angeles", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/marketplace/search": { "get": { "operationId": "get_facebook_marketplace_search", "summary": "Facebook Marketplace Search", "description": "Facebook marketplace search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "bike", "schema": { "type": "string" } }, { "name": "lat", "in": "query", "required": true, "example": "40.7128", "schema": { "type": "string" } }, { "name": "lng", "in": "query", "required": true, "example": "-74.0060", "schema": { "type": "string" } }, { "name": "radius_km", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "suggested", "distance_ascend", "creation_time_descend", "price_ascend", "price_descend" ] } }, { "name": "delivery_method", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "local_pickup", "shipping" ] } }, { "name": "condition", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "new", "used_like_new", "used_good", "used_fair" ] } }, { "name": "date_listed", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "1", "7", "30", "last_24_hours", "last_7_days", "last_30_days" ] } }, { "name": "availability", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "available", "sold", "all" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/marketplace/item": { "get": { "operationId": "get_facebook_marketplace_item", "summary": "Facebook Marketplace Item", "description": "Facebook marketplace item. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/marketplace/item/1656586118821988/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Facebook" ] } }, "/facebook/events/search": { "get": { "operationId": "get_facebook_events_search", "summary": "Facebook Events Search", "description": "Facebook events search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "dogs", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/events": { "get": { "operationId": "get_facebook_events", "summary": "Facebook Events", "description": "Facebook events. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547", "schema": { "type": "string" } }, { "name": "time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "today", "this_week", "next_week" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "details" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/event/details": { "get": { "operationId": "get_facebook_event_details", "summary": "Facebook Event Details", "description": "Facebook event details. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/events/2255360061870188/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Facebook" ] } }, "/facebook/adlibrary/ad/transcript": { "get": { "operationId": "get_facebook_adlibrary_ad_transcript", "summary": "Facebook Adlibrary Ad Transcript", "description": "Facebook adlibrary ad transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "1702938977100376", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/ads/library?id=1702938977100376", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Facebook" ] } }, "/reddit/subreddit/search": { "get": { "operationId": "get_reddit_subreddit_search", "summary": "Reddit Subreddit Search", "description": "Reddit subreddit search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "subreddit", "in": "query", "required": true, "example": "technology", "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ] } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "year", "month", "week", "day", "hour" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include_body", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/profile": { "get": { "operationId": "get_reddit_profile", "summary": "Reddit Profile", "description": "Reddit profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "spez", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/profile/posts": { "get": { "operationId": "get_reddit_profile_posts", "summary": "Reddit Profile Posts", "description": "Reddit profile posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "spez", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hot", "new", "top" ] } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "year", "month", "week", "day", "hour" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/profile/comments": { "get": { "operationId": "get_reddit_profile_comments", "summary": "Reddit Profile Comments", "description": "Reddit profile comments. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "spez", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/search/comments": { "get": { "operationId": "get_reddit_search_comments", "summary": "Reddit Search Comments", "description": "Reddit search comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "best project management software", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "top", "new" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "switch_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/subreddits/search": { "get": { "operationId": "get_reddit_subreddits_search", "summary": "Reddit Subreddits Search", "description": "Reddit subreddits search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "machine learning", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "details" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/search/media": { "get": { "operationId": "get_reddit_search_media", "summary": "Reddit Search Media", "description": "Reddit search media. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "mechanical keyboard build", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "new", "top", "comment_count" ] } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/reddit/post/transcript": { "get": { "operationId": "get_reddit_post_transcript", "summary": "Reddit Post Transcript", "description": "Reddit post transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.reddit.com/r/youseeingthisshit/comments/1oiu9xm/football_nostalgiasaints_punter_head_coach_cant/", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/threads/search/users": { "get": { "operationId": "get_threads_search_users", "summary": "Threads Search Users", "description": "Threads search users. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "tech", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "profile" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 12 } }, { "name": "include_details", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Threads" ] } }, "/pinterest/url-stats": { "get": { "operationId": "get_pinterest_url_stats", "summary": "Pinterest Url Stats", "description": "Pinterest url stats. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "urls", "in": "query", "required": true, "example": "https://www.allrecipes.com/recipe/10813/best-chocolate-chip-cookies/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Pinterest" ] } }, "/pinterest/board": { "get": { "operationId": "get_pinterest_board", "summary": "Pinterest Board", "description": "Pinterest board. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.pinterest.com/lizmrodgers/moms-night/", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "engagement" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 15 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Pinterest" ] } }, "/pinterest/user/boards": { "get": { "operationId": "get_pinterest_user_boards", "summary": "Pinterest User Boards", "description": "Pinterest user boards. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "pinterest", "schema": { "type": "string" } }, { "name": "trim", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Pinterest" ] } }, "/pinterest/trends": { "get": { "operationId": "get_pinterest_trends", "summary": "Pinterest Trends", "description": "Pinterest trends. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "country", "in": "query", "required": false, "example": "DE", "schema": { "type": "string", "enum": [ "AR", "AU", "BR", "CA", "CO", "DE", "EG", "ES", "FR", "GB", "ID", "IE", "IN", "IT", "KR", "MX", "MY", "NZ", "PH", "SA", "TH", "TR", "US" ] } }, { "name": "type", "in": "query", "required": false, "example": "growing", "schema": { "type": "string", "enum": [ "growing", "seasonal", "top_monthly", "top_yearly" ] } }, { "name": "limit", "in": "query", "required": false, "example": 5, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Pinterest" ] } }, "/google/search": { "get": { "operationId": "get_google_search", "summary": "Google Search", "description": "Google search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "best restaurants in London", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "last-hour", "last-day", "last-week", "last-month", "last-year" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google" ] } }, "/google/ad": { "get": { "operationId": "get_google_ad", "summary": "Google Ad", "description": "Google ad. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://adstransparency.google.com/advertiser/AR01614014350098432001/creative/CR10449491775734153217", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google" ] } }, "/google/adlibrary/advertisers/search": { "get": { "operationId": "get_google_adlibrary_advertisers_search", "summary": "Google Adlibrary Advertisers Search", "description": "Google adlibrary advertisers search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "lululemon", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google" ] } }, "/google/company/ads": { "get": { "operationId": "get_google_company_ads", "summary": "Google Company Ads", "description": "Google company ads. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "domain", "in": "query", "required": false, "example": "lululemon.com", "schema": { "type": "string" } }, { "name": "advertiser_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "political" ] } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "google_maps", "google_play", "google_search", "google_shopping", "youtube" ] } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "text", "image", "video" ] } }, { "name": "get_ad_details", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "domain", "advertiser_id" ] ], "tags": [ "Google" ] } }, "/google/business/info": { "get": { "operationId": "get_google_business_info", "summary": "Google Business Info", "description": "Google business info. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": false, "example": "Irving Farm New York 645 5th Ave", "schema": { "type": "string" } }, { "name": "cid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "place_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "keyword", "cid", "place_id" ] ], "tags": [ "Google" ] } }, "/google/business/extended-reviews": { "get": { "operationId": "get_google_business_extended_reviews", "summary": "Google Business Extended Reviews", "description": "Google business extended reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": false, "example": "Irving Farm New York 645 5th Ave", "schema": { "type": "string" } }, { "name": "cid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "place_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "keyword", "cid", "place_id" ] ], "tags": [ "Google" ] } }, "/google/business/updates": { "get": { "operationId": "get_google_business_updates", "summary": "Google Business Updates", "description": "Google business updates. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": false, "example": "Toyota of Manhattan New York", "schema": { "type": "string" } }, { "name": "cid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "keyword", "cid" ] ], "tags": [ "Google" ] } }, "/google/business/questions": { "get": { "operationId": "get_google_business_questions", "summary": "Google Business Questions", "description": "Google business questions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": false, "example": "Starbucks Reserve Roastery New York", "schema": { "type": "string" } }, { "name": "cid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "place_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "keyword", "cid", "place_id" ] ], "tags": [ "Google" ] } }, "/google/hotels/search": { "get": { "operationId": "get_google_hotels_search", "summary": "Google Hotels Search", "description": "Google hotels search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "hotels in New York", "schema": { "type": "string" } }, { "name": "location_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "check_in", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "check_out", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google" ] } }, "/google/hotels/info": { "get": { "operationId": "get_google_hotels_info", "summary": "Google Hotels Info", "description": "Google hotels info. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "hotel_identifier", "in": "query", "required": true, "example": "ChkIoYjXwK-S_okHGg0vZy8xMW1fd3MzY243EAE", "schema": { "type": "string" } }, { "name": "location_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google" ] } }, "/google/keyword-volume": { "get": { "operationId": "get_google_keyword_volume", "summary": "Google Keyword Volume", "description": "Google keyword volume. Availability depends on the configured provider route.", "x-credit-cost": 16, "x-launch-status": "beta", "parameters": [ { "name": "keywords", "in": "query", "required": true, "example": "lip gloss,lip oil", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "example": "GB", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google" ] } }, "/amazon/shop": { "get": { "operationId": "get_amazon_shop", "summary": "Amazon Shop", "description": "Amazon shop. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.amazon.com/shop/sydneydelrey", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/amazon/product-search": { "get": { "operationId": "get_amazon_product_search", "summary": "Amazon Product Search", "description": "Amazon product search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "wireless earbuds", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "DE", "FR", "IT", "ES", "JP", "IN", "MX", "BR", "AU", "NL" ] } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/amazon/product": { "get": { "operationId": "get_amazon_product", "summary": "Amazon Product", "description": "Amazon product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "asin", "in": "query", "required": true, "example": "B0FQFB8FMG", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "DE", "FR", "IT", "ES", "JP", "IN", "MX", "BR", "AU", "NL" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/amazon/reviews": { "get": { "operationId": "get_amazon_reviews", "summary": "Amazon Reviews", "description": "Amazon reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "asin", "in": "query", "required": true, "example": "B0BTYCRJSS", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "DE", "FR", "IT", "ES", "JP", "IN", "MX", "BR", "AU", "NL" ] } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/amazon/sellers": { "get": { "operationId": "get_amazon_sellers", "summary": "Amazon Sellers", "description": "Amazon sellers. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "asin", "in": "query", "required": true, "example": "B09SM24S8C", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "DE", "FR", "IT", "ES", "JP", "IN", "MX", "BR", "AU", "NL" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/amazon/best-sellers": { "get": { "operationId": "get_amazon_best_sellers", "summary": "Amazon Best Sellers", "description": "Amazon best sellers. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "category", "in": "query", "required": true, "example": "software", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "DE", "FR", "IT", "ES", "JP", "IN", "MX", "BR", "AU", "NL" ] } }, { "name": "type", "in": "query", "required": false, "example": "BEST_SELLERS", "schema": { "type": "string", "enum": [ "BEST_SELLERS", "NEW_RELEASES", "MOVERS_AND_SHAKERS", "MOST_WISHED_FOR", "GIFT_IDEAS" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/amazon/deals": { "get": { "operationId": "get_amazon_deals", "summary": "Amazon Deals", "description": "Amazon deals. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "DE", "FR", "IT", "ES", "JP", "IN", "MX", "BR", "AU", "NL" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/amazon/seller": { "get": { "operationId": "get_amazon_seller", "summary": "Amazon Seller", "description": "Amazon seller. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "seller_id", "in": "query", "required": true, "example": "A294P4X9EWVXLJ", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "GB", "CA", "DE", "FR", "IT", "ES", "JP", "IN", "MX", "BR", "AU", "NL" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Amazon" ] } }, "/google_shopping/product-search": { "get": { "operationId": "get_google_shopping_product_search", "summary": "Google Shopping Product Search", "description": "Google Shopping product search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "wireless earbuds", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "price_min", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "price_max", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "review_score", "price_low_to_high", "price_high_to_low" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Shopping" ] } }, "/google_shopping/product": { "get": { "operationId": "get_google_shopping_product", "summary": "Google Shopping Product", "description": "Google Shopping product. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1749519698216963169", "schema": { "type": "string" } }, { "name": "gid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "data_docid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "gid", "data_docid" ] ], "tags": [ "Google Shopping" ] } }, "/google_shopping/reviews": { "get": { "operationId": "get_google_shopping_reviews", "summary": "Google Shopping Reviews", "description": "Google Shopping reviews. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "gid", "in": "query", "required": true, "example": "3591805395819257241", "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "data_docid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Shopping" ] } }, "/google_shopping/sellers": { "get": { "operationId": "get_google_shopping_sellers", "summary": "Google Shopping Sellers", "description": "Google Shopping sellers. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1749519698216963169", "schema": { "type": "string" } }, { "name": "gid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "data_docid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "gid", "data_docid" ] ], "tags": [ "Google Shopping" ] } }, "/google_shopping/price-history": { "get": { "operationId": "get_google_shopping_price_history", "summary": "Google Shopping Price History", "description": "Google Shopping price history. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": true, "example": "catalogid:7310953537322941042,productid:2695666608789071335", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Shopping" ] } }, "/google_news/search": { "get": { "operationId": "get_google_news_search", "summary": "Google News Search", "description": "Google News search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "openai", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "location_code", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "location_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_coordinate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language_code", "in": "query", "required": false, "example": "en", "schema": { "type": "string" } }, { "name": "time_range", "in": "query", "required": false, "example": "day", "schema": { "type": "string", "enum": [ "hour", "day", "week", "month", "year" ] } }, { "name": "publisher", "in": "query", "required": false, "example": "bbc.com", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "example": "2026-07-01", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "example": "2026-07-15", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google News" ] } }, "/finance/quote": { "get": { "operationId": "get_finance_quote", "summary": "Finance Quote", "description": "Finance quote. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "GOOGL:NASDAQ", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/finance/ticker-search": { "get": { "operationId": "get_finance_ticker_search", "summary": "Finance Ticker Search", "description": "Finance ticker search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "Apple", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "stock", "index", "mutual_fund", "currency", "futures" ] } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/finance/markets": { "get": { "operationId": "get_finance_markets", "summary": "Finance Markets", "description": "Finance markets. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/finance/news": { "get": { "operationId": "get_finance_news", "summary": "Finance News", "description": "Finance news. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "AAPL", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/finance/history": { "get": { "operationId": "get_finance_history", "summary": "Finance History", "description": "Finance history. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "AAPL", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": true, "example": "2026-06-01", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": true, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "interval", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1d", "5d", "1wk", "1mo", "3mo" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/finance/statements": { "get": { "operationId": "get_finance_statements", "summary": "Finance Statements", "description": "Finance statements. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "AAPL", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "example": "quarterly", "schema": { "type": "string", "enum": [ "annual", "quarterly", "trailing" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/finance/options": { "get": { "operationId": "get_finance_options", "summary": "Finance Options", "description": "Finance options. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "AAPL", "schema": { "type": "string" } }, { "name": "expiry", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/finance/fundamentals": { "get": { "operationId": "get_finance_fundamentals", "summary": "Finance Fundamentals", "description": "Finance fundamentals. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "TGT", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "example": "quarterly", "schema": { "type": "string", "enum": [ "quarterly", "annual" ] } }, { "name": "limit", "in": "query", "required": false, "example": 8, "schema": { "type": "integer", "minimum": 1, "maximum": 40 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Finance" ] } }, "/google_trends/explore": { "get": { "operationId": "get_google_trends_explore", "summary": "Google Trends Explore", "description": "Google Trends explore. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keywords", "in": "query", "required": true, "example": "uv index", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "required": false, "example": "past_90_days", "schema": { "type": "string", "enum": [ "past_hour", "past_4_hours", "past_day", "past_7_days", "past_30_days", "past_90_days", "past_12_months", "past_5_years" ] } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Trends" ] } }, "/google_trends/rising": { "get": { "operationId": "get_google_trends_rising", "summary": "Google Trends Rising", "description": "Google Trends rising. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "uv index", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "past_hour", "past_4_hours", "past_day", "past_7_days", "past_30_days", "past_90_days", "past_12_months", "past_5_years" ] } }, { "name": "category", "in": "query", "required": false, "example": 66, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Trends" ] } }, "/google_trends/trending": { "get": { "operationId": "get_google_trends_trending", "summary": "Google Trends Trending", "description": "Google Trends trending. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "location", "in": "query", "required": true, "example": "DE", "schema": { "type": "string" } }, { "name": "hours", "in": "query", "required": false, "example": "24", "schema": { "type": "string", "enum": [ "4", "24", "48", "168" ] } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "autos_and_vehicles", "beauty_and_fashion", "business_and_finance", "entertainment", "food_and_drink", "games", "health", "hobbies_and_leisure", "jobs_and_education", "law_and_government", "other", "pets_and_animals", "politics", "science", "shopping", "sports", "technology", "travel_and_transportation", "climate" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "active" ] } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "search_volume", "recency", "title" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Trends" ] } }, "/trustpilot/business-search": { "get": { "operationId": "get_trustpilot_business_search", "summary": "Trustpilot Business Search", "description": "Trustpilot business search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "nike", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Trustpilot" ] } }, "/trustpilot/reviews": { "get": { "operationId": "get_trustpilot_reviews", "summary": "Trustpilot Reviews", "description": "Trustpilot reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "domain", "in": "query", "required": true, "example": "www.nike.com", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "example": "recency", "schema": { "type": "string", "enum": [ "recency", "relevance" ] } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Trustpilot" ] } }, "/trustpilot/reviews/history": { "post": { "operationId": "post_trustpilot_reviews_history", "summary": "Trustpilot Reviews History", "description": "Trustpilot reviews history. Availability depends on the configured provider route.", "x-credit-cost": 6, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domain", "depth" ], "properties": { "domain": { "type": "string" }, "depth": { "type": "string" } } } } } }, "tags": [ "Trustpilot" ] } }, "/g2/product": { "get": { "operationId": "get_g2_product", "summary": "G2 Product", "description": "G2 product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "postman", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "website_contacts_crawl_mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "off", "homepage", "deep" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "G2" ] } }, "/g2/reviews": { "get": { "operationId": "get_g2_reviews", "summary": "G2 Reviews", "description": "G2 reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "postman", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "industry", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "keywords", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "small-business", "mid-market", "enterprise" ] } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "default", "most-recent", "most-helpful", "highest-rated", "lowest-rated" ] } }, { "name": "stars", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "G2" ] } }, "/g2/category": { "get": { "operationId": "get_g2_category", "summary": "G2 Category", "description": "G2 category. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "category", "in": "query", "required": true, "example": "marketing-automation", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "g2-score", "popularity", "satisfaction" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "G2" ] } }, "/g2/categories": { "get": { "operationId": "get_g2_categories", "summary": "G2 Categories", "description": "G2 categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "G2" ] } }, "/g2/seller": { "get": { "operationId": "get_g2_seller", "summary": "G2 Seller", "description": "G2 seller. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "hubspot", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "products_page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "reviews_page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url", "handle" ] ], "tags": [ "G2" ] } }, "/g2/seller/products": { "get": { "operationId": "get_g2_seller_products", "summary": "G2 Seller Products", "description": "G2 seller products. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "google", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "G2" ] } }, "/g2/product-index": { "get": { "operationId": "get_g2_product_index", "summary": "G2 Product Index", "description": "G2 product index. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "G2" ] } }, "/google_play/app-search": { "get": { "operationId": "get_google_play_app_search", "summary": "Google Play App Search", "description": "Google Play app search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "photo editor", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "United States", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 30, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/search-suggestions": { "get": { "operationId": "get_google_play_search_suggestions", "summary": "Google Play Search Suggestions", "description": "Google Play search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "reverse", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "us", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "example": "en", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/app-info": { "get": { "operationId": "get_google_play_app_info", "summary": "Google Play App Info", "description": "Google Play app info. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "app_id", "in": "query", "required": true, "example": "com.spotify.music", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "United States", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/app-reviews": { "get": { "operationId": "get_google_play_app_reviews", "summary": "Google Play App Reviews", "description": "Google Play app reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "app_id", "in": "query", "required": true, "example": "com.spotify.music", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 150, "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "required": false, "example": "newest", "schema": { "type": "string", "enum": [ "newest", "most_relevant" ] } }, { "name": "rating", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/app-list": { "get": { "operationId": "get_google_play_app_list", "summary": "Google Play App List", "description": "Google Play app list. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "app_collection", "in": "query", "required": true, "example": "topselling_free", "schema": { "type": "string" } }, { "name": "app_category", "in": "query", "required": false, "example": "photography", "schema": { "type": "string", "enum": [ "art_and_design", "auto_and_vehicles", "beauty", "books_and_reference", "business", "comics", "communication", "dating", "education", "entertainment", "events", "finance", "food_and_drink", "health_and_fitness", "house_and_home", "libraries_and_demo", "lifestyle", "maps_and_navigation", "medical", "music_and_audio", "news_and_magazines", "parenting", "personalization", "photography", "productivity", "shopping", "social", "sports", "tools", "travel_and_local", "video_players", "android_wear", "watch_face", "weather", "game", "game_action", "game_adventure", "game_arcade", "game_board", "game_card", "game_casino", "game_casual", "game_educational", "game_music", "game_puzzle", "game_racing", "game_role_playing", "game_simulation", "game_sports", "game_strategy", "game_trivia", "game_word", "family" ] } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 100, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/app-listings-search": { "get": { "operationId": "get_google_play_app_listings_search", "summary": "Google Play App Listings Search", "description": "Google Play app listings search. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "title", "in": "query", "required": true, "example": "photo editor", "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "offset_token", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "example": "[[\"item.rating.value\",\">\",4]]", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/categories": { "get": { "operationId": "get_google_play_categories", "summary": "Google Play Categories", "description": "Google Play categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/locations": { "get": { "operationId": "get_google_play_locations", "summary": "Google Play Locations", "description": "Google Play locations. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "location_type", "in": "query", "required": false, "example": "country", "schema": { "type": "string", "enum": [ "country", "all" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/google_play/languages": { "get": { "operationId": "get_google_play_languages", "summary": "Google Play Languages", "description": "Google Play languages. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Google Play" ] } }, "/app_store/app-search": { "get": { "operationId": "get_app_store_app_search", "summary": "App Store App Search", "description": "App Store app search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "photo editor", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "United States", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 100, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/search-suggestions": { "get": { "operationId": "get_app_store_search_suggestions", "summary": "App Store Search Suggestions", "description": "App Store search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "reverse", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "us", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/app-info": { "get": { "operationId": "get_app_store_app_info", "summary": "App Store App Info", "description": "App Store app info. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "app_id", "in": "query", "required": true, "example": "324684580", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "United States", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/app-reviews": { "get": { "operationId": "get_app_store_app_reviews", "summary": "App Store App Reviews", "description": "App Store app reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "app_id", "in": "query", "required": true, "example": "324684580", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 50, "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "required": false, "example": "most_recent", "schema": { "type": "string", "enum": [ "most_recent", "most_helpful" ] } }, { "name": "rating", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/app-list": { "get": { "operationId": "get_app_store_app_list", "summary": "App Store App List", "description": "App Store app list. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "app_collection", "in": "query", "required": true, "example": "top_free_ios", "schema": { "type": "string" } }, { "name": "app_category", "in": "query", "required": false, "example": "photo_and_video", "schema": { "type": "string", "enum": [ "books", "business", "catalogs", "education", "entertainment", "finance", "food_and_drink", "games", "games_action", "games_adventure", "games_arcade", "games_board", "games_card", "games_casino", "games_dice", "games_educational", "games_family", "games_music", "games_puzzle", "games_racing", "games_role_playing", "games_simulation", "games_sports", "games_strategy", "games_trivia", "games_word", "health_and_fitness", "lifestyle", "magazines_and_newspapers", "magazines_arts", "magazines_automotive", "magazines_weddings", "magazines_business", "magazines_children", "magazines_computer", "magazines_food", "magazines_crafts", "magazines_electronics", "magazines_entertainment", "magazines_fashion", "magazines_health", "magazines_history", "magazines_home", "magazines_literary", "magazines_men", "magazines_movies_and_music", "magazines_politics", "magazines_outdoors", "magazines_family", "magazines_pets", "magazines_professional", "magazines_regional", "magazines_science", "magazines_sports", "magazines_teens", "magazines_travel", "magazines_women", "medical", "music", "navigation", "news", "photo_and_video", "productivity", "reference", "shopping", "social_networking", "sports", "travel", "utilities", "weather" ] } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 100, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/app-listings-search": { "get": { "operationId": "get_app_store_app_listings_search", "summary": "App Store App Listings Search", "description": "App Store app listings search. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "title", "in": "query", "required": true, "example": "photo editor", "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "offset_token", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "example": "[[\"item.rating.value\",\">\",4]]", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/categories": { "get": { "operationId": "get_app_store_categories", "summary": "App Store Categories", "description": "App Store categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/locations": { "get": { "operationId": "get_app_store_locations", "summary": "App Store Locations", "description": "App Store locations. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "location_type", "in": "query", "required": false, "example": "country", "schema": { "type": "string", "enum": [ "country", "all" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/app_store/languages": { "get": { "operationId": "get_app_store_languages", "summary": "App Store Languages", "description": "App Store languages. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "App Store" ] } }, "/tripadvisor/search": { "get": { "operationId": "get_tripadvisor_search", "summary": "Tripadvisor Search", "description": "Tripadvisor search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "q", "in": "query", "required": true, "example": "pizza restaurant", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "example": "New York,New York,United States", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/reviews": { "get": { "operationId": "get_tripadvisor_reviews", "summary": "Tripadvisor Reviews", "description": "Tripadvisor reviews. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "most_recent", "detailed_reviews" ] } }, { "name": "rating", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "excellent", "very_good", "average", "poor", "terrible" ] } }, { "name": "visit_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "families", "couples", "solo", "business", "friends" ] } }, { "name": "search_reviews_keyword", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "translate", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/place": { "get": { "operationId": "get_tripadvisor_place", "summary": "Tripadvisor Place", "description": "Tripadvisor place. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/autocomplete": { "get": { "operationId": "get_tripadvisor_autocomplete", "summary": "Tripadvisor Autocomplete", "description": "Tripadvisor autocomplete. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "q", "in": "query", "required": true, "example": "Paris", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/hotels": { "get": { "operationId": "get_tripadvisor_hotels", "summary": "Tripadvisor Hotels", "description": "Tripadvisor hotels. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "q", "in": "query", "required": true, "example": "Paris", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 30, "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "BEST_VALUE", "RANKED", "PRICE_LOW_TO_HIGH", "DISTANCE" ] } }, { "name": "price_min", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "price_max", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "star_rating_min", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "0", "1", "2", "3", "4", "5" ] } }, { "name": "review_score_min", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "3", "3.5", "4", "4.5", "5" ] } }, { "name": "property_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "hotel", "resort", "apartment", "villa", "hostel", "guest_house", "bed_and_breakfast" ] } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/hotel": { "get": { "operationId": "get_tripadvisor_hotel", "summary": "Tripadvisor Hotel", "description": "Tripadvisor hotel. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/restaurants": { "get": { "operationId": "get_tripadvisor_restaurants", "summary": "Tripadvisor Restaurants", "description": "Tripadvisor restaurants. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "q", "in": "query", "required": true, "example": "Paris", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 30, "schema": { "type": "integer" } }, { "name": "cuisine", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "local", "italian", "french", "indian", "chinese", "japanese", "mexican", "seafood", "steakhouse", "cafe", "fast_food" ] } }, { "name": "meal_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "breakfast", "lunch", "dinner", "brunch" ] } }, { "name": "price_level", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "cheap", "moderate", "expensive", "fine_dining" ] } }, { "name": "dietary_restriction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "vegetarian", "vegan", "gluten_free", "halal", "kosher" ] } }, { "name": "open_now", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "online_reservations", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/restaurant": { "get": { "operationId": "get_tripadvisor_restaurant", "summary": "Tripadvisor Restaurant", "description": "Tripadvisor restaurant. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/restaurant/reviews": { "get": { "operationId": "get_tripadvisor_restaurant_reviews", "summary": "Tripadvisor Restaurant Reviews", "description": "Tripadvisor restaurant reviews. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/attractions": { "get": { "operationId": "get_tripadvisor_attractions", "summary": "Tripadvisor Attractions", "description": "Tripadvisor attractions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "q", "in": "query", "required": true, "example": "Bangkok", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 30, "schema": { "type": "integer" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "attractions", "tours", "outdoor_activities", "museums", "shopping", "nightlife", "spas", "classes_workshops" ] } }, { "name": "duration", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "lt_1_hour", "1_to_4_hours", "4_hours_to_1_day", "multi_day" ] } }, { "name": "traveler_rating", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "3", "3.5", "4", "4.5", "5" ] } }, { "name": "free_cancellation", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "skip_the_line", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "private_tour", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/attraction": { "get": { "operationId": "get_tripadvisor_attraction", "summary": "Tripadvisor Attraction", "description": "Tripadvisor attraction. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/attraction/reviews": { "get": { "operationId": "get_tripadvisor_attraction_reviews", "summary": "Tripadvisor Attraction Reviews", "description": "Tripadvisor attraction reviews. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/experience-types": { "get": { "operationId": "get_tripadvisor_experience_types", "summary": "Tripadvisor Experience Types", "description": "Tripadvisor experience types. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Bangkok", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/cruises": { "get": { "operationId": "get_tripadvisor_cruises", "summary": "Tripadvisor Cruises", "description": "Tripadvisor cruises. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "q", "in": "query", "required": true, "example": "Caribbean", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "departure_month", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cabin_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "inside", "oceanview", "balcony", "suite" ] } }, { "name": "length", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "any", "1-2", "3-5", "6-9", "10-14", "15+" ] } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/cruise": { "get": { "operationId": "get_tripadvisor_cruise", "summary": "Tripadvisor Cruise", "description": "Tripadvisor cruise. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Cruise_Review-d15691642-Reviews-MSC_Seaside", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/tripadvisor/cruise/reviews": { "get": { "operationId": "get_tripadvisor_cruise_reviews", "summary": "Tripadvisor Cruise Reviews", "description": "Tripadvisor cruise reviews. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url_path", "in": "query", "required": true, "example": "Cruise_Review-d15691642-Reviews-MSC_Seaside", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 20, "schema": { "type": "integer" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tripadvisor" ] } }, "/walmart/product": { "get": { "operationId": "get_walmart_product", "summary": "Walmart Product", "description": "Walmart product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": true, "example": "17835006350", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "example": "US", "schema": { "type": "string", "enum": [ "US", "CA" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Walmart" ] } }, "/walmart/reviews": { "get": { "operationId": "get_walmart_reviews", "summary": "Walmart Reviews", "description": "Walmart reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": true, "example": "17835006350", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "limit", "in": "query", "required": false, "example": 50, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "sort", "in": "query", "required": false, "example": "recent", "schema": { "type": "string", "enum": [ "relevancy", "recent", "rating_high_low", "rating_low_high" ] } }, { "name": "rating", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA" ] } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Walmart" ] } }, "/walmart/search": { "get": { "operationId": "get_walmart_search", "summary": "Walmart Search", "description": "Walmart search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "airpods pro", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best_match", "price_low", "price_high", "best_seller", "top_rated" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "zip_code", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "facet", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Walmart" ] } }, "/walmart/category": { "get": { "operationId": "get_walmart_category", "summary": "Walmart Category", "description": "Walmart category. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "3944", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best_match", "price_low", "price_high", "best_seller", "top_rated" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "zip_code", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "facet", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA" ] } }, { "name": "limit", "in": "query", "required": false, "example": 40, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Walmart" ] } }, "/walmart/offers": { "get": { "operationId": "get_walmart_offers", "summary": "Walmart Offers", "description": "Walmart offers. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": true, "example": "17835006350", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Walmart" ] } }, "/target/product": { "get": { "operationId": "get_target_product", "summary": "Target Product", "description": "Target product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "tcin", "in": "query", "required": true, "example": "92148487", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Target" ] } }, "/target/reviews": { "get": { "operationId": "get_target_reviews", "summary": "Target Reviews", "description": "Target reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "tcin", "in": "query", "required": true, "example": "92146817", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Target" ] } }, "/target/category": { "get": { "operationId": "get_target_category", "summary": "Target Category", "description": "Target category. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "hz89j", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Target" ] } }, "/target/categories": { "get": { "operationId": "get_target_categories", "summary": "Target Categories", "description": "Target categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Target" ] } }, "/target/stores": { "get": { "operationId": "get_target_stores", "summary": "Target Stores", "description": "Target stores. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "10001", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Target" ] } }, "/wayfair/search": { "get": { "operationId": "get_wayfair_search", "summary": "Wayfair Search", "description": "Wayfair search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "office chair", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA", "GB", "IE", "DE" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 750 } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "24", "48", "96" ] } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "price_low", "price_high", "top_rated", "newest" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "in_stock", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Wayfair" ] } }, "/wayfair/product": { "get": { "operationId": "get_wayfair_product", "summary": "Wayfair Product", "description": "Wayfair product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "sku", "in": "query", "required": true, "example": "W003564166", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA", "GB", "IE", "DE" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Wayfair" ] } }, "/wayfair/reviews": { "get": { "operationId": "get_wayfair_reviews", "summary": "Wayfair Reviews", "description": "Wayfair reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "sku", "in": "query", "required": true, "example": "W003564166", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA", "GB", "IE", "DE" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "helpful", "date_ascending", "date_descending", "rating_ascending", "rating_descending" ] } }, { "name": "star", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Wayfair" ] } }, "/home_depot/product": { "get": { "operationId": "get_home_depot_product", "summary": "Home Depot Product", "description": "Home Depot product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "item_id", "in": "query", "required": false, "example": "326680222", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "item_id", "url" ] ], "tags": [ "Home Depot" ] } }, "/home_depot/reviews": { "get": { "operationId": "get_home_depot_reviews", "summary": "Home Depot Reviews", "description": "Home Depot reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "item_id", "in": "query", "required": true, "example": "326680222", "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Home Depot" ] } }, "/home_depot/search": { "get": { "operationId": "get_home_depot_search", "summary": "Home Depot Search", "description": "Home Depot search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "drill", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 30 } }, { "name": "store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Home Depot" ] } }, "/home_depot/stores": { "get": { "operationId": "get_home_depot_stores", "summary": "Home Depot Stores", "description": "Home Depot stores. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "95032", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Home Depot" ] } }, "/ebay/search": { "get": { "operationId": "get_ebay_search", "summary": "eBay Search", "description": "Ebay search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "airpods pro", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "GB", "AU", "CA", "DE", "FR", "IT", "ES", "IE", "AT", "CH", "NL", "BE", "PL", "SG", "MY", "PH", "HK", "MX" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best_match", "price_low", "price_high", "newly_listed", "ending_soonest" ] } }, { "name": "condition", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "new", "refurbished", "used" ] } }, { "name": "buying_format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "auction", "buy_it_now", "accepts_offers" ] } }, { "name": "show_only", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "aspects", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "eBay" ] } }, "/ebay/product": { "get": { "operationId": "get_ebay_product", "summary": "eBay Product", "description": "Ebay product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": true, "example": "327256602116", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "GB", "AU", "CA", "DE", "FR", "IT", "ES", "IE", "AT", "CH", "NL", "BE", "PL", "SG", "MY", "PH", "HK", "MX" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "eBay" ] } }, "/etsy/product": { "get": { "operationId": "get_etsy_product", "summary": "Etsy Product", "description": "Etsy product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1215970085", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Etsy" ] } }, "/etsy/shop/products": { "get": { "operationId": "get_etsy_shop_products", "summary": "Etsy Shop Products", "description": "Etsy shop products. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "AceElegance", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 36 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "most_recent", "price_low", "price_high" ] } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Etsy" ] } }, "/etsy/product/similar": { "get": { "operationId": "get_etsy_product_similar", "summary": "Etsy Product Similar", "description": "Etsy product similar. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1215970085", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Etsy" ] } }, "/etsy/search/suggestions": { "get": { "operationId": "get_etsy_search_suggestions", "summary": "Etsy Search Suggestions", "description": "Etsy search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "leather", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Etsy" ] } }, "/sephora/product": { "get": { "operationId": "get_sephora_product", "summary": "Sephora Product", "description": "Sephora product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "P427414", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sku", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "en-US", "en-CA", "fr-CA" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Sephora" ] } }, "/sephora/reviews": { "get": { "operationId": "get_sephora_reviews", "summary": "Sephora Reviews", "description": "Sephora reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "P427414", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "most_helpful", "highest_rating", "lowest_rating", "oldest", "newest" ] } }, { "name": "rating", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Sephora" ] } }, "/sephora/search": { "get": { "operationId": "get_sephora_search", "summary": "Sephora Search", "description": "Sephora search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "moisturizer", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 60 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best_selling", "top_rated", "price_low", "price_high", "new" ] } }, { "name": "min_rating", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "is_new", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/search/suggestions": { "get": { "operationId": "get_sephora_search_suggestions", "summary": "Sephora Search Suggestions", "description": "Sephora search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "moistur", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "en-US", "en-CA", "fr-CA" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/category": { "get": { "operationId": "get_sephora_category", "summary": "Sephora Category", "description": "Sephora category. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "cat1100057", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 60 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best_selling", "top_rated", "price_low", "price_high", "new" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/categories": { "get": { "operationId": "get_sephora_categories", "summary": "Sephora Categories", "description": "Sephora categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/category/data": { "get": { "operationId": "get_sephora_category_data", "summary": "Sephora Category Data", "description": "Sephora category data. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "cat1100057", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/brands": { "get": { "operationId": "get_sephora_brands", "summary": "Sephora Brands", "description": "Sephora brands. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/brand/products": { "get": { "operationId": "get_sephora_brand_products", "summary": "Sephora Brand Products", "description": "Sephora brand products. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "gucci", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 60 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "best_selling", "top_rated", "price_low", "price_high", "new" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "min_rating", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/stores": { "get": { "operationId": "get_sephora_stores", "summary": "Sephora Stores", "description": "Sephora stores. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "location_coordinate", "in": "query", "required": true, "example": "37.4418834,-122.1430195", "schema": { "type": "string" } }, { "name": "radius", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Sephora" ] } }, "/sephora/availability": { "get": { "operationId": "get_sephora_availability", "summary": "Sephora Availability", "description": "Sephora availability. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "sku", "in": "query", "required": true, "example": "2210581", "schema": { "type": "string" } }, { "name": "latitude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "longitude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_coordinate", "in": "query", "required": false, "example": "37.4418834,-122.1430195", "schema": { "type": "string" } }, { "name": "radius", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "location_coordinate", "latitude" ] ], "tags": [ "Sephora" ] } }, "/aliexpress/product": { "get": { "operationId": "get_aliexpress_product", "summary": "Aliexpress Product", "description": "Aliexpress product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3256812847028710", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Aliexpress" ] } }, "/aliexpress/search": { "get": { "operationId": "get_aliexpress_search", "summary": "Aliexpress Search", "description": "Aliexpress search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "xiaomi", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "price_low", "price_high", "most_sold", "least_sold" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "delivery_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 30 } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Aliexpress" ] } }, "/aliexpress/product/similar": { "get": { "operationId": "get_aliexpress_product_similar", "summary": "Aliexpress Product Similar", "description": "Aliexpress product similar. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3256812847028710", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "price_low", "price_high", "most_sold", "least_sold" ] } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url", "query" ] ], "tags": [ "Aliexpress" ] } }, "/aliexpress/reviews": { "get": { "operationId": "get_aliexpress_reviews", "summary": "Aliexpress Reviews", "description": "Aliexpress reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1005006079931969", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "1", "2", "3", "4", "5", "image", "additional", "local" ] } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "default", "newest" ] } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Aliexpress" ] } }, "/aliexpress/product/shipping": { "get": { "operationId": "get_aliexpress_product_shipping", "summary": "Aliexpress Product Shipping", "description": "Aliexpress product shipping. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "sku_id", "in": "query", "required": true, "example": "12000060082591973", "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "required": false, "example": "3256812847028710", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tax_rate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Aliexpress" ] } }, "/aliexpress/search/hot": { "get": { "operationId": "get_aliexpress_search_hot", "summary": "Aliexpress Search Hot", "description": "Aliexpress search hot. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "xiaomi", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "price_low", "price_high", "most_sold", "least_sold" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Aliexpress" ] } }, "/aliexpress/search/promo": { "get": { "operationId": "get_aliexpress_search_promo", "summary": "Aliexpress Search Promo", "description": "Aliexpress search promo. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "promotion_name", "in": "query", "required": true, "example": "0203-Knasta-202602-PE", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "price_low", "price_high", "most_sold", "least_sold" ] } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Aliexpress" ] } }, "/aliexpress/categories": { "get": { "operationId": "get_aliexpress_categories", "summary": "Aliexpress Categories", "description": "Aliexpress categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Aliexpress" ] } }, "/aliexpress/promo": { "get": { "operationId": "get_aliexpress_promo", "summary": "Aliexpress Promo", "description": "Aliexpress promo. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Aliexpress" ] } }, "/hm/search": { "get": { "operationId": "get_hm_search", "summary": "Hm Search", "description": "Hm search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "t-shirts", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 36 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "newest", "price_low", "price_high" ] } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hm" ] } }, "/hm/search/suggestions": { "get": { "operationId": "get_hm_search_suggestions", "summary": "Hm Search Suggestions", "description": "Hm search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "tshirt", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hm" ] } }, "/hm/stores": { "get": { "operationId": "get_hm_stores", "summary": "Hm Stores", "description": "Hm stores. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "us", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hm" ] } }, "/hm/countries": { "get": { "operationId": "get_hm_countries", "summary": "Hm Countries", "description": "Hm countries. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hm" ] } }, "/hm/categories": { "get": { "operationId": "get_hm_categories", "summary": "Hm Categories", "description": "Hm categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hm" ] } }, "/hm/product/suppliers": { "get": { "operationId": "get_hm_product_suppliers", "summary": "Hm Product Suppliers", "description": "Hm product suppliers. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": true, "example": "0963662139", "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hm" ] } }, "/kohls/search": { "get": { "operationId": "get_kohls_search", "summary": "Kohls Search", "description": "Kohls search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "jeans", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 48 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "featured", "newest", "price_low", "price_high", "rating", "percent_off" ] } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Kohls" ] } }, "/kohls/reviews": { "get": { "operationId": "get_kohls_reviews", "summary": "Kohls Reviews", "description": "Kohls reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1695762", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Kohls" ] } }, "/kohls/questions": { "get": { "operationId": "get_kohls_questions", "summary": "Kohls Questions", "description": "Kohls questions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1695762", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Kohls" ] } }, "/kohls/stores": { "get": { "operationId": "get_kohls_stores", "summary": "Kohls Stores", "description": "Kohls stores. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "location_coordinate", "in": "query", "required": false, "example": "40.758,-73.9855", "schema": { "type": "string" } }, { "name": "latitude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "longitude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "radius", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "location_coordinate", "latitude" ] ], "tags": [ "Kohls" ] } }, "/kohls/categories": { "get": { "operationId": "get_kohls_categories", "summary": "Kohls Categories", "description": "Kohls categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Kohls" ] } }, "/klarna/product": { "get": { "operationId": "get_klarna_product", "summary": "Klarna Product", "description": "Klarna product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3331931731", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category_id", "in": "query", "required": false, "example": "cl94", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Klarna" ] } }, "/klarna/product/offers": { "get": { "operationId": "get_klarna_product_offers", "summary": "Klarna Product Offers", "description": "Klarna product offers. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3331931731", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Klarna" ] } }, "/klarna/search": { "get": { "operationId": "get_klarna_search", "summary": "Klarna Search", "description": "Klarna search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "headphone", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/search/suggestions": { "get": { "operationId": "get_klarna_search_suggestions", "summary": "Klarna Search Suggestions", "description": "Klarna search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "headphone", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/reviews": { "get": { "operationId": "get_klarna_reviews", "summary": "Klarna Reviews", "description": "Klarna reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3331931731", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "nextBatchId", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Klarna" ] } }, "/klarna/reviews/pro": { "get": { "operationId": "get_klarna_reviews_pro", "summary": "Klarna Reviews Pro", "description": "Klarna reviews pro. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3331931731", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "nextBatchId", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Klarna" ] } }, "/klarna/reviews/overview": { "get": { "operationId": "get_klarna_reviews_overview", "summary": "Klarna Reviews Overview", "description": "Klarna reviews overview. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3331931731", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Klarna" ] } }, "/klarna/product/price-history": { "get": { "operationId": "get_klarna_product_price_history", "summary": "Klarna Product Price History", "description": "Klarna product price history. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "3331931731", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "interval", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ONE_MONTH", "THREE_MONTHS", "INFINITE_DAYS" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Klarna" ] } }, "/klarna/product/compare": { "get": { "operationId": "get_klarna_product_compare", "summary": "Klarna Product Compare", "description": "Klarna product compare. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": true, "example": "3331931731", "schema": { "type": "string" } }, { "name": "product_id_2", "in": "query", "required": true, "example": "3216399795", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/category": { "get": { "operationId": "get_klarna_category", "summary": "Klarna Category", "description": "Klarna category. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "cl94", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "popularity", "price_low", "price_high", "trend", "name", "rating", "price_drop" ] } }, { "name": "price_range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category_path_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/categories": { "get": { "operationId": "get_klarna_categories", "summary": "Klarna Categories", "description": "Klarna categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/categories/children": { "get": { "operationId": "get_klarna_categories_children", "summary": "Klarna Categories Children", "description": "Klarna categories children. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "t1", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/category/filters": { "get": { "operationId": "get_klarna_category_filters", "summary": "Klarna Category Filters", "description": "Klarna category filters. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "cl94", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "category_path_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/category/keywords": { "get": { "operationId": "get_klarna_category_keywords", "summary": "Klarna Category Keywords", "description": "Klarna category keywords. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "t1", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/category/guide": { "get": { "operationId": "get_klarna_category_guide", "summary": "Klarna Category Guide", "description": "Klarna category guide. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "cl94", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/stores": { "get": { "operationId": "get_klarna_stores", "summary": "Klarna Stores", "description": "Klarna stores. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "categories", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cashback", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "shop_in_app", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "klarna_at_checkout", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/store/products": { "get": { "operationId": "get_klarna_store_products", "summary": "Klarna Store Products", "description": "Klarna store products. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "09f4d635-0452-4f63-9455-c45420d95669", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "popularity", "price_low", "price_high", "trend", "name", "rating", "price_drop" ] } }, { "name": "price_range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/klarna/store/filters": { "get": { "operationId": "get_klarna_store_filters", "summary": "Klarna Store Filters", "description": "Klarna store filters. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "09f4d635-0452-4f63-9455-c45420d95669", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usa", "uk", "germany", "sweden", "france", "italy", "spain", "netherlands", "austria", "ireland", "norway", "finland", "denmark" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Klarna" ] } }, "/gumtree/search": { "get": { "operationId": "get_gumtree_search", "summary": "Gumtree Search", "description": "Gumtree search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "iphone", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "newest", "price_low", "price_high" ] } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "distance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "0", "1", "3", "5", "10", "15", "30", "50", "75", "100", "150", "250", "500", "nationwide" ] } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "seller_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "private", "trade" ] } }, { "name": "attributes", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "url" ] ], "tags": [ "Gumtree" ] } }, "/gumtree/product": { "get": { "operationId": "get_gumtree_product", "summary": "Gumtree Product", "description": "Gumtree product. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1515115590", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Gumtree" ] } }, "/gumtree/product/similar": { "get": { "operationId": "get_gumtree_product_similar", "summary": "Gumtree Product Similar", "description": "Gumtree product similar. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "product_id", "in": "query", "required": false, "example": "1515115590", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "product_id", "url" ] ], "tags": [ "Gumtree" ] } }, "/gumtree/seller": { "get": { "operationId": "get_gumtree_seller", "summary": "Gumtree Seller", "description": "Gumtree seller. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "seller_id", "in": "query", "required": false, "example": "17804454", "schema": { "type": "string" } }, { "name": "public_id", "in": "query", "required": false, "example": "13b4fddbbabbef26807a535511d79289", "schema": { "type": "string" } }, { "name": "account_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "seller_id" ] ], "tags": [ "Gumtree" ] } }, "/gumtree/seller/listings": { "get": { "operationId": "get_gumtree_seller_listings", "summary": "Gumtree Seller Listings", "description": "Gumtree seller listings. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "seller_id", "in": "query", "required": false, "example": "17804454", "schema": { "type": "string" } }, { "name": "public_id", "in": "query", "required": false, "example": "13b4fddbbabbef26807a535511d79289", "schema": { "type": "string" } }, { "name": "account_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "seller_id" ] ], "tags": [ "Gumtree" ] } }, "/gumtree/search/suggestions": { "get": { "operationId": "get_gumtree_search_suggestions", "summary": "Gumtree Search Suggestions", "description": "Gumtree search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "iphone", "schema": { "type": "string" } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Gumtree" ] } }, "/gumtree/trending": { "get": { "operationId": "get_gumtree_trending", "summary": "Gumtree Trending", "description": "Gumtree trending. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Gumtree" ] } }, "/gumtree/categories": { "get": { "operationId": "get_gumtree_categories", "summary": "Gumtree Categories", "description": "Gumtree categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Gumtree" ] } }, "/gumtree/filters": { "get": { "operationId": "get_gumtree_filters", "summary": "Gumtree Filters", "description": "Gumtree filters. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "category_id", "in": "query", "required": true, "example": "10205", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Gumtree" ] } }, "/gumtree/locations": { "get": { "operationId": "get_gumtree_locations", "summary": "Gumtree Locations", "description": "Gumtree locations. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "london", "schema": { "type": "string" } }, { "name": "location_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "LOCATION", "OUTCODE", "POSTCODE" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Gumtree" ] } }, "/gumtree/locations/nearest": { "get": { "operationId": "get_gumtree_locations_nearest", "summary": "Gumtree Locations Nearest", "description": "Gumtree locations nearest. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "latitude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "longitude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_coordinate", "in": "query", "required": false, "example": "51.5074,-0.1278", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "location_coordinate", "latitude" ] ], "tags": [ "Gumtree" ] } }, "/yelp/business/info": { "get": { "operationId": "get_yelp_business_info", "summary": "Yelp Business Info", "description": "Yelp business info. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "zj8Lq1T8KIC5zwFief15jg", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Yelp" ] } }, "/yelp/business/reviews": { "get": { "operationId": "get_yelp_business_reviews", "summary": "Yelp Business Reviews", "description": "Yelp business reviews. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "zj8Lq1T8KIC5zwFief15jg", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reports", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Yelp" ] } }, "/yelp/search": { "get": { "operationId": "get_yelp_search", "summary": "Yelp Search", "description": "Yelp search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Pizza", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": true, "example": "New York, NY", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recommended", "rating", "review_count" ] } }, { "name": "ads", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Yelp" ] } }, "/yelp/search/full": { "get": { "operationId": "get_yelp_search_full", "summary": "Yelp Search Full", "description": "Yelp search full. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Pizza", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": true, "example": "New York, NY", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recommended", "rating", "review_count" ] } }, { "name": "ads", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Yelp" ] } }, "/yelp/search/suggestions": { "get": { "operationId": "get_yelp_search_suggestions", "summary": "Yelp Search Suggestions", "description": "Yelp search suggestions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Pizza", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": true, "example": "New York, NY", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Yelp" ] } }, "/utility/endpoints": { "get": { "operationId": "get_utility_endpoints", "summary": "Utility Endpoints", "description": "Utility endpoints. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "platform", "in": "query", "required": false, "example": "tiktok", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "GET", "POST", "PATCH", "DELETE" ] } }, { "name": "fingerprint", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Utility" ] } }, "/utility/endpoint": { "get": { "operationId": "get_utility_endpoint", "summary": "Utility Endpoint", "description": "Utility endpoint. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "tiktok/profile", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "GET", "POST", "PATCH", "DELETE" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Utility" ] } }, "/utility/capabilities": { "get": { "operationId": "get_utility_capabilities", "summary": "Utility Capabilities", "description": "Utility capabilities. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "param", "in": "query", "required": false, "example": "relevance", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Utility" ] } }, "/utility/plan": { "get": { "operationId": "get_utility_plan", "summary": "Utility Plan", "description": "Utility plan. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "Combine @acme's TikTok profile with their recent videos and the comments on them", "schema": { "type": "string" } }, { "name": "task", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "task" ] ], "tags": [ "Utility" ] } }, "/utility/resolve": { "get": { "operationId": "get_utility_resolve", "summary": "Utility Resolve", "description": "Utility resolve. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "input", "in": "query", "required": false, "example": "https://www.tiktok.com/@charlidamelio/video/7234567890123456789", "schema": { "type": "string" } }, { "name": "inputs", "in": "query", "required": false, "example": "instagram:nasa,https://www.youtube.com/@MrBeast,B08N5WRWNW", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "input", "inputs" ] ], "tags": [ "Utility" ] } }, "/utility/estimate": { "get": { "operationId": "get_utility_estimate", "summary": "Utility Estimate", "description": "Utility estimate. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "tiktok/post/comments", "schema": { "type": "string" } }, { "name": "method", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "GET", "POST", "PATCH", "DELETE" ] } }, { "name": "params", "in": "query", "required": false, "example": "url=https://www.tiktok.com/@stoolpresidente/video/7623818255903329566&label=spam", "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "items", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } }, { "name": "plan", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "plan" ] ], "tags": [ "Utility" ] } }, "/utility/explain-error": { "get": { "operationId": "get_utility_explain_error", "summary": "Utility Explain Error", "description": "Utility explain error. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "status", "in": "query", "required": false, "example": 400, "schema": { "type": "integer", "minimum": 100, "maximum": 599 } }, { "name": "body", "in": "query", "required": false, "example": "{\"success\":false,\"error\":{\"type\":\"INVALID_REQUEST\",\"message\":\"Unknown query parameter 'handel'. Did you mean 'handle'?\",\"status\":400,\"details\":{\"unknown_parameters\":[\"handel\"],\"suggestions\":{\"handel\":\"handle\"}}}}", "schema": { "type": "string" } }, { "name": "request", "in": "query", "required": false, "example": "/v1/tiktok/profile?handel=nasa", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "body", "status" ] ], "tags": [ "Utility" ] } }, "/utility/docs-search": { "get": { "operationId": "get_utility_docs_search", "summary": "Utility Docs Search", "description": "Utility docs search. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "how does cursor pagination work", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 3, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "q" ] ], "tags": [ "Utility" ] } }, "/utility/find": { "get": { "operationId": "get_utility_find", "summary": "Utility Find", "description": "Utility find. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "task", "in": "query", "required": false, "example": "last 200 comments on https://www.tiktok.com/@stoolpresidente/video/7623818255903329566", "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "task", "query" ] ], "tags": [ "Utility" ] } }, "/utility/recipes": { "get": { "operationId": "get_utility_recipes", "summary": "Utility Recipes", "description": "Utility recipes. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "example": "export-tiktok-comments", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Utility" ] } }, "/utility/quickstart": { "get": { "operationId": "get_utility_quickstart", "summary": "Utility Quickstart", "description": "Utility quickstart. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "platform", "in": "query", "required": false, "example": "tiktok", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Utility" ] } }, "/utility/llms": { "get": { "operationId": "get_utility_llms", "summary": "Utility Llms", "description": "Utility llms. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "platform", "in": "query", "required": false, "example": "tiktok", "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "markdown", "json" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Utility" ] } }, "/linktree/page": { "get": { "operationId": "get_linktree_page", "summary": "Linktree Page", "description": "Linktree page. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://linktr.ee/charlidamelio", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Linktree" ] } }, "/linkbio/page": { "get": { "operationId": "get_linkbio_page", "summary": "Linkbio Page", "description": "Linkbio page. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://lnk.bio/example", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Linkbio" ] } }, "/linkme/page": { "get": { "operationId": "get_linkme_page", "summary": "Linkme Page", "description": "Linkme page. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://link.me/example", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Linkme" ] } }, "/komi/page": { "get": { "operationId": "get_komi_page", "summary": "Komi Page", "description": "Komi page. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://kimkardashian.komi.io/", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Komi" ] } }, "/pillar/page": { "get": { "operationId": "get_pillar_page", "summary": "Pillar Page", "description": "Pillar page. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://pillar.io/example", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Pillar" ] } }, "/polymarket/research": { "get": { "operationId": "get_polymarket_research", "summary": "Polymarket Research", "description": "Polymarket research. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "trump 2028 election", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Polymarket" ] } }, "/hackernews/search": { "get": { "operationId": "get_hackernews_search", "summary": "Hacker News Search", "description": "Hackernews search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "claude code", "schema": { "type": "string" } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "numericFilters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "hitsPerPage", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hacker News" ] } }, "/hackernews/story": { "get": { "operationId": "get_hackernews_story", "summary": "Hacker News Story", "description": "Hackernews story. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "8863", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hacker News" ] } }, "/hackernews/story/comments": { "get": { "operationId": "get_hackernews_story_comments", "summary": "Hacker News Story Comments", "description": "Hackernews story comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "8863", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hacker News" ] } }, "/hackernews/profile": { "get": { "operationId": "get_hackernews_profile", "summary": "Hacker News Profile", "description": "Hackernews profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "pg", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Hacker News" ] } }, "/quora/search": { "get": { "operationId": "get_quora_search", "summary": "Quora Search", "description": "Quora search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "learn programming", "schema": { "type": "string" } }, { "name": "time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "hour", "day", "week", "month", "year" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Quora" ] } }, "/quora/post": { "get": { "operationId": "get_quora_post", "summary": "Quora Post", "description": "Quora post. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.quora.com/What-is-the-best-alternative-to-SendGrid-Email-API", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Quora" ] } }, "/quora/answers": { "get": { "operationId": "get_quora_answers", "summary": "Quora Answers", "description": "Quora answers. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "learn programming", "schema": { "type": "string" } }, { "name": "time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "hour", "day", "week", "month", "year" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Quora" ] } }, "/quora/posts": { "get": { "operationId": "get_quora_posts", "summary": "Quora Posts", "description": "Quora posts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "learn programming", "schema": { "type": "string" } }, { "name": "time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "hour", "day", "week", "month", "year" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Quora" ] } }, "/quora/profiles": { "get": { "operationId": "get_quora_profiles", "summary": "Quora Profiles", "description": "Quora profiles. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "learn programming", "schema": { "type": "string" } }, { "name": "time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "hour", "day", "week", "month", "year" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Quora" ] } }, "/quora/spaces": { "get": { "operationId": "get_quora_spaces", "summary": "Quora Spaces", "description": "Quora spaces. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "learn programming", "schema": { "type": "string" } }, { "name": "time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "hour", "day", "week", "month", "year" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Quora" ] } }, "/quora/topics": { "get": { "operationId": "get_quora_topics", "summary": "Quora Topics", "description": "Quora topics. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "learn programming", "schema": { "type": "string" } }, { "name": "time", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "hour", "day", "week", "month", "year" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Quora" ] } }, "/douyin/search": { "get": { "operationId": "get_douyin_search", "summary": "Douyin Search", "description": "Douyin search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "美食", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25 } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "most_liked", "latest" ] } }, { "name": "published", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "half_year" ] } }, { "name": "duration", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "under_1m", "one_to_five_m", "over_5m" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Douyin" ] } }, "/douyin/profile": { "get": { "operationId": "get_douyin_profile", "summary": "Douyin Profile", "description": "Douyin profile. Availability depends on the configured provider route.", "x-credit-cost": 6, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://www.douyin.com/user/MS4wLjABAAAAtxsy7VmVkU3RN9oIX0vdkh_6-LlQAb0gwI-tDf-bYNg", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "url", "id" ] ], "tags": [ "Douyin" ] } }, "/douyin/profile/posts": { "get": { "operationId": "get_douyin_profile_posts", "summary": "Douyin Profile Posts", "description": "Douyin profile posts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://www.douyin.com/user/MS4wLjABAAAAtxsy7VmVkU3RN9oIX0vdkh_6-LlQAb0gwI-tDf-bYNg", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25 } }, { "name": "recent_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "exclude_pinned", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "url", "id" ] ], "tags": [ "Douyin" ] } }, "/douyin/post": { "get": { "operationId": "get_douyin_post", "summary": "Douyin Post", "description": "Douyin post. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.douyin.com/video/7681266289940544369", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Douyin" ] } }, "/douyin/post/comments": { "get": { "operationId": "get_douyin_post_comments", "summary": "Douyin Post Comments", "description": "Douyin post comments. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.douyin.com/video/7681266289940544369", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Douyin" ] } }, "/douyin/comment/replies": { "get": { "operationId": "get_douyin_comment_replies", "summary": "Douyin Comment Replies", "description": "Douyin comment replies. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.douyin.com/video/7681266289940544369", "schema": { "type": "string" } }, { "name": "comment_id", "in": "query", "required": true, "example": "7682735175344833317", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Douyin" ] } }, "/douyin/search/users": { "get": { "operationId": "get_douyin_search_users", "summary": "Douyin Search Users", "description": "Douyin search users. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "美食", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "followers", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "under_1k", "1k_to_10k", "10k_to_100k", "100k_to_1m", "over_1m" ] } }, { "name": "user_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "regular_user", "enterprise_verified", "individual_verified" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Douyin" ] } }, "/douyin/trending": { "get": { "operationId": "get_douyin_trending", "summary": "Douyin Trending", "description": "Douyin trending. Availability depends on the configured provider route.", "x-credit-cost": 25, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Douyin" ] } }, "/github/profile": { "get": { "operationId": "get_github_profile", "summary": "GitHub Profile", "description": "Github profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "octocat", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/repo": { "get": { "operationId": "get_github_repo", "summary": "GitHub Repo", "description": "Github repo. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/octocat/Hello-World", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/profile/repos": { "get": { "operationId": "get_github_profile_repos", "summary": "GitHub Profile Repos", "description": "Github profile repos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "octocat", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "owner", "member" ] } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "pushed", "full_name" ] } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/repo/readme": { "get": { "operationId": "get_github_repo_readme", "summary": "GitHub Repo Readme", "description": "Github repo readme. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/octocat/Hello-World", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/repo/releases": { "get": { "operationId": "get_github_repo_releases", "summary": "GitHub Repo Releases", "description": "Github repo releases. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/facebook/react", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/repo/issues": { "get": { "operationId": "get_github_repo_issues", "summary": "GitHub Repo Issues", "description": "Github repo issues. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/facebook/react", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "issue", "pr", "all" ] } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "all" ] } }, { "name": "labels", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "comments" ] } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/issue": { "get": { "operationId": "get_github_issue", "summary": "GitHub Issue", "description": "Github issue. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/facebook/react/issues/27522", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/issue/comments": { "get": { "operationId": "get_github_issue_comments", "summary": "GitHub Issue Comments", "description": "Github issue comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/facebook/react/issues/27522", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/search": { "get": { "operationId": "get_github_search", "summary": "GitHub Search", "description": "Github search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "repo:vercel/next.js is:issue is:open", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "reactions", "comments", "created", "updated" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/repo/top-issues": { "get": { "operationId": "get_github_repo_top_issues", "summary": "GitHub Repo Top Issues", "description": "Github repo top issues. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/facebook/react", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/repo/dossier": { "get": { "operationId": "get_github_repo_dossier", "summary": "GitHub Repo Dossier", "description": "Github repo dossier. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://github.com/facebook/react", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/github/user/profile-velocity": { "get": { "operationId": "get_github_user_profile_velocity", "summary": "GitHub User Profile Velocity", "description": "Github user profile velocity. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "octocat", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "quick", "default", "deep" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "GitHub" ] } }, "/tavily/search": { "get": { "operationId": "get_tavily_search", "summary": "Tavily Search", "description": "Tavily search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "claude opus 4.7 release notes", "schema": { "type": "string" } }, { "name": "search_depth", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "basic", "advanced", "fast", "ultra-fast" ] } }, { "name": "topic", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "general", "news", "finance" ] } }, { "name": "time_range", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "day", "week", "month", "year", "d", "w", "m", "y" ] } }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "chunks_per_source", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "include_images", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_image_descriptions", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_answer", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_raw_content", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tavily" ] } }, "/tavily/extract": { "get": { "operationId": "get_tavily_extract", "summary": "Tavily Extract", "description": "Tavily extract. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "urls", "in": "query", "required": true, "example": "https://en.wikipedia.org/wiki/Lionel_Messi", "schema": { "type": "string" } }, { "name": "extract_depth", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "basic", "advanced" ] } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "markdown", "text" ] } }, { "name": "include_images", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "include_favicon", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tavily" ] } }, "/tavily/map": { "get": { "operationId": "get_tavily_map", "summary": "Tavily Map", "description": "Tavily map. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://docs.tavily.com", "schema": { "type": "string" } }, { "name": "max_depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "max_breadth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "instructions", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "select_paths", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "select_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_paths", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "allow_external", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "categories", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tavily" ] } }, "/tavily/crawl": { "get": { "operationId": "get_tavily_crawl", "summary": "Tavily Crawl", "description": "Tavily crawl. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://docs.tavily.com", "schema": { "type": "string" } }, { "name": "max_depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "max_breadth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "instructions", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "select_paths", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "select_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_paths", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "allow_external", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "extract_depth", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "basic", "advanced" ] } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "markdown", "text" ] } }, { "name": "categories", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Tavily" ] } }, "/naver/blog/search": { "get": { "operationId": "get_naver_blog_search", "summary": "Naver Blog Search", "description": "Naver blog search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "소셜크롤", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "sim", "date" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/news/search": { "get": { "operationId": "get_naver_news_search", "summary": "Naver News Search", "description": "Naver news search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "삼성전자", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "sim", "date" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/encyc/search": { "get": { "operationId": "get_naver_encyc_search", "summary": "Naver Encyc Search", "description": "Naver encyc search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "양자역학", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/cafearticle/search": { "get": { "operationId": "get_naver_cafearticle_search", "summary": "Naver Cafearticle Search", "description": "Naver cafearticle search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "주식", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "sim", "date" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/kin/search": { "get": { "operationId": "get_naver_kin_search", "summary": "Naver Kin Search", "description": "Naver kin search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "코로나 증상", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "sim", "date", "point" ] } }, { "name": "group", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "question" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/local/search": { "get": { "operationId": "get_naver_local_search", "summary": "Naver Local Search", "description": "Naver local search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "강남역 카페", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 5, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "random", "comment" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/image/search": { "get": { "operationId": "get_naver_image_search", "summary": "Naver Image Search", "description": "Naver image search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "한라산", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "sim", "date" ] } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "large", "medium", "small" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/webkr/search": { "get": { "operationId": "get_naver_webkr_search", "summary": "Naver Webkr Search", "description": "Naver webkr search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "기후변화", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/errata": { "get": { "operationId": "get_naver_errata", "summary": "Naver Errata", "description": "Naver errata. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "네이볘", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/adult": { "get": { "operationId": "get_naver_adult", "summary": "Naver Adult", "description": "Naver adult. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "성인영화", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/search-trend": { "get": { "operationId": "get_naver_search_trend", "summary": "Naver Search Trend", "description": "Naver search trend. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "keywords", "in": "query", "required": false, "example": "삼성전자,갤럭시", "schema": { "type": "string" } }, { "name": "groups", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "time_unit", "in": "query", "required": false, "example": "month", "schema": { "type": "string", "enum": [ "date", "week", "month" ] } }, { "name": "group_name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "device", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pc", "mo" ] } }, { "name": "gender", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "f", "m" ] } }, { "name": "ages", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "keywords", "groups" ] ], "tags": [ "Naver" ] } }, "/naver/shopping-insight/category": { "get": { "operationId": "get_naver_shopping_insight_category", "summary": "Naver Shopping Insight Category", "description": "Naver shopping insight category. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "category_code", "in": "query", "required": true, "example": "50000000", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "time_unit", "in": "query", "required": false, "example": "month", "schema": { "type": "string", "enum": [ "date", "week", "month" ] } }, { "name": "device", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pc", "mo" ] } }, { "name": "gender", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "f", "m" ] } }, { "name": "ages", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "breakdown", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "device", "gender", "age" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/naver/shopping-insight/keyword": { "get": { "operationId": "get_naver_shopping_insight_keyword", "summary": "Naver Shopping Insight Keyword", "description": "Naver shopping insight keyword. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "category_code", "in": "query", "required": true, "example": "50000000", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "example": "코트", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "time_unit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "date", "week", "month" ] } }, { "name": "device", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pc", "mo" ] } }, { "name": "gender", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "f", "m" ] } }, { "name": "ages", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "breakdown", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "device", "gender", "age" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/rumble/search": { "get": { "operationId": "get_rumble_search", "summary": "Rumble Search", "description": "Rumble search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "funny cats", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Rumble" ] } }, "/rumble/channel/videos": { "get": { "operationId": "get_rumble_channel_videos", "summary": "Rumble Channel Videos", "description": "Rumble channel videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "CuteCats223", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "url" ] ], "tags": [ "Rumble" ] } }, "/rumble/video": { "get": { "operationId": "get_rumble_video", "summary": "Rumble Video", "description": "Rumble video. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://rumble.com/v79xhhm-discovery-example.html", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Rumble" ] } }, "/rumble/video/transcript": { "get": { "operationId": "get_rumble_video_transcript", "summary": "Rumble Video Transcript", "description": "Rumble video transcript. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://rumble.com/v784xoi-president-donald-j.-trump-and-secwar-pete-hegseth-hold-a-press-conference-a.html", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Rumble" ] } }, "/rumble/video/comments": { "get": { "operationId": "get_rumble_video_comments", "summary": "Rumble Video Comments", "description": "Rumble video comments. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://rumble.com/v792vns-example.html", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Rumble" ] } }, "/bluesky/profile": { "get": { "operationId": "get_bluesky_profile", "summary": "Bluesky Profile", "description": "Bluesky profile. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "espn.com", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Bluesky" ] } }, "/bluesky/user/posts": { "get": { "operationId": "get_bluesky_user_posts", "summary": "Bluesky User Posts", "description": "Bluesky user posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "espn.com", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Bluesky" ] } }, "/bluesky/post": { "get": { "operationId": "get_bluesky_post", "summary": "Bluesky Post", "description": "Bluesky post. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://bsky.app/profile/espn.com/post/3lqdfq7fkvm2g", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Bluesky" ] } }, "/bluesky/search": { "get": { "operationId": "get_bluesky_search", "summary": "Bluesky Search", "description": "Bluesky search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "espresso", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "top" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "author", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Bluesky" ] } }, "/spotify/artist": { "get": { "operationId": "get_spotify_artist", "summary": "Spotify Artist", "description": "Spotify artist. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://open.spotify.com/artist/0cGUm45nv7Z6M6qdXYQGTX", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Spotify" ] } }, "/spotify/track": { "get": { "operationId": "get_spotify_track", "summary": "Spotify Track", "description": "Spotify track. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://open.spotify.com/track/1ITJflybJsfarsUtiBvkfK", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Spotify" ] } }, "/spotify/album": { "get": { "operationId": "get_spotify_album", "summary": "Spotify Album", "description": "Spotify album. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://open.spotify.com/album/0pgrg7phBbnwGJ2HBEl9EG", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Spotify" ] } }, "/spotify/search": { "get": { "operationId": "get_spotify_search", "summary": "Spotify Search", "description": "Spotify search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "my first million", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Spotify" ] } }, "/spotify/podcast": { "get": { "operationId": "get_spotify_podcast", "summary": "Spotify Podcast", "description": "Spotify podcast. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://open.spotify.com/show/3mliji9352UAk3XnWElnDV", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Spotify" ] } }, "/spotify/podcast/episodes": { "get": { "operationId": "get_spotify_podcast_episodes", "summary": "Spotify Podcast Episodes", "description": "Spotify podcast episodes. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://open.spotify.com/show/4rOoJ6Egrf8K2IrywzwOMk", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Spotify" ] } }, "/apple_music/search": { "get": { "operationId": "get_apple_music_search", "summary": "Apple Music Search", "description": "Apple Music search. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "taylor swift", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "example": "song", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Apple Music" ] } }, "/apple_music/artist": { "get": { "operationId": "get_apple_music_artist", "summary": "Apple Music Artist", "description": "Apple Music artist. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://music.apple.com/us/artist/taylor-swift/159260351", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Apple Music" ] } }, "/apple_music/album": { "get": { "operationId": "get_apple_music_album", "summary": "Apple Music Album", "description": "Apple Music album. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://music.apple.com/us/album/red-taylors-version/1590368448", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Apple Music" ] } }, "/apple_music/track": { "get": { "operationId": "get_apple_music_track", "summary": "Apple Music Track", "description": "Apple Music track. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "example": "https://music.apple.com/us/album/22-taylors-version/1590368448?i=1590368457", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "id", "url" ] ], "tags": [ "Apple Music" ] } }, "/apple_music/charts": { "get": { "operationId": "get_apple_music_charts", "summary": "Apple Music Charts", "description": "Apple Music charts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "country", "in": "query", "required": false, "example": "de", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "example": "songs", "schema": { "type": "string", "enum": [ "songs", "albums", "music-videos", "playlists" ] } }, { "name": "limit", "in": "query", "required": false, "example": 10, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Apple Music" ] } }, "/search/everywhere": { "get": { "operationId": "get_search_everywhere", "summary": "Search Everywhere", "description": "Search everywhere. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "kanye west", "schema": { "type": "string" } }, { "name": "lookback_days", "in": "query", "required": false, "example": 30, "schema": { "type": "integer", "minimum": 1 } }, { "name": "from_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": false, "example": "reddit,youtube,github", "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include_transcripts", "in": "query", "required": false, "example": false, "schema": { "type": "boolean" } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "filter" ] } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "switch_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Search" ] } }, "/search/forums": { "get": { "operationId": "get_search_forums", "summary": "Search Forums", "description": "Search forums. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "airpods pro 3 battery", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": false, "example": "reddit,hackernews,naver_kin", "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "comments", "in": "query", "required": false, "example": "on", "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lookback_days", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Search" ] } }, "/search/creators": { "get": { "operationId": "get_search_creators", "summary": "Search Creators", "description": "Search creators. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "skincare routine", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": false, "example": "tiktok,instagram", "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_followers", "in": "query", "required": false, "example": 50000, "schema": { "type": "integer", "minimum": 0 } }, { "name": "verified_only", "in": "query", "required": false, "example": false, "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "required": false, "example": "relevance", "schema": { "type": "string", "enum": [ "relevance", "followers", "verification" ] } }, { "name": "brief", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Search" ] } }, "/search/multi": { "get": { "operationId": "get_search_multi", "summary": "Search Multi", "description": "Search multi. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "matcha latte", "schema": { "type": "string" } }, { "name": "platforms", "in": "query", "required": false, "example": "tiktok,instagram,youtube", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "example": "2026-09-01", "schema": { "type": "string" } }, { "name": "tiktok.date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "yesterday", "this-week", "this-month", "last-3-months", "last-6-months", "all-time" ] } }, { "name": "tiktok.sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "most-liked", "date-posted" ] } }, { "name": "tiktok.region", "in": "query", "required": false, "example": "US", "schema": { "type": "string" } }, { "name": "instagram.date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "last-week", "last-month", "last-year" ] } }, { "name": "youtube.uploadDate", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "today", "this_week", "this_month", "this_year" ] } }, { "name": "youtube.sortBy", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "popular" ] } }, { "name": "youtube.type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "videos", "shorts" ] } }, { "name": "youtube.duration", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "under_3_min", "between_3_and_20_min", "over_20_min" ] } }, { "name": "youtube.region", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reddit.sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "new", "top", "comment_count" ] } }, { "name": "reddit.timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ] } }, { "name": "threads.start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "threads.end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "twitter.sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "top" ] } }, { "name": "facebook.start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "facebook.end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "facebook.recent_posts", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "facebook.location_uid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "linkedin.sort_by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "date_posted", "relevance" ] } }, { "name": "linkedin.date_posted", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "past_24h", "past_week", "past_month" ] } }, { "name": "linkedin.content_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "videos", "photos", "jobs", "live_videos", "documents", "collaborative_articles" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Search" ] } }, "/search/news": { "get": { "operationId": "get_search_news", "summary": "Search News", "description": "Search news. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "samsung galaxy launch", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "required": false, "example": "KR,US,JP", "schema": { "type": "string" } }, { "name": "engines", "in": "query", "required": false, "example": "google,bing", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "example": "date", "schema": { "type": "string", "enum": [ "relevance", "date" ] } }, { "name": "time_range", "in": "query", "required": false, "example": "week", "schema": { "type": "string", "enum": [ "day", "week", "month", "year" ] } }, { "name": "from", "in": "query", "required": false, "example": "2026-07-01", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "example": "2026-07-31", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "required": false, "example": "bbc.com", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 10, "schema": { "type": "integer", "minimum": 10, "maximum": 100 } }, { "name": "max_legs", "in": "query", "required": false, "example": 4, "schema": { "type": "integer", "minimum": 1, "maximum": 12 } }, { "name": "group", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "stories" ] } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Search" ] } }, "/prism/lookup": { "get": { "operationId": "get_prism_lookup", "summary": "Prism Lookup", "description": "Prism lookup. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/comments": { "get": { "operationId": "get_prism_comments", "summary": "Prism Comments", "description": "Prism comments. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "max", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "replies", "in": "query", "required": false, "example": true, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "example": "top", "schema": { "type": "string", "enum": [ "top", "recent" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/tiktok/profile/full": { "get": { "operationId": "get_tiktok_profile_full", "summary": "TikTok Profile Full", "description": "Tiktok profile full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "posts", "in": "query", "required": false, "example": 25, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "TikTok" ] } }, "/instagram/profile/full": { "get": { "operationId": "get_instagram_profile_full", "summary": "Instagram Profile Full", "description": "Instagram profile full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "posts", "in": "query", "required": false, "example": 25, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle" ] ], "tags": [ "Instagram" ] } }, "/youtube/profile/full": { "get": { "operationId": "get_youtube_profile_full", "summary": "YouTube Profile Full", "description": "Youtube profile full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "posts", "in": "query", "required": false, "example": 25, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "channelId", "url" ] ], "tags": [ "YouTube" ] } }, "/twitter/profile/full": { "get": { "operationId": "get_twitter_profile_full", "summary": "X (Twitter) Profile Full", "description": "Twitter profile full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "posts", "in": "query", "required": false, "example": 25, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle" ] ], "tags": [ "X (Twitter)" ] } }, "/facebook/profile/full": { "get": { "operationId": "get_facebook_profile_full", "summary": "Facebook Profile Full", "description": "Facebook profile full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.facebook.com/mrbeast", "schema": { "type": "string" } }, { "name": "posts", "in": "query", "required": false, "example": 25, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url" ] ], "tags": [ "Facebook" ] } }, "/linkedin/profile/full": { "get": { "operationId": "get_linkedin_profile_full", "summary": "LinkedIn Profile Full", "description": "Linkedin profile full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.linkedin.com/company/microsoft", "schema": { "type": "string" } }, { "name": "posts", "in": "query", "required": false, "example": 25, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url" ] ], "tags": [ "LinkedIn" ] } }, "/instagram/profile/reels/full": { "get": { "operationId": "get_instagram_profile_reels_full", "summary": "Instagram Profile Reels Full", "description": "Instagram profile reels full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "sid.and.listen", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Instagram" ] } }, "/instagram/profile/posts/full": { "get": { "operationId": "get_instagram_profile_posts_full", "summary": "Instagram Profile Posts Full", "description": "Instagram profile posts full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "sid.and.listen", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "user_id" ] ], "tags": [ "Instagram" ] } }, "/facebook/profile/reels/full": { "get": { "operationId": "get_facebook_profile_reels_full", "summary": "Facebook Profile Reels Full", "description": "Facebook profile reels full. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.facebook.com/Meta", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/search/posts": { "get": { "operationId": "get_facebook_search_posts", "summary": "Facebook Search Posts", "description": "Facebook search posts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "NASA", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "recent_posts", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "location_uid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label_evidence", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "max_pages", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "seen", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/search/pages": { "get": { "operationId": "get_facebook_search_pages", "summary": "Facebook Search Pages", "description": "Facebook search pages. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "NASA", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_uid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/search/people": { "get": { "operationId": "get_facebook_search_people", "summary": "Facebook Search People", "description": "Facebook search people. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "NASA", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location_uid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/search/videos": { "get": { "operationId": "get_facebook_search_videos", "summary": "Facebook Search Videos", "description": "Facebook search videos. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "NASA", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "recent_videos", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "location_uid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/facebook/search/groups": { "get": { "operationId": "get_facebook_search_groups", "summary": "Facebook Search Groups", "description": "Facebook search groups. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "vintage cars", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "details" ] } }, { "name": "relevance", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "score", "filter" ] } }, { "name": "relevance_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "judgments", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fit", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "goal" ] } }, { "name": "goal", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fit_tokens", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Facebook" ] } }, "/reddit/omni-search": { "get": { "operationId": "get_reddit_omni_search", "summary": "Reddit Omni Search", "description": "Reddit omni search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "best mechanical keyboard", "schema": { "type": "string" } }, { "name": "threads", "in": "query", "required": false, "example": 5, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "new", "top", "comment_count" ] } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "month", "year" ] } }, { "name": "subreddit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Reddit" ] } }, "/prism/brand-mentions": { "get": { "operationId": "get_prism_brand_mentions", "summary": "Prism Brand Mentions", "description": "Prism brand mentions. Availability depends on the configured provider route.", "x-credit-cost": 50, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "socialcrawl", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": true, "example": "2026-06-01", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_group", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "day", "week", "month" ] } }, { "name": "page_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ecommerce", "news", "blogs", "message-boards", "organization" ] } }, { "name": "include", "in": "query", "required": false, "example": "digest", "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/demand-signals": { "get": { "operationId": "get_prism_demand_signals", "summary": "Prism Demand Signals", "description": "Prism demand signals. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "spotify", "schema": { "type": "string" } }, { "name": "google_play_id", "in": "query", "required": false, "example": "com.spotify.music", "schema": { "type": "string" } }, { "name": "app_store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "signals", "in": "query", "required": false, "example": "app_reviews,mentions,reddit,commerce", "schema": { "type": "string" } }, { "name": "amazon_query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/campaign": { "get": { "operationId": "get_prism_campaign", "summary": "Prism Campaign", "description": "Prism campaign. Availability depends on the configured provider route.", "x-credit-cost": 35, "x-launch-status": "beta", "parameters": [ { "name": "hashtag", "in": "query", "required": false, "example": "summergiveaway", "schema": { "type": "string" } }, { "name": "phrase", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "window_start", "in": "query", "required": false, "example": "2026-06-01", "schema": { "type": "string" } }, { "name": "window_end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pre_days", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "post_days", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "include", "in": "query", "required": false, "example": "amplifier_dates", "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "hashtag", "phrase" ] ], "tags": [ "Prism" ] } }, "/prism/ai-visibility": { "get": { "operationId": "get_prism_ai_visibility", "summary": "Prism Ai Visibility", "description": "Prism ai visibility. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "brand", "in": "query", "required": true, "example": "socialcrawl", "schema": { "type": "string" } }, { "name": "prompts", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": false, "example": "social media data api", "schema": { "type": "string" } }, { "name": "competitors", "in": "query", "required": false, "example": "competitor one,competitor two", "schema": { "type": "string" } }, { "name": "engines", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "runs", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "preset", "in": "query", "required": false, "example": "standard", "schema": { "type": "string", "enum": [ "quick", "standard", "deep" ] } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_domains", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "topic", "prompts" ] ], "tags": [ "Prism" ] } }, "/prism/crisis-postmortem": { "get": { "operationId": "get_prism_crisis_postmortem", "summary": "Prism Crisis Postmortem", "description": "Prism crisis postmortem. Availability depends on the configured provider route.", "x-credit-cost": 35, "x-launch-status": "beta", "parameters": [ { "name": "brand", "in": "query", "required": true, "example": "acme", "schema": { "type": "string" } }, { "name": "window_start", "in": "query", "required": false, "example": "2026-06-02", "schema": { "type": "string" } }, { "name": "window_end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "crisis_terms", "in": "query", "required": false, "example": "breach,leak", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/crisis-radar": { "get": { "operationId": "get_prism_crisis_radar", "summary": "Prism Crisis Radar", "description": "Prism crisis radar. Availability depends on the configured provider route.", "x-credit-cost": 15, "x-launch-status": "beta", "parameters": [ { "name": "brand", "in": "query", "required": true, "example": "socialcrawl", "schema": { "type": "string" } }, { "name": "sensitivity", "in": "query", "required": false, "example": "2.0", "schema": { "type": "string" } }, { "name": "confirm", "in": "query", "required": false, "example": true, "schema": { "type": "boolean" } }, { "name": "baseline_days", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/devtool-pulse": { "get": { "operationId": "get_prism_devtool_pulse", "summary": "Prism Devtool Pulse", "description": "Prism devtool pulse. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Bun", "schema": { "type": "string" } }, { "name": "repo", "in": "query", "required": false, "example": "oven-sh/bun", "schema": { "type": "string" } }, { "name": "subreddit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/leads": { "get": { "operationId": "get_prism_leads", "summary": "Prism Leads", "description": "Prism leads. Availability depends on the configured provider route.", "x-credit-cost": 50, "x-launch-status": "beta", "parameters": [ { "name": "competitor", "in": "query", "required": true, "example": "notion", "schema": { "type": "string" } }, { "name": "product_category", "in": "query", "required": false, "example": "project management", "schema": { "type": "string" } }, { "name": "freshness", "in": "query", "required": false, "example": "30d", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "offer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/comment-leads": { "get": { "operationId": "get_prism_comment_leads", "summary": "Prism Comment Leads", "description": "Prism comment leads. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "standing desk setup", "schema": { "type": "string" } }, { "name": "offer", "in": "query", "required": false, "example": "Height-adjustable standing desks delivered to your home", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "tiktok" ] } }, { "name": "posts", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 90 } }, { "name": "open", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "comments_per_post", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/earned-media": { "get": { "operationId": "get_prism_earned_media", "summary": "Prism Earned Media", "description": "Prism earned media. Availability depends on the configured provider route.", "x-credit-cost": 25, "x-launch-status": "beta", "parameters": [ { "name": "brand", "in": "query", "required": true, "example": "Vercel", "schema": { "type": "string" } }, { "name": "competitor", "in": "query", "required": false, "example": "Netlify", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "min_domain_rank", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/truthsocial-pulse": { "get": { "operationId": "get_prism_truthsocial_pulse", "summary": "Prism Truthsocial Pulse", "description": "Prism truthsocial pulse. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "realDonaldTrump", "schema": { "type": "string" } }, { "name": "drill", "in": "query", "required": false, "example": 5, "schema": { "type": "integer" } }, { "name": "posts", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "news_query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/launch-echo": { "get": { "operationId": "get_prism_launch_echo", "summary": "Prism Launch Echo", "description": "Prism launch echo. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Bun 1.2", "schema": { "type": "string" } }, { "name": "repo", "in": "query", "required": false, "example": "oven-sh/bun", "schema": { "type": "string" } }, { "name": "threads", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/audience-overlap": { "get": { "operationId": "get_prism_audience_overlap", "summary": "Prism Audience Overlap", "description": "Prism audience overlap. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "handle_a", "in": "query", "required": true, "example": "mkbhd", "schema": { "type": "string" } }, { "name": "handle_b", "in": "query", "required": true, "example": "mrwhosetheboss", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "videos_per_creator", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/reputation": { "get": { "operationId": "get_prism_reputation", "summary": "Prism Reputation", "description": "Prism reputation. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "brand", "in": "query", "required": true, "example": "Notion", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": false, "example": "trustpilot,google_play,app_store,web", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "place", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "axis", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "company", "product", "both" ] } }, { "name": "app_store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "google_play_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/employer-brand": { "get": { "operationId": "get_prism_employer_brand", "summary": "Prism Employer Brand", "description": "Prism employer brand. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "company", "in": "query", "required": true, "example": "Stripe", "schema": { "type": "string" } }, { "name": "linkedin_url", "in": "query", "required": false, "example": "https://www.linkedin.com/company/stripe", "schema": { "type": "string" } }, { "name": "surfaces", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "phrases", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/audience-questions": { "get": { "operationId": "get_prism_audience_questions", "summary": "Prism Audience Questions", "description": "Prism audience questions. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "topic", "in": "query", "required": true, "example": "kubernetes operators", "schema": { "type": "string" } }, { "name": "platforms", "in": "query", "required": false, "example": "reddit,youtube", "schema": { "type": "string" } }, { "name": "max_questions", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "threads_per_source", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/product-reviews": { "get": { "operationId": "get_prism_product_reviews", "summary": "Prism Product Reviews", "description": "Prism product reviews. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "AirPods Pro 3", "schema": { "type": "string" } }, { "name": "asin", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "gid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": false, "example": "amazon,google_shopping,trustpilot", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "competitors", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "asin", "gid" ] ], "tags": [ "Prism" ] } }, "/prism/apps-lookup": { "get": { "operationId": "get_prism_apps_lookup", "summary": "Prism Apps Lookup", "description": "Prism apps lookup. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "title", "in": "query", "required": false, "example": "Notion", "schema": { "type": "string" } }, { "name": "google_play_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "app_store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stores", "in": "query", "required": false, "example": "google_play,app_store", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "match_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "title", "google_play_id", "app_store_id" ] ], "tags": [ "Prism" ] } }, "/prism/org-radar": { "get": { "operationId": "get_prism_org_radar", "summary": "Prism Org Radar", "description": "Prism org radar. Availability depends on the configured provider route.", "x-credit-cost": 6, "x-launch-status": "beta", "parameters": [ { "name": "org", "in": "query", "required": true, "example": "vercel", "schema": { "type": "string" } }, { "name": "repos", "in": "query", "required": false, "example": 5, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "stars", "updated", "pushed" ] } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/creator-vet": { "get": { "operationId": "get_prism_creator_vet", "summary": "Prism Creator Vet", "description": "Prism creator vet. Availability depends on the configured provider route.", "x-credit-cost": 50, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "mkbhd", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": false, "example": "youtube", "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/adverse-screen": { "get": { "operationId": "get_prism_adverse_screen", "summary": "Prism Adverse Screen", "description": "Prism adverse screen. Availability depends on the configured provider route.", "x-credit-cost": 25, "x-launch-status": "beta", "parameters": [ { "name": "linkedin", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "twitter", "in": "query", "required": false, "example": "elonmusk", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "instagram", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "threads", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tiktok", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "example": "Elon Musk", "schema": { "type": "string" } }, { "name": "employer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "city", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "categories", "in": "query", "required": false, "example": "fraud_or_financial_crime,violence_or_threats", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "screen_unconfirmed", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "linkedin", "twitter", "facebook", "instagram", "threads", "tiktok" ] ], "tags": [ "Prism" ] } }, "/prism/find-accounts": { "get": { "operationId": "get_prism_find_accounts", "summary": "Prism Find Accounts", "description": "Prism find accounts. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "name", "in": "query", "required": true, "example": "Ogilvy", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "example": "company", "schema": { "type": "string", "enum": [ "person", "company" ] } }, { "name": "platforms", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "employer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "website", "in": "query", "required": false, "example": "ogilvy.com", "schema": { "type": "string" } }, { "name": "candidates", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/mentions": { "get": { "operationId": "get_prism_mentions", "summary": "Prism Mentions", "description": "Prism mentions. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": false, "example": "nasa", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "platforms", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include_self", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "handle", "url", "name" ] ], "tags": [ "Prism" ] } }, "/prism/brief-check": { "get": { "operationId": "get_prism_brief_check", "summary": "Prism Brief Check", "description": "Prism brief check. Availability depends on the configured provider route.", "x-credit-cost": 15, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.tiktok.com/@creator/video/1", "schema": { "type": "string" } }, { "name": "points", "in": "query", "required": true, "example": "Use the code SAVE20, Show the app on camera", "schema": { "type": "string" } }, { "name": "forbidden", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "require_disclosure", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "brand", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/format-lift": { "get": { "operationId": "get_prism_format_lift", "summary": "Prism Format Lift", "description": "Prism format lift. Availability depends on the configured provider route.", "x-credit-cost": 4, "x-launch-status": "beta", "parameters": [ { "name": "platform", "in": "query", "required": true, "example": "youtube", "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": true, "example": "joshuaweissman", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/earliness": { "get": { "operationId": "get_prism_earliness", "summary": "Prism Earliness", "description": "Prism earliness. Availability depends on the configured provider route.", "x-credit-cost": 25, "x-launch-status": "beta", "parameters": [ { "name": "term", "in": "query", "required": true, "example": "swerve app", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "example": "US", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/trend-board": { "get": { "operationId": "get_prism_trend_board", "summary": "Prism Trend Board", "description": "Prism trend board. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "country_code", "in": "query", "required": true, "example": "DE", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "7", "30" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/audience-language": { "get": { "operationId": "get_prism_audience_language", "summary": "Prism Audience Language", "description": "Prism audience language. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "platform", "in": "query", "required": true, "example": "tiktok", "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": true, "example": "charlidamelio", "schema": { "type": "string" } }, { "name": "posts", "in": "query", "required": false, "example": 5, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/korea-gap": { "get": { "operationId": "get_prism_korea_gap", "summary": "Prism Korea Gap", "description": "Prism korea gap. Availability depends on the configured provider route.", "x-credit-cost": 15, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "Stanley cup", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "example": "social,quotes", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/share-of-voice": { "get": { "operationId": "get_prism_share_of_voice", "summary": "Prism Share Of Voice", "description": "Prism share of voice. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "brands", "in": "query", "required": true, "example": "notion,coda,airtable", "schema": { "type": "string" } }, { "name": "category_code", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "market_shares", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "example": "social,emotions", "schema": { "type": "string" } }, { "name": "page_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ecommerce", "news", "blogs", "message-boards", "organization" ] } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "brand_descriptions", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/review-integrity": { "get": { "operationId": "get_prism_review_integrity", "summary": "Prism Review Integrity", "description": "Prism review integrity. Availability depends on the configured provider route.", "x-credit-cost": 30, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "AirPods Pro 3", "schema": { "type": "string" } }, { "name": "asin", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "gid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": false, "example": "amazon,trustpilot,forums", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "asin", "gid" ] ], "tags": [ "Prism" ] } }, "/prism/answers": { "get": { "operationId": "get_prism_answers", "summary": "Prism Answers", "description": "Prism answers. Availability depends on the configured provider route.", "x-credit-cost": 15, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "will the fed cut rates in september", "schema": { "type": "string" } }, { "name": "engines", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "example": "polymarket", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/video-intel": { "get": { "operationId": "get_prism_video_intel", "summary": "Prism Video Intel", "description": "Prism video intel. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "comments", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "example": "transcript,commenter_profiles", "schema": { "type": "string" } }, { "name": "app_demand", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "claim", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/voice": { "get": { "operationId": "get_prism_voice", "summary": "Prism Voice", "description": "Prism voice. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "nasa", "schema": { "type": "string" } }, { "name": "platforms", "in": "query", "required": false, "example": "twitter,threads,bluesky,truthsocial", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/naver/brief": { "get": { "operationId": "get_naver_brief", "summary": "Naver Brief", "description": "Naver brief. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "삼성전자", "schema": { "type": "string" } }, { "name": "corpora", "in": "query", "required": false, "example": "news,blog,kin", "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Naver" ] } }, "/prism/app-reviews": { "get": { "operationId": "get_prism_app_reviews", "summary": "Prism App Reviews", "description": "Prism app reviews. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "google_play_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "app_store_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "example": "spotify", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "required": false, "example": 150, "schema": { "type": "integer" } }, { "name": "stores", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "google_play_id", "app_store_id", "query" ] ], "tags": [ "Prism" ] } }, "/prism/creator-card": { "get": { "operationId": "get_prism_creator_card", "summary": "Prism Creator Card", "description": "Prism creator card. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "platforms", "in": "query", "required": false, "example": "tiktok,instagram,youtube,twitter", "schema": { "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "verify", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "anchor", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "tiktok", "instagram", "youtube", "twitter", "threads", "bluesky", "truthsocial" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/handle-audit": { "get": { "operationId": "get_prism_handle_audit", "summary": "Prism Handle Audit", "description": "Prism handle audit. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "mrbeast", "schema": { "type": "string" } }, { "name": "platforms", "in": "query", "required": false, "example": "tiktok,instagram,youtube,twitter", "schema": { "type": "string" } }, { "name": "sample", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25 } }, { "name": "relevant_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/post-stats": { "post": { "operationId": "post_prism_post_stats", "summary": "Prism Post Stats", "description": "Prism post stats. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "urls" ], "properties": { "urls": { "type": "array", "items": { "type": "string" } }, "include": { "type": "string" } } } } } }, "tags": [ "Prism" ] } }, "/prism/comment-lookup": { "post": { "operationId": "post_prism_comment_lookup", "summary": "Prism Comment Lookup", "description": "Prism comment lookup. Availability depends on the configured provider route.", "x-credit-cost": 2, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "string" } } } } } }, "tags": [ "Prism" ] } }, "/prism/profiles": { "post": { "operationId": "post_prism_profiles", "summary": "Prism Profiles", "description": "Prism profiles. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "string" }, "include": { "type": "string", "enum": [ "posts" ] }, "since": { "type": "string" } } } } } }, "tags": [ "Prism" ] } }, "/prism/jobs": { "post": { "operationId": "post_prism_jobs", "summary": "Prism Jobs", "description": "Prism jobs. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "endpoint", "items" ], "properties": { "endpoint": { "type": "string" }, "items": { "type": "string" }, "include": { "type": "string", "enum": [ "posts" ] }, "since": { "type": "string" }, "webhook": { "type": "string" } } } } } }, "tags": [ "Prism" ] }, "get": { "operationId": "get_prism_jobs", "summary": "Prism Jobs", "description": "Prism jobs. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/jobs/{job_id}": { "get": { "operationId": "get_prism_jobs_job_id", "summary": "Prism Jobs {Job Id}", "description": "Prism jobs {job id}. Availability depends on the configured provider route.", "x-credit-cost": 0, "x-launch-status": "beta", "parameters": [ { "name": "job_id", "in": "path", "required": true, "example": "bj_3kP9x2LmQ7", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/prism/investigate": { "get": { "operationId": "get_prism_investigate", "summary": "Prism Investigate", "description": "Prism investigate. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "goal", "in": "query", "required": true, "example": "Find Korean skincare creators on TikTok whose commenters ask where to buy", "schema": { "type": "string" } }, { "name": "budget", "in": "query", "required": false, "example": 40, "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "max_steps", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 12 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Prism" ] } }, "/content_analysis/search": { "get": { "operationId": "get_content_analysis_search", "summary": "Content Analysis Search", "description": "Content Analysis search. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "openai", "schema": { "type": "string" } }, { "name": "page_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ecommerce", "news", "blogs", "message-boards", "organization" ] } }, { "name": "search_mode", "in": "query", "required": false, "example": "as_is", "schema": { "type": "string", "enum": [ "as_is", "one_per_domain" ] } }, { "name": "limit", "in": "query", "required": false, "example": 10, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/summary": { "get": { "operationId": "get_content_analysis_summary", "summary": "Content Analysis Summary", "description": "Content Analysis summary. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "openai", "schema": { "type": "string" } }, { "name": "page_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ecommerce", "news", "blogs", "message-boards", "organization" ] } }, { "name": "positive_connotation_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sentiments_connotation_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "internal_list_limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/sentiment": { "get": { "operationId": "get_content_analysis_sentiment", "summary": "Content Analysis Sentiment", "description": "Content Analysis sentiment. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "openai", "schema": { "type": "string" } }, { "name": "page_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ecommerce", "news", "blogs", "message-boards", "organization" ] } }, { "name": "positive_connotation_threshold", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/rating-distribution": { "get": { "operationId": "get_content_analysis_rating_distribution", "summary": "Content Analysis Rating Distribution", "description": "Content Analysis rating distribution. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "iphone", "schema": { "type": "string" } }, { "name": "page_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ecommerce", "news", "blogs", "message-boards", "organization" ] } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/phrase-trends": { "get": { "operationId": "get_content_analysis_phrase_trends", "summary": "Content Analysis Phrase Trends", "description": "Content Analysis phrase trends. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "openai", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": true, "example": "2025-01-01", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_group", "in": "query", "required": false, "example": "month", "schema": { "type": "string", "enum": [ "day", "week", "month" ] } }, { "name": "page_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ecommerce", "news", "blogs", "message-boards", "organization" ] } }, { "name": "internal_list_limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/category-trends": { "get": { "operationId": "get_content_analysis_category_trends", "summary": "Content Analysis Category Trends", "description": "Content Analysis category trends. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "category_code", "in": "query", "required": true, "example": "10021", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": true, "example": "2025-01-01", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_group", "in": "query", "required": false, "example": "month", "schema": { "type": "string", "enum": [ "day", "week", "month" ] } }, { "name": "internal_list_limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/languages": { "get": { "operationId": "get_content_analysis_languages", "summary": "Content Analysis Languages", "description": "Content Analysis languages. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/locations": { "get": { "operationId": "get_content_analysis_locations", "summary": "Content Analysis Locations", "description": "Content Analysis locations. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/categories": { "get": { "operationId": "get_content_analysis_categories", "summary": "Content Analysis Categories", "description": "Content Analysis categories. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/content_analysis/filters": { "get": { "operationId": "get_content_analysis_filters", "summary": "Content Analysis Filters", "description": "Content Analysis filters. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Content Analysis" ] } }, "/on_page/page": { "get": { "operationId": "get_on_page_page", "summary": "On Page Page", "description": "On Page page. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.socialcrawl.dev/", "schema": { "type": "string" } }, { "name": "enable_javascript", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "On Page" ] } }, "/jobs/linkedin/search": { "get": { "operationId": "get_jobs_linkedin_search", "summary": "Jobs Linkedin Search", "description": "Jobs linkedin search. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "software engineer", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "example": "United States", "schema": { "type": "string" } }, { "name": "organization_ids", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date_posted", "in": "query", "required": false, "example": "week", "schema": { "type": "string", "enum": [ "month", "week", "day" ] } }, { "name": "employment_types", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "experience_levels", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workplace_types", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "cursor" ] ], "tags": [ "Jobs" ] } }, "/jobs/linkedin": { "get": { "operationId": "get_jobs_linkedin", "summary": "Jobs Linkedin", "description": "Jobs linkedin. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "4460359588", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Jobs" ] } }, "/jobs/linkedin/organizations": { "get": { "operationId": "get_jobs_linkedin_organizations", "summary": "Jobs Linkedin Organizations", "description": "Jobs linkedin organizations. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "google", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Jobs" ] } }, "/jobs/indeed/search": { "get": { "operationId": "get_jobs_indeed_search", "summary": "Jobs Indeed Search", "description": "Jobs indeed search. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "software engineer", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "example": "San Francisco", "schema": { "type": "string" } }, { "name": "country_code", "in": "query", "required": false, "example": "us", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "date" ] } }, { "name": "radius", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "radius_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "km", "miles" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "cursor" ], [ "country_code", "cursor" ] ], "tags": [ "Jobs" ] } }, "/jobs/indeed": { "get": { "operationId": "get_jobs_indeed", "summary": "Jobs Indeed", "description": "Jobs indeed. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "aWQ9NWExYzEwM2YzOTEzODljNDtjYz11cw==", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Jobs" ] } }, "/jobs/bing/search": { "get": { "operationId": "get_jobs_bing_search", "summary": "Jobs Bing Search", "description": "Jobs bing search. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "software engineer", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "example": "United States", "schema": { "type": "string" } }, { "name": "date_posted", "in": "query", "required": false, "example": "week", "schema": { "type": "string", "enum": [ "week", "day" ] } }, { "name": "employment_types", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "remote_only", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "cursor" ], [ "location", "cursor" ] ], "tags": [ "Jobs" ] } }, "/jobs/bing": { "get": { "operationId": "get_jobs_bing", "summary": "Jobs Bing", "description": "Jobs bing. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "MTE5OTc2NjYxOS5SZXRybw==", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Jobs" ] } }, "/jobs/xing/search": { "get": { "operationId": "get_jobs_xing_search", "summary": "Jobs Xing Search", "description": "Jobs xing search. Availability depends on the configured provider route.", "x-credit-cost": 10, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": false, "example": "software engineer", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "example": "Berlin", "schema": { "type": "string" } }, { "name": "date_posted", "in": "query", "required": false, "example": "week", "schema": { "type": "string", "enum": [ "month", "week", "day" ] } }, { "name": "employment_types", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "career_levels", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "remote_options", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "minimum_salary", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "query", "cursor" ] ], "tags": [ "Jobs" ] } }, "/jobs/xing": { "get": { "operationId": "get_jobs_xing", "summary": "Jobs Xing", "description": "Jobs xing. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "id", "in": "query", "required": true, "example": "YmVybGluLXNlbmlvci1zb2x1dGlvbi1lbmdpbmVlci0xNTY3NTI5MTA=", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Jobs" ] } }, "/jobs/salary/titles": { "get": { "operationId": "get_jobs_salary_titles", "summary": "Jobs Salary Titles", "description": "Jobs salary titles. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "software", "schema": { "type": "string" } }, { "name": "country_code", "in": "query", "required": true, "example": "us", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Jobs" ] } }, "/jobs/salary": { "get": { "operationId": "get_jobs_salary", "summary": "Jobs Salary", "description": "Jobs salary. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "software engineer", "schema": { "type": "string" } }, { "name": "country_code", "in": "query", "required": true, "example": "us", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Jobs" ] } }, "/us_congress_trades/trades": { "get": { "operationId": "get_us_congress_trades_trades", "summary": "Us Congress Trades Trades", "description": "Us Congress Trades trades. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "ticker", "in": "query", "required": false, "example": "NVDA", "schema": { "type": "string" } }, { "name": "politician", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "party", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "democrat", "republican" ] } }, { "name": "chamber", "in": "query", "required": false, "example": "senate", "schema": { "type": "string", "enum": [ "senate", "house" ] } }, { "name": "sector", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tx_type", "in": "query", "required": false, "example": "buy", "schema": { "type": "string", "enum": [ "buy", "sell", "exchange" ] } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pub_date", "tx_date", "value", "reporting_gap" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/trades/latest": { "get": { "operationId": "get_us_congress_trades_trades_latest", "summary": "Us Congress Trades Trades Latest", "description": "Us Congress Trades trades latest. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "limit", "in": "query", "required": false, "example": 20, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/trades/recent": { "get": { "operationId": "get_us_congress_trades_trades_recent", "summary": "Us Congress Trades Trades Recent", "description": "Us Congress Trades trades recent. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "limit", "in": "query", "required": false, "example": 20, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/members": { "get": { "operationId": "get_us_congress_trades_members", "summary": "Us Congress Trades Members", "description": "Us Congress Trades members. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "party", "in": "query", "required": false, "example": "democrat", "schema": { "type": "string", "enum": [ "democrat", "republican" ] } }, { "name": "state", "in": "query", "required": false, "example": "ca", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/politician": { "get": { "operationId": "get_us_congress_trades_politician", "summary": "Us Congress Trades Politician", "description": "Us Congress Trades politician. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "Pelosi", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/politician/trades": { "get": { "operationId": "get_us_congress_trades_politician_trades", "summary": "Us Congress Trades Politician Trades", "description": "Us Congress Trades politician trades. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "handle", "in": "query", "required": true, "example": "Pelosi", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pub_date", "tx_date", "value", "reporting_gap" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/ticker": { "get": { "operationId": "get_us_congress_trades_ticker", "summary": "Us Congress Trades Ticker", "description": "Us Congress Trades ticker. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "AAPL", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/ticker/trades": { "get": { "operationId": "get_us_congress_trades_ticker_trades", "summary": "Us Congress Trades Ticker Trades", "description": "Us Congress Trades ticker trades. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "keyword", "in": "query", "required": true, "example": "NVDA", "schema": { "type": "string" } }, { "name": "chamber", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "senate", "house" ] } }, { "name": "party", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "democrat", "republican" ] } }, { "name": "tx_type", "in": "query", "required": false, "example": "buy", "schema": { "type": "string", "enum": [ "buy", "sell", "exchange" ] } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/state/trades": { "get": { "operationId": "get_us_congress_trades_state_trades", "summary": "Us Congress Trades State Trades", "description": "Us Congress Trades state trades. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "state", "in": "query", "required": true, "example": "ca", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats": { "get": { "operationId": "get_us_congress_trades_stats", "summary": "Us Congress Trades Stats", "description": "Us Congress Trades stats. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/party": { "get": { "operationId": "get_us_congress_trades_stats_party", "summary": "Us Congress Trades Stats Party", "description": "Us Congress Trades stats party. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/sectors": { "get": { "operationId": "get_us_congress_trades_stats_sectors", "summary": "Us Congress Trades Stats Sectors", "description": "Us Congress Trades stats sectors. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/issuers": { "get": { "operationId": "get_us_congress_trades_stats_issuers", "summary": "Us Congress Trades Stats Issuers", "description": "Us Congress Trades stats issuers. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "limit", "in": "query", "required": false, "example": 10, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/politicians": { "get": { "operationId": "get_us_congress_trades_stats_politicians", "summary": "Us Congress Trades Stats Politicians", "description": "Us Congress Trades stats politicians. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "limit", "in": "query", "required": false, "example": 10, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/tickers": { "get": { "operationId": "get_us_congress_trades_stats_tickers", "summary": "Us Congress Trades Stats Tickers", "description": "Us Congress Trades stats tickers. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "tx_type", "in": "query", "required": false, "example": "buy", "schema": { "type": "string", "enum": [ "buy", "sell" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/volume": { "get": { "operationId": "get_us_congress_trades_stats_volume", "summary": "Us Congress Trades Stats Volume", "description": "Us Congress Trades stats volume. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "days", "in": "query", "required": false, "example": 90, "schema": { "type": "integer", "minimum": 7, "maximum": 3650 } }, { "name": "period", "in": "query", "required": false, "example": "week", "schema": { "type": "string", "enum": [ "day", "week", "month" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/unusual": { "get": { "operationId": "get_us_congress_trades_stats_unusual", "summary": "Us Congress Trades Stats Unusual", "description": "Us Congress Trades stats unusual. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "days", "in": "query", "required": false, "example": 30, "schema": { "type": "integer", "minimum": 1, "maximum": 365 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/buy-sell": { "get": { "operationId": "get_us_congress_trades_stats_buy_sell", "summary": "Us Congress Trades Stats Buy Sell", "description": "Us Congress Trades stats buy sell. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "days", "in": "query", "required": false, "example": 90, "schema": { "type": "integer", "minimum": 1, "maximum": 3650 } }, { "name": "party", "in": "query", "required": false, "example": "democrat", "schema": { "type": "string", "enum": [ "democrat", "republican" ] } }, { "name": "sector", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/us_congress_trades/stats/reporting-gaps": { "get": { "operationId": "get_us_congress_trades_stats_reporting_gaps", "summary": "Us Congress Trades Stats Reporting Gaps", "description": "Us Congress Trades stats reporting gaps. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "chamber", "in": "query", "required": false, "example": "senate", "schema": { "type": "string", "enum": [ "senate", "house" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Us Congress Trades" ] } }, "/producthunt/launches": { "get": { "operationId": "get_producthunt_launches", "summary": "Product Hunt Launches", "description": "Producthunt launches. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "topic", "in": "query", "required": false, "example": "artificial-intelligence", "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Product Hunt" ] } }, "/xiaohongshu/search": { "get": { "operationId": "get_xiaohongshu_search", "summary": "Xiaohongshu Search", "description": "Xiaohongshu search. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "query", "in": "query", "required": true, "example": "护肤", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "latest", "most_liked", "most_commented", "most_collected" ] } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "image", "video" ] } }, { "name": "published", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "day", "week", "half_year" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Xiaohongshu" ] } }, "/xiaohongshu/trending": { "get": { "operationId": "get_xiaohongshu_trending", "summary": "Xiaohongshu Trending", "description": "Xiaohongshu trending. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Xiaohongshu" ] } }, "/xiaohongshu/profile": { "get": { "operationId": "get_xiaohongshu_profile", "summary": "Xiaohongshu Profile", "description": "Xiaohongshu profile. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.xiaohongshu.com/user/profile/6a59f257000000000f03b000", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "id" ] ], "tags": [ "Xiaohongshu" ] } }, "/xiaohongshu/profile/posts": { "get": { "operationId": "get_xiaohongshu_profile_posts", "summary": "Xiaohongshu Profile Posts", "description": "Xiaohongshu profile posts. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": false, "example": "https://www.xiaohongshu.com/user/profile/6a59f257000000000f03b000", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "url", "id" ] ], "tags": [ "Xiaohongshu" ] } }, "/xiaohongshu/post": { "get": { "operationId": "get_xiaohongshu_post", "summary": "Xiaohongshu Post", "description": "Xiaohongshu post. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.xiaohongshu.com/explore/6aac8143000000002a007389", "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Xiaohongshu" ] } }, "/xiaohongshu/post/comments": { "get": { "operationId": "get_xiaohongshu_post_comments", "summary": "Xiaohongshu Post Comments", "description": "Xiaohongshu post comments. Availability depends on the configured provider route.", "x-credit-cost": 5, "x-launch-status": "beta", "parameters": [ { "name": "url", "in": "query", "required": true, "example": "https://www.xiaohongshu.com/explore/6aac8143000000002a007389", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "relevance", "latest", "most_liked" ] } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Xiaohongshu" ] } }, "/economy/consumer-spend": { "get": { "operationId": "get_economy_consumer_spend", "summary": "Economy Consumer Spend", "description": "Economy consumer spend. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "country_code", "in": "query", "required": true, "example": "DE,FR", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "example": "transport,food", "schema": { "type": "string" } }, { "name": "from_year", "in": "query", "required": false, "example": 2020, "schema": { "type": "integer", "minimum": 1990, "maximum": 2100 } }, { "name": "to_year", "in": "query", "required": false, "example": 2024, "schema": { "type": "integer", "minimum": 1990, "maximum": 2100 } }, { "name": "unit", "in": "query", "required": false, "example": "eur_millions", "schema": { "type": "string", "enum": [ "eur_millions", "eur_per_capita", "share_of_total" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Economy" ] } }, "/economy/tourism-spend": { "get": { "operationId": "get_economy_tourism_spend", "summary": "Economy Tourism Spend", "description": "Economy tourism spend. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "country_code", "in": "query", "required": true, "example": "DE,FR", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "example": "total,accommodation,transport", "schema": { "type": "string" } }, { "name": "purpose", "in": "query", "required": false, "example": "business", "schema": { "type": "string", "enum": [ "total", "personal", "business" ] } }, { "name": "destination", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "world", "domestic", "foreign" ] } }, { "name": "measure", "in": "query", "required": false, "example": "total", "schema": { "type": "string", "enum": [ "total", "per_trip", "per_night" ] } }, { "name": "from_year", "in": "query", "required": false, "example": 2022, "schema": { "type": "integer", "minimum": 1990, "maximum": 2100 } }, { "name": "to_year", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1990, "maximum": 2100 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Economy" ] } }, "/economy/government-spend": { "get": { "operationId": "get_economy_government_spend", "summary": "Economy Government Spend", "description": "Economy government spend. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "naics", "in": "query", "required": false, "example": "4811", "schema": { "type": "string" } }, { "name": "psc", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_date", "in": "query", "required": false, "example": "2024-10-01", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "required": false, "example": "2025-09-30", "schema": { "type": "string" } }, { "name": "geo", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "state", "county", "country" ] } }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "place_of_performance", "recipient_location" ] } }, { "name": "award_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "contracts", "grants", "all" ] } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Economy" ] } }, "/economy/government-contracts": { "get": { "operationId": "get_economy_government_contracts", "summary": "Economy Government Contracts", "description": "Economy government contracts. Availability depends on the configured provider route.", "x-credit-cost": 1, "x-launch-status": "beta", "parameters": [ { "name": "recipient", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "naics", "in": "query", "required": false, "example": "4811", "schema": { "type": "string" } }, { "name": "psc", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "example": "purchase_order", "schema": { "type": "string", "enum": [ "purchase_order", "delivery_order", "definitive_contract", "bpa_call", "all" ] } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "amount", "start_date", "end_date", "recipient" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "limit", "in": "query", "required": false, "example": 10, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "x-one-of-parameters": [ [ "recipient", "keyword", "naics", "psc" ] ], "tags": [ "Economy" ] } }, "/economy/imports": { "get": { "operationId": "get_economy_imports", "summary": "Economy Imports", "description": "Economy imports. Availability depends on the configured provider route.", "x-credit-cost": 20, "x-launch-status": "beta", "parameters": [ { "name": "company", "in": "query", "required": true, "example": "Nike", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "example": 10, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "Cache-Control", "in": "header", "required": false, "example": "no-cache", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "example": "7a5e1b4c-2d8f-4a3b-9c1e-6e8b4d2a1f3c", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "402": { "$ref": "#/components/responses/Error402" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "405": { "$ref": "#/components/responses/Error405" }, "409": { "$ref": "#/components/responses/Error409" }, "422": { "$ref": "#/components/responses/Error422" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" }, "502": { "$ref": "#/components/responses/Error502" }, "503": { "$ref": "#/components/responses/Error503" }, "504": { "$ref": "#/components/responses/Error504" } }, "tags": [ "Economy" ] } } } }