{ "service": "unifapi", "displayName": "UnifAPI", "categories": [ "AI", "Data", "Location" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Key", "placeholder": "UNIFAPI_API_KEY", "description": "UnifAPI API key used with the Authorization: Bearer header. Sign in and create an API key in the UnifAPI dashboard: https://api.unifapi.com/sign-in." } ], "homepageUrl": "https://unifapi.com", "actions": [ { "id": "unifapi.aggregate_geo_mentions", "service": "unifapi", "name": "aggregate_geo_mentions", "description": "Aggregate LLM mention metrics by dimension.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 63, "description": "Target domain (no protocol/www). Provide domain or keyword." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Target keyword. Provide domain or keyword." }, "filter": { "type": "string", "enum": [ "include", "exclude" ], "description": "Whether to include or exclude matches for this entity. Defaults to include." }, "scope": { "type": "array", "items": { "type": "string", "description": "One item in the array." }, "description": "Where to look. Domain scopes: any, sources, search_results. Keyword scopes: any, question, answer, brand_entities, fan_out_queries." }, "match": { "type": "string", "enum": [ "word", "partial" ], "description": "Keyword match type. word = full-term match; partial = substring. Defaults to word." }, "include_subdomains": { "type": "boolean", "description": "Include subdomains of the target domain. Defaults to false." } }, "description": "One item in the array." }, "minItems": 1, "maxItems": 10, "description": "Up to 10 target entities, each a domain or a keyword." }, "engine": { "allOf": [ { "type": "string", "enum": [ "chatgpt", "google" ], "description": "The engine value." }, { "description": "AI platform to query. `google` covers Google AI Overviews; `chatgpt` covers ChatGPT (United States + English only). Defaults to google." } ], "description": "The engine value." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the raw mentions dataset before it is aggregated. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: ai_search_volume (monthly AI search volume); mentions (number of mentions); platform (LLM engine, e.g. chat_gpt, google); location (location name); language (language name); sources_domain (cited source domain); search_results_domain (domain in the engine's search results); brand_entities_title (brand entity title); brand_entities_category (brand entity category). Example: {\"field\":\"ai_search_volume\",\"op\":\">\",\"value\":1000}" }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 20, "description": "Max elements per internal grouped array (source/search-result domains). Default 10." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Aggregate LLM mention metrics by dimension.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.batch_get_tiktok_videos", "service": "unifapi", "name": "batch_get_tiktok_videos", "description": "Batch-fetch TikTok videos by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "pattern": "^\\d+$", "description": "One item in the array." }, "minItems": 1, "maxItems": 20, "description": "Up to 20 numeric TikTok video ids" } }, "additionalProperties": false, "description": "The input payload for Batch-fetch TikTok videos by ID.", "required": [ "ids" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.browse_instagram_explore", "service": "unifapi", "name": "browse_instagram_explore", "description": "Browse Instagram's Explore feed.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for Browse Instagram's Explore feed." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.browse_instagram_recommended_reels", "service": "unifapi", "name": "browse_instagram_recommended_reels", "description": "Browse Instagram's recommended Reels feed.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for Browse Instagram's recommended Reels feed." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.browse_reddit_feed_home", "service": "unifapi", "name": "browse_reddit_feed_home", "description": "Browse Reddit's anonymous home feed.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for Browse Reddit's anonymous home feed." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.browse_reddit_feed_news", "service": "unifapi", "name": "browse_reddit_feed_news", "description": "Browse Reddit's news feed.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for Browse Reddit's news feed." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.browse_reddit_feed_popular", "service": "unifapi", "name": "browse_reddit_feed_popular", "description": "Browse Reddit's popular feed.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for Browse Reddit's popular feed." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.browse_youtube_trending", "service": "unifapi", "name": "browse_youtube_trending", "description": "Browse YouTube's trending videos.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Optional ISO 3166 country code, e.g. `US` (default), `GB`." }, "type": { "type": "string", "enum": [ "now", "music", "gaming", "movies" ], "description": "Optional trending section (default `now`)." }, "language_code": { "type": "string", "description": "Optional language code, e.g. `en`." } }, "additionalProperties": false, "description": "The input payload for Browse YouTube's trending videos." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.capture_screenshot", "service": "unifapi", "name": "capture_screenshot", "description": "Capture a page screenshot.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "description": "Absolute http(s) URL of the page to render." }, "wait_until": { "type": "string", "enum": [ "load", "domcontentloaded", "networkidle0", "networkidle2" ], "description": "When navigation is considered complete. `networkidle0` waits for the network to go idle (best for JavaScript-heavy pages); `load` is fastest." }, "timeout_ms": { "type": "integer", "minimum": 1000, "maximum": 60000, "description": "Navigation timeout in milliseconds (1000-60000)." }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 1, "maximum": 3840, "description": "Viewport width in CSS pixels." }, "height": { "type": "integer", "minimum": 1, "maximum": 3840, "description": "Viewport height in CSS pixels." } }, "required": [ "width", "height" ], "description": "Browser viewport. Defaults to a standard desktop size." }, "full_page": { "type": "boolean", "description": "Capture the full scrollable page instead of just the viewport." }, "format": { "type": "string", "enum": [ "png", "jpeg", "webp" ], "default": "png", "description": "Output image format." }, "quality": { "type": "integer", "minimum": 0, "maximum": 100, "description": "Compression quality (0-100). Only valid for `jpeg` and `webp`." }, "selector": { "type": "string", "description": "Capture only the first element matching this CSS selector." }, "omit_background": { "type": "boolean", "description": "Render a transparent background (ignored for `jpeg`)." } }, "additionalProperties": false, "description": "The input payload for Capture a page screenshot.", "required": [ "url" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.check_x_friendship", "service": "unifapi", "name": "check_x_friendship", "description": "Check whether one X user follows another.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "source_id": { "type": "string", "description": "The source_id value." }, "target_id": { "type": "string", "description": "The target_id value." }, "source_screen_name": { "type": "string", "description": "The source_screen_name value." }, "target_screen_name": { "type": "string", "description": "The target_screen_name value." } }, "additionalProperties": false, "description": "The input payload for Check whether one X user follows another." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.classify_seo_keyword_intent", "service": "unifapi", "name": "classify_seo_keyword_intent", "description": "Classify keyword search intent.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Keywords to classify (1-1000). Returns the search intent for each." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." } }, "additionalProperties": false, "description": "The input payload for Classify keyword search intent.", "required": [ "keywords" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.collect_seo_keyword_autocomplete", "service": "unifapi", "name": "collect_seo_keyword_autocomplete", "description": "Collect autocomplete keyword suggestions.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Seed query typed into Google search. Returns the autocomplete suggestions Google offers." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "cursor_pointer": { "type": "integer", "minimum": 0, "maximum": 700, "description": "Cursor position within the keyword. Defaults to the end of the keyword, matching how Google expands suggestions as you type." }, "client": { "type": "string", "minLength": 1, "maxLength": 80, "description": "Autocomplete client to emulate, such as chrome or gws-wiz. Different clients can return different suggestion sets." } }, "additionalProperties": false, "description": "The input payload for Collect autocomplete keyword suggestions.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.collect_seo_serp", "service": "unifapi", "name": "collect_seo_serp", "description": "Collect organic SERP SEO evidence.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query to inspect." }, "target": { "type": "string", "minLength": 1, "description": "Optional domain or URL to mark in the results, such as example.com or https://example.com/page." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "device": { "type": "string", "enum": [ "desktop", "mobile" ], "description": "SERP device type. Defaults to desktop." }, "os": { "allOf": [ { "type": "string", "enum": [ "windows", "macos", "android", "ios" ], "description": "The os value." }, { "description": "Optional device operating system. Use windows/macos with desktop or android/ios with mobile." } ], "description": "The os value." }, "page": { "type": "integer", "minimum": 1, "maximum": 20, "description": "1-based Google result page to start from. Defaults to 1. Implemented with Google's start parameter and ranks are adjusted to global SERP positions." }, "depth": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Organic result depth to crawl from the requested page. Defaults to 10. DataForSEO bills source in 10-result pages; UnifAPI bills returned billable organic records." }, "limit": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Number of organic results to return, matching the limit parameter used across other UnifAPI endpoints. Maps to DataForSEO depth and is used only when depth is omitted; defaults to 10." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean rank evidence, standard omits raw extras, full includes raw rich SERP context. Defaults to standard." } ], "description": "The view value." }, "include_ai_overview": { "type": "boolean", "description": "When true, ask DataForSEO to load asynchronous Google AI Overview blocks in the organic SERP when available. This can add source cost." }, "people_also_ask_depth": { "type": "integer", "minimum": 1, "maximum": 4, "description": "Optional click depth for People Also Ask expansion. Useful for SEO content-gap research and can add source cost." }, "include_pixel_rankings": { "type": "boolean", "description": "When true, request pixel rectangle data for above-the-fold and visual rank analysis. This can add source cost." }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 240, "maximum": 9999, "description": "Browser viewport width for pixel ranking calculations." }, "height": { "type": "integer", "minimum": 240, "maximum": 9999, "description": "Browser viewport height for pixel ranking calculations." }, "pixel_ratio": { "type": "number", "minimum": 0.5, "maximum": 3, "description": "Browser device pixel ratio for pixel ranking calculations." } }, "description": "Viewport settings used only with include_pixel_rankings." }, "google_domain": { "type": "string", "minLength": 4, "maxLength": 80, "description": "Optional Google domain override such as google.co.uk or google.de." }, "google_search_params": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Advanced Google search URL parameters such as nfpr=1. Prefer typed fields like page and include_omitted_results when available." }, "include_omitted_results": { "type": "boolean", "description": "When true, adds filter=0 to inspect Google results that may otherwise be omitted. Useful for deep rank checks." }, "remove_url_params": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80, "description": "One item in the array." }, "maxItems": 10, "description": "URL query parameters to remove from result URLs before matching, such as srsltid." }, "expand_related_results": { "type": "boolean", "description": "When true, return related/sitelink-style organic results as separate organic elements instead of nesting them." }, "stop_at_target": { "type": "boolean", "description": "When true and target is provided, stop crawling once the target is found. Useful for cheaper deep-rank checks, but later competitors may be omitted." }, "target_match": { "type": "string", "enum": [ "domain", "with_subdomains", "wildcard" ], "description": "How stop_at_target should match the target. Defaults to with_subdomains." }, "target_search_mode": { "type": "string", "enum": [ "any", "all" ], "description": "When stop_at_target is true and multiple targets are used source, controls whether any or all targets stop the crawl. Defaults to any." }, "target_element_types": { "type": "array", "items": { "type": "string", "enum": [ "organic", "paid", "local_pack", "featured_snippet", "events", "google_flights", "images", "jobs", "knowledge_graph", "local_service", "map", "scholarly_articles", "third_party_reviews", "twitter" ], "description": "One item in the array." }, "maxItems": 8, "description": "SERP element types to inspect for stop_at_target matches. Defaults to all first-level URL/domain elements." } }, "additionalProperties": false, "description": "The input payload for Collect organic SERP SEO evidence.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.compare_geo_mention_groups", "service": "unifapi", "name": "compare_geo_mention_groups", "description": "Compare LLM mentions across labeled groups.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 250, "description": "Aggregation label that groups and identifies this target set in the response." }, "target": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 63, "description": "Target domain (no protocol/www). Provide domain or keyword." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Target keyword. Provide domain or keyword." }, "filter": { "type": "string", "enum": [ "include", "exclude" ], "description": "Whether to include or exclude matches for this entity. Defaults to include." }, "scope": { "type": "array", "items": { "type": "string", "description": "One item in the array." }, "description": "Where to look. Domain scopes: any, sources, search_results. Keyword scopes: any, question, answer, brand_entities, fan_out_queries." }, "match": { "type": "string", "enum": [ "word", "partial" ], "description": "Keyword match type. word = full-term match; partial = substring. Defaults to word." }, "include_subdomains": { "type": "boolean", "description": "Include subdomains of the target domain. Defaults to false." } }, "description": "One item in the array." }, "minItems": 1, "maxItems": 10, "description": "Up to 10 target entities, each a domain or a keyword." } }, "required": [ "label", "target" ], "description": "One item in the array." }, "minItems": 1, "maxItems": 10, "description": "Labeled target groups to compare against each other." }, "engine": { "allOf": [ { "type": "string", "enum": [ "chatgpt", "google" ], "description": "The engine value." }, { "description": "AI platform to query. `google` covers Google AI Overviews; `chatgpt` covers ChatGPT (United States + English only). Defaults to google." } ], "description": "The engine value." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the raw mentions dataset before it is aggregated. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: ai_search_volume (monthly AI search volume); mentions (number of mentions); platform (LLM engine, e.g. chat_gpt, google); location (location name); language (language name); sources_domain (cited source domain); search_results_domain (domain in the engine's search results); brand_entities_title (brand entity title); brand_entities_category (brand entity category). Example: {\"field\":\"ai_search_volume\",\"op\":\">\",\"value\":1000}" }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Max elements per internal grouped array. Default 5." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Compare LLM mentions across labeled groups.", "required": [ "groups" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.convert_instagram_media_id", "service": "unifapi", "name": "convert_instagram_media_id", "description": "Convert an Instagram post shortcode into its numeric media_id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "shortcode": { "type": "string", "minLength": 1, "description": "The shortcode value." } }, "additionalProperties": false, "description": "The input payload for Convert an Instagram post shortcode into its numeric media_id.", "required": [ "shortcode" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.convert_instagram_shortcode_from_media", "service": "unifapi", "name": "convert_instagram_shortcode_from_media", "description": "Convert an Instagram numeric media_id into its shortcode.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "media_id": { "type": "string", "minLength": 1, "description": "The media_id value." } }, "additionalProperties": false, "description": "The input payload for Convert an Instagram numeric media_id into its shortcode.", "required": [ "media_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.convert_instagram_user_id", "service": "unifapi", "name": "convert_instagram_user_id", "description": "Convert an Instagram username into its numeric user_id (pk).", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for Convert an Instagram username into its numeric user_id (pk).", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.count_seo_bulk_backlinks", "service": "unifapi", "name": "count_seo_bulk_backlinks", "description": "Count backlinks for many targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains, subdomains, or pages to analyze (up to 1000). Domains/subdomains without https:// and www.; pages as absolute URLs." } }, "additionalProperties": false, "description": "The input payload for Count backlinks for many targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.count_seo_bulk_new_lost_backlinks", "service": "unifapi", "name": "count_seo_bulk_new_lost_backlinks", "description": "Count new and lost backlinks for many targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains, subdomains, or pages to analyze (up to 1000). Domains/subdomains without https:// and www.; pages as absolute URLs." }, "date_from": { "type": "string", "description": "Start date (yyyy-mm-dd) for counting new and lost backlinks. Minimum 2019-01-30; defaults to one month ago." } }, "additionalProperties": false, "description": "The input payload for Count new and lost backlinks for many targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.count_seo_bulk_new_lost_referring_domains", "service": "unifapi", "name": "count_seo_bulk_new_lost_referring_domains", "description": "Count new and lost referring domains for many targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains, subdomains, or pages to analyze (up to 1000). Domains/subdomains without https:// and www.; pages as absolute URLs." }, "date_from": { "type": "string", "description": "Start date (yyyy-mm-dd) for counting new and lost referring domains. Minimum 2019-01-30; defaults to one month ago." } }, "additionalProperties": false, "description": "The input payload for Count new and lost referring domains for many targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.count_seo_bulk_referring_domains", "service": "unifapi", "name": "count_seo_bulk_referring_domains", "description": "Count referring domains for many targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains, subdomains, or pages to analyze (up to 1000). Domains/subdomains without https:// and www.; pages as absolute URLs." } }, "additionalProperties": false, "description": "The input payload for Count referring domains for many targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.discover_seo_keyword_ideas", "service": "unifapi", "name": "discover_seo_keyword_ideas", "description": "Discover keyword ideas.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80, "description": "One item in the array." }, "minItems": 1, "maxItems": 200, "description": "Seed keywords (1-200). Returns search terms relevant to the product or service categories of these keywords." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of keyword ideas to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of keyword ideas to skip from the start of the results." }, "offset_token": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Pagination token from a previous response. When set, all other params except limit are ignored." }, "closely_variants": { "type": "boolean", "description": "When true, use phrase-match search; when false (default), use broad-match search for wider ideas." }, "ignore_synonyms": { "type": "boolean", "description": "When true, exclude highly similar keywords and return only core keywords." }, "include_serp_info": { "type": "boolean", "description": "When true, include SERP data (result count and SERP feature types) for each keyword. Can add source cost." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to standard." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Discover keyword ideas.", "required": [ "keywords" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.estimate_seo_bulk_traffic", "service": "unifapi", "name": "estimate_seo_bulk_traffic", "description": "Estimate organic traffic for domains.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains to estimate traffic for (1-1000)." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps headline traffic and top positions, full adds the complete position breakdown. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Estimate organic traffic for domains.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.estimate_seo_historical_bulk_traffic", "service": "unifapi", "name": "estimate_seo_historical_bulk_traffic", "description": "Estimate historical traffic for domains.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains to estimate historical traffic for (1-1000)." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "date_from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Start of the history window. Date in yyyy-mm-dd format. Minimum date: 2019-01-01." }, "date_to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "End of the history window. Date in yyyy-mm-dd format. Minimum date: 2019-01-01." } }, "additionalProperties": false, "description": "The input payload for Estimate historical traffic for domains.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.extract_instagram_shortcode", "service": "unifapi", "name": "extract_instagram_shortcode", "description": "Extract a post shortcode from an Instagram URL.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "The url value." } }, "additionalProperties": false, "description": "The input payload for Extract a post shortcode from an Instagram URL.", "required": [ "url" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.extract_links", "service": "unifapi", "name": "extract_links", "description": "Extract links from a page.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "description": "Absolute http(s) URL of the page to render." }, "wait_until": { "type": "string", "enum": [ "load", "domcontentloaded", "networkidle0", "networkidle2" ], "description": "When navigation is considered complete. `networkidle0` waits for the network to go idle (best for JavaScript-heavy pages); `load` is fastest." }, "timeout_ms": { "type": "integer", "minimum": 1000, "maximum": 60000, "description": "Navigation timeout in milliseconds (1000-60000)." }, "visible_links_only": { "type": "boolean", "description": "Only return links visible in the rendered viewport." }, "exclude_external_links": { "type": "boolean", "description": "Drop links that point to a different domain than the page." } }, "additionalProperties": false, "description": "The input payload for Extract links from a page.", "required": [ "url" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_backlink_competitors", "service": "unifapi", "name": "find_seo_backlink_competitors", "description": "Find competitors by shared referring domains.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "main_domain": { "type": "boolean", "description": "Treat the target and competitors as root domains rather than exact subdomains." }, "exclude_large_domains": { "type": "boolean", "description": "Exclude very large generic domains (e.g. youtube.com, facebook.com) from results." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the returned competitors. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: rank (backlink rank of the competing domain, 0-1000); intersections (referring domains shared with the target). Example: {\"field\":\"intersections\",\"op\":\">\",\"value\":20}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the returned competitors. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: rank, intersections." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Find competitors by shared referring domains.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_backlink_domain_intersection", "service": "unifapi", "name": "find_seo_backlink_domain_intersection", "description": "Find domains linking to multiple targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 20, "description": "Domains, subdomains, or pages to find common referring domains for (1-20). Order is preserved as the 1-based index in the response." }, "exclude_targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "maxItems": 10, "description": "Domains, subdomains, or pages to exclude (up to 10). Domains linking to these are dropped." }, "intersection_mode": { "type": "string", "enum": [ "all", "partial" ], "description": "all (default) returns domains linking to any target; partial returns only domains linking to every target." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the intersecting domains. Prefix each metric field with the 1-based target index, e.g. 1.rank, 2.referring_domains. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: rank (backlink rank, 0-1000); backlinks (number of backlinks); backlinks_spam_score (average spam score, 0-100); referring_domains (referring domains count); referring_main_domains (referring root domains count); referring_pages (referring pages count); referring_ips (referring IPs count); referring_subnets (referring subnets count); broken_backlinks (backlinks to broken pages); broken_pages (broken pages still receiving backlinks); first_seen (ISO date the first backlink was found); lost_date (ISO date the last backlink was lost). Example: {\"and\":[{\"field\":\"1.rank\",\"op\":\">\",\"value\":300},{\"field\":\"2.rank\",\"op\":\">\",\"value\":300}]}" }, "backlinks_filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the underlying individual backlinks before the aggregate metrics are computed. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {\"and\":[{\"field\":\"dofollow\",\"op\":\"=\",\"value\":true},{\"field\":\"backlink_spam_score\",\"op\":\"<\",\"value\":10}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the intersecting domains. Prefix each field with the 1-based target index, e.g. 1.rank. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: rank, backlinks, backlinks_spam_score, referring_domains, referring_main_domains, referring_pages, referring_ips, referring_subnets, broken_backlinks, broken_pages, first_seen, lost_date." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Find domains linking to multiple targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_backlink_page_intersection", "service": "unifapi", "name": "find_seo_backlink_page_intersection", "description": "Find pages linking to multiple targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 20, "description": "Domains, subdomains, or pages to find common referring pages for (1-20). Order is preserved as the 1-based index in the response." }, "exclude_targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "maxItems": 10, "description": "Domains, subdomains, or pages to exclude (up to 10). Pages linking to these are dropped." }, "intersection_mode": { "type": "string", "enum": [ "all", "partial" ], "description": "all (default) returns pages linking to any target; partial returns only pages linking to every target." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the intersecting referring pages. Prefix each backlink field with the 1-based target index, e.g. 1.dofollow, 2.rank. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {\"field\":\"1.dofollow\",\"op\":\"=\",\"value\":true}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the intersecting referring pages. Prefix each field with the 1-based target index, e.g. 1.rank. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: dofollow, is_new, is_lost, is_broken, rank, page_from_rank, domain_from_rank, backlink_spam_score, item_type, anchor, tld_from, semantic_location, first_seen, last_seen." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls backlink detail. summary keeps link identity and headline rank/anchor data; full adds referring-page details and link attributes. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Find pages linking to multiple targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_domain_competitors", "service": "unifapi", "name": "find_seo_domain_competitors", "description": "Find a domain's organic competitors.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Target domain, such as example.com or https://example.com. Specified without www." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "exclude_top_domains": { "type": "boolean", "description": "When true, exclude the largest global domains (e.g. wikipedia, amazon) from results." }, "intersecting_domains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253, "description": "One item in the array." }, "maxItems": 20, "description": "Restrict results to competitors that also share keywords with these domains." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of competing domains to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of domains to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps headline traffic and top positions, full adds the complete position breakdown and full-domain metrics. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Find a domain's organic competitors.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_domain_keyword_intersection", "service": "unifapi", "name": "find_seo_domain_keyword_intersection", "description": "Find keywords two domains both rank for.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target1": { "type": "string", "minLength": 1, "maxLength": 253, "description": "First domain, such as example.com." }, "target2": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Second domain to compare against." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "intersections": { "type": "boolean", "description": "When true (default), return keywords both domains rank for. When false, return keywords the first domain ranks for but the second does not." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of keywords to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of keywords to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls keyword detail. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Find keywords two domains both rank for.", "required": [ "target1", "target2" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_keyword_suggestions", "service": "unifapi", "name": "find_seo_keyword_suggestions", "description": "Find keyword suggestions.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "maxLength": 80, "description": "Seed keyword. Returns long-tail search queries that include this keyword." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of keyword suggestions to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of keyword suggestions to skip from the start of the results." }, "offset_token": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Pagination token from a previous response. When set, all other params except limit are ignored." }, "exact_match": { "type": "boolean", "description": "When true, return only suggestions that contain the exact seed keyword in the same word order." }, "ignore_synonyms": { "type": "boolean", "description": "When true, exclude highly similar keywords and return only core keywords." }, "include_serp_info": { "type": "boolean", "description": "When true, include SERP data (result count and SERP feature types) for each keyword. Can add source cost." }, "include_seed_keyword": { "type": "boolean", "description": "When true, include metrics for the seed keyword in the response." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to standard." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Find keyword suggestions.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_page_keyword_intersection", "service": "unifapi", "name": "find_seo_page_keyword_intersection", "description": "Find keywords specific pages rank for.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 20, "description": "Absolute page URLs to compare (1-20). A trailing /* wildcard matches a page and its sub-paths." }, "exclude_pages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "maxItems": 10, "description": "Page URLs to exclude (up to 10). Keywords where these rank are dropped." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "intersection_mode": { "type": "string", "enum": [ "union", "intersect" ], "description": "union (default) returns keywords any page ranks for; intersect returns only keywords all pages rank for in the same SERP." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of keywords to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of keywords to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls keyword detail. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Find keywords specific pages rank for.", "required": [ "pages" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_ranked_keywords", "service": "unifapi", "name": "find_seo_ranked_keywords", "description": "Find the keywords a domain ranks for.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Target domain, such as example.com or https://example.com. Specified without www. A page URL can also be passed to get only that page's rankings." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of ranked keywords to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of keywords to skip from the start of the results." }, "ignore_synonyms": { "type": "boolean", "description": "When true, exclude highly similar keyword variations from the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls keyword detail. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Find the keywords a domain ranks for.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_related_keywords", "service": "unifapi", "name": "find_seo_related_keywords", "description": "Find related keywords.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "maxLength": 80, "description": "Seed keyword. Returns keywords from Google's 'searches related to' element." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "depth": { "type": "integer", "minimum": 0, "maximum": 4, "description": "Keyword search depth, 0-4. Higher depth returns more keywords (1about 8, 2about 72, 3about 584, 4about 4680). Defaults to 1." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of related keywords to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of related keywords to skip from the start of the results." }, "ignore_synonyms": { "type": "boolean", "description": "When true, exclude highly similar keywords and return only core keywords." }, "include_serp_info": { "type": "boolean", "description": "When true, include SERP data (result count and SERP feature types) for each keyword. Can add source cost." }, "include_seed_keyword": { "type": "boolean", "description": "When true, include metrics for the seed keyword in the response." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to standard." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Find related keywords.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_serp_competitors", "service": "unifapi", "name": "find_seo_serp_competitors", "description": "Find domains competing for keywords.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80, "description": "One item in the array." }, "minItems": 1, "maxItems": 200, "description": "Seed keywords (1-200). Returns the domains that rank for them." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "include_subdomains": { "type": "boolean", "description": "When true (default), count subdomain rankings toward each domain." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of competing domains to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of domains to skip from the start of the results." } }, "additionalProperties": false, "description": "The input payload for Find domains competing for keywords.", "required": [ "keywords" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.find_seo_site_keywords", "service": "unifapi", "name": "find_seo_site_keywords", "description": "Find keywords a domain ranks for.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Target domain, such as example.com or https://example.com. Returns keywords the domain is relevant for." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of keywords to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of keywords to skip from the start of the results." }, "offset_token": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Pagination token from a previous response. When set, all other params except limit are ignored." }, "include_subdomains": { "type": "boolean", "description": "When true (default), include keywords from subdomains of the target." }, "include_serp_info": { "type": "boolean", "description": "When true, include SERP data (result count and SERP feature types) for each keyword. Can add source cost." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to standard." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Find keywords a domain ranks for.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_geo_keyword_search_volume", "service": "unifapi", "name": "get_geo_keyword_search_volume", "description": "Get AI search volume for keywords.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 250, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Keywords to look up AI search volume for. Up to 1000 keywords, 250 chars each." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." } }, "additionalProperties": false, "description": "The input payload for Get AI search volume for keywords.", "required": [ "keywords" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_hacker_news_item", "service": "unifapi", "name": "get_hacker_news_item", "description": "Get Hacker News item by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "integer", "exclusiveMinimum": 0, "description": "Hacker News item id." } }, "additionalProperties": false, "description": "The input payload for Get Hacker News item by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_hacker_news_max_item", "service": "unifapi", "name": "get_hacker_news_max_item", "description": "Get largest Hacker News item ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "The input payload for Get largest Hacker News item ID." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_hacker_news_updates", "service": "unifapi", "name": "get_hacker_news_updates", "description": "Get changed Hacker News items and profiles.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "The input payload for Get changed Hacker News items and profiles." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_hacker_news_user", "service": "unifapi", "name": "get_hacker_news_user", "description": "Get Hacker News user by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Case-sensitive Hacker News username." } }, "additionalProperties": false, "description": "The input payload for Get Hacker News user by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_hotel_info", "service": "unifapi", "name": "get_hotel_info", "description": "Get Hotels detail.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "hotel_identifier": { "type": "string", "minLength": 1, "maxLength": 400, "description": "Unique hotel id returned by /hotels/search." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "check_in": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-in date. Date in YYYY-MM-DD format." }, "check_out": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-out date. Date in YYYY-MM-DD format." }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "description": "ISO 4217 currency code for prices, such as USD." }, "adults": { "type": "integer", "minimum": 1, "maximum": 30, "description": "Number of adult guests." }, "children": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 17, "description": "One item in the array." }, "maxItems": 10, "description": "Ages of children staying, used to refine availability and pricing." }, "load_prices_by_dates": { "type": "boolean", "description": "When true, return a daily price calendar across the requested date range instead of a single stay price." }, "prices_start_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Start date for the daily price calendar. Date in YYYY-MM-DD format." }, "prices_end_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "End date for the daily price calendar. Date in YYYY-MM-DD format." }, "prices_date_range": { "type": "string", "minLength": 1, "maxLength": 40, "description": "Predefined period for the daily price calendar, such as next_30_days." } }, "additionalProperties": false, "description": "The input payload for Get Hotels detail.", "required": [ "hotel_identifier" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_instagram_location", "service": "unifapi", "name": "get_instagram_location", "description": "Get an Instagram location by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Numeric Instagram location id." } }, "additionalProperties": false, "description": "The input payload for Get an Instagram location by id.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_instagram_post", "service": "unifapi", "name": "get_instagram_post", "description": "Get an Instagram post (photo / video / carousel / reel) by shortcode.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "shortcode": { "type": "string", "minLength": 1, "description": "The shortcode value." } }, "additionalProperties": false, "description": "The input payload for Get an Instagram post (photo / video / carousel / reel) by shortcode.", "required": [ "shortcode" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_instagram_user", "service": "unifapi", "name": "get_instagram_user", "description": "Get an Instagram user profile by username.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Instagram URL slug, e.g. `instagram`" } }, "additionalProperties": false, "description": "The input payload for Get an Instagram user profile by username.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_ad", "service": "unifapi", "name": "get_linkedin_ad", "description": "Get a LinkedIn Ad Library entry by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn Ad Library entry by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_company", "service": "unifapi", "name": "get_linkedin_company", "description": "Get a LinkedIn company profile by URL slug.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "LinkedIn URL slug (universal_name), e.g. `microsoft`" } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn company profile by URL slug.", "required": [ "slug" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_company_job_count", "service": "unifapi", "name": "get_linkedin_company_job_count", "description": "Get the number of active jobs at a LinkedIn company.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "The slug value." } }, "additionalProperties": false, "description": "The input payload for Get the number of active jobs at a LinkedIn company.", "required": [ "slug" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_company_member_insights", "service": "unifapi", "name": "get_linkedin_company_member_insights", "description": "Get a LinkedIn company's aggregated member insights.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "The slug value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn company's aggregated member insights.", "required": [ "slug" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_group", "service": "unifapi", "name": "get_linkedin_group", "description": "Get a LinkedIn group by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn group by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_job", "service": "unifapi", "name": "get_linkedin_job", "description": "Get a LinkedIn job posting by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." }, "include_skills": { "type": "string", "enum": [ "true", "false" ], "description": "The include_skills value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn job posting by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_post", "service": "unifapi", "name": "get_linkedin_post", "description": "Get a LinkedIn post by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn post by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_user", "service": "unifapi", "name": "get_linkedin_user", "description": "Get a LinkedIn user profile by URL slug.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "LinkedIn URL slug, e.g. `williamhgates`" } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn user profile by URL slug.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_user_about", "service": "unifapi", "name": "get_linkedin_user_about", "description": "Get a LinkedIn profile's 'about' metadata.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn profile's 'about' metadata.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_user_contact", "service": "unifapi", "name": "get_linkedin_user_contact", "description": "Get a LinkedIn user's public contact info.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn user's public contact info.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_linkedin_user_follower_count", "service": "unifapi", "name": "get_linkedin_user_follower_count", "description": "Get a LinkedIn user's follower & connection counts.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for Get a LinkedIn user's follower & connection counts.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_reddit_post", "service": "unifapi", "name": "get_reddit_post", "description": "Get a Reddit post by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Reddit post fullname, e.g. `t3_1thjm1o`." } }, "additionalProperties": false, "description": "The input payload for Get a Reddit post by id.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_reddit_subreddit", "service": "unifapi", "name": "get_reddit_subreddit", "description": "Get a Reddit subreddit by name.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Subreddit slug without `r/`, e.g. `pics`." } }, "additionalProperties": false, "description": "The input payload for Get a Reddit subreddit by name.", "required": [ "name" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_reddit_user", "service": "unifapi", "name": "get_reddit_user", "description": "Get a Reddit user profile by username.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for Get a Reddit user profile by username.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_backlink_history", "service": "unifapi", "name": "get_seo_backlink_history", "description": "Get historical backlink metrics for a target.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "date_from": { "type": "string", "description": "Start date (yyyy-mm-dd) for the history. Minimum 2019-01-30; defaults to one year ago." }, "date_to": { "type": "string", "description": "End date (yyyy-mm-dd). Defaults to today." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Get historical backlink metrics for a target.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_backlink_summary", "service": "unifapi", "name": "get_seo_backlink_summary", "description": "Get the backlink profile summary for a target.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Get the backlink profile summary for a target.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_backlink_timeseries", "service": "unifapi", "name": "get_seo_backlink_timeseries", "description": "Get backlink metrics over time.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "date_from": { "type": "string", "description": "Start date (yyyy-mm-dd) for the series. Minimum 2019-01-30; defaults to one month ago." }, "date_to": { "type": "string", "description": "End date (yyyy-mm-dd). Defaults to today." }, "group_range": { "type": "string", "enum": [ "day", "week", "month", "year" ], "description": "Granularity used to group the series. Defaults to month." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." } }, "additionalProperties": false, "description": "The input payload for Get backlink metrics over time.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_bulk_backlink_ranks", "service": "unifapi", "name": "get_seo_bulk_backlink_ranks", "description": "Get backlink ranks for many targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains, subdomains, or pages to analyze (up to 1000). Domains/subdomains without https:// and www.; pages as absolute URLs." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." } }, "additionalProperties": false, "description": "The input payload for Get backlink ranks for many targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_bulk_spam_scores", "service": "unifapi", "name": "get_seo_bulk_spam_scores", "description": "Get spam scores for many targets.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains, subdomains, or pages to analyze (up to 1000). Domains/subdomains without https:// and www.; pages as absolute URLs." } }, "additionalProperties": false, "description": "The input payload for Get spam scores for many targets.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_domain_rank_overview", "service": "unifapi", "name": "get_seo_domain_rank_overview", "description": "Get a domain's ranking and traffic overview.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Target domain, such as example.com or https://example.com. Specified without www." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. full (default) returns the complete position breakdown; summary keeps only headline traffic and top positions." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Get a domain's ranking and traffic overview.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_historical_rank_overview", "service": "unifapi", "name": "get_seo_historical_rank_overview", "description": "Get a domain's historical ranking overview.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Target domain, such as example.com or https://example.com. Specified without www." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "date_from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Start of the history window. Date in yyyy-mm-dd format. Minimum date: 2019-01-01." }, "date_to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "End of the history window. Date in yyyy-mm-dd format. Minimum date: 2019-01-01." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps headline traffic and top positions, full adds the complete position breakdown. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Get a domain's historical ranking overview.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_historical_serps", "service": "unifapi", "name": "get_seo_historical_serps", "description": "Get historical SERP snapshots for a keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Keyword to retrieve historical SERP snapshots for." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "date_from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Start of the history window. Date in yyyy-mm-dd format. Minimum date: 2019-01-01." }, "date_to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "End of the history window. Date in yyyy-mm-dd format. Minimum date: 2019-01-01." } }, "additionalProperties": false, "description": "The input payload for Get historical SERP snapshots for a keyword.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_keyword_history", "service": "unifapi", "name": "get_seo_keyword_history", "description": "Get historical keyword data.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80, "description": "One item in the array." }, "minItems": 1, "maxItems": 700, "description": "Keywords to look up (1-700). Returns historical metrics since 2019 for each." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." } }, "additionalProperties": false, "description": "The input payload for Get historical keyword data.", "required": [ "keywords" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_keyword_overview", "service": "unifapi", "name": "get_seo_keyword_overview", "description": "Look up keyword metrics.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80, "description": "One item in the array." }, "minItems": 1, "maxItems": 700, "description": "Keywords to look up (1-700). Returns current metrics for each keyword." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "include_serp_info": { "type": "boolean", "description": "When true, include SERP data (result count and SERP feature types) for each keyword. Can add source cost." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean metrics, standard adds intent/bids/SERP context, full includes monthly trend data. Defaults to standard." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Look up keyword metrics.", "required": [ "keywords" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_seo_new_lost_backlinks_timeseries", "service": "unifapi", "name": "get_seo_new_lost_backlinks_timeseries", "description": "Get new and lost backlinks over time.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "date_from": { "type": "string", "description": "Start date (yyyy-mm-dd) for the series. Minimum 2019-01-30; defaults to one month ago." }, "date_to": { "type": "string", "description": "End date (yyyy-mm-dd). Defaults to today." }, "group_range": { "type": "string", "enum": [ "day", "week", "month", "year" ], "description": "Granularity used to group the series. Defaults to month." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." } }, "additionalProperties": false, "description": "The input payload for Get new and lost backlinks over time.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_threads_user", "service": "unifapi", "name": "get_threads_user", "description": "Get a Threads user profile by username.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for Get a Threads user profile by username.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_tiktok_hashtag", "service": "unifapi", "name": "get_tiktok_hashtag", "description": "Get a TikTok hashtag by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$", "description": "The id value." } }, "additionalProperties": false, "description": "The input payload for Get a TikTok hashtag by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_tiktok_music", "service": "unifapi", "name": "get_tiktok_music", "description": "Get a TikTok music track by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$", "description": "The id value." } }, "additionalProperties": false, "description": "The input payload for Get a TikTok music track by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_tiktok_recommended_feed", "service": "unifapi", "name": "get_tiktok_recommended_feed", "description": "Get TikTok recommendation videos.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cookie": { "type": "string", "description": "The cookie value." }, "region": { "type": "string", "minLength": 2, "maxLength": 2, "default": "US", "description": "The region value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for Get TikTok recommendation videos." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_tiktok_user", "service": "unifapi", "name": "get_tiktok_user", "description": "Get a TikTok user profile.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sec_uid, numeric user id, or public handle." } }, "additionalProperties": false, "description": "The input payload for Get a TikTok user profile.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_tiktok_video", "service": "unifapi", "name": "get_tiktok_video", "description": "Get a TikTok video by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$", "description": "The id value." } }, "additionalProperties": false, "description": "The input payload for Get a TikTok video by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_autocomplete", "service": "unifapi", "name": "get_x_autocomplete", "description": "Autocomplete X users, topics, hashtags, and cashtags.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "description": "The query value." } }, "additionalProperties": false, "description": "The input payload for Autocomplete X users, topics, hashtags, and cashtags.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_community", "service": "unifapi", "name": "get_x_community", "description": "Get X Community by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "community.fields": { "type": "string", "description": "The community.fields value." } }, "additionalProperties": false, "description": "The input payload for Get X Community by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_community_about", "service": "unifapi", "name": "get_x_community_about", "description": "Get an X Community about timeline.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get an X Community about timeline.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.get_x_trends_by_woeid", "service": "unifapi", "name": "get_x_trends_by_woeid", "description": "Get X trends by WOEID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "woeid": { "type": "string", "pattern": "^\\d+$", "description": "The woeid value." }, "max_trends": { "type": "integer", "minimum": 1, "maximum": 50, "description": "The max_trends value." }, "trend.fields": { "type": "string", "description": "The trend.fields value." } }, "additionalProperties": false, "description": "The input payload for Get X trends by WOEID.", "required": [ "woeid" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.get_x_tweet", "service": "unifapi", "name": "get_x_tweet", "description": "Get X Post by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." } }, "additionalProperties": false, "description": "The input payload for Get X Post by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_tweet_article", "service": "unifapi", "name": "get_x_tweet_article", "description": "Get the article-style payload for an X Post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." } }, "additionalProperties": false, "description": "The input payload for Get the article-style payload for an X Post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_tweets", "service": "unifapi", "name": "get_x_tweets", "description": "Get X Posts by IDs.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "ids": { "type": "string", "minLength": 1, "description": "Comma-separated resource ids." } }, "additionalProperties": false, "description": "The input payload for Get X Posts by IDs.", "required": [ "ids" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_user", "service": "unifapi", "name": "get_x_user", "description": "Get X user by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." } }, "additionalProperties": false, "description": "The input payload for Get X user by ID.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_user_by_username", "service": "unifapi", "name": "get_x_user_by_username", "description": "Get X user by username.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "X handle without the leading `@`." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." } }, "additionalProperties": false, "description": "The input payload for Get X user by username.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_users", "service": "unifapi", "name": "get_x_users", "description": "Get X users by IDs.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "ids": { "type": "string", "minLength": 1, "description": "Comma-separated resource ids." } }, "additionalProperties": false, "description": "The input payload for Get X users by IDs.", "required": [ "ids" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_x_users_by_usernames", "service": "unifapi", "name": "get_x_users_by_usernames", "description": "Get X users by usernames.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "usernames": { "type": "string", "minLength": 1, "description": "Comma-separated usernames." } }, "additionalProperties": false, "description": "The input payload for Get X users by usernames.", "required": [ "usernames" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_youtube_channel", "service": "unifapi", "name": "get_youtube_channel", "description": "Get a YouTube channel by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "channel_id": { "type": "string", "minLength": 1, "description": "YouTube channel id (`UCxxx...`)." } }, "additionalProperties": false, "description": "The input payload for Get a YouTube channel by id.", "required": [ "channel_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_youtube_playlist", "service": "unifapi", "name": "get_youtube_playlist", "description": "Get a YouTube playlist by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "playlist_id": { "type": "string", "minLength": 1, "description": "YouTube playlist id (`PL...`)." } }, "additionalProperties": false, "description": "The input payload for Get a YouTube playlist by id.", "required": [ "playlist_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_youtube_video", "service": "unifapi", "name": "get_youtube_video", "description": "Get a YouTube video by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "video_id": { "type": "string", "minLength": 1, "description": "YouTube video id, e.g. `oaSNBz4qMQY`." } }, "additionalProperties": false, "description": "The input payload for Get a YouTube video by id.", "required": [ "video_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.get_youtube_video_transcript", "service": "unifapi", "name": "get_youtube_video_transcript", "description": "Get a YouTube video's transcript.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "video_id": { "type": "string", "minLength": 1, "description": "The video_id value." }, "lang": { "type": "string", "minLength": 2, "maxLength": 35, "description": "Caption language code to transcribe, e.g. `en` or `es`. Defaults to English." } }, "additionalProperties": false, "description": "The input payload for Get a YouTube video's transcript.", "required": [ "video_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_geo_top_mentioned_domains", "service": "unifapi", "name": "list_geo_top_mentioned_domains", "description": "List domains most cited in LLM answers.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 63, "description": "Target domain (no protocol/www). Provide domain or keyword." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Target keyword. Provide domain or keyword." }, "filter": { "type": "string", "enum": [ "include", "exclude" ], "description": "Whether to include or exclude matches for this entity. Defaults to include." }, "scope": { "type": "array", "items": { "type": "string", "description": "One item in the array." }, "description": "Where to look. Domain scopes: any, sources, search_results. Keyword scopes: any, question, answer, brand_entities, fan_out_queries." }, "match": { "type": "string", "enum": [ "word", "partial" ], "description": "Keyword match type. word = full-term match; partial = substring. Defaults to word." }, "include_subdomains": { "type": "boolean", "description": "Include subdomains of the target domain. Defaults to false." } }, "description": "One item in the array." }, "minItems": 1, "maxItems": 10, "description": "Up to 10 target entities, each a domain or a keyword." }, "engine": { "allOf": [ { "type": "string", "enum": [ "chatgpt", "google" ], "description": "The engine value." }, { "description": "AI platform to query. `google` covers Google AI Overviews; `chatgpt` covers ChatGPT (United States + English only). Defaults to google." } ], "description": "The engine value." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "links_scope": { "type": "string", "enum": [ "sources", "search_results" ], "description": "Which links to extract domains from. Defaults to sources." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the raw mentions dataset before it is aggregated. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: ai_search_volume (monthly AI search volume); mentions (number of mentions); platform (LLM engine, e.g. chat_gpt, google); location (location name); language (language name); sources_domain (cited source domain); search_results_domain (domain in the engine's search results); brand_entities_title (brand entity title); brand_entities_category (brand entity category). Example: {\"field\":\"ai_search_volume\",\"op\":\">\",\"value\":1000}" }, "items_list_limit": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Max number of top domains to return. Default 5." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Max elements per internal grouped array. Default 5." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for List domains most cited in LLM answers.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_geo_top_mentioned_pages", "service": "unifapi", "name": "list_geo_top_mentioned_pages", "description": "List pages most cited in LLM answers.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 63, "description": "Target domain (no protocol/www). Provide domain or keyword." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Target keyword. Provide domain or keyword." }, "filter": { "type": "string", "enum": [ "include", "exclude" ], "description": "Whether to include or exclude matches for this entity. Defaults to include." }, "scope": { "type": "array", "items": { "type": "string", "description": "One item in the array." }, "description": "Where to look. Domain scopes: any, sources, search_results. Keyword scopes: any, question, answer, brand_entities, fan_out_queries." }, "match": { "type": "string", "enum": [ "word", "partial" ], "description": "Keyword match type. word = full-term match; partial = substring. Defaults to word." }, "include_subdomains": { "type": "boolean", "description": "Include subdomains of the target domain. Defaults to false." } }, "description": "One item in the array." }, "minItems": 1, "maxItems": 10, "description": "Up to 10 target entities, each a domain or a keyword." }, "engine": { "allOf": [ { "type": "string", "enum": [ "chatgpt", "google" ], "description": "The engine value." }, { "description": "AI platform to query. `google` covers Google AI Overviews; `chatgpt` covers ChatGPT (United States + English only). Defaults to google." } ], "description": "The engine value." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "links_scope": { "type": "string", "enum": [ "sources", "search_results" ], "description": "Which links to extract pages from. Defaults to sources." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the raw mentions dataset before it is aggregated. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: ai_search_volume (monthly AI search volume); mentions (number of mentions); platform (LLM engine, e.g. chat_gpt, google); location (location name); language (language name); sources_domain (cited source domain); search_results_domain (domain in the engine's search results); brand_entities_title (brand entity title); brand_entities_category (brand entity category). Example: {\"field\":\"ai_search_volume\",\"op\":\">\",\"value\":1000}" }, "items_list_limit": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Max number of top pages to return. Default 5." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Max elements per internal grouped array. Default 5." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for List pages most cited in LLM answers.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_hacker_news_story_ids", "service": "unifapi", "name": "list_hacker_news_story_ids", "description": "List Hacker News story IDs.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "feed": { "type": "string", "enum": [ "top", "new", "best", "ask", "show", "jobs" ], "description": "Story feed: top, new, best, ask, show, or jobs." }, "cursor": { "type": "string", "description": "Zero-based offset cursor returned as `next_cursor`." }, "limit": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List Hacker News story IDs.", "required": [ "feed" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_hacker_news_story_items", "service": "unifapi", "name": "list_hacker_news_story_items", "description": "List Hacker News story items.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "feed": { "type": "string", "enum": [ "top", "new", "best", "ask", "show", "jobs" ], "description": "Story feed: top, new, best, ask, show, or jobs." }, "cursor": { "type": "string", "description": "Zero-based offset cursor returned as `next_cursor`." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List Hacker News story items.", "required": [ "feed" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_location_posts", "service": "unifapi", "name": "list_instagram_location_posts", "description": "List posts tagged with an Instagram location.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "tab": { "type": "string", "enum": [ "ranked", "recent" ], "description": "Which tab to fetch - `ranked` (top) or `recent` (latest)." } }, "additionalProperties": false, "description": "The input payload for List posts tagged with an Instagram location.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_nearby_locations", "service": "unifapi", "name": "list_instagram_nearby_locations", "description": "List Instagram locations geographically near a given location.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." } }, "additionalProperties": false, "description": "The input payload for List Instagram locations geographically near a given location.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_post_comment_replies", "service": "unifapi", "name": "list_instagram_post_comment_replies", "description": "List replies to an Instagram comment.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "shortcode": { "type": "string", "minLength": 1, "description": "The shortcode value." }, "commentId": { "type": "string", "minLength": 1, "description": "The commentId value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List replies to an Instagram comment.", "required": [ "shortcode", "commentId" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_post_comments", "service": "unifapi", "name": "list_instagram_post_comments", "description": "List comments on an Instagram post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "shortcode": { "type": "string", "minLength": 1, "description": "The shortcode value." }, "cursor": { "type": "string", "description": "The cursor value." }, "sort": { "type": "string", "enum": [ "popular", "newest" ], "description": "The sort value." } }, "additionalProperties": false, "description": "The input payload for List comments on an Instagram post.", "required": [ "shortcode" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_followers", "service": "unifapi", "name": "list_instagram_user_followers", "description": "List followers of an Instagram user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List followers of an Instagram user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_following", "service": "unifapi", "name": "list_instagram_user_following", "description": "List accounts an Instagram user follows.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List accounts an Instagram user follows.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_former_usernames", "service": "unifapi", "name": "list_instagram_user_former_usernames", "description": "List former usernames for an Instagram user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for List former usernames for an Instagram user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_highlights", "service": "unifapi", "name": "list_instagram_user_highlights", "description": "List Instagram highlight reels for a user (metadata only).", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Instagram highlight reels for a user (metadata only).", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_posts", "service": "unifapi", "name": "list_instagram_user_posts", "description": "List feed posts authored by an Instagram user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List feed posts authored by an Instagram user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_reels", "service": "unifapi", "name": "list_instagram_user_reels", "description": "List reels authored by an Instagram user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List reels authored by an Instagram user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_stories", "service": "unifapi", "name": "list_instagram_user_stories", "description": "List active Instagram stories for a user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." } }, "additionalProperties": false, "description": "The input payload for List active Instagram stories for a user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_instagram_user_tagged_posts", "service": "unifapi", "name": "list_instagram_user_tagged_posts", "description": "List posts an Instagram user is tagged in.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List posts an Instagram user is tagged in.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_company_affiliated", "service": "unifapi", "name": "list_linkedin_company_affiliated", "description": "List a LinkedIn company's affiliated pages.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "The slug value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn company's affiliated pages.", "required": [ "slug" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_company_jobs", "service": "unifapi", "name": "list_linkedin_company_jobs", "description": "List active job postings at a LinkedIn company.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "The slug value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List active job postings at a LinkedIn company.", "required": [ "slug" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_company_people", "service": "unifapi", "name": "list_linkedin_company_people", "description": "List employees of a LinkedIn company.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "The slug value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List employees of a LinkedIn company.", "required": [ "slug" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_company_posts", "service": "unifapi", "name": "list_linkedin_company_posts", "description": "List posts published by a LinkedIn company page.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "The slug value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List posts published by a LinkedIn company page.", "required": [ "slug" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_group_posts", "service": "unifapi", "name": "list_linkedin_group_posts", "description": "List posts in a LinkedIn group.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List posts in a LinkedIn group.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_post_comment_replies", "service": "unifapi", "name": "list_linkedin_post_comment_replies", "description": "List replies to a LinkedIn comment.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." }, "comment_id": { "type": "string", "minLength": 1, "description": "The comment_id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List replies to a LinkedIn comment.", "required": [ "id", "comment_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_post_comments", "service": "unifapi", "name": "list_linkedin_post_comments", "description": "List top-level comments on a LinkedIn post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List top-level comments on a LinkedIn post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_post_reactions", "service": "unifapi", "name": "list_linkedin_post_reactions", "description": "List users who reacted to a LinkedIn post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "type": { "type": "string", "enum": [ "all", "like", "praise", "empathy", "interest", "appreciation", "entertainment" ], "default": "all", "description": "Filter by reaction type. `all` returns every reaction (default)." } }, "additionalProperties": false, "description": "The input payload for List users who reacted to a LinkedIn post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_post_reposts", "service": "unifapi", "name": "list_linkedin_post_reposts", "description": "List reposts of a LinkedIn post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List reposts of a LinkedIn post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_certifications", "service": "unifapi", "name": "list_linkedin_user_certifications", "description": "List a LinkedIn user's certifications.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn user's certifications.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_comments", "service": "unifapi", "name": "list_linkedin_user_comments", "description": "List comments authored by a LinkedIn user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List comments authored by a LinkedIn user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_educations", "service": "unifapi", "name": "list_linkedin_user_educations", "description": "List a LinkedIn user's education.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn user's education.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_experience", "service": "unifapi", "name": "list_linkedin_user_experience", "description": "List a LinkedIn user's work experience.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn user's work experience.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_honors", "service": "unifapi", "name": "list_linkedin_user_honors", "description": "List a LinkedIn user's honors and awards.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn user's honors and awards.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_images", "service": "unifapi", "name": "list_linkedin_user_images", "description": "List image posts authored by a LinkedIn user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List image posts authored by a LinkedIn user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_interest_companies", "service": "unifapi", "name": "list_linkedin_user_interest_companies", "description": "List companies a LinkedIn user follows.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List companies a LinkedIn user follows.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_interest_groups", "service": "unifapi", "name": "list_linkedin_user_interest_groups", "description": "List LinkedIn groups a user follows.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List LinkedIn groups a user follows.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_posts", "service": "unifapi", "name": "list_linkedin_user_posts", "description": "List posts authored by a LinkedIn user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List posts authored by a LinkedIn user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_publications", "service": "unifapi", "name": "list_linkedin_user_publications", "description": "List a LinkedIn user's publications.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn user's publications.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_reactions", "service": "unifapi", "name": "list_linkedin_user_reactions", "description": "List reactions a LinkedIn user has placed on posts.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List reactions a LinkedIn user has placed on posts.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_recommendations", "service": "unifapi", "name": "list_linkedin_user_recommendations", "description": "List recommendations written for a LinkedIn user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List recommendations written for a LinkedIn user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_skills", "service": "unifapi", "name": "list_linkedin_user_skills", "description": "List a LinkedIn user's skills.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn user's skills.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_videos", "service": "unifapi", "name": "list_linkedin_user_videos", "description": "List video posts authored by a LinkedIn user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List video posts authored by a LinkedIn user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_linkedin_user_volunteers", "service": "unifapi", "name": "list_linkedin_user_volunteers", "description": "List a LinkedIn user's volunteer experience.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a LinkedIn user's volunteer experience.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_reddit_post_comments", "service": "unifapi", "name": "list_reddit_post_comments", "description": "List Reddit comments on a post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Reddit post fullname, e.g. `t3_1thjm1o`." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Reddit comments on a post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_reddit_trending_searches", "service": "unifapi", "name": "list_reddit_trending_searches", "description": "List Reddit's current trending search queries.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "The input payload for List Reddit's current trending search queries." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_reddit_user_comments", "service": "unifapi", "name": "list_reddit_user_comments", "description": "List Reddit comments authored by a user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Reddit comments authored by a user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_reddit_user_posts", "service": "unifapi", "name": "list_reddit_user_posts", "description": "List Reddit posts authored by a user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Reddit posts authored by a user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_seo_backlink_anchors", "service": "unifapi", "name": "list_seo_backlink_anchors", "description": "Get anchor texts used in backlinks to a target.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the returned anchor rows. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: anchor (anchor text); rank (backlink rank, 0-1000); backlinks (number of backlinks); backlinks_spam_score (average spam score, 0-100); referring_domains (referring domains count); referring_main_domains (referring root domains count); referring_pages (referring pages count); referring_ips (referring IPs count); referring_subnets (referring subnets count); broken_backlinks (backlinks to broken pages); broken_pages (broken pages still receiving backlinks); first_seen (ISO date the first backlink was found); lost_date (ISO date the last backlink was lost). Example: {\"and\":[{\"field\":\"backlinks\",\"op\":\">\",\"value\":50},{\"field\":\"rank\",\"op\":\">\",\"value\":100}]}" }, "backlinks_filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the underlying individual backlinks before the aggregate metrics are computed. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {\"and\":[{\"field\":\"dofollow\",\"op\":\"=\",\"value\":true},{\"field\":\"backlink_spam_score\",\"op\":\"<\",\"value\":10}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the returned anchors. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: anchor, rank, backlinks, backlinks_spam_score, referring_domains, referring_main_domains, referring_pages, referring_ips, referring_subnets, broken_backlinks, broken_pages, first_seen, lost_date." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Get anchor texts used in backlinks to a target.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_seo_backlink_domain_pages", "service": "unifapi", "name": "list_seo_backlink_domain_pages", "description": "List target pages ranked by backlinks.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the returned target pages. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: url (page URL on the target); status_code (last HTTP status code of the page); size (page size in bytes); media_type (media type, e.g. text/html); first_visited (ISO date first crawled); fetch_time (ISO date last crawled); rank (backlink rank, 0-1000); backlinks (number of backlinks); backlinks_spam_score (average spam score, 0-100); referring_domains (referring domains count); referring_main_domains (referring root domains count); referring_pages (referring pages count); referring_ips (referring IPs count); referring_subnets (referring subnets count); broken_backlinks (backlinks to broken pages); broken_pages (broken pages still receiving backlinks); first_seen (ISO date the first backlink was found); lost_date (ISO date the last backlink was lost). Example: {\"and\":[{\"field\":\"referring_domains\",\"op\":\">\",\"value\":5},{\"field\":\"status_code\",\"op\":\"=\",\"value\":200}]}" }, "backlinks_filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the underlying individual backlinks before the aggregate metrics are computed. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {\"and\":[{\"field\":\"dofollow\",\"op\":\"=\",\"value\":true},{\"field\":\"backlink_spam_score\",\"op\":\"<\",\"value\":10}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the returned target pages. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: url, status_code, size, media_type, first_visited, fetch_time, rank, backlinks, backlinks_spam_score, referring_domains, referring_main_domains, referring_pages, referring_ips, referring_subnets, broken_backlinks, broken_pages, first_seen, lost_date." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for List target pages ranked by backlinks.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_seo_backlinks", "service": "unifapi", "name": "list_seo_backlinks", "description": "List individual backlinks pointing to a target.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "mode": { "type": "string", "enum": [ "as_is", "one_per_domain", "one_per_anchor" ], "description": "Result grouping: as_is returns every backlink (default), one_per_domain returns one per referring domain, one_per_anchor returns one per anchor." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the returned individual backlinks. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: domain_from (domain of the referring page); url_from (URL of the referring page); url_to (target URL the backlink points to); domain_to (target domain the backlink points to); dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {\"and\":[{\"field\":\"dofollow\",\"op\":\"=\",\"value\":true},{\"field\":\"is_broken\",\"op\":\"=\",\"value\":false}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the returned backlinks. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: domain_from, url_from, url_to, domain_to, dofollow, is_new, is_lost, is_broken, rank, page_from_rank, domain_from_rank, backlink_spam_score, item_type, anchor, tld_from, semantic_location, first_seen, last_seen." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "search_after_token": { "type": "string", "description": "Continuation token from a previous response, used to page past the 20,000-result offset limit. Keep all other parameters identical when paging." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls backlink detail. summary keeps link identity and headline rank/anchor data; full adds referring-page details and link attributes. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for List individual backlinks pointing to a target.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_seo_referring_domains", "service": "unifapi", "name": "list_seo_referring_domains", "description": "List referring domains pointing to a target.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the returned referring domains. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: domain (referring domain); rank (backlink rank, 0-1000); backlinks (number of backlinks); backlinks_spam_score (average spam score, 0-100); referring_domains (referring domains count); referring_main_domains (referring root domains count); referring_pages (referring pages count); referring_ips (referring IPs count); referring_subnets (referring subnets count); broken_backlinks (backlinks to broken pages); broken_pages (broken pages still receiving backlinks); first_seen (ISO date the first backlink was found); lost_date (ISO date the last backlink was lost). Example: {\"and\":[{\"field\":\"rank\",\"op\":\">\",\"value\":200},{\"field\":\"backlinks\",\"op\":\">\",\"value\":10}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the returned referring domains. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: domain, rank, backlinks, backlinks_spam_score, referring_domains, referring_main_domains, referring_pages, referring_ips, referring_subnets, broken_backlinks, broken_pages, first_seen, lost_date." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for List referring domains pointing to a target.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_seo_referring_networks", "service": "unifapi", "name": "list_seo_referring_networks", "description": "List referring IP networks pointing to a target.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "network_address_type": { "type": "string", "enum": [ "ip", "subnet" ], "description": "Group referring networks by individual IP (ip, default) or by subnet (subnet)." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the returned referring networks. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: rank (backlink rank, 0-1000); backlinks (number of backlinks); backlinks_spam_score (average spam score, 0-100); referring_domains (referring domains count); referring_main_domains (referring root domains count); referring_pages (referring pages count); referring_ips (referring IPs count); referring_subnets (referring subnets count); broken_backlinks (backlinks to broken pages); broken_pages (broken pages still receiving backlinks); first_seen (ISO date the first backlink was found); lost_date (ISO date the last backlink was lost). Example: {\"field\":\"referring_domains\",\"op\":\">\",\"value\":5}" }, "backlinks_filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the underlying individual backlinks before the aggregate metrics are computed. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {\"and\":[{\"field\":\"dofollow\",\"op\":\"=\",\"value\":true},{\"field\":\"backlink_spam_score\",\"op\":\"<\",\"value\":10}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the returned referring networks. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: rank, backlinks, backlinks_spam_score, referring_domains, referring_main_domains, referring_pages, referring_ips, referring_subnets, broken_backlinks, broken_pages, first_seen, lost_date." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for List referring IP networks pointing to a target.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_seo_relevant_pages", "service": "unifapi", "name": "list_seo_relevant_pages", "description": "List a domain's top ranking pages.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Target domain, such as example.com or https://example.com. Specified without www." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of pages to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of pages to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps headline traffic and top positions, full adds the complete position breakdown. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for List a domain's top ranking pages.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_seo_subdomains", "service": "unifapi", "name": "list_seo_subdomains", "description": "List a domain's subdomains with traffic.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 253, "description": "Target domain, such as example.com or https://example.com. Specified without www." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of subdomains to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of subdomains to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps headline traffic and top positions, full adds the complete position breakdown. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for List a domain's subdomains with traffic.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_threads_user_posts", "service": "unifapi", "name": "list_threads_user_posts", "description": "List Threads posts authored by a user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Threads posts authored by a user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_threads_user_replies", "service": "unifapi", "name": "list_threads_user_replies", "description": "List Threads replies authored by a user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Threads replies authored by a user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_threads_user_reposts", "service": "unifapi", "name": "list_threads_user_reposts", "description": "List Threads reposts by a user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "The username value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Threads reposts by a user.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_hashtag_videos", "service": "unifapi", "name": "list_tiktok_hashtag_videos", "description": "List videos tagged with a TikTok hashtag.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$", "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List videos tagged with a TikTok hashtag.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_music_videos", "service": "unifapi", "name": "list_tiktok_music_videos", "description": "List videos using a TikTok music track.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$", "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List videos using a TikTok music track.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_user_followers", "service": "unifapi", "name": "list_tiktok_user_followers", "description": "List a TikTok user's followers.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sec_uid, numeric user id, or public handle." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List a TikTok user's followers.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_user_following", "service": "unifapi", "name": "list_tiktok_user_following", "description": "List users a TikTok user is following.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sec_uid, numeric user id, or public handle." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List users a TikTok user is following.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_user_likes", "service": "unifapi", "name": "list_tiktok_user_likes", "description": "List videos liked by a TikTok user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sec_uid, numeric user id, or public handle." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List videos liked by a TikTok user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_user_videos", "service": "unifapi", "name": "list_tiktok_user_videos", "description": "List videos posted by a TikTok user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sec_uid, numeric user id, or public handle." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List videos posted by a TikTok user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_video_comment_replies", "service": "unifapi", "name": "list_tiktok_video_comment_replies", "description": "List replies to a TikTok comment.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$", "description": "The id value." }, "comment_id": { "type": "string", "pattern": "^\\d+$", "description": "The comment_id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List replies to a TikTok comment.", "required": [ "id", "comment_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_tiktok_video_comments", "service": "unifapi", "name": "list_tiktok_video_comments", "description": "List top-level comments on a TikTok video.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d+$", "description": "The id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." } }, "additionalProperties": false, "description": "The input payload for List top-level comments on a TikTok video.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_community_media", "service": "unifapi", "name": "list_x_community_media", "description": "Get media Posts from an X Community.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get media Posts from an X Community.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_community_members", "service": "unifapi", "name": "list_x_community_members", "description": "Get members of an X Community.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get members of an X Community.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_community_moderators", "service": "unifapi", "name": "list_x_community_moderators", "description": "Get moderators of an X Community.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get moderators of an X Community.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_community_tweets", "service": "unifapi", "name": "list_x_community_tweets", "description": "Get Posts from an X Community.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get Posts from an X Community.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_list_followers", "service": "unifapi", "name": "list_x_list_followers", "description": "Get followers/subscribers of an X List.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get followers/subscribers of an X List.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_list_members", "service": "unifapi", "name": "list_x_list_members", "description": "Get members of an X List.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get members of an X List.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_list_tweets", "service": "unifapi", "name": "list_x_list_tweets", "description": "Get Posts from an X List.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get Posts from an X List.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_tweet_liking_users", "service": "unifapi", "name": "list_x_tweet_liking_users", "description": "Get users who liked an X Post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get users who liked an X Post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_tweet_quotes", "service": "unifapi", "name": "list_x_tweet_quotes", "description": "Get quote Posts for an X Post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get quote Posts for an X Post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_tweet_repost_users", "service": "unifapi", "name": "list_x_tweet_repost_users", "description": "Get users who reposted an X Post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get users who reposted an X Post.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_user_follower_ids", "service": "unifapi", "name": "list_x_user_follower_ids", "description": "Get follower IDs for an X user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get follower IDs for an X user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_user_followers", "service": "unifapi", "name": "list_x_user_followers", "description": "Get an X user's followers.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get an X user's followers.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_user_following", "service": "unifapi", "name": "list_x_user_following", "description": "Get users followed by an X user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get users followed by an X user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_user_following_ids", "service": "unifapi", "name": "list_x_user_following_ids", "description": "Get following IDs for an X user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get following IDs for an X user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_user_liked_tweets", "service": "unifapi", "name": "list_x_user_liked_tweets", "description": "Get Posts liked by an X user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get Posts liked by an X user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_user_tweets", "service": "unifapi", "name": "list_x_user_tweets", "description": "Get Posts authored by an X user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." }, "exclude": { "type": "string", "description": "Comma-separated X timeline exclusions, e.g. `replies`." } }, "additionalProperties": false, "description": "The input payload for Get Posts authored by an X user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_x_user_verified_followers", "service": "unifapi", "name": "list_x_user_verified_followers", "description": "Get verified followers for an X user.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." } }, "additionalProperties": false, "description": "The input payload for Get verified followers for an X user.", "required": [ "id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_channel_community_posts", "service": "unifapi", "name": "list_youtube_channel_community_posts", "description": "List a YouTube channel's community posts.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "channel_id": { "type": "string", "minLength": 1, "description": "The channel_id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List a YouTube channel's community posts.", "required": [ "channel_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_channel_playlists", "service": "unifapi", "name": "list_youtube_channel_playlists", "description": "List playlists created by a YouTube channel.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "channel_id": { "type": "string", "minLength": 1, "description": "The channel_id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List playlists created by a YouTube channel.", "required": [ "channel_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_channel_shorts", "service": "unifapi", "name": "list_youtube_channel_shorts", "description": "List Shorts uploaded by a YouTube channel.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "channel_id": { "type": "string", "minLength": 1, "description": "The channel_id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List Shorts uploaded by a YouTube channel.", "required": [ "channel_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_channel_videos", "service": "unifapi", "name": "list_youtube_channel_videos", "description": "List videos uploaded by a YouTube channel.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "channel_id": { "type": "string", "minLength": 1, "description": "The channel_id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List videos uploaded by a YouTube channel.", "required": [ "channel_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_hashtag_videos", "service": "unifapi", "name": "list_youtube_hashtag_videos", "description": "List videos for a YouTube hashtag.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "tag": { "type": "string", "minLength": 1, "description": "Hashtag, with or without a leading `#`, e.g. `lofi`." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List videos for a YouTube hashtag.", "required": [ "tag" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_playlist_videos", "service": "unifapi", "name": "list_youtube_playlist_videos", "description": "List videos in a YouTube playlist.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "playlist_id": { "type": "string", "minLength": 1, "description": "The playlist_id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List videos in a YouTube playlist.", "required": [ "playlist_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_related_videos", "service": "unifapi", "name": "list_youtube_related_videos", "description": "List YouTube videos related to a given video.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "video_id": { "type": "string", "minLength": 1, "description": "The video_id value." }, "cursor": { "type": "string", "description": "The cursor value." } }, "additionalProperties": false, "description": "The input payload for List YouTube videos related to a given video.", "required": [ "video_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_video_captions", "service": "unifapi", "name": "list_youtube_video_captions", "description": "List a YouTube video's caption tracks.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "video_id": { "type": "string", "minLength": 1, "description": "The video_id value." } }, "additionalProperties": false, "description": "The input payload for List a YouTube video's caption tracks.", "required": [ "video_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.list_youtube_video_comments", "service": "unifapi", "name": "list_youtube_video_comments", "description": "List comments on a YouTube video.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "video_id": { "type": "string", "minLength": 1, "description": "The video_id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "sort_by": { "type": "string", "enum": [ "top", "newest" ], "description": "Comment ordering: `top` (default) or `newest`." } }, "additionalProperties": false, "description": "The input payload for List comments on a YouTube video.", "required": [ "video_id" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.render_html", "service": "unifapi", "name": "render_html", "description": "Render a page to HTML.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "description": "Absolute http(s) URL of the page to render." }, "wait_until": { "type": "string", "enum": [ "load", "domcontentloaded", "networkidle0", "networkidle2" ], "description": "When navigation is considered complete. `networkidle0` waits for the network to go idle (best for JavaScript-heavy pages); `load` is fastest." }, "timeout_ms": { "type": "integer", "minimum": 1000, "maximum": 60000, "description": "Navigation timeout in milliseconds (1000-60000)." } }, "additionalProperties": false, "description": "The input payload for Render a page to HTML.", "required": [ "url" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.render_markdown", "service": "unifapi", "name": "render_markdown", "description": "Render a page to Markdown.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "description": "Absolute http(s) URL of the page to render." }, "wait_until": { "type": "string", "enum": [ "load", "domcontentloaded", "networkidle0", "networkidle2" ], "description": "When navigation is considered complete. `networkidle0` waits for the network to go idle (best for JavaScript-heavy pages); `load` is fastest." }, "timeout_ms": { "type": "integer", "minimum": 1000, "maximum": 60000, "description": "Navigation timeout in milliseconds (1000-60000)." } }, "additionalProperties": false, "description": "The input payload for Render a page to Markdown.", "required": [ "url" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.resolve_linkedin_industries", "service": "unifapi", "name": "resolve_linkedin_industries", "description": "Resolve a free-text industry name to LinkedIn industry IDs.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "description": "The keyword value." } }, "additionalProperties": false, "description": "The input payload for Resolve a free-text industry name to LinkedIn industry IDs.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.resolve_linkedin_locations", "service": "unifapi", "name": "resolve_linkedin_locations", "description": "Resolve a free-text location into LinkedIn geocode tokens.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "description": "The keyword value." } }, "additionalProperties": false, "description": "The input payload for Resolve a free-text location into LinkedIn geocode tokens.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.resolve_tiktok_user", "service": "unifapi", "name": "resolve_tiktok_user", "description": "Resolve a TikTok username to a user id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Public TikTok handle, e.g. 'jennmelon'" } }, "additionalProperties": false, "description": "The input payload for Resolve a TikTok username to a user id.", "required": [ "username" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.resolve_tiktok_video", "service": "unifapi", "name": "resolve_tiktok_video", "description": "Resolve a TikTok share URL to a video.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "TikTok share URL (long or short form)" } }, "additionalProperties": false, "description": "The input payload for Resolve a TikTok share URL to a video.", "required": [ "url" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.resolve_youtube_channel_id", "service": "unifapi", "name": "resolve_youtube_channel_id", "description": "Resolve a YouTube channel URL to its UC... channel id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "Full channel URL - supports `youtube.com/@handle`, `/channel/UC...`, `/c/name`." } }, "additionalProperties": false, "description": "The input payload for Resolve a YouTube channel URL to its UC... channel id.", "required": [ "url" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.score_seo_keyword_difficulty", "service": "unifapi", "name": "score_seo_keyword_difficulty", "description": "Score keyword difficulty.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Keywords to score (1-1000). Returns the keyword difficulty for each." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, or full location name. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." } }, "additionalProperties": false, "description": "The input payload for Score keyword difficulty.", "required": [ "keywords" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_events", "service": "unifapi", "name": "search_events", "description": "Search Events.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query to inspect." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 700, "description": "Number of results to return, matching the limit parameter used across other UnifAPI endpoints. Maps to result depth." }, "view": { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "Controls response size. summary keeps lean rank evidence, standard adds descriptive fields, full includes raw extras and nested items. Defaults to standard." }, "os": { "type": "string", "enum": [ "windows", "macos", "android", "ios" ], "description": "Optional device operating system." }, "date_range": { "type": "string", "enum": [ "today", "tomorrow", "this_week", "this_weekend", "next_week", "this_month", "next_month" ], "description": "Restrict events to a relative date range. Defaults to all upcoming events." } }, "additionalProperties": false, "description": "The input payload for Search Events.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_geo_ai_mode", "service": "unifapi", "name": "search_geo_ai_mode", "description": "Search AI Mode generative results.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query to inspect in AI Mode." }, "target": { "type": "string", "minLength": 1, "description": "Optional domain or URL to mark when it appears in AI Mode answers, links, or cited references." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "device": { "type": "string", "enum": [ "desktop", "mobile" ], "description": "AI SERP device type. Defaults to desktop." }, "include_pixel_rankings": { "type": "boolean", "description": "When true, request pixel rectangle data for visual AI SERP analysis." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. Defaults to full, which keeps every answer section, cited reference, link, and image because AI Mode evidence is not billed per record. standard drops raw extras and nested items; summary keeps only the core answer plus citation domains." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Search AI Mode generative results.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_geo_mentions", "service": "unifapi", "name": "search_geo_mentions", "description": "Search LLM mentions of a domain or keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 63, "description": "Target domain (no protocol/www). Provide domain or keyword." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Target keyword. Provide domain or keyword." }, "filter": { "type": "string", "enum": [ "include", "exclude" ], "description": "Whether to include or exclude matches for this entity. Defaults to include." }, "scope": { "type": "array", "items": { "type": "string", "description": "One item in the array." }, "description": "Where to look. Domain scopes: any, sources, search_results. Keyword scopes: any, question, answer, brand_entities, fan_out_queries." }, "match": { "type": "string", "enum": [ "word", "partial" ], "description": "Keyword match type. word = full-term match; partial = substring. Defaults to word." }, "include_subdomains": { "type": "boolean", "description": "Include subdomains of the target domain. Defaults to false." } }, "description": "One item in the array." }, "minItems": 1, "maxItems": 10, "description": "Up to 10 target entities, each a domain or a keyword." }, "engine": { "allOf": [ { "type": "string", "enum": [ "chatgpt", "google" ], "description": "The engine value." }, { "description": "AI platform to query. `google` covers Google AI Overviews; `chatgpt` covers ChatGPT (United States + English only). Defaults to google." } ], "description": "The engine value." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the matched mentions. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: ai_search_volume (monthly AI search volume); platform (LLM engine, e.g. chat_gpt, google, perplexity); model (model name that produced the answer). Example: {\"and\":[{\"field\":\"ai_search_volume\",\"op\":\">\",\"value\":1000},{\"field\":\"platform\",\"op\":\"=\",\"value\":\"chat_gpt\"}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the matched mentions. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: ai_search_volume, platform, model." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Max mentions to return. Default 100." }, "offset": { "type": "integer", "minimum": 0, "maximum": 9000, "description": "Mentions to skip. Use cursor beyond 9000." }, "cursor": { "type": "string", "description": "search_after_token from a previous response, for deep pagination." }, "view": { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "Response size. full keeps answers, sources, and raw search results; standard drops raw search results; summary keeps only the question, volume, and cited sources. Defaults to standard." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Search LLM mentions of a domain or keyword.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_hotels", "service": "unifapi", "name": "search_hotels", "description": "Search Hotels.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Optional hotel name or search query. Combine with location to scope the search." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Number of hotels to return. Defaults to 10." }, "check_in": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-in date. Date in YYYY-MM-DD format." }, "check_out": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-out date. Date in YYYY-MM-DD format." }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "description": "ISO 4217 currency code for prices, such as USD." }, "adults": { "type": "integer", "minimum": 1, "maximum": 30, "description": "Number of adult guests." }, "children": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 17, "description": "One item in the array." }, "maxItems": 10, "description": "Ages of children staying, used to refine availability and pricing." }, "stars": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 5, "description": "One item in the array." }, "maxItems": 5, "description": "Filter to hotels with these class ratings, such as [4, 5]." }, "min_rating": { "type": "number", "minimum": 0, "maximum": 5, "description": "Filter to hotels with at least this guest rating." }, "sort_by": { "type": "string", "enum": [ "relevance", "lowest_price", "highest_rating", "most_reviewed" ], "description": "Sort order for results. Defaults to relevance." }, "min_price": { "type": "integer", "minimum": 0, "description": "Minimum price per night." }, "max_price": { "type": "integer", "minimum": 0, "description": "Maximum price per night." }, "free_cancellation": { "type": "boolean", "description": "When true, only return hotels offering free cancellation." }, "is_vacation_rentals": { "type": "boolean", "description": "When true, search vacation rentals instead of hotels." }, "amenities": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60, "description": "One item in the array." }, "maxItems": 30, "description": "Filter to hotels offering these amenities, such as pool or free_wifi." } }, "additionalProperties": false, "description": "The input payload for Search Hotels." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_instagram", "service": "unifapi", "name": "search_instagram", "description": "Cross-type Instagram search (posts/reels).", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword." } }, "additionalProperties": false, "description": "The input payload for Cross-type Instagram search (posts/reels).", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_linkedin_ads", "service": "unifapi", "name": "search_linkedin_ads", "description": "Search the LinkedIn Ad Library.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "keyword": { "type": "string", "description": "The keyword value." }, "advertiser_name": { "type": "string", "description": "The advertiser_name value." }, "country": { "type": "string", "description": "ISO-3166-1 alpha-2 code, e.g. `US`" }, "date": { "type": "string", "description": "The date value." } }, "additionalProperties": false, "description": "The input payload for Search the LinkedIn Ad Library." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_linkedin_jobs", "service": "unifapi", "name": "search_linkedin_jobs", "description": "Search LinkedIn jobs by keyword and filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "keyword": { "type": "string", "minLength": 1, "description": "Free-text search query" }, "sort_by": { "type": "string", "description": "The sort_by value." }, "date_posted": { "type": "string", "description": "The date_posted value." }, "geocode": { "type": "string", "description": "The geocode value." }, "company": { "type": "string", "description": "The company value." }, "experience_level": { "type": "string", "description": "The experience_level value." }, "remote": { "type": "string", "description": "The remote value." }, "job_type": { "type": "string", "description": "The job_type value." }, "easy_apply": { "type": "string", "enum": [ "true", "false" ], "description": "The easy_apply value." }, "has_verifications": { "type": "string", "enum": [ "true", "false" ], "description": "The has_verifications value." }, "under_10_applicants": { "type": "string", "enum": [ "true", "false" ], "description": "The under_10_applicants value." }, "fair_chance_employer": { "type": "string", "enum": [ "true", "false" ], "description": "The fair_chance_employer value." } }, "additionalProperties": false, "description": "The input payload for Search LinkedIn jobs by keyword and filters.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_linkedin_people", "service": "unifapi", "name": "search_linkedin_people", "description": "Search LinkedIn people by name, title, company, etc.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "name": { "type": "string", "description": "The name value." }, "first_name": { "type": "string", "description": "The first_name value." }, "last_name": { "type": "string", "description": "The last_name value." }, "title": { "type": "string", "description": "The title value." }, "company": { "type": "string", "description": "The company value." }, "school": { "type": "string", "description": "The school value." }, "geocode_location": { "type": "string", "description": "The geocode_location value." }, "current_company": { "type": "string", "description": "The current_company value." }, "profile_language": { "type": "string", "description": "The profile_language value." }, "industry": { "type": "string", "description": "The industry value." }, "service_category": { "type": "string", "description": "The service_category value." } }, "additionalProperties": false, "description": "The input payload for Search LinkedIn people by name, title, company, etc." }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_linkedin_posts", "service": "unifapi", "name": "search_linkedin_posts", "description": "Search LinkedIn posts by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "keyword": { "type": "string", "minLength": 1, "description": "The keyword value." }, "date_posted": { "type": "string", "description": "The date_posted value." }, "sort_by": { "type": "string", "description": "The sort_by value." }, "from_member": { "type": "string", "description": "The from_member value." }, "from_company": { "type": "string", "description": "The from_company value." }, "content_type": { "type": "string", "description": "The content_type value." } }, "additionalProperties": false, "description": "The input payload for Search LinkedIn posts by keyword.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_linkedin_schools", "service": "unifapi", "name": "search_linkedin_schools", "description": "Search LinkedIn schools by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "keyword": { "type": "string", "minLength": 1, "description": "The keyword value." } }, "additionalProperties": false, "description": "The input payload for Search LinkedIn schools by keyword.", "required": [ "keyword" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_local", "service": "unifapi", "name": "search_local", "description": "Search Local Finder.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query to inspect." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "Search location as a country code/name, full location name, or coordinate string." }, { "type": "integer", "exclusiveMinimum": 0, "description": "DataForSEO location code." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 700, "description": "Number of results to return, matching the limit parameter used across other UnifAPI endpoints. Maps to result depth." }, "view": { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "Controls response size. summary keeps lean rank evidence, standard adds descriptive fields, full includes raw extras and nested items. Defaults to standard." }, "device": { "type": "string", "enum": [ "desktop", "mobile" ], "description": "SERP device type. Defaults to desktop." }, "os": { "type": "string", "enum": [ "windows", "macos", "android", "ios" ], "description": "Optional device operating system." }, "min_rating": { "type": "number", "minimum": 0, "maximum": 5, "description": "Filter results to places with at least this average rating." }, "time_filter": { "type": "string", "enum": [ "any", "open_now" ], "description": "Filter results by open hours. open_now keeps only places open at request time." } }, "additionalProperties": false, "description": "The input payload for Search Local Finder.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_maps", "service": "unifapi", "name": "search_maps", "description": "Search Maps.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query to inspect." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 700, "description": "Number of results to return, matching the limit parameter used across other UnifAPI endpoints. Maps to result depth." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean rank evidence, standard adds descriptive fields, full includes raw extras and nested items. Defaults to standard." } ], "description": "The view value." }, "device": { "type": "string", "enum": [ "desktop", "mobile" ], "description": "SERP device type. Defaults to desktop." }, "os": { "type": "string", "enum": [ "windows", "macos", "android", "ios" ], "description": "Optional device operating system." }, "search_this_area": { "type": "boolean", "description": "When true, return results from the displayed map area rather than the broader location." }, "search_places": { "type": "boolean", "description": "When true, use search-places mode to return listings the way the mobile app surfaces them." } }, "additionalProperties": false, "description": "The input payload for Search Maps.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_news", "service": "unifapi", "name": "search_news", "description": "Search News.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query to inspect." }, "location": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120, "description": "The location value." }, { "type": "integer", "exclusiveMinimum": 0, "description": "The location value." } ], "description": "Search location as a country code/name, DataForSEO location code, full location name, or latitude,longitude,radius coordinate string. Defaults to us." }, "language": { "type": "string", "minLength": 2, "maxLength": 80, "description": "Search language as an ISO code or full language name. Defaults to en." }, "limit": { "type": "integer", "minimum": 1, "maximum": 700, "description": "Number of results to return, matching the limit parameter used across other UnifAPI endpoints. Maps to result depth." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "standard", "full" ], "description": "The view value." }, { "description": "Controls response size. summary keeps lean rank evidence, standard adds descriptive fields, full includes raw extras and nested items. Defaults to standard." } ], "description": "The view value." }, "os": { "type": "string", "enum": [ "windows", "macos", "android", "ios" ], "description": "Optional device operating system." } }, "additionalProperties": false, "description": "The input payload for Search News.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_threads_profiles", "service": "unifapi", "name": "search_threads_profiles", "description": "Search Threads users by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "q": { "type": "string", "minLength": 1, "description": "Search keyword." } }, "additionalProperties": false, "description": "The input payload for Search Threads users by keyword.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.search_threads_recent", "service": "unifapi", "name": "search_threads_recent", "description": "Search recent Threads posts.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword." } }, "additionalProperties": false, "description": "The input payload for Search recent Threads posts.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_threads_top", "service": "unifapi", "name": "search_threads_top", "description": "Search top Threads posts.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword." } }, "additionalProperties": false, "description": "The input payload for Search top Threads posts.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_tiktok", "service": "unifapi", "name": "search_tiktok", "description": "General TikTok search (returns videos).", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword" } }, "additionalProperties": false, "description": "The input payload for General TikTok search (returns videos).", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_tiktok_hashtags", "service": "unifapi", "name": "search_tiktok_hashtags", "description": "Search TikTok hashtags by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword" } }, "additionalProperties": false, "description": "The input payload for Search TikTok hashtags by keyword.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_tiktok_users", "service": "unifapi", "name": "search_tiktok_users", "description": "Search TikTok users by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword" } }, "additionalProperties": false, "description": "The input payload for Search TikTok users by keyword.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_tiktok_videos", "service": "unifapi", "name": "search_tiktok_videos", "description": "Search TikTok videos by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20, "description": "The limit value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword" } }, "additionalProperties": false, "description": "The input payload for Search TikTok videos by keyword.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_x_communities", "service": "unifapi", "name": "search_x_communities", "description": "Search X Communities.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." }, "query": { "type": "string", "minLength": 1, "description": "The query value." }, "community.fields": { "type": "string", "description": "The community.fields value." } }, "additionalProperties": false, "description": "The input payload for Search X Communities.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_x_community_member", "service": "unifapi", "name": "search_x_community_member", "description": "Search members in an X Community.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." }, "query": { "type": "string", "minLength": 1, "description": "The query value." } }, "additionalProperties": false, "description": "The input payload for Search members in an X Community.", "required": [ "id", "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_x_lists", "service": "unifapi", "name": "search_x_lists", "description": "Search X Lists.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." }, "query": { "type": "string", "minLength": 1, "description": "The query value." } }, "additionalProperties": false, "description": "The input payload for Search X Lists.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_x_recent_tweets", "service": "unifapi", "name": "search_x_recent_tweets", "description": "Search recent X Posts.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "expansions": { "type": "string", "description": "The expansions value." }, "tweet.fields": { "type": "string", "description": "The tweet.fields value." }, "user.fields": { "type": "string", "description": "The user.fields value." }, "media.fields": { "type": "string", "description": "The media.fields value." }, "place.fields": { "type": "string", "description": "The place.fields value." }, "poll.fields": { "type": "string", "description": "The poll.fields value." }, "pagination_token": { "type": "string", "description": "The pagination_token value." }, "next_token": { "type": "string", "description": "The next_token value." }, "max_results": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The max_results value." }, "query": { "type": "string", "minLength": 1, "description": "Recent search query." } }, "additionalProperties": false, "description": "The input payload for Search recent X Posts.", "required": [ "query" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_youtube_channel", "service": "unifapi", "name": "search_youtube_channel", "description": "Search within a YouTube channel.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "channel_id": { "type": "string", "minLength": 1, "description": "The channel_id value." }, "cursor": { "type": "string", "description": "The cursor value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword." } }, "additionalProperties": false, "description": "The input payload for Search within a YouTube channel.", "required": [ "channel_id", "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_youtube_channels", "service": "unifapi", "name": "search_youtube_channels", "description": "Search YouTube channels by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword." } }, "additionalProperties": false, "description": "The input payload for Search YouTube channels by keyword.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_youtube_playlists", "service": "unifapi", "name": "search_youtube_playlists", "description": "Search YouTube playlists by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword." } }, "additionalProperties": false, "description": "The input payload for Search YouTube playlists by keyword.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.search_youtube_videos", "service": "unifapi", "name": "search_youtube_videos", "description": "Search YouTube videos by keyword.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "cursor": { "type": "string", "description": "The cursor value." }, "q": { "type": "string", "minLength": 1, "description": "Search keyword." }, "sort_by": { "type": "string", "enum": [ "relevance", "date", "views", "rating" ], "description": "Result ordering (default `relevance`)." }, "upload_date": { "type": "string", "enum": [ "hour", "today", "week", "month", "year" ], "description": "Restrict to videos uploaded within this window." }, "duration": { "type": "string", "enum": [ "short", "medium", "long" ], "description": "Restrict by video length bucket." }, "region": { "type": "string", "minLength": 2, "maxLength": 2, "description": "ISO 3166 country code, e.g. `US`." }, "language": { "type": "string", "description": "Language code, e.g. `en`." } }, "additionalProperties": false, "description": "The input payload for Search YouTube videos by keyword.", "required": [ "q" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "pagination": { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "Cursor to request the next page." } }, "additionalProperties": true, "description": "UnifAPI pagination details when the endpoint is paginated." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The paginated response returned by UnifAPI." } }, { "id": "unifapi.summarize_seo_backlink_domain_pages", "service": "unifapi", "name": "summarize_seo_backlink_domain_pages", "description": "Summarize backlinks for each page of a target.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/)." }, "backlinks_status_type": { "type": "string", "enum": [ "live", "all", "lost" ], "description": "Which backlinks to count: live (found on the last check, default), all, or lost." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "include_indirect_links": { "type": "boolean", "description": "Include indirect links (via redirects or canonicals) to the target. Defaults to true." }, "exclude_internal_backlinks": { "type": "boolean", "description": "Exclude internal backlinks from the target's own subdomains. Defaults to true." }, "internal_list_limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the returned page summaries. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: url (page URL on the target); rank (backlink rank, 0-1000); backlinks (number of backlinks); backlinks_spam_score (average spam score, 0-100); referring_domains (referring domains count); referring_main_domains (referring root domains count); referring_pages (referring pages count); referring_ips (referring IPs count); referring_subnets (referring subnets count); broken_backlinks (backlinks to broken pages); broken_pages (broken pages still receiving backlinks); first_seen (ISO date the first backlink was found); lost_date (ISO date the last backlink was lost). Example: {\"field\":\"referring_domains\",\"op\":\">\",\"value\":5}" }, "backlinks_filters": { "$ref": "#/$defs/DataForSeoFilter", "description": "Filter the underlying individual backlinks before the aggregate metrics are computed. Provide a single condition {\"field\",\"op\",\"value\"} or an {\"and\":[...]} / {\"or\":[...]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {\"and\":[{\"field\":\"dofollow\",\"op\":\"=\",\"value\":true},{\"field\":\"backlink_spam_score\",\"op\":\"<\",\"value\":10}]}" }, "order_by": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to sort by. See the endpoint's list of sortable fields." }, "dir": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort direction: asc or desc. Defaults to desc." } }, "required": [ "field" ], "additionalProperties": false, "description": "One item in the array." }, "minItems": 1, "maxItems": 3, "description": "Sort the returned page summaries. Each rule is {\"field\",\"dir\"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: url, rank, backlinks, backlinks_spam_score, referring_domains, referring_main_domains, referring_pages, referring_ips, referring_subnets, broken_backlinks, broken_pages, first_seen, lost_date." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Maximum number of records to return. Defaults to 100." }, "offset": { "type": "integer", "minimum": 0, "description": "Number of records to skip from the start of the results." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "$defs": { "DataForSeoFilterCondition": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "description": "Field to filter on. See the endpoint's list of filterable fields." }, "op": { "type": "string", "enum": [ "=", "<>", "<", "<=", ">", ">=", "in", "not_in", "like", "not_like", "ilike", "not_ilike", "match", "not_match" ], "description": "Comparison operator." }, "value": { "$ref": "#/$defs/DataForSeoFilterValue" } }, "required": [ "field", "op", "value" ], "additionalProperties": false, "description": "The filter condition." }, "DataForSeoFilterValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "minItems": 1 } ], "description": "Comparison value: a string, number, or boolean for scalar operators, or a non-empty array for \"in\" / \"not_in\"." }, "DataForSeoFilter": { "anyOf": [ { "$ref": "#/$defs/DataForSeoFilterCondition" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions that must all match." } }, "required": [ "and" ], "additionalProperties": false }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/$defs/DataForSeoFilter" }, "minItems": 2, "description": "Sub-expressions where at least one must match." } }, "required": [ "or" ], "additionalProperties": false } ] } }, "additionalProperties": false, "description": "The input payload for Summarize backlinks for each page of a target.", "required": [ "target" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.summarize_seo_bulk_pages", "service": "unifapi", "name": "summarize_seo_bulk_pages", "description": "Summarize backlinks for many pages at once.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "One item in the array." }, "minItems": 1, "maxItems": 1000, "description": "Domains, subdomains, or pages to analyze (up to 1000). Domains/subdomains without https:// and www.; pages as absolute URLs." }, "include_subdomains": { "type": "boolean", "description": "Include backlinks pointing to the target's subdomains. Defaults to true." }, "rank_scale": { "type": "string", "enum": [ "one_hundred", "one_thousand" ], "description": "Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100)." }, "view": { "allOf": [ { "type": "string", "enum": [ "summary", "full" ], "description": "The view value." }, { "description": "Controls metric depth. summary keeps the headline counters; full adds nofollow variants and the referring_links_* breakdown maps. Defaults to summary." } ], "description": "The view value." } }, "additionalProperties": false, "description": "The input payload for Summarize backlinks for many pages at once.", "required": [ "targets" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.translate_x_tweet", "service": "unifapi", "name": "translate_x_tweet", "description": "Translate an X Post.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "language": { "type": "string", "minLength": 1, "description": "The language value." } }, "additionalProperties": false, "description": "The input payload for Translate an X Post.", "required": [ "id", "language" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } }, { "id": "unifapi.translate_x_user_profile", "service": "unifapi", "name": "translate_x_user_profile", "description": "Translate an X user profile.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "X resource id." }, "language": { "type": "string", "minLength": 1, "description": "The language value." } }, "additionalProperties": false, "description": "The input payload for Translate an X user profile.", "required": [ "id", "language" ] }, "outputSchema": { "type": "object", "properties": { "request_id": { "type": "string", "description": "UnifAPI request id for support and ledger correlation." }, "data": { "description": "The data payload returned by UnifAPI for this operation." }, "billing": { "type": "object", "properties": { "credits_charged": { "type": "integer", "minimum": 0, "description": "Credits charged for the request." }, "records_charged": { "type": "integer", "minimum": 0, "description": "Records charged for the request." }, "balance_remaining": { "type": "integer", "minimum": 0, "description": "Credits remaining after the request." }, "truncated_due_to_balance": { "type": "boolean", "description": "Whether results were truncated because of credit balance." } }, "additionalProperties": true, "description": "UnifAPI billing details for the request." } }, "additionalProperties": true, "description": "The response returned by UnifAPI." } } ] }