{ "openapi": "3.1.0", "info": { "title": "FastFetchz API", "version": "1.0.0", "summary": "One prepaid API for public social and web data.", "description": "FastFetchz exposes public social and web data through one endpoint shape and one normalized JSON envelope. Authenticate with an `X-API-Key` header. Every successful call deducts that service’s published credit cost from your prepaid balance (a credit is worth $0.0015); failed calls are never charged. Only publicly accessible data is returned.", "contact": { "name": "FastFetchz support", "email": "support@fastfetchz.com", "url": "https://fastfetchz.com/contact" }, "termsOfService": "https://fastfetchz.com/legal/terms" }, "externalDocs": { "description": "API documentation", "url": "https://fastfetchz.com/docs" }, "servers": [ { "url": "https://api.fastfetchz.com", "description": "Production" } ], "security": [ { "ApiKeyAuth": [] } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "Your API key, prefixed `ff_live_`. Create one in the dashboard." } } }, "paths": { "/v1/instagram/profile": { "get": { "operationId": "get_instagram_profile", "summary": "Instagram — Profile", "description": "Fetch profile data from Instagram. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Instagram" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Instagram", "name": "Profile", "endpoint": "/v1/instagram/profile" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/instagram/posts": { "get": { "operationId": "get_instagram_posts", "summary": "Instagram — Posts", "description": "Fetch posts data from Instagram. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Instagram" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Instagram", "name": "Posts", "endpoint": "/v1/instagram/posts" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/instagram/reels": { "get": { "operationId": "get_instagram_reels", "summary": "Instagram — Reels", "description": "Fetch reels data from Instagram. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Instagram" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Instagram", "name": "Reels", "endpoint": "/v1/instagram/reels" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/instagram/comments": { "get": { "operationId": "get_instagram_comments", "summary": "Instagram — Comments", "description": "Fetch comments data from Instagram. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Instagram" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Instagram", "name": "Comments", "endpoint": "/v1/instagram/comments" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/instagram/followers-following": { "get": { "operationId": "get_instagram_followers_following", "summary": "Instagram — Followers / Following", "description": "Fetch followers / following data from Instagram. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Instagram" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Instagram", "name": "Followers / Following", "endpoint": "/v1/instagram/followers-following" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/instagram/search-hashtags": { "get": { "operationId": "get_instagram_search_hashtags", "summary": "Instagram — Search / Hashtags", "description": "Fetch search / hashtags data from Instagram. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Instagram" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Instagram", "name": "Search / Hashtags", "endpoint": "/v1/instagram/search-hashtags" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/instagram/transcript": { "get": { "operationId": "get_instagram_transcript", "summary": "Instagram — Transcript", "description": "Fetch transcript data from Instagram. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Instagram" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Instagram", "name": "Transcript", "endpoint": "/v1/instagram/transcript" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok/profile": { "get": { "operationId": "get_tiktok_profile", "summary": "TikTok — Profile", "description": "Fetch profile data from TikTok. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok", "name": "Profile", "endpoint": "/v1/tiktok/profile" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok/videos-user-videos": { "get": { "operationId": "get_tiktok_videos_user_videos", "summary": "TikTok — Videos / User Videos", "description": "Fetch videos / user videos data from TikTok. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok", "name": "Videos / User Videos", "endpoint": "/v1/tiktok/videos-user-videos" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok/comments-replies": { "get": { "operationId": "get_tiktok_comments_replies", "summary": "TikTok — Comments / Replies", "description": "Fetch comments / replies data from TikTok. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok", "name": "Comments / Replies", "endpoint": "/v1/tiktok/comments-replies" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok/search-hashtags-trending": { "get": { "operationId": "get_tiktok_search_hashtags_trending", "summary": "TikTok — Search / Hashtags / Trending", "description": "Fetch search / hashtags / trending data from TikTok. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok", "name": "Search / Hashtags / Trending", "endpoint": "/v1/tiktok/search-hashtags-trending" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok/transcript": { "get": { "operationId": "get_tiktok_transcript", "summary": "TikTok — Transcript", "description": "Fetch transcript data from TikTok. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok", "name": "Transcript", "endpoint": "/v1/tiktok/transcript" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok/live-room": { "get": { "operationId": "get_tiktok_live_room", "summary": "TikTok — Live Room", "description": "Fetch live room data from TikTok. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok", "name": "Live Room", "endpoint": "/v1/tiktok/live-room" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/youtube/channel-profile": { "get": { "operationId": "get_youtube_channel_profile", "summary": "YouTube — Channel / Profile", "description": "Fetch channel / profile data from YouTube. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "YouTube" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "YouTube", "name": "Channel / Profile", "endpoint": "/v1/youtube/channel-profile" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/youtube/video-shorts": { "get": { "operationId": "get_youtube_video_shorts", "summary": "YouTube — Video / Shorts", "description": "Fetch video / shorts data from YouTube. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "YouTube" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "YouTube", "name": "Video / Shorts", "endpoint": "/v1/youtube/video-shorts" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/youtube/channel-playlist-videos": { "get": { "operationId": "get_youtube_channel_playlist_videos", "summary": "YouTube — Channel / Playlist Videos", "description": "Fetch channel / playlist videos data from YouTube. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "YouTube" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "YouTube", "name": "Channel / Playlist Videos", "endpoint": "/v1/youtube/channel-playlist-videos" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/youtube/comments-replies": { "get": { "operationId": "get_youtube_comments_replies", "summary": "YouTube — Comments / Replies", "description": "Fetch comments / replies data from YouTube. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "YouTube" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "YouTube", "name": "Comments / Replies", "endpoint": "/v1/youtube/comments-replies" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/youtube/search-hashtag": { "get": { "operationId": "get_youtube_search_hashtag", "summary": "YouTube — Search / Hashtag", "description": "Fetch search / hashtag data from YouTube. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "YouTube" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "YouTube", "name": "Search / Hashtag", "endpoint": "/v1/youtube/search-hashtag" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/youtube/transcript": { "get": { "operationId": "get_youtube_transcript", "summary": "YouTube — Transcript", "description": "Fetch transcript data from YouTube. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "YouTube" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "YouTube", "name": "Transcript", "endpoint": "/v1/youtube/transcript" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook/profile-page": { "get": { "operationId": "get_facebook_profile_page", "summary": "Facebook — Profile / Page", "description": "Fetch profile / page data from Facebook. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook", "name": "Profile / Page", "endpoint": "/v1/facebook/profile-page" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook/posts-reels": { "get": { "operationId": "get_facebook_posts_reels", "summary": "Facebook — Posts / Reels", "description": "Fetch posts / reels data from Facebook. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook", "name": "Posts / Reels", "endpoint": "/v1/facebook/posts-reels" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook/comments-replies": { "get": { "operationId": "get_facebook_comments_replies", "summary": "Facebook — Comments / Replies", "description": "Fetch comments / replies data from Facebook. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook", "name": "Comments / Replies", "endpoint": "/v1/facebook/comments-replies" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook/groups-group-posts": { "get": { "operationId": "get_facebook_groups_group_posts", "summary": "Facebook — Groups / Group Posts", "description": "Fetch groups / group posts data from Facebook. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook", "name": "Groups / Group Posts", "endpoint": "/v1/facebook/groups-group-posts" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook/events-reviews-photos": { "get": { "operationId": "get_facebook_events_reviews_photos", "summary": "Facebook — Events / Reviews / Photos", "description": "Fetch events / reviews / photos data from Facebook. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook", "name": "Events / Reviews / Photos", "endpoint": "/v1/facebook/events-reviews-photos" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook/video-ad-transcript": { "get": { "operationId": "get_facebook_video_ad_transcript", "summary": "Facebook — Video / Ad Transcript", "description": "Fetch video / ad transcript data from Facebook. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook", "name": "Video / Ad Transcript", "endpoint": "/v1/facebook/video-ad-transcript" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/x/profile": { "get": { "operationId": "get_x_profile", "summary": "X / Twitter — Profile", "description": "Fetch profile data from X / Twitter. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.30 per 1,000 calls (0.2 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "X / Twitter" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.2 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "X / Twitter", "name": "Profile", "endpoint": "/v1/x/profile" }, "mode": "sandbox", "credits_charged": 0.2, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.2 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/x/posts-user-posts": { "get": { "operationId": "get_x_posts_user_posts", "summary": "X / Twitter — Posts / User Posts", "description": "Fetch posts / user posts data from X / Twitter. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.30 per 1,000 calls (0.2 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "X / Twitter" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.2 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "X / Twitter", "name": "Posts / User Posts", "endpoint": "/v1/x/posts-user-posts" }, "mode": "sandbox", "credits_charged": 0.2, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.2 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/x/replies-quotes-retweeters": { "get": { "operationId": "get_x_replies_quotes_retweeters", "summary": "X / Twitter — Replies / Quotes / Retweeters", "description": "Fetch replies / quotes / retweeters data from X / Twitter. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.30 per 1,000 calls (0.2 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "X / Twitter" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.2 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "X / Twitter", "name": "Replies / Quotes / Retweeters", "endpoint": "/v1/x/replies-quotes-retweeters" }, "mode": "sandbox", "credits_charged": 0.2, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.2 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/x/followers-following": { "get": { "operationId": "get_x_followers_following", "summary": "X / Twitter — Followers / Following", "description": "Fetch followers / following data from X / Twitter. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.30 per 1,000 calls (0.2 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "X / Twitter" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.2 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "X / Twitter", "name": "Followers / Following", "endpoint": "/v1/x/followers-following" }, "mode": "sandbox", "credits_charged": 0.2, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.2 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/x/search-trends": { "get": { "operationId": "get_x_search_trends", "summary": "X / Twitter — Search / Trends", "description": "Fetch search / trends data from X / Twitter. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.30 per 1,000 calls (0.2 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "X / Twitter" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.2 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "X / Twitter", "name": "Search / Trends", "endpoint": "/v1/x/search-trends" }, "mode": "sandbox", "credits_charged": 0.2, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.2 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkedin/profile": { "get": { "operationId": "get_linkedin_profile", "summary": "LinkedIn — Profile", "description": "Fetch profile data from LinkedIn. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "LinkedIn" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "LinkedIn", "name": "Profile", "endpoint": "/v1/linkedin/profile" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkedin/company": { "get": { "operationId": "get_linkedin_company", "summary": "LinkedIn — Company", "description": "Fetch company data from LinkedIn. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "LinkedIn" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "LinkedIn", "name": "Company", "endpoint": "/v1/linkedin/company" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkedin/posts-comments": { "get": { "operationId": "get_linkedin_posts_comments", "summary": "LinkedIn — Posts / Comments", "description": "Fetch posts / comments data from LinkedIn. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "LinkedIn" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "LinkedIn", "name": "Posts / Comments", "endpoint": "/v1/linkedin/posts-comments" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkedin/jobs-company-jobs": { "get": { "operationId": "get_linkedin_jobs_company_jobs", "summary": "LinkedIn — Jobs / Company Jobs", "description": "Fetch jobs / company jobs data from LinkedIn. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "LinkedIn" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "LinkedIn", "name": "Jobs / Company Jobs", "endpoint": "/v1/linkedin/jobs-company-jobs" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkedin/people-job-post-search": { "get": { "operationId": "get_linkedin_people_job_post_search", "summary": "LinkedIn — People / Job / Post Search", "description": "Fetch people / job / post search data from LinkedIn. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "LinkedIn" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "LinkedIn", "name": "People / Job / Post Search", "endpoint": "/v1/linkedin/people-job-post-search" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/reddit/post": { "get": { "operationId": "get_reddit_post", "summary": "Reddit — Post", "description": "Fetch post data from Reddit. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Reddit" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Reddit", "name": "Post", "endpoint": "/v1/reddit/post" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/reddit/comments": { "get": { "operationId": "get_reddit_comments", "summary": "Reddit — Comments", "description": "Fetch comments data from Reddit. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Reddit" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Reddit", "name": "Comments", "endpoint": "/v1/reddit/comments" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/reddit/subreddit-posts": { "get": { "operationId": "get_reddit_subreddit_posts", "summary": "Reddit — Subreddit Posts", "description": "Fetch subreddit posts data from Reddit. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Reddit" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Reddit", "name": "Subreddit Posts", "endpoint": "/v1/reddit/subreddit-posts" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/reddit/search": { "get": { "operationId": "get_reddit_search", "summary": "Reddit — Search", "description": "Fetch search data from Reddit. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Reddit" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Reddit", "name": "Search", "endpoint": "/v1/reddit/search" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/threads/profile": { "get": { "operationId": "get_threads_profile", "summary": "Threads — Profile", "description": "Fetch profile data from Threads. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Threads" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Threads", "name": "Profile", "endpoint": "/v1/threads/profile" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/threads/posts-user-posts": { "get": { "operationId": "get_threads_posts_user_posts", "summary": "Threads — Posts / User Posts", "description": "Fetch posts / user posts data from Threads. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Threads" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Threads", "name": "Posts / User Posts", "endpoint": "/v1/threads/posts-user-posts" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/amazon/product-search-detail-best-sellers": { "get": { "operationId": "get_amazon_product_search_detail_best_sellers", "summary": "Amazon — Product Search / Detail / Best Sellers", "description": "Fetch product search / detail / best sellers data from Amazon. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.90 per 1,000 calls (0.6 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Amazon" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.6 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Amazon", "name": "Product Search / Detail / Best Sellers", "endpoint": "/v1/amazon/product-search-detail-best-sellers" }, "mode": "sandbox", "credits_charged": 0.6, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.6 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/amazon/reviews-seller-info": { "get": { "operationId": "get_amazon_reviews_seller_info", "summary": "Amazon — Reviews / Seller Info", "description": "Fetch reviews / seller info data from Amazon. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.90 per 1,000 calls (0.6 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Amazon" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.6 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Amazon", "name": "Reviews / Seller Info", "endpoint": "/v1/amazon/reviews-seller-info" }, "mode": "sandbox", "credits_charged": 0.6, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.6 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/google-maps/search-place-details-reviews": { "get": { "operationId": "get_google_maps_search_place_details_reviews", "summary": "Google Maps — Search / Place Details / Reviews", "description": "Fetch search / place details / reviews data from Google Maps. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.90 per 1,000 calls (0.6 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Google Maps" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.6 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Google Maps", "name": "Search / Place Details / Reviews", "endpoint": "/v1/google-maps/search-place-details-reviews" }, "mode": "sandbox", "credits_charged": 0.6, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.6 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook-ad-library/ad-details": { "get": { "operationId": "get_facebook_ad_library_ad_details", "summary": "Facebook Ad Library — Ad Details", "description": "Fetch ad details data from Facebook Ad Library. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook Ad Library" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook Ad Library", "name": "Ad Details", "endpoint": "/v1/facebook-ad-library/ad-details" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook-ad-library/company-ads": { "get": { "operationId": "get_facebook_ad_library_company_ads", "summary": "Facebook Ad Library — Company Ads", "description": "Fetch company ads data from Facebook Ad Library. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook Ad Library" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook Ad Library", "name": "Company Ads", "endpoint": "/v1/facebook-ad-library/company-ads" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/facebook-ad-library/search-company-search": { "get": { "operationId": "get_facebook_ad_library_search_company_search", "summary": "Facebook Ad Library — Search / Company Search", "description": "Fetch search / company search data from Facebook Ad Library. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Facebook Ad Library" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Facebook Ad Library", "name": "Search / Company Search", "endpoint": "/v1/facebook-ad-library/search-company-search" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok-ad-library/ad-search": { "get": { "operationId": "get_tiktok_ad_library_ad_search", "summary": "TikTok Ad Library — Ad / Search", "description": "Fetch ad / search data from TikTok Ad Library. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok Ad Library" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok Ad Library", "name": "Ad / Search", "endpoint": "/v1/tiktok-ad-library/ad-search" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/google-ad-library/ad-advertiser-search-company-ads": { "get": { "operationId": "get_google_ad_library_ad_advertiser_search_company_ads", "summary": "Google Ad Library — Ad / Advertiser Search / Company Ads", "description": "Fetch ad / advertiser search / company ads data from Google Ad Library. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Google Ad Library" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Google Ad Library", "name": "Ad / Advertiser Search / Company Ads", "endpoint": "/v1/google-ad-library/ad-advertiser-search-company-ads" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkedin-ad-library/ad-search": { "get": { "operationId": "get_linkedin_ad_library_ad_search", "summary": "LinkedIn Ad Library — Ad / Search", "description": "Fetch ad / search data from LinkedIn Ad Library. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "LinkedIn Ad Library" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "LinkedIn Ad Library", "name": "Ad / Search", "endpoint": "/v1/linkedin-ad-library/ad-search" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok-shop/search-products-showcase": { "get": { "operationId": "get_tiktok_shop_search_products_showcase", "summary": "TikTok Shop — Search / Products / Showcase", "description": "Fetch search / products / showcase data from TikTok Shop. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok Shop" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok Shop", "name": "Search / Products / Showcase", "endpoint": "/v1/tiktok-shop/search-products-showcase" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/tiktok-shop/product-product-reviews": { "get": { "operationId": "get_tiktok_shop_product_product_reviews", "summary": "TikTok Shop — Product / Product Reviews", "description": "Fetch product / product reviews data from TikTok Shop. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "TikTok Shop" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "TikTok Shop", "name": "Product / Product Reviews", "endpoint": "/v1/tiktok-shop/product-product-reviews" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/seo/organic-serp": { "get": { "operationId": "get_seo_organic_serp", "summary": "SEO / Google — Organic SERP", "description": "Fetch organic serp data from SEO / Google. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.90 per 1,000 calls (0.6 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "SEO / Google" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.6 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "SEO / Google", "name": "Organic SERP", "endpoint": "/v1/seo/organic-serp" }, "mode": "sandbox", "credits_charged": 0.6, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.6 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/seo/keyword-difficulty-intent": { "get": { "operationId": "get_seo_keyword_difficulty_intent", "summary": "SEO / Google — Keyword Difficulty / Intent", "description": "Fetch keyword difficulty / intent data from SEO / Google. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.90 per 1,000 calls (0.6 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "SEO / Google" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.6 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "SEO / Google", "name": "Keyword Difficulty / Intent", "endpoint": "/v1/seo/keyword-difficulty-intent" }, "mode": "sandbox", "credits_charged": 0.6, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.6 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/seo/keyword-overview-relevant-pages": { "get": { "operationId": "get_seo_keyword_overview_relevant_pages", "summary": "SEO / Google — Keyword Overview / Relevant Pages", "description": "Fetch keyword overview / relevant pages data from SEO / Google. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.90 per 1,000 calls (0.6 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "SEO / Google" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.6 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "SEO / Google", "name": "Keyword Overview / Relevant Pages", "endpoint": "/v1/seo/keyword-overview-relevant-pages" }, "mode": "sandbox", "credits_charged": 0.6, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.6 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/seo/ranked-related-suggested-keywords": { "get": { "operationId": "get_seo_ranked_related_suggested_keywords", "summary": "SEO / Google — Ranked / Related / Suggested Keywords", "description": "Fetch ranked / related / suggested keywords data from SEO / Google. Returns normalized JSON with the fields teams need for analytics, monitoring and enrichment.\n\nPrice: $0.90 per 1,000 calls (0.6 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "SEO / Google" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 0.6 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "SEO / Google", "name": "Ranked / Related / Suggested Keywords", "endpoint": "/v1/seo/ranked-related-suggested-keywords" }, "mode": "sandbox", "credits_charged": 0.6, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 0.6 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/spotify/artist-album-track": { "get": { "operationId": "get_spotify_artist_album_track", "summary": "Spotify — Artist / Album / Track", "description": "Artist, album and track metadata from Spotify including popularity, release dates and audio details.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Spotify" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Spotify", "name": "Artist / Album / Track", "endpoint": "/v1/spotify/artist-album-track" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/spotify/playlist": { "get": { "operationId": "get_spotify_playlist", "summary": "Spotify — Playlist", "description": "Spotify playlist details with owner, follower count and the full ordered track list.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Spotify" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Spotify", "name": "Playlist", "endpoint": "/v1/spotify/playlist" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/spotify/podcast-episodes": { "get": { "operationId": "get_spotify_podcast_episodes", "summary": "Spotify — Podcast / Episodes", "description": "Spotify podcast show data and its episode list with descriptions, durations and publish dates.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Spotify" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Spotify", "name": "Podcast / Episodes", "endpoint": "/v1/spotify/podcast-episodes" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/spotify/search": { "get": { "operationId": "get_spotify_search", "summary": "Spotify — Search", "description": "Keyword search across Spotify artists, albums, tracks, playlists and podcasts.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Spotify" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Spotify", "name": "Search", "endpoint": "/v1/spotify/search" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/apple-music/artist-album-track": { "get": { "operationId": "get_apple_music_artist_album_track", "summary": "Apple Music — Artist / Album / Track", "description": "Apple Music artist, album and song metadata with artwork, genres and release information.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Apple Music" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Apple Music", "name": "Artist / Album / Track", "endpoint": "/v1/apple-music/artist-album-track" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/apple-music/search": { "get": { "operationId": "get_apple_music_search", "summary": "Apple Music — Search", "description": "Keyword search across Apple Music artists, albums, songs and playlists.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Apple Music" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Apple Music", "name": "Search", "endpoint": "/v1/apple-music/search" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/soundcloud/artist-tracks-track": { "get": { "operationId": "get_soundcloud_artist_tracks_track", "summary": "SoundCloud — Artist / Artist Tracks / Track", "description": "SoundCloud artist profiles, their uploaded tracks and individual track stats.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "SoundCloud" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "SoundCloud", "name": "Artist / Artist Tracks / Track", "endpoint": "/v1/soundcloud/artist-tracks-track" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/kick/clip": { "get": { "operationId": "get_kick_clip", "summary": "Kick — Clip", "description": "Kick clip details with streamer, title, view count, duration and video URL.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Kick" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Kick", "name": "Clip", "endpoint": "/v1/kick/clip" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linktree/page": { "get": { "operationId": "get_linktree_page", "summary": "Linktree — Page", "description": "Public Linktree page contents: avatar, bio and every outbound link in order.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Linktree" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Linktree", "name": "Page", "endpoint": "/v1/linktree/page" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/komi/page": { "get": { "operationId": "get_komi_page", "summary": "Komi — Page", "description": "Public Komi page contents: creator profile, socials and linked blocks.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Komi" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Komi", "name": "Page", "endpoint": "/v1/komi/page" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/pillar/page": { "get": { "operationId": "get_pillar_page", "summary": "Pillar — Page", "description": "Public Pillar page contents: creator profile, socials and linked blocks.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Pillar" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Pillar", "name": "Page", "endpoint": "/v1/pillar/page" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkbio/page": { "get": { "operationId": "get_linkbio_page", "summary": "Linkbio — Page", "description": "Public Linkbio page contents: profile details and all listed links.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Linkbio" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Linkbio", "name": "Page", "endpoint": "/v1/linkbio/page" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/linkme/profile": { "get": { "operationId": "get_linkme_profile", "summary": "Linkme — Profile", "description": "Public Linkme profile with bio, socials and outbound links.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Linkme" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Linkme", "name": "Profile", "endpoint": "/v1/linkme/profile" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } }, "/v1/amazon-shop/storefront": { "get": { "operationId": "get_amazon_shop_storefront", "summary": "Amazon Shop — Storefront", "description": "A creator's Amazon storefront page: avatar, bio, socials, product lists and trending picks.\n\nPrice: $1.50 per 1,000 calls (1 credits per successful call, one credit = $0.0015). Failed calls are not charged.", "tags": [ "Amazon Shop" ], "parameters": [ { "name": "target", "in": "query", "required": true, "description": "The subject of the lookup — a username, URL, ID or search term, depending on the service.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return for list-shaped responses.", "schema": { "type": "integer", "default": 10, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. 1 credits are charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "service": { "type": "object", "properties": { "platform": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "type": "string" } } }, "mode": { "type": "string", "enum": [ "sandbox", "live" ] }, "credits_charged": { "type": "number" }, "credits_remaining": { "type": "number" }, "latency_ms": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "success", "service", "credits_charged", "data" ] }, "example": { "success": true, "service": { "platform": "Amazon Shop", "name": "Storefront", "endpoint": "/v1/amazon-shop/storefront" }, "mode": "sandbox", "credits_charged": 1, "credits_remaining": 99, "latency_ms": 142, "data": {} } } } }, "400": { "description": "The `target` parameter is missing. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "missing_target", "message": "The `target` parameter is required.", "status": 400 } } } } }, "401": { "description": "Missing or unrecognized API key. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "invalid_api_key", "message": "This API key is not recognised.", "status": 401 } } } } }, "402": { "description": "Not enough credits for this call. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "insufficient_credits", "message": "This call costs 1 credits and your balance is lower than that. Top up to continue.", "status": 402 } } } } }, "403": { "description": "The key is revoked or the account is suspended. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "account_suspended", "message": "This account is suspended. Contact support.", "status": 403 } } } } }, "429": { "description": "The key reached its monthly call cap. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "monthly_cap_reached", "message": "This key reached its monthly call cap.", "status": 429 } } } } }, "500": { "description": "Upstream request failed. Not charged.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "code", "message", "status" ] } }, "required": [ "error" ] }, "example": { "error": { "code": "upstream_error", "message": "Upstream request failed. No credits were charged.", "status": 500 } } } } } } } } } }