{ "openapi": "3.1.0", "info": { "title": "YepAPI", "version": "1.0.0", "description": "Unified developer API — one key for SEO, SERP, web scraping, AI chat, AI media, YouTube, TikTok, Instagram, and Amazon data. Spec generated from the docs.", "contact": { "url": "https://yepapi.com" } }, "servers": [ { "url": "https://api.yepapi.com", "description": "Production" } ], "security": [ { "apiKey": [] } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "const": false }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } }, "required": [ "ok", "error" ] } } }, "paths": { "/v1/ai/chat": { "post": { "operationId": "aiChat", "summary": "GLM 5", "description": "Zhipu's general-purpose model. Reliable performance for a wide range of tasks with competitive pricing. Cost: $0.01/call.", "tags": [ "AI" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "description": "Model ID (e.g. z-ai/glm-5)" }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Array of { role, content } objects" }, "maxTokens": { "type": "number", "description": "Maximum tokens in the response" }, "temperature": { "type": "number", "description": "Sampling temperature (0.0–2.0)", "default": 1 }, "topP": { "type": "number", "description": "Nucleus sampling threshold", "default": 1 }, "frequencyPenalty": { "type": "number", "description": "Penalize repeated tokens", "default": 0 }, "presencePenalty": { "type": "number", "description": "Penalize tokens already present", "default": 0 }, "stream": { "type": "boolean", "description": "Enable SSE streaming", "default": false } }, "required": [ "model", "messages" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "model": "z-ai/glm-5", "message": { "role": "assistant", "content": "Subject: Re: Meeting Invitation\n\nThank you for the invitation. Unfortunately, I have a prior commitment at that time and won't be able to attend. I'd appreciate it if you could share the meeting notes afterward." }, "usage": { "promptTokens": 14, "completionTokens": 96, "totalTokens": 110 } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ai/chat/completions": { "post": { "operationId": "aiChatCompletions", "summary": "Chat Completions", "description": "Unified endpoint for 70+ LLM models. OpenAI-compatible drop-in replacement — just change the base URL. Cost: $0.01/call.", "tags": [ "AI" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ai/models": { "get": { "operationId": "aiModels", "summary": "List AI Models", "description": "List all available chat models with pricing and metadata. Free.", "tags": [ "AI" ], "responses": { "200": { "description": "Model catalog", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/v1/amazon/best-sellers": { "post": { "operationId": "amazonBestSellers", "summary": "Best Sellers", "description": "Get Amazon's best sellers, hot new releases, or most-wished-for items for any category. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "string", "description": "Amazon leaf category slug (e.g. software, home-garden) — see /v1/amazon/categories" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" }, "type": { "type": "string", "description": "BEST_SELLERS, HOT_NEW_RELEASES, HIGH_RATED", "default": "BEST_SELLERS" }, "page": { "type": "number", "description": "Page number (50 items/page)", "default": 1 } }, "required": [ "category" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "ccb92b08-2845-4f7d-a2c5-aa9ef0bd5e85", "parameters": { "country": "US", "type": "BEST_SELLERS", "page": 1, "category": "software" }, "data": { "best_sellers": [ { "rank": 1, "asin": "B0FWV56H48", "product_title": "TurboTax Deluxe Desktop Edition 2025, Federal & State Tax Return [Win11/Mac14 Download]", "product_price": "$79.99", "product_star_rating": "3.7", "product_num_ratings": 4969, "product_url": "https://www.amazon.com/dp/B0FWV56H48", "product_photo": "https://images-na.ssl-images-amazon.com/images/I/71OcM906MLL._AC_UL900_SR900,600_.jpg", "rank_change_label": null }, { "rank": 2, "asin": "B0FRPW868X", "product_title": "H&R Block Tax Software Deluxe + State 2025 Win/Mac", "product_price": "$49.97", "product_star_rating": "3.8", "product_num_ratings": 2300, "product_url": "https://www.amazon.com/dp/B0FRPW868X", "product_photo": "https://images-na.ssl-images-amazon.com/images/I/611uM-FzipL._AC_UL900_SR900,600_.jpg", "rank_change_label": null } ] } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/categories": { "post": { "operationId": "amazonCategories", "summary": "Categories", "description": "List all Amazon top-level browse categories and their IDs for a given country. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "e2a81e08-6840-48e0-b793-8490cd956386", "parameters": { "country": "US" }, "data": [ { "name": "All Departments", "id": "aps" }, { "name": "Alexa Skills", "id": "alexa-skills" }, { "name": "Amazon Devices", "id": "amazon-devices" }, { "name": "Appliances", "id": "appliances" }, { "name": "Baby", "id": "baby-products" }, { "name": "Beauty & Personal Care", "id": "beauty" }, { "name": "Books", "id": "stripbooks" }, { "name": "Cell Phones & Accessories", "id": "mobile" }, { "name": "Clothing, Shoes & Jewelry", "id": "fashion" }, { "name": "Electronics", "id": "electronics" }, { "name": "Home & Kitchen", "id": "garden" }, { "name": "Software", "id": "software" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/deals": { "post": { "operationId": "amazonDeals", "summary": "Deals", "description": "Get current Amazon deals with price, discount, rating, and category filters. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" }, "page": { "type": "number", "description": "Page number (30 deals/page)", "default": 1 }, "price_range": { "type": "string", "description": "Filter like ALL, UNDER_25, 25_50, 50_100, OVER_100", "default": "ALL" }, "discount_range": { "type": "string", "description": "ALL, 10_OFF, 25_OFF, 50_OFF, 70_OFF", "default": "ALL" }, "deal_type": { "type": "string", "description": "e.g. BEST_DEAL, LIGHTNING_DEAL" }, "category": { "type": "string", "description": "Amazon category slug" }, "min_rating": { "type": "string", "description": "Minimum star rating filter" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "01ad1c29-5bf1-4f80-b321-009f1a64fa4e", "parameters": { "country": "US", "price_range": "ALL", "discount_range": "ALL" }, "data": { "deals": [ { "deal_id": "64fc3cf8", "deal_type": "BEST_DEAL", "deal_title": "Ring Battery Doorbell, Head-to-Toe Video, Live View with Two-Way Talk", "deal_photo": "https://m.media-amazon.com/images/I/51IswCEoJXL.jpg", "deal_state": "AVAILABLE", "deal_url": "https://www.amazon.com/Ring-Battery-Doorbell/dp/B0BZWRSRWV", "canonical_deal_url": "https://www.amazon.com/deal/64fc3cf8", "deal_starts_at": null, "deal_ends_at": null, "deal_price": { "amount": 59.99, "currency": "USD" }, "list_price": { "amount": 99.99, "currency": "USD" }, "savings_percentage": 40, "savings_amount": { "amount": 40, "currency": "USD" }, "deal_badge": "40% off", "type": "MULTI_ASIN", "product_asin": "B0BZWRSRWV" } ] } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/influencer": { "post": { "operationId": "amazonInfluencer", "summary": "Influencer Profile", "description": "Get Amazon Live / Amazon Storefront metadata for an influencer by username. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "influencer_name": { "type": "string", "description": "Influencer's Amazon username (part after /shop/)" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" } }, "required": [ "influencer_name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "d245f5ee-8ca3-488e-9224-69336c6245fd", "parameters": { "influencer_name": "amazonhaul", "country": "US" }, "data": { "name": null, "country": "US", "domain": "www.amazon.com", "profile_link": "https://www.amazon.com/shop/amazonhaul", "affiliate_status": null, "has_curations": false } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/product": { "post": { "operationId": "amazonProduct", "summary": "Product Details", "description": "Get full product details for any Amazon ASIN — title, description, images, pricing, offer box, and specs. Cost: $0.02/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number (e.g. B07ZPKBL9V)" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" } }, "required": [ "asin" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "56ba58ed-368d-4cf5-8322-6e34a7d0e3d6", "parameters": { "asin": "B07ZPKBL9V", "country": "US" }, "data": { "asin": "B07ZPKBL9V", "product_title": "Apple iPhone 11, 64GB, PRODUCT RED - Unlocked (Renewed)", "product_price": "169.00", "product_original_price": "$174.64", "delivery_price": "FREE", "currency": "USD", "country": "US", "domain": "www.amazon.com", "product_byline": "Visit the Amazon Renewed Store", "product_star_rating": "4.2", "product_num_ratings": 59992, "product_url": "https://www.amazon.com/dp/B07ZPKBL9V", "product_photo": "https://m.media-amazon.com/images/I/514k7uOBMwL._AC_SL1000_.jpg", "product_num_offers": 33, "product_availability": "Only 16 left in stock - order soon.", "product_condition": "Refurbished - Excellent", "offer_box_title": "Refurbished - Good", "offer_box_price": "$159.00", "is_best_seller": false, "is_amazon_choice": false, "is_prime": false, "sales_volume": "200+ bought in past month", "about_product": [ "Unlocked and compatible with any carrier of choice on GSM and CDMA networks.", "Tested for battery health and guaranteed minimum 80% capacity.", "Passed a full diagnostic test ensuring like-new functionality." ], "product_description": "The iPhone 11 features a 6.1-inch LCD 'Liquid Retina HD Display' at 326ppi with True Tone and wide color support.", "product_information": { "Operating System": "iOS 16", "RAM Memory Installed": "4 GB", "Memory Storage Capacity": "64 GB", "Color": "(PRODUCT) RED", "Form Factor": "Smartphone" } } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/product-offers": { "post": { "operationId": "amazonProductOffers", "summary": "Product Offers", "description": "Get all third-party seller offers for any Amazon ASIN, including price, condition, and shipping. Cost: $0.02/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon ASIN" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" }, "limit": { "type": "number", "description": "Max offers (1–100)", "default": 100 }, "page": { "type": "number", "description": "Page number", "default": 1 }, "product_condition": { "type": "string", "description": "ALL, NEW, USED, RENEWED, COLLECTIBLE", "default": "ALL" } }, "required": [ "asin" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "c9845825-48ba-4503-8890-ad17805df07c", "parameters": { "asin": "B07ZPKBL9V", "country": "US", "limit": 100, "page": 1 }, "data": { "asin": "B07ZPKBL9V", "product_title": "Apple iPhone 11, 64GB, PRODUCT RED - Unlocked (Renewed)", "product_price": "169.00", "product_original_price": "$174.64", "delivery_price": "FREE", "currency": "USD", "country": "US", "domain": "www.amazon.com", "product_byline": "Visit the Amazon Renewed Store", "product_star_rating": "4.2", "product_num_ratings": 59992, "product_url": "https://www.amazon.com/dp/B07ZPKBL9V", "product_num_offers": 33, "product_availability": "Only 16 left in stock - order soon.", "product_condition": "Refurbished - Excellent", "is_prime": false, "buy_boxes": [], "sales_volume": "200+ bought in past month" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/product-reviews": { "post": { "operationId": "amazonProductReviews", "summary": "Product Reviews", "description": "Get customer reviews for any Amazon product with star filters, verified-purchase filter, and pagination. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon ASIN" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" }, "sort_by": { "type": "string", "description": "TOP_REVIEWS or MOST_RECENT", "default": "TOP_REVIEWS" }, "star_rating": { "type": "string", "description": "ALL, 5_STARS, 4_STARS, 3_STARS, 2_STARS, 1_STARS, POSITIVE, CRITICAL", "default": "ALL" }, "verified_purchases_only": { "type": "boolean", "description": "Only verified purchasers", "default": false }, "images_or_videos_only": { "type": "boolean", "description": "Only reviews with media", "default": false }, "current_format_only": { "type": "boolean", "description": "Only reviews for the current format/variation", "default": false }, "page": { "type": "number", "description": "Page number (7 reviews/page)", "default": 1 } }, "required": [ "asin" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "272b8277-8deb-46c3-99ff-1948bcc081d8", "parameters": { "asin": "B07ZPKBL9V", "sort_by": "TOP_REVIEWS", "star_rating": "ALL", "page": 1 }, "data": { "asin": "B07ZPKBL9V", "country": "US", "domain": "www.amazon.com", "total_ratings": 59992, "rating_distribution": { "1": 11, "2": 3, "3": 5, "4": 12, "5": 69 }, "reviews": [ { "review_id": "RY89LJI770S2T", "review_title": "Great price", "review_comment": "Perfect replacement for my 13 year old daughter. Works perfectly.", "review_star_rating": "5", "review_link": "https://www.amazon.com/gp/customer-reviews/RY89LJI770S2T", "review_author": "JEKurtz", "review_author_avatar": "https://m.media-amazon.com/images/S/amazon-avatars-global/default.png", "review_images": [], "review_video": null, "review_date": "Reviewed in the United States on March 8, 2026", "is_verified_purchase": true, "helpful_vote_statement": "5 people found this helpful", "reviewed_product_asin": "B07ZPKBL9V", "reviewed_product_variant": { "Size": "64GB", "Color": "White", "Service provider": "Unlocked", "Product grade": "Renewed" }, "is_vine": false } ] } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/products-by-category": { "post": { "operationId": "amazonProductsByCategory", "summary": "Products by Category", "description": "List Amazon products under any category node ID with filters for sort, price, and Prime. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_id": { "type": "string", "description": "Amazon category browse-node ID (numeric)" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" }, "sort_by": { "type": "string", "description": "RELEVANCE, LOWEST_PRICE, HIGHEST_PRICE, REVIEWS, NEWEST, BEST_SELLERS", "default": "RELEVANCE" }, "product_condition": { "type": "string", "description": "ALL, NEW, USED, RENEWED, COLLECTIBLE", "default": "ALL" }, "page": { "type": "number", "description": "Page number (48 products/page)", "default": 1 }, "is_prime": { "type": "boolean", "description": "Only Prime-eligible" }, "deals_and_discounts": { "type": "string", "description": "Discount filter" } }, "required": [ "category_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "6dc35479-a1dc-45d4-828d-978ec94ebe61", "parameters": { "category_id": "2478868012", "country": "US", "sort_by": "RELEVANCE", "page": 1 }, "data": { "total_products": 975521, "country": "US", "domain": "www.amazon.com", "products": [ { "asin": "168281808X", "product_title": "Untitled Empyrean (Not Book Four)", "product_price": "$17.49", "product_original_price": "$24.99", "currency": "USD", "product_star_rating": null, "product_num_ratings": 0, "book_format": "Hardcover", "product_url": "https://www.amazon.com/dp/168281808X", "product_photo": "https://m.media-amazon.com/images/I/716ogrQC-4L._AC_UL960_QL65_.jpg", "product_num_offers": 1, "product_minimum_offer_price": "$17.49", "is_best_seller": false, "is_amazon_choice": false, "is_prime": false, "has_variations": false } ] } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/search": { "post": { "operationId": "amazonSearch", "summary": "Search", "description": "Search Amazon for products by keyword with filters for price, rating, Prime, and deals. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search keywords" }, "page": { "type": "number", "description": "Page number (1-based)", "default": 1 }, "country": { "type": "string", "description": "ISO alpha-2 country code (US, GB, DE, CA, AU, IN, JP, FR, IT, ES, etc.)", "default": "US" }, "sort_by": { "type": "string", "description": "RELEVANCE, LOWEST_PRICE, HIGHEST_PRICE, REVIEWS, NEWEST, BEST_SELLERS", "default": "RELEVANCE" }, "product_condition": { "type": "string", "description": "ALL, NEW, USED, RENEWED, COLLECTIBLE", "default": "ALL" }, "is_prime": { "type": "boolean", "description": "Only return Prime-eligible products" }, "deals_and_discounts": { "type": "string", "description": "Filter for discount tiers (e.g. ALL_DISCOUNTS)" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "15a2016d-c6a2-4b15-ab0b-7764d1cd25c1", "parameters": { "query": "Phone", "country": "US", "sort_by": "RELEVANCE", "page": 1 }, "data": { "total_products": 135961, "country": "US", "domain": "www.amazon.com", "products": [ { "asin": "B0DM1S54MZ", "product_title": "Samsung Galaxy A16 4G LTE (128GB + 4GB) International Model, Unlocked, 6.7\", 50MP Triple Camera, Black", "product_price": "$133.47", "product_original_price": null, "currency": "USD", "product_star_rating": "4.4", "product_num_ratings": 4084, "product_url": "https://www.amazon.com/dp/B0DM1S54MZ", "product_photo": "https://m.media-amazon.com/images/I/61Lp1UcxeLL._AC_UY654_QL65_.jpg", "product_num_offers": 12, "product_minimum_offer_price": "$126.80", "is_best_seller": false, "is_amazon_choice": true, "is_prime": false, "sales_volume": "4K+ bought in past month", "has_variations": true } ] } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/seller": { "post": { "operationId": "amazonSeller", "summary": "Seller Profile", "description": "Get a third-party Amazon seller's profile — name, business info, ratings, and review breakdown. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "seller_id": { "type": "string", "description": "Amazon seller ID (e.g. A02211013Q5HP3OMSZC7W)" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" } }, "required": [ "seller_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "01a5448d-6d26-4beb-a352-ff8eb99205f9", "parameters": { "seller_id": "A02211013Q5HP3OMSZC7W", "country": "US" }, "data": { "seller_id": "A02211013Q5HP3OMSZC7W", "country": "US", "domain": "www.amazon.com", "name": "MemoryWhiz", "seller_link": "https://www.amazon.com/sp?seller=A02211013Q5HP3OMSZC7W", "store_link": "https://www.amazon.com/s?ie=UTF8&marketplaceID=ATVPDKIKX0DER&me=A02211013Q5HP3OMSZC7W", "logo": "https://m.media-amazon.com/images/I/01inXJbpK2L.gif", "phone": "909-610-9170", "business_name": "Alast Corporation", "business_address": "20651 GOLDEN SPRINGS DRIVE Suite 111 Walnut CA 91789 US", "rating": 4.9, "ratings_total": 52177, "ratings_total_percentage": 99, "review_summary": { "thirty_days": { "positive_percent": 94, "neutral_percent": 4, "negative_percent": 2, "count": 45 }, "ninety_days": { "positive_percent": 97, "neutral_percent": 1, "negative_percent": 2, "count": 183 }, "twelve_months": { "positive_percent": 100, "neutral_percent": 0, "negative_percent": 0, "count": 1107 }, "lifetime": { "positive_percent": 99, "neutral_percent": 0, "negative_percent": 0, "count": 52177 } } } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/amazon/seller-reviews": { "post": { "operationId": "amazonSellerReviews", "summary": "Seller Reviews", "description": "Get reviews for a third-party Amazon seller with star-rating and verified-purchase filters. Cost: $0.01/call.", "tags": [ "Amazon" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "seller_id": { "type": "string", "description": "Amazon seller ID" }, "country": { "type": "string", "description": "ISO alpha-2 country code", "default": "US" }, "page": { "type": "number", "description": "Page number (5 reviews/page)", "default": 1 }, "star_rating": { "type": "string", "description": "ALL, 5_STARS, 4_STARS, 3_STARS, 2_STARS, 1_STARS, POSITIVE, CRITICAL", "default": "ALL" }, "verified_purchases_only": { "type": "boolean", "description": "Only verified purchasers", "default": false } }, "required": [ "seller_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "request_id": "6c2f60f0-2322-4d79-9b82-a4a87e64b44d", "parameters": { "seller_id": "A02211013Q5HP3OMSZC7W", "country": "US", "page": 1, "star_rating": "ALL" }, "data": { "seller_id": "A02211013Q5HP3OMSZC7W", "country": "US", "domain": "www.amazon.com", "has_next_page": true, "seller_reviews": [ { "review_author": "Vadim p", "review_comment": "I love this product and its smell. But this particular refill is a huge disappointment. The original had strong, lasting smell for weeks. These refills are DOA — all I get is aftersmell.", "review_star_rating": 1, "has_response": false, "review_date": "April 24, 2026" }, { "review_author": "Skye c.", "review_comment": "Came on time and not damaged", "review_star_rating": 5, "has_response": false, "review_date": "April 24, 2026" } ] } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/author-finder": { "post": { "operationId": "emailAuthorFinder", "summary": "Author Finder", "description": "Find the email address of the author behind any article or blog post URL. Cost: $0.02/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the article or blog post to find the author of" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "contact": { "acceptAll": false, "company": null, "companyDomain": null, "confidenceScore": 0, "country": null, "department": null, "disposable": false, "email": null, "firstName": null, "fullName": null, "gender": null, "hasPhone": false, "lastName": null, "linkedin": null, "position": null, "seniority": null, "sources": [], "twitter": null, "type": null, "verificationStatus": null, "verified": false, "webmail": false } }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/combined": { "post": { "operationId": "emailCombined", "summary": "Combined Enrichment", "description": "Get a structured person profile and full company profile from a single email address in one call. Cost: $0.04/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to enrich" } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "company": { "category": { "industry": null, "naicsCode": "51", "sector": null, "sicCode": "73" }, "description": "stripe is a payment processing platform enabling businesses to accept payments and manage online transactions.", "domain": "stripe.com", "emails": [ "jordan@stripe.com", "support@stripe.com", "jobs@stripe.com", "sales@stripe.com", "recruiting@stripe.com", "nick@stripe.com" ], "foundedYear": "2010", "geo": { "city": "San Francisco", "country": "United States", "countryCode": "US", "postalCode": "94107", "state": "California", "streetAddress": "354 oyster point blvd" }, "legalName": "Stripe", "logo": null, "metrics": { "employees": "5K-10K", "employeesRange": null, "estimatedAnnualRevenue": "$100M-$250M" }, "name": "Stripe", "phones": null, "social": { "facebook": "stripehq", "linkedin": "stripe", "twitter": "stripe" } }, "person": { "bio": null, "email": "matthew.yalowitz@stripe.com", "employment": { "company": "Stripe", "domain": "stripe.com", "role": null, "seniority": null, "title": null }, "firstName": "Matthew", "fullName": "Matthew Yalowitz", "gender": "male", "geo": { "city": null, "country": "United States", "countryCode": "US", "state": null }, "lastName": "Yalowitz", "location": "US", "social": { "facebook": null, "github": null, "linkedin": "https://www.linkedin.com/in/myalowitz", "twitter": null } } }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/company": { "post": { "operationId": "emailCompany", "summary": "Company Enrichment", "description": "Turn a domain into a structured company profile — industry codes, location, size, revenue, emails, and social handles. Cost: $0.03/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain to enrich (e.g., stripe.com)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "company": { "category": { "industry": null, "naicsCode": "51", "sector": null, "sicCode": "73" }, "description": "stripe is a payment processing platform enabling businesses to accept payments and manage online transactions.", "domain": "stripe.com", "emails": [ "jordan@stripe.com", "support@stripe.com", "jobs@stripe.com", "sales@stripe.com", "recruiting@stripe.com", "nick@stripe.com" ], "foundedYear": "2010", "geo": { "city": "San Francisco", "country": "United States", "countryCode": "US", "postalCode": "94107", "state": "California", "streetAddress": "354 oyster point blvd" }, "legalName": "Stripe", "logo": null, "metrics": { "employees": "5K-10K", "employeesRange": null, "estimatedAnnualRevenue": "$100M-$250M" }, "name": "Stripe", "phones": null, "social": { "facebook": "stripehq", "linkedin": "stripe", "twitter": "stripe" } } }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/count": { "post": { "operationId": "emailCount", "summary": "Email Count", "description": "Get the number of email addresses available for a domain, broken down by department and seniority. Cost: $0.01/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to count emails for (e.g., stripe.com)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "byDepartment": { "accounting": 27, "administrative": 14, "communication": 14, "diversity": 2, "education": 6, "engineering": 284, "executive": 112, "facilities": 2, "finance": 119, "healthcare": 0, "hr": 81, "it": 102, "legal": 39, "management": 259, "marketing": 166, "operations": 159, "pr": 13, "sales": 222, "security": 72, "software": 584, "support": 87, "warehouse": 83 }, "bySeniority": { "executive": 75, "junior": 55, "senior": 307 }, "genericEmails": 213, "personalEmails": 4852, "total": 5065 }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/domain-search": { "post": { "operationId": "emailDomainSearch", "summary": "Domain Search", "description": "Find every email address on a company domain — names, positions, departments, confidence scores, plus a full company profile. Cost: $0.03/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain to search (e.g., stripe.com). Required unless company is provided." }, "company": { "type": "string", "description": "Company name to search instead of a domain" }, "limit": { "type": "number", "description": "Number of emails to return: 10, 20, or 50", "default": 10 }, "page": { "type": "number", "description": "Page number for pagination", "default": 1 }, "department": { "type": "string", "description": "Filter results by department (e.g., engineering, sales)" }, "country": { "type": "string", "description": "Filter results by ISO country code (e.g., US)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "company": { "acceptAll": true, "description": "stripe is a payment processing platform enabling businesses to accept payments and manage online transactions.", "domain": "stripe.com", "emailPattern": "{first}", "founded": "2010", "industry": "Information Technology and Services", "location": { "address": "354 oyster point blvd", "city": "San Francisco", "country": "US", "postalCode": "94107", "state": "California" }, "name": "Stripe", "revenue": "$100M-$250M", "size": "5K-10K", "social": { "facebook": "https://www.facebook.com/stripehq", "github": "https://www.github.com/stripe", "instagram": null, "linkedin": "https://www.linkedin.com/company/stripe", "twitter": "https://twitter.com/stripe", "youtube": null }, "type": "privately held" }, "emails": [ { "acceptAll": false, "company": null, "companyDomain": null, "confidenceScore": 51, "country": "US", "department": null, "disposable": false, "email": "matthew.yalowitz@stripe.com", "firstName": "Matthew", "fullName": "Matthew Yalowitz", "gender": "male", "hasPhone": true, "lastName": "Yalowitz", "linkedin": "https://www.linkedin.com/in/myalowitz", "position": null, "seniority": null, "sources": [], "twitter": null, "type": "personal", "verificationStatus": null, "verified": false, "webmail": false } ], "total": 5065 }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/domain-status": { "post": { "operationId": "emailDomainStatus", "summary": "Domain Status", "description": "Check whether a domain is webmail, disposable, catch-all, or gibberish before you trust its email addresses. Cost: $0.01/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to check (e.g., stripe.com)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "acceptAll": false, "disposable": false, "domain": "stripe.com", "gibberish": false, "webmail": false }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/enrich": { "post": { "operationId": "emailEnrich", "summary": "Email Enrichment", "description": "Turn any email address into a full contact profile — name, company, location, social links, and verification status. Cost: $0.02/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to enrich" } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "contact": { "acceptAll": true, "company": "Stripe", "companyDomain": "stripe.com", "confidenceScore": 26, "country": "US", "department": null, "disposable": false, "email": "matthew.yalowitz@stripe.com", "firstName": "Matthew", "fullName": "Matthew Yalowitz", "gender": "male", "hasPhone": true, "lastName": "Yalowitz", "linkedin": "https://www.linkedin.com/in/myalowitz", "position": null, "seniority": null, "sources": [], "twitter": null, "type": "personal", "verificationStatus": "invalid", "verified": false, "webmail": false } }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/finder": { "post": { "operationId": "emailFinder", "summary": "Email Finder", "description": "Find a person's professional email address from their name and company domain, with a verified confidence score. Cost: $0.02/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain to search on (e.g., stripe.com)" }, "first_name": { "type": "string", "description": "First name of the person" }, "last_name": { "type": "string", "description": "Last name of the person" }, "full_name": { "type": "string", "description": "Full name, as an alternative to first/last name" }, "company": { "type": "string", "description": "Company name, used to help disambiguate" } }, "required": [ "domain", "first_name", "last_name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "contact": { "acceptAll": true, "company": "Stripe", "companyDomain": "stripe.com", "confidenceScore": 99, "country": null, "department": null, "disposable": false, "email": "patrick@stripe.com", "firstName": "Patrick", "fullName": "Patrick Collison", "gender": null, "hasPhone": false, "lastName": "Collison", "linkedin": null, "position": null, "seniority": null, "sources": [], "twitter": null, "type": null, "verificationStatus": "valid", "verified": true, "webmail": false } }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/format": { "post": { "operationId": "emailFormat", "summary": "Email Pattern", "description": "Discover the most common email address patterns used by a company domain, with usage percentages. Cost: $0.01/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to detect email patterns for (e.g., stripe.com)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "patterns": [ { "pattern": "{last}", "percentage": 2 }, { "pattern": "{first}.{last}", "percentage": 9 }, { "pattern": "{f}{l}", "percentage": 2 }, { "pattern": "{first}", "percentage": 64 }, { "pattern": "{f}{last}", "percentage": 23 } ] }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/linkedin-finder": { "post": { "operationId": "emailLinkedinFinder", "summary": "LinkedIn Finder", "description": "Find a verified email address from any LinkedIn profile URL, with position, company, and source data. Cost: $0.02/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "LinkedIn profile URL (e.g., https://www.linkedin.com/in/username)" }, "full": { "type": "boolean", "description": "Return the full contact profile including sources", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "contact": { "acceptAll": true, "company": "Stripe", "companyDomain": "stripe.com", "confidenceScore": 100, "country": "US", "department": "marketing", "disposable": false, "email": "patrick@stripe.com", "firstName": "Patrick", "fullName": "Patrick Collison", "gender": "male", "hasPhone": true, "lastName": "Collison", "linkedin": "https://www.linkedin.com/in/patrickcollison", "position": "social media marketing manager", "seniority": null, "sources": [ { "domain": "microconf.gen.co", "firstSeen": "2021-01-30T22:46:21+01:00", "lastSeen": "2021-02-02T16:51:05+01:00" }, { "domain": "microconf.gen.co", "firstSeen": "2021-01-30T22:46:22+01:00", "lastSeen": "2021-02-02T16:51:06+01:00" }, { "domain": "microconf.gen.co", "firstSeen": "2021-01-30T22:46:35+01:00", "lastSeen": "2021-02-02T16:51:09+01:00" }, { "domain": "patrickcollison.com", "firstSeen": "2021-01-30T23:24:37+01:00", "lastSeen": "2023-10-24T11:31:14+02:00" }, { "domain": "patrickcollison.com", "firstSeen": "2021-01-30T23:24:37+01:00", "lastSeen": "2023-10-24T11:31:14+02:00" }, { "domain": "paganresearch.io", "firstSeen": "2021-01-29T19:15:40+01:00", "lastSeen": "2024-12-18T15:19:56+01:00" }, { "domain": "app.cxoreach.com", "firstSeen": "2021-05-17T16:30:01+02:00", "lastSeen": "2024-12-18T15:37:43+01:00" }, { "domain": "offerdos.com", "firstSeen": "2021-06-13T08:37:39+02:00", "lastSeen": "2021-06-13T22:58:27+02:00" }, { "domain": "docs.google.com", "firstSeen": "2021-07-21T18:23:55+02:00", "lastSeen": "2021-10-03T00:25:39+02:00" }, { "domain": "docs.betteruptime.com", "firstSeen": "2021-12-22T14:48:43+01:00", "lastSeen": "2022-01-23T18:15:58+01:00" }, { "domain": "web.archive.org", "firstSeen": "2022-03-26T10:01:30+01:00", "lastSeen": "2022-03-28T20:44:26+02:00" }, { "domain": "web.archive.org", "firstSeen": "2022-03-26T10:03:52+01:00", "lastSeen": "2022-03-28T20:44:30+02:00" }, { "domain": "functional.tools", "firstSeen": "2023-09-17T14:07:44+02:00", "lastSeen": "2023-10-24T20:54:56+02:00" }, { "domain": "patrickcollison.com", "firstSeen": "2024-09-17T01:10:47+02:00", "lastSeen": "2024-11-29T15:39:14+01:00" }, { "domain": "deliverabilityguide.com", "firstSeen": "2024-09-20T03:54:56+02:00", "lastSeen": "2024-12-21T12:32:03+01:00" }, { "domain": "www.surviving-tomorrow.com", "firstSeen": "2025-02-13T17:15:18+01:00", "lastSeen": "2025-03-08T11:27:22+01:00" }, { "domain": "www.surviving-tomorrow.com", "firstSeen": "2025-02-13T16:52:51+01:00", "lastSeen": "2025-03-08T12:49:52+01:00" } ], "twitter": "https://twitter.com/patrickc", "type": "personal", "verificationStatus": "valid", "verified": true, "webmail": false } }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/locations": { "post": { "operationId": "emailLocations", "summary": "Employee Locations", "description": "See where a company's employees are located — email contact counts broken down by country. Cost: $0.01/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Company domain to get employee locations for (e.g., stripe.com)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "locations": [ { "count": 4, "country": "IN" }, { "count": 1, "country": "HK" }, { "count": 2, "country": "NL" }, { "count": 1, "country": "GH" }, { "count": 1, "country": "MY" }, { "count": 116, "country": "IE" }, { "count": 16, "country": "GB" }, { "count": 2, "country": "ES" }, { "count": 4, "country": "DE" }, { "count": 1, "country": "SE" }, { "count": 10, "country": "AU" }, { "count": 16, "country": "CA" }, { "count": 9, "country": "FR" }, { "count": 4015, "country": "us" }, { "count": 1, "country": "NO" }, { "count": 1, "country": "IT" }, { "count": 4015, "country": "US" }, { "count": 7, "country": "JP" }, { "count": 1, "country": "JM" }, { "count": 1, "country": "TW" }, { "count": 17, "country": "SG" }, { "count": 1, "country": "PH" } ] }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/person": { "post": { "operationId": "emailPerson", "summary": "Person Enrichment", "description": "Turn an email address into a structured person profile — name, employment, location, and social handles. Cost: $0.03/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address of the person to enrich" } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "person": { "bio": null, "email": "matthew.yalowitz@stripe.com", "employment": { "company": "Stripe", "domain": "stripe.com", "role": null, "seniority": null, "title": null }, "firstName": "Matthew", "fullName": "Matthew Yalowitz", "gender": "male", "geo": { "city": null, "country": "United States", "countryCode": "US", "state": null }, "lastName": "Yalowitz", "location": "US", "social": { "facebook": null, "github": null, "linkedin": "https://www.linkedin.com/in/myalowitz", "twitter": null } } }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/phone-finder": { "post": { "operationId": "emailPhoneFinder", "summary": "Phone Finder", "description": "Find a contact's phone number from an email address, domain, or LinkedIn profile — with formats, line type, and timezone. Cost: $0.05/call.", "tags": [ "Other" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to find a phone number for" }, "domain": { "type": "string", "description": "Company domain to find a phone number for" }, "linkedin": { "type": "string", "description": "LinkedIn profile URL to find a phone number for" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "carrier": null, "countryCode": "US", "domain": "stripe.com", "e164Format": "+13015882564", "email": "matthew.yalowitz@stripe.com", "intlFormat": "+1 301-588-2564", "lineType": "FIXED_LINE_OR_MOBILE", "localFormat": "(301) 588-2564", "timezones": [ "America/New_York" ], "valid": true }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/phone-validator": { "post": { "operationId": "emailPhoneValidator", "summary": "Phone Validator", "description": "Validate and normalize any phone number — E.164, international, and local formats plus line type and timezone. Cost: $0.01/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "description": "Phone number to validate, in any common format" }, "country_code": { "type": "string", "description": "ISO country code hint for numbers without an international prefix (e.g., US)" } }, "required": [ "phone" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "carrier": null, "countryCode": "US", "e164Format": "+14155550132", "intlFormat": "+1 415-555-0132", "lineType": "FIXED_LINE_OR_MOBILE", "localFormat": "(415) 555-0132", "timezones": [ "America/Los_Angeles" ], "valid": true }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/similar": { "post": { "operationId": "emailSimilar", "summary": "Similar Domains", "description": "Find similar and competitor domains for any company, with names and industry classifications. Cost: $0.02/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to find similar companies for (e.g., stripe.com)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "domains": [ { "domain": "fairbit.com", "industry": "Information Technology and Services", "name": "Fairbit" }, { "domain": "t1payments.com", "industry": "Financial Services", "name": "T1 Payments" }, { "domain": "victorypayments.com", "industry": "Financial Services", "name": "Victory Payments" }, { "domain": "woocommerce.com", "industry": "Information Technology and Services", "name": "..." }, { "domain": "shopify.com", "industry": "Information Technology and Services", "name": "Shopify" }, { "domain": "paypal.com", "industry": "Information Technology and Services", "name": "PayPal" }, { "domain": "adyen.com", "industry": "Financial Services", "name": "Adyen" }, { "domain": "payliance.com", "industry": "Financial Services", "name": "Payliance" }, { "domain": "nationaltransaction.com", "industry": "Banking", "name": "National Transaction" }, { "domain": "signaturecard.com", "industry": "Financial Services", "name": "Signature Card" }, { "domain": "gotobilling.com", "industry": "Financial Services", "name": "OmniFund" }, { "domain": "playspan.com", "industry": "Computer Games", "name": "PlaySpan" }, { "domain": "pplocal.com", "industry": "Financial Services", "name": "pplocal.com" }, { "domain": "paybear.io", "industry": "Financial Services", "name": "PayBear" }, { "domain": "capitalmerchantservicestx.com", "industry": null, "name": "..." }, { "domain": "inoviopay.com", "industry": "Financial Services", "name": "Inovio" }, { "domain": "kapitalinc.com", "industry": "Financial Services", "name": "Kapital Solutions" }, { "domain": "cybersource.com.au", "industry": null, "name": null }, { "domain": "kassa.com", "industry": null, "name": "kassa.com" }, { "domain": "acqualtscards.com", "industry": "Financial Services", "name": "Acqualtscards" }, { "domain": "switchio.com", "industry": "Information Services", "name": "Switchio" }, { "domain": "paymentoptions.com", "industry": "Financial Services", "name": "payment options" }, { "domain": "kashier.io", "industry": "Financial Services", "name": "Kashier" }, { "domain": "visionpay.com.au", "industry": "Software Development", "name": "VisionPay" }, { "domain": "paymore.org", "industry": null, "name": null } ] }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/sources": { "post": { "operationId": "emailSources", "summary": "Email Sources", "description": "See the public web pages where an email address appears, with first-seen and last-seen dates. Cost: $0.01/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to look up sources for" } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "sources": [] }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/technology": { "post": { "operationId": "emailTechnology", "summary": "Technology Lookup", "description": "Discover the technology stack behind any website — frameworks, analytics, hosting, and more. Cost: $0.02/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to detect technologies for (e.g., stripe.com)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "domain": "stripe.com", "technologies": [ { "category": null, "name": "Contentful", "slug": "contentful", "website": "contentful.com" }, { "category": null, "name": "Java", "slug": "java", "website": "java.com" }, { "category": null, "name": "dc.js", "slug": "dc-js", "website": "dc-js.github.io" }, { "category": null, "name": "hCaptcha", "slug": "hcaptcha", "website": "hcaptcha.com" }, { "category": null, "name": "Google Analytics", "slug": "google-analytics", "website": "google.com" }, { "category": null, "name": "Klarna Checkout", "slug": "klarna-checkout", "website": "klarna.com" }, { "category": null, "name": "Stripe", "slug": "stripe", "website": "stripe.com" }, { "category": null, "name": "Nginx", "slug": "nginx", "website": "nginx.org" }, { "category": null, "name": "Bootstrap", "slug": "bootstrap", "website": "getbootstrap.com" }, { "category": null, "name": "Stimulus", "slug": "stimulus", "website": "stimulusjs.org" }, { "category": null, "name": "C3.js", "slug": "c3-js", "website": "c3js.org" }, { "category": null, "name": "jQuery", "slug": "jquery", "website": "jquery.com" }, { "category": null, "name": "Amazon Web Services", "slug": "amazon-web-services", "website": "aws.amazon.com" }, { "category": null, "name": "SAP Commerce Cloud", "slug": "sap-commerce-cloud", "website": "sap.com" }, { "category": null, "name": "HSTS", "slug": "hsts", "website": "rfc-editor.org" }, { "category": null, "name": "Linkedin Ads", "slug": "linkedin-ads", "website": "business.linkedin.com" }, { "category": null, "name": "React", "slug": "react", "website": "reactjs.org" }, { "category": null, "name": "AMP", "slug": "amp", "website": "amp.dev" }, { "category": null, "name": "Algolia", "slug": "algolia", "website": "algolia.com" }, { "category": null, "name": "Amazon S3", "slug": "amazon-s3", "website": "aws.amazon.com" } ] }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/verify": { "post": { "operationId": "emailVerify", "summary": "Email Verifier", "description": "Verify any email address before you send — SMTP and MX checks, deliverability status, and a 0–100 quality score. Cost: $0.01/call.", "tags": [ "Other" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address to verify" } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "data": { "checks": { "acceptAll": false, "blocked": false, "disposable": false, "gibberish": false, "greylisted": false, "mx": true, "smtp": true, "smtpServer": true, "validFormat": true, "webmail": false }, "deliverability": "undeliverable", "email": "matthew.yalowitz@stripe.com", "mxRecords": [ "aspmx.l.google.com", "alt1.aspmx.l.google.com", "alt2.aspmx.l.google.com", "aspmx2.googlemail.com", "aspmx3.googlemail.com" ], "score": 12, "smtpProvider": "Google Workspace", "sources": [], "status": "invalid" }, "ok": true } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/hashtag": { "post": { "operationId": "instagramHashtag", "summary": "Hashtag Search", "description": "Get top and recent posts for an Instagram hashtag. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hashtag": { "type": "string", "description": "Hashtag name (without #)" } }, "required": [ "hashtag" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "name": "travelphotography", "media_count": 189000000, "top_posts": [ { "id": "3456789012345678901", "shortcode": "C5xAbCdEfGh", "type": "GraphImage", "caption": "Sunset in Santorini #travelphotography", "like_count": 890000, "comment_count": 4500, "taken_at": 1712345678, "display_url": "https://scontent.cdninstagram.com/...", "is_video": false, "owner": { "username": "travel_photographer", "profile_pic_url": "https://scontent.cdninstagram.com/..." } } ], "recent_posts": [ { "id": "3456789012345678902", "shortcode": "C5yBcDeFgHi", "type": "GraphImage", "like_count": 1200, "comment_count": 45, "taken_at": 1712678901, "display_url": "https://scontent.cdninstagram.com/...", "is_video": false } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/media-id": { "post": { "operationId": "instagramMediaId", "summary": "Media ID Lookup", "description": "Convert an Instagram post shortcode to its numeric media ID. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Post shortcode from the Instagram URL" } }, "required": [ "shortcode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "shortcode": "C5xAbCdEfGh", "media_id": "3456789012345678901", "media_id_with_owner": "3456789012345678901_787132" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/post": { "post": { "operationId": "instagramPost", "summary": "Post Details", "description": "Get full details for an Instagram post by its shortcode. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Post shortcode from the Instagram URL" } }, "required": [ "shortcode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "id": "3456789012345678901", "shortcode": "C5xAbCdEfGh", "type": "GraphImage", "caption": "A stunning sunset over the Sahara Desert. Photo by @photographer_name", "like_count": 450000, "comment_count": 1200, "taken_at": 1712345678, "display_url": "https://scontent.cdninstagram.com/...", "is_video": false, "video_url": null, "video_view_count": null, "video_duration": null, "owner": { "id": "787132", "username": "natgeo", "full_name": "National Geographic", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": true }, "location": { "name": "Sahara Desert", "lat": 23.4162, "lng": 25.6628 }, "tagged_users": [ { "username": "photographer_name", "full_name": "John Photographer" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/post-comments": { "post": { "operationId": "instagramPostComments", "summary": "Post Comments", "description": "Get comments on an Instagram post with pagination. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Post shortcode from the Instagram URL" }, "end_cursor": { "type": "string", "description": "Pagination cursor from previous response" } }, "required": [ "shortcode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_next_page": true, "end_cursor": "QVFDcE...", "comment_count": 1200, "comments": [ { "id": "17891234567890123", "text": "Absolutely breathtaking!", "created_at": 1712346000, "like_count": 4500, "reply_count": 12, "owner": { "username": "photo_fan", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": false } }, { "id": "17891234567890124", "text": "Where was this taken?", "created_at": 1712347000, "like_count": 230, "reply_count": 3, "owner": { "username": "traveler_mike", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": false } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/post-likers": { "post": { "operationId": "instagramPostLikers", "summary": "Post Likers", "description": "Get users who liked an Instagram post. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Post shortcode from the Instagram URL" }, "end_cursor": { "type": "string", "description": "Pagination cursor from previous response" } }, "required": [ "shortcode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_next_page": true, "end_cursor": "QVFDcE...", "likers": [ { "id": "12345678901", "username": "photo_fan", "full_name": "Photo Fan", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": false, "is_private": false } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/search": { "post": { "operationId": "instagramSearch", "summary": "Instagram Search", "description": "Search Instagram for users, hashtags, and places. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "users": [ { "username": "travelphotography", "full_name": "Travel Photography", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": true, "follower_count": 5200000, "is_private": false } ], "hashtags": [ { "name": "travelphotography", "media_count": 189000000 } ], "places": [ { "title": "Travel Photography Studio", "location": { "lat": 40.7128, "lng": -74.006 } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user": { "post": { "operationId": "instagramUser", "summary": "User Profile", "description": "Get profile information for an Instagram user. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "id": "787132", "username": "natgeo", "full_name": "National Geographic", "biography": "Experience the world through the eyes of National Geographic photographers.", "profile_pic_url": "https://scontent.cdninstagram.com/...", "profile_pic_url_hd": "https://scontent.cdninstagram.com/...", "follower_count": 284000000, "following_count": 156, "media_count": 28500, "is_verified": true, "is_private": false, "is_business_account": true, "category": "Media/News Company", "external_url": "https://www.nationalgeographic.com" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-about": { "post": { "operationId": "instagramUserAbout", "summary": "User About", "description": "Get extended about information for an Instagram user including account transparency data. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "username": "natgeo", "full_name": "National Geographic", "biography": "Experience the world through the eyes of National Geographic photographers.", "date_joined": "2012-05-15", "account_type": "Business", "category": "Media/News Company", "country": "United States", "former_usernames": [], "ads_count": 12 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-followers": { "post": { "operationId": "instagramUserFollowers", "summary": "User Followers", "description": "Get a list of followers for an Instagram user. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" }, "end_cursor": { "type": "string", "description": "Pagination cursor from previous response" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_next_page": true, "end_cursor": "QVFDcE...", "followers": [ { "id": "12345678901", "username": "photo_enthusiast", "full_name": "Photo Enthusiast", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": false, "is_private": false } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-highlights": { "post": { "operationId": "instagramUserHighlights", "summary": "User Highlights", "description": "Get story highlights from an Instagram user's profile. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "username": "natgeo", "highlights": [ { "id": "17891234567890123", "title": "Wildlife", "cover_media_url": "https://scontent.cdninstagram.com/...", "item_count": 24, "items": [ { "id": "3456789012345678901", "taken_at": 1712345678, "is_video": false, "display_url": "https://scontent.cdninstagram.com/...", "video_url": null } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-posts": { "post": { "operationId": "instagramUserPosts", "summary": "User Posts", "description": "Get recent posts from an Instagram user's profile. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" }, "end_cursor": { "type": "string", "description": "Pagination cursor from previous response" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_next_page": true, "end_cursor": "QVFDcE...", "posts": [ { "id": "3456789012345678901", "shortcode": "C5xAbCdEfGh", "type": "GraphImage", "caption": "A stunning sunset over the Sahara Desert. Photo by @photographer_name", "like_count": 450000, "comment_count": 1200, "taken_at": 1712345678, "display_url": "https://scontent.cdninstagram.com/...", "thumbnail_url": "https://scontent.cdninstagram.com/...", "is_video": false, "video_view_count": null, "accessibility_caption": "Photo of desert landscape at sunset" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-reels": { "post": { "operationId": "instagramUserReels", "summary": "User Reels", "description": "Get reels posted by an Instagram user. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" }, "end_cursor": { "type": "string", "description": "Pagination cursor from previous response" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_next_page": true, "end_cursor": "QVFDcE...", "reels": [ { "id": "3456789012345678901", "shortcode": "C5xAbCdEfGh", "caption": "Watch this incredible migration in the Serengeti", "like_count": 890000, "comment_count": 3400, "play_count": 12000000, "taken_at": 1712345678, "video_duration": 30.5, "display_url": "https://scontent.cdninstagram.com/...", "video_url": "https://scontent.cdninstagram.com/..." } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-similar": { "post": { "operationId": "instagramUserSimilar", "summary": "Similar Accounts", "description": "Get Instagram accounts similar to a given user. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "similar_accounts": [ { "username": "discoverearth", "full_name": "Discover Earth", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": true, "follower_count": 12500000 }, { "username": "earthpix", "full_name": "EarthPix", "profile_pic_url": "https://scontent.cdninstagram.com/...", "is_verified": true, "follower_count": 8900000 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-stories": { "post": { "operationId": "instagramUserStories", "summary": "User Stories", "description": "Get current active stories from an Instagram user. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "username": "natgeo", "stories": [ { "id": "3456789012345678901", "taken_at": 1712345678, "expiring_at": 1712432078, "is_video": false, "display_url": "https://scontent.cdninstagram.com/...", "video_url": null, "video_duration": null }, { "id": "3456789012345678902", "taken_at": 1712350000, "expiring_at": 1712436400, "is_video": true, "display_url": "https://scontent.cdninstagram.com/...", "video_url": "https://scontent.cdninstagram.com/...", "video_duration": 12.3 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/instagram/user-tagged": { "post": { "operationId": "instagramUserTagged", "summary": "User Tagged Posts", "description": "Get posts in which an Instagram user has been tagged. Cost: $0.01/call.", "tags": [ "Instagram" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Instagram username" }, "end_cursor": { "type": "string", "description": "Pagination cursor from previous response" } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_next_page": true, "end_cursor": "QVFDcE...", "posts": [ { "id": "3456789012345678901", "shortcode": "C5xAbCdEfGh", "type": "GraphImage", "caption": "Amazing shot featured by @natgeo", "like_count": 125000, "comment_count": 340, "taken_at": 1712345678, "display_url": "https://scontent.cdninstagram.com/...", "owner": { "username": "photographer_name", "profile_pic_url": "https://scontent.cdninstagram.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/media/queue": { "post": { "operationId": "mediaQueue", "summary": "Seedance 2.0", "description": "AI video generation from text, images, video, or audio references. 4-15 seconds, flexible aspect ratios, optional audio. Cost: ~$1.50 est..", "tags": [ "AI Media" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "description": "bytedance/seedance-2-0 or alias seedance" }, "prompt": { "type": "string", "description": "Text description of the video to generate" }, "options.aspectRatio": { "type": "string", "description": "21:9, 16:9, 4:3, 1:1, 3:4, or 9:16", "default": "16:9" }, "options.duration": { "type": "string", "description": "4 to 15 (seconds)", "default": "5" }, "options.generateAudio": { "type": "boolean", "description": "Generate audio track for the video", "default": false }, "options.watermark": { "type": "boolean", "description": "Add watermark to output", "default": false }, "options.imageRole": { "type": "string", "description": "How to use the input image: first_frame, last_frame, or reference_image", "default": "first_frame" }, "options.referenceVideoUrl": { "type": "string", "description": "URL of a reference video for style/motion guidance" }, "options.referenceAudioUrl": { "type": "string", "description": "URL of a reference audio track" }, "imageData.mimeType": { "type": "string", "description": "MIME type of input image" }, "imageData.base64": { "type": "string", "description": "Base64-encoded input image for image-to-video" } }, "required": [ "model", "prompt" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/media/status/{jobId}": { "get": { "operationId": "mediaStatus", "summary": "Media Job Status", "description": "Poll an async media generation/analysis job by its jobId. Free; the job itself is billed on completion.", "tags": [ "AI Media" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Job status and result", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/v1/scrape": { "post": { "operationId": "scrape", "summary": "Standard Scrape", "description": "Scrape any URL and get back clean markdown, HTML, or structured data. Cost: $0.01/call.", "tags": [ "Scraping" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to scrape" }, "format": { "type": "string", "description": "Output format: markdown, html, text", "default": "markdown" }, "waitFor": { "type": "number", "description": "Wait for JS rendering (ms)", "default": 0 }, "selector": { "type": "string", "description": "CSS selector to extract specific element" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "url": "https://example.com", "statusCode": 200, "title": "Example Domain", "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples...", "metadata": { "description": "Example Domain", "ogTitle": "Example Domain" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/scrape/ai-extract": { "post": { "operationId": "scrapeAiExtract", "summary": "AI Extraction", "description": "Extract structured data from any webpage using AI — no selectors needed. Cost: $0.03/call.", "tags": [ "Scraping" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to extract data from" }, "prompt": { "type": "string", "description": "What data to extract" }, "schema": { "type": "object", "description": "JSON Schema for structured output" } }, "required": [ "url", "prompt" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "url": "https://example.com/product/123", "extracted": { "productName": "Wireless Headphones Pro", "price": 149.99, "currency": "USD", "description": "Premium noise-cancelling wireless headphones with 30-hour battery life" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/scrape/extract": { "post": { "operationId": "scrapeExtract", "summary": "Data Extraction", "description": "Extract structured data from any page using CSS or XPath selectors. Cost: $0.01/call.", "tags": [ "Scraping" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to extract data from" }, "extractRules": { "type": "object", "description": "CSS/XPath extraction rules (see below)" } }, "required": [ "url", "extractRules" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "url": "https://news.ycombinator.com", "extracted": { "titles": [ "Show HN: Open-source AI code editor", "The State of WebAssembly 2026", "PostgreSQL 18 Released" ] } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/scrape/js": { "post": { "operationId": "scrapeJs", "summary": "JavaScript Scrape", "description": "Scrape JavaScript-rendered pages with a full headless browser. Cost: $0.02/call.", "tags": [ "Scraping" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to scrape" }, "format": { "type": "string", "description": "Output format: markdown, html, text", "default": "markdown" }, "waitFor": { "type": "number", "description": "Wait for JS to render (ms)", "default": 0 }, "selector": { "type": "string", "description": "CSS selector to extract specific element" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "url": "https://react.dev", "statusCode": 200, "content": "# React\n\nThe library for web and native user interfaces...", "format": "markdown" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/scrape/screenshot": { "post": { "operationId": "scrapeScreenshot", "summary": "Screenshot", "description": "Take pixel-perfect screenshots of any webpage. Cost: $0.02/call.", "tags": [ "Scraping" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to screenshot" }, "fullPage": { "type": "boolean", "description": "Capture entire scrollable page", "default": false }, "width": { "type": "number", "description": "Viewport width in pixels", "default": 1920 }, "height": { "type": "number", "description": "Viewport height in pixels", "default": 1080 } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "url": "https://example.com", "image": "iVBORw0KGgoAAAANSUhEUgAA...(base64 PNG)", "width": 1920, "height": 1080 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/scrape/stealth": { "post": { "operationId": "scrapeStealth", "summary": "Stealth Scrape", "description": "Scrape heavily protected sites using premium residential proxies and advanced browser fingerprinting. Cost: $0.03/call.", "tags": [ "Scraping" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to scrape" }, "format": { "type": "string", "description": "Output format: markdown, html, text", "default": "markdown" }, "waitFor": { "type": "number", "description": "Wait for JS rendering (ms)", "default": 2000 }, "country": { "type": "string", "description": "Proxy country code", "default": "us" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "url": "https://protected-site.com/pricing", "statusCode": 200, "title": "Pricing - Protected Site", "markdown": "# Pricing\n\n## Starter Plan\n$29/month...", "metadata": { "description": "View our pricing plans" } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/search/google": { "post": { "operationId": "searchGoogle", "summary": "Google Search", "description": "Get raw Google search results for any query. Cost: $0.02/call.", "tags": [ "Scraping" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query" }, "country": { "type": "string", "description": "Country code for geo-targeted results", "default": "us" }, "numResults": { "type": "number", "description": "Number of results to return", "default": 10 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "best web scraping api", "html": "...(full Google SERP HTML)..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/ai/chatgpt": { "post": { "operationId": "seoAiChatgpt", "summary": "ChatGPT Scraper", "description": "See what ChatGPT says about any topic — scrape AI responses with source references. Cost: $0.05/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Query to send to ChatGPT" }, "location": { "type": "string", "description": "Country code", "default": "us" } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keyword": "best website hosting platforms", "response": "Based on current market analysis, the top website hosting platforms include Vercel for frontend deployments, AWS for enterprise infrastructure...", "references": [ { "url": "https://www.g2.com/categories/web-hosting", "title": "Best Web Hosting Services 2026", "snippet": "Compare the top web hosting..." }, { "url": "https://www.techradar.com/hosting", "title": "Best Web Hosting 2026", "snippet": "We tested and reviewed..." } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/ai/gemini": { "post": { "operationId": "seoAiGemini", "summary": "Gemini Scraper", "description": "See what Google Gemini says about any topic — scrape AI responses with source references. Cost: $0.05/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Query to send to Gemini" }, "location": { "type": "string", "description": "Country code", "default": "us" } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keyword": "best seo tools for startups", "response": "For startups looking to improve their SEO, several tools stand out based on pricing, features, and ease of use...", "references": [ { "url": "https://ahrefs.com/blog/seo-tools", "title": "12 Best SEO Tools in 2026", "snippet": "A curated list of SEO tools..." }, { "url": "https://www.searchenginejournal.com/best-seo-tools", "title": "Top SEO Tools Reviewed", "snippet": "Expert reviews of the best..." } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/ai/llm-mentions": { "post": { "operationId": "seoAiLlmMentions", "summary": "LLM Mentions", "description": "Find where your brand, domain, or keyword is mentioned across ChatGPT and Google AI Overviews. Pre-indexed mentions corpus with AI search volume. Cost: $0.20/call. + $0.002 per row returned.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "array", "items": {}, "description": "1–10 entries. Each entry is { domain } **or** { keyword } with optional search_filter, search_scope, include_subdomains (domains), or match_type (keywords)." }, "platform": { "type": "string", "description": "\"google\" (AI Overview, multi-locale) or \"chat_gpt\" (US/English only).", "default": "google" }, "location": { "type": "string", "description": "Country code (e.g. \"us\", \"gb\", \"de\").", "default": "us" }, "location_code": { "type": "number", "description": "Raw DataForSEO location code. Overrides location." }, "language": { "type": "string", "description": "Language code (e.g. \"en\").", "default": "en" }, "filters": { "type": "array", "items": {}, "description": "Up to 8 filters. Each is [field, operator, value]. Operators: =, <>, <, >, <=, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match. Combine with \"and\" / \"or\"." }, "order_by": { "type": "string", "description": "Up to 3 sort rules, e.g. [\"ai_search_volume,desc\"]." }, "offset": { "type": "number", "description": "Skip results (0–9000). Use search_after_token for deeper pagination.", "default": 0 }, "search_after_token": { "type": "string", "description": "Pagination cursor returned by a previous response." }, "limit": { "type": "number", "description": "Items returned (1–1000).", "default": 100 }, "tag": { "type": "string", "description": "User-defined task tag (≤255 chars)." } }, "required": [ "target" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "platform": "google", "totalCount": 1842, "itemsCount": 2, "currentOffset": 0, "searchAfterToken": "eyJzZWFyY2hfYWZ0ZXIiOlsx...", "mentions": [ { "platform": "google", "modelName": "google_ai_overview", "locationCode": 2840, "languageCode": "en", "question": "what is the best seo api", "answer": "Several SEO APIs stand out in 2026, including YepAPI for keyword research and SERP data, DataForSEO for enterprise-scale crawling...", "sources": [ { "position": 1, "title": "Keywords API — YepAPI", "url": "https://yepapi.com/seo-api/keywords", "domain": "yepapi.com", "sourceName": "YepAPI", "snippet": "Bulk keyword metrics: search volume, CPC, competition, difficulty, intent...", "thumbnail": null, "markdown": null, "publicationDate": null } ], "searchResults": null, "aiSearchVolume": 1200, "monthlySearches": [ { "year": 2026, "month": 4, "searchVolume": 1200 }, { "year": 2026, "month": 3, "searchVolume": 980 } ], "firstResponseAt": "2026-02-11 08:14:00 +00:00", "lastResponseAt": "2026-05-15 22:41:00 +00:00", "brandEntities": [ { "position": 1, "title": "Developer-first SEO + AI API", "category": "software" } ], "fanOutQueries": null } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/backlinks/anchors": { "post": { "operationId": "seoBacklinksAnchors", "summary": "Anchor Text Analysis", "description": "Analyze anchor text distribution across backlinks to any domain. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "Domain to analyze anchor text for" }, "limit": { "type": "number", "description": "Maximum number of anchors to return", "default": 100 } }, "required": [ "target" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "target": "vercel.com", "anchors": [ { "anchor": "", "backlinks": 556528, "dofollow": 0, "firstSeen": "2019-01-16", "lastSeen": "", "referringDomains": 3809 }, { "anchor": "Vercel", "backlinks": 662041, "dofollow": 0, "firstSeen": "2020-02-17", "lastSeen": "", "referringDomains": 13396 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/backlinks/domain-intersection": { "post": { "operationId": "seoBacklinksDomainIntersection", "summary": "Domain Intersection", "description": "Find domains that link to multiple targets — discover link building opportunities. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "Domains to find common backlinks for" }, "limit": { "type": "number", "description": "Maximum number of intersections to return", "default": 100 } }, "required": [ "targets" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "intersections": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/backlinks/list": { "post": { "operationId": "seoBacklinksList", "summary": "Backlinks List", "description": "Get individual backlinks pointing to any domain, subdomain, or URL. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "Domain, subdomain, or URL to get backlinks for" }, "limit": { "type": "number", "description": "Maximum number of backlinks to return", "default": 100 } }, "required": [ "target" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "target": "vercel.com", "backlinks": [ { "anchor": "Vercel", "dofollow": true, "domainAuthority": 532, "firstSeen": "2025-07-01", "from": "https://ui.shadcn.com/", "fromDomain": "ui.shadcn.com", "lastSeen": "2026-03-15", "spamScore": 0, "status": "active", "to": "https://vercel.com/new?utm_source=shadcn_site&utm_medium=web&utm_campaign=docs_cta_deploy_now_callout" }, { "anchor": "Official site", "dofollow": true, "domainAuthority": 389, "firstSeen": "2025-12-05", "from": "https://dedoo.xyz/", "fromDomain": "dedoo.xyz", "lastSeen": "2026-02-19", "spamScore": 0, "status": "active", "to": "https://lebowskis.vercel.com/" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/backlinks/page-intersection": { "post": { "operationId": "seoBacklinksPageIntersection", "summary": "Page Intersection", "description": "Find pages that link to multiple targets — granular link prospecting. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "Domains to find common backlinks for" }, "limit": { "type": "number", "description": "Maximum number of intersections to return", "default": 100 } }, "required": [ "targets" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "intersections": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/backlinks/referring-domains": { "post": { "operationId": "seoBacklinksReferringDomains", "summary": "Referring Domains", "description": "Get domains linking to a target with domain-level authority metrics. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "Domain to get referring domains for" }, "limit": { "type": "number", "description": "Maximum number of referring domains to return", "default": 100 } }, "required": [ "target" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "target": "vercel.com", "referringDomains": [ { "backlinks": 19307, "dofollow": 0, "domain": "", "firstSeen": "2020-11-23", "lastSeen": "", "rank": 516 }, { "backlinks": 527338, "dofollow": 0, "domain": "", "firstSeen": "2024-09-13", "lastSeen": "", "rank": 480 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/backlinks/summary": { "post": { "operationId": "seoBacklinksSummary", "summary": "Backlink Summary", "description": "Get aggregate backlink metrics for any domain — total links, referring domains, dofollow ratio. Cost: $0.03/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "Domain to get backlink summary for" } }, "required": [ "target" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "target": "vercel.com", "totalBacklinks": 12400000, "referringDomains": 45000, "referringIps": 32000, "dofollowBacklinks": 9800000, "nofollowBacklinks": 2600000, "brokenBacklinks": 145000, "domainRank": 89 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/business/info": { "post": { "operationId": "seoBusinessInfo", "summary": "Google Business Data", "description": "Get Google My Business listings — name, address, ratings, reviews, hours. Cost: $0.03/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Search query for business listings" }, "location": { "type": "string", "description": "Country code", "default": "us" } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keyword": "pizza near times square", "results": [ { "name": "Joe's Pizza", "address": "7 Carmine St, New York, NY 10014", "phone": "+1-212-366-1182", "website": "https://joespizzanyc.com", "rating": 4.5, "reviewCount": 12400, "category": "Pizza restaurant", "workingHours": "Mon-Sun: 10am-4am" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/competitors/domain": { "post": { "operationId": "seoCompetitorsDomain", "summary": "Domain Competitors", "description": "Discover SEO competitor domains for any domain based on keyword overlap. Cost: from $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to find competitors for (without protocol)" }, "location_code": { "type": "number", "description": "Target country code. See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code", "default": "en" }, "limit": { "type": "number", "description": "Max competitor domains to return", "default": 100 } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "domain": "vercel.com", "competitors": [ { "avgPosition": 51.85, "domain": "vercel.com", "intersections": 39218, "organicCount": 39217, "organicEtv": 154912.38 }, { "avgPosition": 21.18, "domain": "youtube.com", "intersections": 36760, "organicCount": 36760, "organicEtv": 147161.67 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/competitors/keywords": { "post": { "operationId": "seoCompetitorsKeywords", "summary": "Keyword Gap Analysis", "description": "Find keyword gaps and overlaps between two competing domains. Cost: from $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain1": { "type": "string", "description": "Primary domain (without protocol)" }, "domain2": { "type": "string", "description": "Competitor domain (without protocol)" }, "intersections": { "type": "boolean", "description": "true = shared keywords, false = keywords only domain1 ranks for", "default": true }, "location_code": { "type": "number", "description": "Target country code. See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code", "default": "en" }, "limit": { "type": "number", "description": "Max keywords to return", "default": 100 }, "filters": { "type": "array", "description": "Up to 8 filter expressions on friendly field names (volume, cpc, competition, competitionLevel, difficulty, intent, keyword, words, length). `words`/`length` filter by keyword length. See /reference/keyword-filters.", "maxItems": 8, "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string", "enum": [ ">", ">=", "<", "<=", "=", "!=", "in", "nin", "like", "not_like" ] }, "value": {} }, "required": [ "field", "op", "value" ] } }, "match": { "type": "string", "enum": [ "all", "any" ], "default": "all", "description": "Combine filters with AND (all) or OR (any)." }, "sort": { "type": "array", "description": "Up to 3 sort rules like \"volume:desc\".", "maxItems": 3, "items": { "type": "string" } } }, "required": [ "domain1", "domain2" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "domain1": "stripe.com", "domain2": "square.com", "intersections": true, "keywords": [ { "keyword": "payment processing", "volume": 33100, "cpc": 15.2, "competition": 0.85, "difficulty": 72, "intent": "commercial", "domain1": { "position": 3, "url": "https://stripe.com/payments", "etv": 4500 }, "domain2": { "position": 7, "url": "https://square.com/payments", "etv": 1200 } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/competitors/pages": { "post": { "operationId": "seoCompetitorsPages", "summary": "Page Intersection", "description": "Find keywords where specific pages rank in the same search results. Cost: from $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "object", "description": "Numbered keys (\"1\", \"2\", etc.) mapping to page URLs. Up to 20." }, "location_code": { "type": "number", "description": "Target country code. See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code", "default": "en" }, "limit": { "type": "number", "description": "Max keywords to return", "default": 100 } }, "required": [ "pages" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keywords": [ { "keyword": "payment processing api", "volume": 2400, "cpc": 18.5, "competition": 0.82, "difficulty": 68, "intent": "commercial", "pages": [ { "url": "https://stripe.com/payments", "position": 2, "type": "organic", "etv": 650 }, { "url": "https://square.com/payments", "position": 5, "type": "organic", "etv": 180 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/competitors/serp": { "post": { "operationId": "seoCompetitorsSerp", "summary": "SERP Competitors", "description": "Find which domains compete for your target keywords in search results. Cost: from $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "Keywords to analyze (up to 200)" }, "location_code": { "type": "number", "description": "Target country code. See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code", "default": "en" }, "limit": { "type": "number", "description": "Max competitor domains to return", "default": 100 } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "competitors": [ { "avgPosition": 1, "domain": "nextjs.org", "etv": 15048, "keywordsCount": 1, "medianPosition": 1, "rating": 99, "visibility": 1 }, { "avgPosition": 2, "domain": "en.wikipedia.org", "etv": 8019, "keywordsCount": 1, "medianPosition": 2, "rating": 98, "visibility": 0.9 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/content/search": { "post": { "operationId": "seoContentSearch", "summary": "Content Search", "description": "Find online content mentions for any keyword — articles, blog posts, news. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Keyword to search for" }, "limit": { "type": "number", "description": "Number of results to return", "default": 100 } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keyword": "nextjs seo", "results": [ { "contentQualityScore": 0, "datePublished": "", "domain": "codecheap.org", "sentiment": "neutral", "snippet": "", "spamScore": 0, "title": "", "url": "https://codecheap.org/downloads/lums-v-1-0-seo-landing-react-nextjs-template/" }, { "contentQualityScore": 0, "datePublished": "", "domain": "jakarta.telkomuniversity.ac.id", "sentiment": "neutral", "snippet": "", "spamScore": 0, "title": "", "url": "https://jakarta.telkomuniversity.ac.id/tag/nextjs/" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/content/sentiment": { "post": { "operationId": "seoContentSentiment", "summary": "Content Sentiment", "description": "Analyze sentiment across content mentioning a keyword. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Keyword to analyze" }, "limit": { "type": "number", "description": "Number of results to return", "default": 100 } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keyword": "vercel", "results": [ { "url": "https://blog.example.com/vercel-review", "domain": "blog.example.com", "title": "Vercel Review 2026", "sentiment": "positive", "sentimentScore": 0.85, "date": "2026-03-20" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/content/summary": { "post": { "operationId": "seoContentSummary", "summary": "Content Summary", "description": "Get aggregate content analysis — top domains, sentiment breakdown, content types. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Keyword to analyze" } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "avgContentQualityScore": 0, "keyword": "nextjs seo", "sentimentDistribution": { "negative": 0, "neutral": 0, "positive": 0 }, "totalCount": 15607 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/available": { "post": { "operationId": "seoDomainAvailable", "summary": "Domain Availability", "description": "Check domain availability in bulk — up to 50 domains per call. Detects premium names with pricing. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Single domain to check (no protocol, e.g. example.com)" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Up to 50 domains to check in one call" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "domains": [ { "domain": "example.com", "available": false, "isPremium": false, "premiumRegistrationPrice": 0, "premiumRenewalPrice": 0, "icannFee": 0, "eapFee": 0 }, { "domain": "some-unique-name-xyz-123.com", "available": true, "isPremium": false, "premiumRegistrationPrice": 0, "premiumRenewalPrice": 0, "icannFee": 0.18, "eapFee": 0 }, { "domain": "cars.ai", "available": true, "isPremium": true, "premiumRegistrationPrice": 2450, "premiumRenewalPrice": 95, "icannFee": 0, "eapFee": 0 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/backlinks": { "post": { "operationId": "seoDomainBacklinks", "summary": "Domain Backlinks", "description": "Full backlink profile for any domain — source URLs, anchor text, dofollow status, and authority scores. Cost: from $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to get backlinks for (without protocol, e.g., \"github.com\")" }, "limit": { "type": "number", "description": "Maximum number of backlinks to return", "default": 100 } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": [ { "sourceUrl": "https://blog.example.com/tools-review", "sourceDomain": "blog.example.com", "anchorText": "GitHub", "isDofollow": true, "domainAuthority": 72, "firstSeen": "2025-08-14" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/keywords": { "post": { "operationId": "seoDomainKeywords", "summary": "Domain Keywords", "description": "Get every keyword a domain ranks for with positions, search volume, CPC, and landing URLs. Cost: from $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to analyze (without protocol, e.g., \"stripe.com\")" }, "limit": { "type": "number", "description": "Maximum number of keywords to return", "default": 100 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" }, "filters": { "type": "array", "description": "Up to 8 filter expressions on friendly field names (volume, cpc, competition, competitionLevel, difficulty, intent, keyword, words, length). `words`/`length` filter by keyword length. See /reference/keyword-filters.", "maxItems": 8, "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string", "enum": [ ">", ">=", "<", "<=", "=", "!=", "in", "nin", "like", "not_like" ] }, "value": {} }, "required": [ "field", "op", "value" ] } }, "match": { "type": "string", "enum": [ "all", "any" ], "default": "all", "description": "Combine filters with AND (all) or OR (any)." }, "sort": { "type": "array", "description": "Up to 3 sort rules like \"volume:desc\".", "maxItems": 3, "items": { "type": "string" } } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": [ { "keyword": "stripe", "position": 1, "searchVolume": 450000, "cpc": 8.5, "url": "https://stripe.com" }, { "keyword": "payment gateway", "position": 3, "searchVolume": 74000, "cpc": 12.3, "url": "https://stripe.com/payments" } ] } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/metrics": { "post": { "operationId": "seoDomainMetrics", "summary": "Domain Metrics", "description": "Ahrefs-style authority and traffic metrics — DR, UR, backlinks, ref domains, traffic, traffic value, and organic keywords at page and domain scope. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain or URL to analyze. http(s):// is stripped automatically." } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "target": "anthropic.com", "page": { "backlinks": 34425, "refDomains": 3870, "traffic": 0, "trafficValue": 0, "organicKeywords": 0, "urlRating": 16, "numberOfWordsOnPage": 0 }, "domainMetrics": { "domainRating": 91, "ahrefsRank": 693, "domainRank": 693, "backlinks": 1911955, "refDomains": 85326, "traffic": 981693, "trafficValue": 382569.64, "organicKeywords": 11757 } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/overview": { "post": { "operationId": "seoDomainOverview", "summary": "Domain Metrics", "description": "Get domain authority, traffic estimates, backlinks, and keyword rankings for any domain. Cost: $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to analyze (without protocol)" }, "location_code": { "type": "number", "description": "Target country code. See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code", "default": "en" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "domain": "vercel.com", "domainRank": 742.3, "organicTraffic": 2450000, "organicKeywords": 156000, "backlinks": 12400000, "referringDomains": 45000 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/rank-overview": { "post": { "operationId": "seoDomainRankOverview", "summary": "Domain Rank Overview", "description": "Get organic and paid traffic, keyword counts, SERP position distribution, and ranking movement for any domain. Cost: $0.04/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to analyze (e.g., stripe.com)" }, "location": { "type": "string", "description": "Target country as a two-letter code (e.g., \"us\", \"gb\")", "default": "us" }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "organic": { "keywords": 143677, "movement": { "down": 26470, "lost": 95303, "new": 80152, "up": 25876 }, "positions": { "pos1": 9269, "pos11_20": 22677, "pos21_30": 15179, "pos2_3": 12645, "pos31_40": 11934, "pos41_50": 9490, "pos4_10": 33692, "pos51_60": 7862, "pos61_70": 6936, "pos71_80": 6003, "pos81_90": 4812, "pos91_100": 3178 }, "traffic": 3591807.199092444, "trafficCost": 35377608.92198893 }, "paid": { "keywords": 32, "movement": { "down": 3, "lost": 18, "new": 28, "up": 1 }, "positions": { "pos1": 21, "pos11_20": 0, "pos21_30": 0, "pos2_3": 9, "pos31_40": 0, "pos41_50": 0, "pos4_10": 2, "pos51_60": 0, "pos61_70": 0, "pos71_80": 0, "pos81_90": 0, "pos91_100": 0 }, "traffic": 864.6850079298019, "trafficCost": 23754.52531862259 }, "target": "stripe.com" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/technologies": { "post": { "operationId": "seoDomainTechnologies", "summary": "Domain Technologies", "description": "Detect technologies used on any domain — CMS, analytics, frameworks, and more. Cost: $0.03/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to analyze (without protocol)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "domain": "vercel.com", "technologies": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/traffic": { "post": { "operationId": "seoDomainTraffic", "summary": "Bulk Traffic Estimation", "description": "Estimate organic and paid traffic and keyword counts for up to 1,000 domains in a single request. Cost: $0.03/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "Array of domains to estimate (max 1,000)" }, "location": { "type": "string", "description": "Target country as a two-letter code (e.g., \"us\", \"gb\")", "default": "us" }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "targets" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "domains": [ { "domain": "stripe.com", "organicKeywords": 143677, "organicTraffic": 3591807.199092444, "paidKeywords": 32, "paidTraffic": 864.6850079298019 }, { "domain": "paypal.com", "organicKeywords": 137644, "organicTraffic": 10100772.282336311, "paidKeywords": 93, "paidTraffic": 3090.948067307472 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/domain/whois": { "post": { "operationId": "seoDomainWhois", "summary": "WHOIS Lookup", "description": "Get WHOIS registration data for any domain — registrar, dates, nameservers. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain to look up (without protocol)" } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "domain": "youtube.com", "registrar": "MarkMonitor Inc.", "createdDate": "", "updatedDate": "", "expiryDate": "", "nameServers": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/keywords": { "post": { "operationId": "seoKeywords", "summary": "Keyword Research", "description": "Get search volume, CPC, competition, and difficulty for up to 100 keywords per request. Cost: $0.11/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "Array of keywords to analyze (max 100). See validity rules below." }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" }, "filters": { "type": "array", "description": "Up to 8 filter expressions on friendly field names (volume, cpc, competition, competitionLevel, difficulty, intent, keyword, words, length). `words`/`length` filter by keyword length. See /reference/keyword-filters.", "maxItems": 8, "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string", "enum": [ ">", ">=", "<", "<=", "=", "!=", "in", "nin", "like", "not_like" ] }, "value": {} }, "required": [ "field", "op", "value" ] } }, "match": { "type": "string", "enum": [ "all", "any" ], "default": "all", "description": "Combine filters with AND (all) or OR (any)." }, "sort": { "type": "array", "description": "Up to 3 sort rules like \"volume:desc\".", "maxItems": 3, "items": { "type": "string" } } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keywords": [ { "keyword": "nextjs seo", "volume": 390, "cpc": 0, "difficulty": 0, "competition": 0.01, "competitionLevel": "LOW", "intent": "unknown", "avgBacklinks": 0, "avgReferringDomains": 0, "serpFeatures": [], "totalResults": 0, "trend": [ { "month": "2026-03", "volume": 390 }, { "month": "2026-02", "volume": 140 }, { "month": "2026-01", "volume": 170 } ] }, { "keyword": "vibe coding", "volume": 0, "cpc": 0, "difficulty": 0, "competition": 0, "competitionLevel": "unknown", "intent": "unknown", "avgBacklinks": 0, "avgReferringDomains": 0, "serpFeatures": [], "totalResults": 0, "trend": [] } ], "skipped": [ { "keyword": "what is an api?", "reason": "invalid_characters" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/keywords/difficulty": { "post": { "operationId": "seoKeywordsDifficulty", "summary": "Bulk Keyword Difficulty", "description": "Get keyword difficulty (KD 0-100) for up to 1,000 keywords in a single request. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "Array of keywords to score (max 1,000)" }, "location": { "type": "string", "description": "Target country as a two-letter code (e.g., \"us\", \"gb\")", "default": "us" }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keywords": [ { "difficulty": 0, "keyword": "email finder api" }, { "difficulty": 22, "keyword": "seo api" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/keywords/ideas": { "post": { "operationId": "seoKeywordsIdeas", "summary": "Keyword Ideas", "description": "Generate hundreds of keyword ideas from any seed keyword with search volume, CPC, and difficulty scores. Cost: from $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Seed keyword to generate ideas from (e.g., \"react framework\")" }, "limit": { "type": "number", "description": "Maximum number of keyword ideas to return", "default": 50 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" }, "filters": { "type": "array", "description": "Up to 8 filter expressions on friendly field names (volume, cpc, competition, competitionLevel, difficulty, intent, keyword, words, length). `words`/`length` filter by keyword length. See /reference/keyword-filters.", "maxItems": 8, "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string", "enum": [ ">", ">=", "<", "<=", "=", "!=", "in", "nin", "like", "not_like" ] }, "value": {} }, "required": [ "field", "op", "value" ] } }, "match": { "type": "string", "enum": [ "all", "any" ], "default": "all", "description": "Combine filters with AND (all) or OR (any)." }, "sort": { "type": "array", "description": "Up to 3 sort rules like \"volume:desc\".", "maxItems": 3, "items": { "type": "string" } } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "seed": "email marketing", "keywords": [ { "keyword": "marketing email platforms", "volume": 22200, "cpc": 72.63, "difficulty": 77, "competition": 0.2, "competitionLevel": "LOW", "intent": "commercial", "avgBacklinks": 97860.5, "avgReferringDomains": 9312.9, "serpFeatures": [], "totalResults": 0, "trend": [ { "month": "2026-02", "volume": 9900 }, { "month": "2026-01", "volume": 14800 }, { "month": "2025-12", "volume": 33100 } ] }, { "keyword": "email marketing platform", "volume": 22200, "cpc": 72.63, "difficulty": 80, "competition": 0.2, "competitionLevel": "LOW", "intent": "commercial", "avgBacklinks": 119229.5, "avgReferringDomains": 9397.5, "serpFeatures": [], "totalResults": 0, "trend": [ { "month": "2026-02", "volume": 9900 }, { "month": "2026-01", "volume": 14800 }, { "month": "2025-12", "volume": 33100 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/keywords/intent": { "post": { "operationId": "seoKeywordsIntent", "summary": "Search Intent", "description": "Classify search intent for up to 1,000 keywords, with a confidence probability and secondary intents. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "Array of keywords to classify (max 1,000)" }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keywords": [ { "intent": "informational", "keyword": "seo api", "probability": 0.972, "secondaryIntents": [] }, { "intent": "transactional", "keyword": "buy running shoes", "probability": 1, "secondaryIntents": [] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/keywords/overview": { "post": { "operationId": "seoKeywordsOverview", "summary": "Keyword Overview", "description": "Full per-keyword metrics — search volume, difficulty, intent, CPC, competition, backlinks, and 12-month trend. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "Array of keywords to analyze (max 700)" }, "location": { "type": "string", "description": "Target country as a two-letter code (e.g., \"us\", \"gb\")", "default": "us" }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keywords": [ { "avgBacklinks": 4063.5, "avgReferringDomains": 803.9, "competition": 0.37, "competitionLevel": "MEDIUM", "cpc": 38.51, "difficulty": 0, "intent": "informational", "keyword": "email finder api", "serpFeatures": [], "totalResults": 0, "trend": [ { "month": "2026-05", "volume": 20 }, { "month": "2026-04", "volume": 30 }, { "month": "2026-03", "volume": 50 } ], "volume": 40 }, { "avgBacklinks": 2185, "avgReferringDomains": 141.3, "competition": 0.1, "competitionLevel": "LOW", "cpc": 25.29, "difficulty": 22, "intent": "commercial", "keyword": "seo api", "serpFeatures": [], "totalResults": 0, "trend": [ { "month": "2026-05", "volume": 390 }, { "month": "2026-04", "volume": 260 }, { "month": "2026-03", "volume": 320 } ], "volume": 480 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/keywords/related": { "post": { "operationId": "seoKeywordsRelated", "summary": "Related Keywords", "description": "Discover semantically related keywords and variations with search volume, CPC, and difficulty. Cost: from $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Seed keyword to find related terms for (e.g., \"email marketing\")" }, "limit": { "type": "number", "description": "Maximum number of related keywords to return", "default": 50 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" }, "filters": { "type": "array", "description": "Up to 8 filter expressions on friendly field names (volume, cpc, competition, competitionLevel, difficulty, intent, keyword, words, length). `words`/`length` filter by keyword length. See /reference/keyword-filters.", "maxItems": 8, "items": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string", "enum": [ ">", ">=", "<", "<=", "=", "!=", "in", "nin", "like", "not_like" ] }, "value": {} }, "required": [ "field", "op", "value" ] } }, "match": { "type": "string", "enum": [ "all", "any" ], "default": "all", "description": "Combine filters with AND (all) or OR (any)." }, "sort": { "type": "array", "description": "Up to 3 sort rules like \"volume:desc\".", "maxItems": 3, "items": { "type": "string" } } }, "required": [ "keyword" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "seed": "email marketing", "keywords": [ { "keyword": "email marketing", "volume": 18100, "cpc": 46.41, "difficulty": 73, "competition": 0.17, "competitionLevel": "LOW", "intent": "informational", "avgBacklinks": 5295.1, "avgReferringDomains": 708.5, "serpFeatures": [ "images", "organic", "peopleAlsoAsk", "video", "perspectives", "relatedSearches" ], "totalResults": 2370000000, "trend": [ { "month": "2026-03", "volume": 27100 }, { "month": "2026-02", "volume": 14800 }, { "month": "2026-01", "volume": 12100 } ] }, { "keyword": "email marketing jobs", "volume": 2900, "cpc": 3.95, "difficulty": 7, "competition": 0.12, "competitionLevel": "LOW", "intent": "informational", "avgBacklinks": 177.4, "avgReferringDomains": 6.7, "serpFeatures": [ "jobs", "organic", "peopleAlsoAsk", "relatedSearches" ], "totalResults": 1840000000, "trend": [ { "month": "2026-03", "volume": 2400 }, { "month": "2026-02", "volume": 2400 }, { "month": "2026-01", "volume": 2900 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/onpage/content": { "post": { "operationId": "seoOnpageContent", "summary": "Content Parsing", "description": "Extract and analyze page content — text, structure, and readability scores. Cost: $0.03/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full URL to parse" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "content": [ { "url": "https://vercel.com/blog/next-15", "title": "Introducing Next.js 15", "description": "Next.js 15 brings...", "wordCount": 3200, "automatedReadabilityIndex": 12.5, "colemanLiauIndex": 11.8, "fleschReadingEase": 52.3 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/onpage/instant": { "post": { "operationId": "seoOnpageInstant", "summary": "Instant Page Audit", "description": "Run an instant technical SEO audit on any page — meta tags, headings, links, images. Cost: $0.03/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full URL to audit" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "pages": [ { "description": "Next.js by Vercel is the full-stack React framework for the web.", "externalLinks": 0, "h1": [ "The React Framework for the Web" ], "images": 0, "internalLinks": 0, "statusCode": 200, "timeToInteractive": 144, "title": "Next.js by Vercel - The React Framework", "url": "https://nextjs.org/", "wordCount": 316 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/onpage/lighthouse": { "post": { "operationId": "seoOnpageLighthouse", "summary": "Lighthouse Audit", "description": "Run a Google Lighthouse audit — performance, accessibility, SEO, and Core Web Vitals. Cost: $0.05/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full URL to audit" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "accessibilityScore": 0.96, "bestPracticesScore": 0.96, "cumulativeLayoutShift": 0, "firstContentfulPaint": 379.582, "largestContentfulPaint": 739.582, "performanceScore": 1, "seoScore": 1, "speedIndex": 517.72, "totalBlockingTime": 0, "url": "" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/seo/trends": { "post": { "operationId": "seoTrends", "summary": "Google Trends", "description": "Get Google Trends interest over time for up to 5 keywords. Cost: $0.02/call.", "tags": [ "SEO" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "Keywords to compare (max 5)" }, "location": { "type": "string", "description": "Country code", "default": "us" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "keywords": [ "react", "vue", "svelte" ], "timeline": [ { "date": "2026-03-01", "values": [ 85, 22, 12 ] }, { "date": "2026-04-01", "values": [ 88, 21, 14 ] } ], "averages": [ 86, 22, 13 ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp": { "post": { "operationId": "serp", "summary": "SERP Analysis", "description": "Get the top search results for any query with rich snippet data, paid ads, knowledge graphs, and 30+ result types. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to analyze" }, "location_code": { "type": "number", "description": "Target country code. See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code", "default": "en" }, "depth": { "type": "number", "description": "Number of results (10, 20, 50, 100)", "default": 10 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "nextjs seo", "totalResults": 3230000, "itemTypes": [ "aiOverview", "organic", "peopleAlsoAsk", "relatedSearches" ], "results": [ { "position": 1, "type": "aiOverview", "title": "", "url": "", "description": "", "domain": "", "data": { "items": [ { "type": "aiOverviewElement", "title": "Next.js SEO Best Practices", "url": "https://nextjs.org/learn/seo", "domain": "nextjs.org" } ] } }, { "position": 2, "type": "organic", "title": "SEO", "url": "https://nextjs.org/learn/seo", "description": "SEO stands for Search Engine Optimization. The goal of SEO is to create a strategy that will increase your rankings position in search engine results.", "domain": "nextjs.org", "data": { "breadcrumb": "nextjs.org > learn > seo", "websiteName": "Next.js", "isFeaturedSnippet": false, "highlighted": [ "SEO" ] } }, { "position": 3, "type": "organic", "title": "Next.js SEO Complete Checklist : r/nextjs", "url": "https://www.reddit.com/r/nextjs/comments/195ikpf/nextjs_seo_complete_checklist/", "description": "I wrote this tutorial to show you guys all the necessary things that should be added to your Next.js app to help search engines understand your site better.", "domain": "www.reddit.com", "data": { "breadcrumb": "www.reddit.com > r > nextjs", "websiteName": "Reddit", "isFeaturedSnippet": false, "highlighted": [ "Next.js", "SEO" ] } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/baidu": { "post": { "operationId": "serpBaidu", "summary": "Baidu SERP", "description": "Baidu search results — organic rankings on China's dominant search engine. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to look up on Baidu" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "cloud computing", "totalResults": 0, "results": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/bing": { "post": { "operationId": "serpBing", "summary": "Bing SERP", "description": "Bing search results — organic rankings on Microsoft's search engine, powering Copilot and DuckDuckGo. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to look up on Bing" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "typescript vs javascript", "totalResults": 50, "results": [ { "position": 1, "type": "organic", "title": "Why use triple-equal (===) in TypeScript? - Stack Overflow", "url": "https://stackoverflow.com/questions/57125700/why-use-triple-equal-in-typescript", "description": "Jul 20, 2019 · Typescript actually does fix == vs === (as far as possible at least). In Javascript there are two comparison operators: == : When comparing primitive values, like numbers and strings, this ...", "domain": "stackoverflow.com" }, { "position": 2, "type": "organic", "title": "What is TypeScript and why should I use it instead of JavaScript ...", "url": "https://stackoverflow.com/questions/12694530/what-is-typescript-and-why-should-i-use-it-instead-of-javascript", "description": "What is the TypeScript language? What can it do that JavaScript or available libraries cannot do, that would give me reason to consider it?", "domain": "stackoverflow.com" }, { "position": 3, "type": "organic", "title": "When should I use ?? (nullish coalescing) vs || (logical ...", "url": "https://stackoverflow.com/questions/61480993/when-should-i-use-nullish-coalescing-vs-logical-or", "description": "The nullish coalescing operator (??) in JavaScript only considers null or undefined as \"nullish\" values. If the left-hand side is any other value, even falsy values like \"\" (empty string), 0, or false, it will not use ...", "domain": "stackoverflow.com" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google": { "post": { "operationId": "serpGoogle", "summary": "Google SERP", "description": "Real-time Google search results — organic rankings, paid ads, featured snippets, People Also Ask, knowledge graphs, local packs, and 30+ rich result types. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to look up on Google" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "pizza near me", "totalResults": 1470000000, "itemTypes": [ "paid", "localPack", "organic", "peopleAlsoAsk", "relatedSearches" ], "results": [ { "position": 1, "type": "paid", "title": "Pizza Delivery - Order Online Now", "url": "https://www.dominos.com/", "description": "Get hot, fresh pizza delivered to your door. Order online for exclusive deals.", "domain": "www.dominos.com", "data": { "breadcrumb": "https://www.dominos.com", "highlighted": [ "Pizza Delivery", "Order Online" ], "extra": { "type": "organic", "links": [ { "title": "Order Pizza Online", "url": "https://www.dominos.com/pages/order/" } ] }, "descriptionRows": [ "Free delivery on orders over $20" ] } }, { "position": 2, "type": "localPack", "title": "Joe's Pizza", "url": "", "description": "", "domain": "", "data": { "rating": { "ratingType": "Max5", "value": 4.7, "votesCount": 2341 }, "phone": "+1-212-555-0199", "address": "7 Carmine St, New York, NY 10014", "cid": "12345678901234567890", "isMapsItem": true } }, { "position": 5, "type": "organic", "title": "Best Pizza Near Me - Find Local Pizza Restaurants", "url": "https://www.yelp.com/search?find_desc=pizza", "description": "Find the best pizza near you with Yelp's comprehensive directory of local pizza restaurants, reviews, and ratings.", "domain": "www.yelp.com", "data": { "breadcrumb": "www.yelp.com > search", "websiteName": "Yelp", "isFeaturedSnippet": false, "isImage": false, "isVideo": false, "highlighted": [ "pizza", "near" ], "links": [ { "type": "link_element", "title": "Pizza Delivery", "url": "https://www.yelp.com/search?find_desc=pizza+delivery" } ], "rating": { "ratingType": "Max5", "value": 4.2, "votesCount": 890 } } }, { "position": 8, "type": "peopleAlsoAsk", "title": "People also ask", "url": "", "description": "", "domain": "", "data": { "items": [ { "type": "peopleAlsoAskElement", "title": "What is the best pizza chain?", "expandedElement": [ { "type": "peopleAlsoAskExpandedElement", "title": "Best Pizza Chains Ranked", "url": "https://www.example.com/best-pizza-chains", "domain": "www.example.com", "description": "According to a nationwide survey..." } ] } ] } }, { "position": 11, "type": "relatedSearches", "title": "", "url": "", "description": "", "domain": "", "data": { "items": [ "best pizza delivery near me", "pizza places open now", "cheap pizza near me" ] } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-ads": { "post": { "operationId": "serpGoogleAds", "summary": "Google Ads Transparency", "description": "Google Ads Transparency Center results — active ads, advertisers, and ad creatives. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to find ads in the Google Ads Transparency Center" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "project management software", "totalResults": 0, "results": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-ai-mode": { "post": { "operationId": "serpGoogleAiMode", "summary": "Google AI Mode", "description": "Google AI Mode results — AI-generated answers, cited sources, and AI Overview data. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to retrieve Google AI Mode results for" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "what is retrieval augmented generation", "totalResults": 0, "results": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-autocomplete": { "post": { "operationId": "serpGoogleAutocomplete", "summary": "Google Autocomplete", "description": "Real-time Google Autocomplete suggestions — search predictions and query completions. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Partial search query to get autocomplete suggestions for" }, "depth": { "type": "number", "description": "Number of suggestions to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "how to build a", "totalResults": 0, "results": [ { "position": 1, "type": "autocomplete", "title": "", "url": "", "description": "", "domain": "" }, { "position": 2, "type": "autocomplete", "title": "", "url": "", "description": "", "domain": "" }, { "position": 3, "type": "autocomplete", "title": "", "url": "", "description": "", "domain": "" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-datasets": { "post": { "operationId": "serpGoogleDatasets", "summary": "Google Datasets", "description": "Google Dataset Search results — public datasets, data sources, and structured data. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Dataset search query to look up on Google Dataset Search" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "global temperature data", "totalResults": 119, "results": [ { "position": 1, "type": "dataset", "title": "Global Temperature Time Series", "url": "", "description": "", "domain": "" }, { "position": 2, "type": "dataset", "title": "Global land and ocean temperature anomalies 1880-2024", "url": "", "description": "", "domain": "" }, { "position": 3, "type": "dataset", "title": "Global Temperatures by Country", "url": "", "description": "", "domain": "" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-finance": { "post": { "operationId": "serpGoogleFinance", "summary": "Google Finance", "description": "Google Finance results — stock tickers, market data, financial news, and indices. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Finance search query to look up on Google Finance" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "AAPL stock", "totalResults": 0, "results": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-images": { "post": { "operationId": "serpGoogleImages", "summary": "Google Images", "description": "Google Image search results — thumbnails, source URLs, titles, and image metadata. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Image search query to look up on Google Images" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "modern dashboard UI", "totalResults": 0, "results": [ { "position": 2, "type": "imagesSearch", "title": "Modern Dashboard Design designs, themes ...", "url": "https://dribbble.com/tags/modern-dashboard-design", "description": "", "domain": "" }, { "position": 3, "type": "imagesSearch", "title": "Modern Dashboard UI Design Design ...", "url": "https://www.figma.com/community/file/1339194361793974200/modern-dashboard-ui-design-design-free", "description": "", "domain": "" }, { "position": 4, "type": "imagesSearch", "title": "Dashboard Design: best practices and ...", "url": "https://www.justinmind.com/ui-design/dashboard-design-best-practices-ux", "description": "", "domain": "" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-maps": { "post": { "operationId": "serpGoogleMaps", "summary": "Google Maps", "description": "Google Maps Places search — full place data sourced live from Google Maps. Ratings, reviews, hours, photos, contact info, amenities, and AI summaries. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Text query, e.g. \"restaurants in chicago\", \"coffee shops near times square\"." }, "limit": { "type": "number", "description": "Number of places to return (1–20). Use nextPageToken for more.", "default": 10 }, "language": { "type": "string", "description": "BCP-47 language code (e.g. en, es, fr).", "default": "en" }, "region": { "type": "string", "description": "CLDR region code (e.g. us, gb, de). Biases results to a country." }, "rank_by": { "type": "string", "description": "\"relevance\" or \"distance\". distance requires latitude + longitude + radius.", "default": "relevance" }, "open_now": { "type": "boolean", "description": "Restrict to places open at request time.", "default": false }, "min_rating": { "type": "number", "description": "Minimum average star rating (0.0–5.0)." }, "price_levels": { "type": "array", "items": { "type": "string" }, "description": "Filter by price tier(s). Any of free, inexpensive, moderate, expensive, very_expensive." }, "included_type": { "type": "string", "description": "Restrict to a single Google Place type (e.g. restaurant, cafe, bar, gym)." }, "latitude": { "type": "number", "description": "Center latitude for an optional location bias circle." }, "longitude": { "type": "number", "description": "Center longitude for an optional location bias circle." }, "radius": { "type": "number", "description": "Radius in meters (1–50000). All three of latitude, longitude, radius must be provided together." } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "restaurants in chicago", "totalResults": 1, "nextPageToken": "AU_ZVEFqNRxa-OTq...", "searchUrl": "https://www.google.com/maps/search/restaurants+in+chicago", "results": [ { "id": "ChIJs8mbNsUsDogRUnpg-b_IK5E", "name": "Girl & The Goat", "primaryType": "american_restaurant", "primaryTypeDisplay": "American Restaurant", "types": [ "brunch_restaurant", "seafood_restaurant", "american_restaurant", "restaurant", "food" ], "address": "809 W Randolph St, Chicago, IL 60607, USA", "shortAddress": "809 W Randolph St, Chicago", "addressComponents": { "city": "Chicago", "state": "Illinois", "country": "US", "postalCode": "60607", "neighborhood": "Fulton Market District" }, "phone": "(312) 492-6262", "internationalPhone": "+1 312-492-6262", "website": "http://www.girlandthegoat.com/", "googleMapsUrl": "https://maps.google.com/?cid=10460675286346267218", "latitude": 41.8841279, "longitude": -87.6479354, "plusCode": "86HJV9M2+MR", "rating": 4.7, "userRatingCount": 7713, "priceLevel": "expensive", "priceRange": { "min": 50, "max": 100, "currency": "USD" }, "businessStatus": "OPERATIONAL", "openNow": false, "hours": [ "Monday: 4:30 – 10:00 PM", "Tuesday: 4:30 – 10:00 PM", "Wednesday: 4:30 – 10:00 PM", "Thursday: 4:30 – 10:00 PM", "Friday: 4:30 – 11:00 PM", "Saturday: 4:00 – 11:00 PM", "Sunday: 10:00 AM – 2:00 PM, 4:30 – 10:00 PM" ], "nextOpenTime": "2026-04-22T21:30:00Z", "timezone": "America/Chicago", "summary": "Hot spot where Stephanie Izard serves up innovative small plates...", "aiSummary": "Cool eatery serving small dishes as well as familiar fare based on American recipes...", "reviewSummary": "People say this restaurant serves delicious goat empanadas, skirt steak, and great cocktails.", "iconUrl": "https://maps.gstatic.com/mapfiles/place_api/icons/v2/restaurant_pinlet.png", "iconBackgroundColor": "#FF9E67", "amenities": { "dineIn": true, "takeout": true, "delivery": false, "reservable": true, "servesDinner": true, "servesCocktails": true, "outdoorSeating": false, "goodForGroups": true }, "payments": { "acceptsCreditCards": true, "acceptsDebitCards": true, "acceptsNfc": true, "acceptsCashOnly": false }, "parking": { "paidStreetParking": true, "valetParking": true }, "accessibility": { "wheelchairAccessibleEntrance": true, "wheelchairAccessibleRestroom": true, "wheelchairAccessibleSeating": true }, "photos": [ { "reference": "places/ChIJs8mbNsUsDogRUnpg-b_IK5E/photos/AU_ZVEFd3Y9YtVSYWUZf4lYRda5p51TB2iSOLW...", "width": 1200, "height": 788, "attribution": "Girl & The Goat", "googleMapsUrl": "https://www.google.com/maps/place//data=!3m4!1e2!3m2!..." } ], "topReview": { "rating": 5, "text": "Dining at Girl & the Goat was an amazing experience for my family on Christmas!...", "author": "Jisoo Choi", "publishedAt": "2026-01-15T18:12:52Z", "relativeTime": "3 months ago" }, "directionsUrl": "https://www.google.com/maps/dir//...", "reviewsUrl": "https://www.google.com/maps/place//...", "photosUrl": "https://www.google.com/maps/place//...", "writeReviewUrl": "https://www.google.com/maps/place//..." } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/google-news": { "post": { "operationId": "serpGoogleNews", "summary": "Google News", "description": "Google News results — headlines, publication sources, timestamps, and article URLs. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "News search query to look up on Google News" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "artificial intelligence startups", "totalResults": 38000, "results": [ { "position": 1, "type": "newsSearch", "title": "Exclusive | Startup Targets New Frontier for AI: Construction Drawings", "url": "https://www.wsj.com/pro/venture-capital/startup-targets-new-frontier-for-ai-construction-drawings-cbf5b51c", "description": "", "domain": "www.wsj.com" }, { "position": 2, "type": "newsSearch", "title": "Venture firm TSVC seeks $120M for targeting physical AI", "url": "https://www.bizjournals.com/sanjose/news/2026/04/13/tsvc-fund-filing-120-million.html", "description": "", "domain": "www.bizjournals.com" }, { "position": 3, "type": "newsSearch", "title": "Chinese AI startup StepFun to unwind offshore structure to pave way for IPO, sources say", "url": "https://www.reuters.com/world/china/chinese-ai-startup-stepfun-unwind-offshore-structure-pave-way-ipo-sources-say-2026-04-13/", "description": "", "domain": "www.reuters.com" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/yahoo": { "post": { "operationId": "serpYahoo", "summary": "Yahoo SERP", "description": "Yahoo search results — organic rankings and search data from Yahoo. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to look up on Yahoo" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "best laptops 2026", "totalResults": 0, "results": [ { "position": 1, "type": "organic", "title": "The Best Laptops We've Tested (April 2026) | PCMag", "url": "https://www.pcmag.com/picks/the-best-laptops", "description": "Apr 1, 2026 · Read on to see all our picks, compare their specs, and get down-to-earth buying advice for nailing down the best laptop for you.", "domain": "www.pcmag.com" }, { "position": 2, "type": "organic", "title": "Best Laptops 2026 - Forbes Vetted", "url": "https://www.forbes.com/sites/forbes-personal-shopper/article/best-laptop/", "description": "Apr 1, 2026 · We tested 18 models across a variety of brands to find the best laptops of 2026.", "domain": "www.forbes.com" }, { "position": 3, "type": "organic", "title": "13 Of The Best Laptops You Can Buy In 2026 - SlashGear", "url": "https://www.slashgear.com/2116777/best-laptops-buy-in-2026/", "description": "Mar 10, 2026 · We've chosen laptops for 13 unique categories, including the best budget-friendly laptop, best gaming laptop, best Chromebook, and even best repairable laptop.", "domain": "www.slashgear.com" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/serp/youtube": { "post": { "operationId": "serpYoutube", "summary": "YouTube SERP", "description": "YouTube search results via SERP — video rankings, channel data, and metadata. Cost: $0.01/call.", "tags": [ "SERP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to look up on YouTube" }, "depth": { "type": "number", "description": "Number of results to return", "default": 10 }, "location_code": { "type": "number", "description": "Target country code (e.g., 2840 for US). See [Location Codes](/reference/location-codes).", "default": 2840 }, "language": { "type": "string", "description": "ISO language code (e.g., en, es)", "default": "en" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "nextjs tutorial", "totalResults": 0, "results": [] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/challenge": { "post": { "operationId": "tiktokChallenge", "summary": "Challenge Info", "description": "Get details about a TikTok challenge (hashtag challenge). Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "challenge_name": { "type": "string", "description": "Challenge hashtag name (without #)" }, "challenge_id": { "type": "string", "description": "Challenge ID (alternative to name)" } }, "required": [ "challenge_name", "challenge_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "challenge_id": "1677534536829953", "challenge_name": "dancechallenge", "description": "Show us your best moves! Join the dance challenge.", "video_count": 48500000, "view_count": 125000000000, "cover": "https://p16-sign.tiktokcdn.com/...", "is_commercial": false } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/challenge-videos": { "post": { "operationId": "tiktokChallengeVideos", "summary": "Challenge Videos", "description": "Get videos associated with a TikTok challenge (hashtag challenge). Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "challenge_id": { "type": "string", "description": "TikTok challenge ID" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "challenge_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "20", "videos": [ { "video_id": "7356291048572839174", "description": "My entry for #dancechallenge", "create_time": 1712345678, "author": { "unique_id": "dancer_jane", "nickname": "Jane Dance", "avatar": "https://p16-sign.tiktokcdn.com/..." }, "statistics": { "play_count": 3200000, "digg_count": 245000, "comment_count": 5600, "share_count": 18000 }, "video": { "duration": 30, "cover": "https://p16-sign.tiktokcdn.com/...", "play_addr": "https://v16-webapp.tiktok.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/comment-replies": { "post": { "operationId": "tiktokCommentReplies", "summary": "Comment Replies", "description": "Get replies to a specific comment on a TikTok video. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "comment_id": { "type": "string", "description": "ID of the parent comment" }, "video_id": { "type": "string", "description": "ID of the video containing the comment" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "comment_id", "video_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": false, "cursor": "12", "replies": [ { "comment_id": "7356291048572839180", "text": "Thank you! I used penne", "create_time": 1712348000, "digg_count": 230, "author": { "unique_id": "chefmaria", "nickname": "Chef Maria", "avatar": "https://p16-sign.tiktokcdn.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/comments": { "post": { "operationId": "tiktokComments", "summary": "Video Comments", "description": "Get comments for a TikTok video with pagination. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full TikTok video URL" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "20", "total_comments": 3200, "comments": [ { "comment_id": "7356291048572839175", "text": "This recipe is amazing! Made it last night", "create_time": 1712346000, "digg_count": 4500, "reply_count": 12, "author": { "unique_id": "foodlover99", "nickname": "Food Lover", "avatar": "https://p16-sign.tiktokcdn.com/..." } }, { "comment_id": "7356291048572839176", "text": "What type of pasta did you use?", "create_time": 1712347000, "digg_count": 890, "reply_count": 3, "author": { "unique_id": "homecook_mike", "nickname": "Mike Cooks", "avatar": "https://p16-sign.tiktokcdn.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/music": { "post": { "operationId": "tiktokMusic", "summary": "Music Info", "description": "Get details about a TikTok sound/music track. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full TikTok music/sound URL" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "music_id": "7123456789012345678", "title": "original sound", "author": "chefmaria", "album": "", "duration": 45, "is_original": true, "cover": "https://p16-sign.tiktokcdn.com/...", "play_url": "https://sf16-ies-music.tiktokcdn.com/...", "video_count": 12500 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/music-videos": { "post": { "operationId": "tiktokMusicVideos", "summary": "Music Videos", "description": "Get videos that use a specific TikTok sound/music track. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "music_id": { "type": "string", "description": "TikTok music/sound ID" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "music_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "20", "videos": [ { "video_id": "7356291048572839174", "description": "My take on this trending sound #fyp", "create_time": 1712345678, "author": { "unique_id": "dancer_jane", "nickname": "Jane Dance", "avatar": "https://p16-sign.tiktokcdn.com/..." }, "statistics": { "play_count": 890000, "digg_count": 67000, "comment_count": 1200 }, "video": { "duration": 30, "cover": "https://p16-sign.tiktokcdn.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/search": { "post": { "operationId": "tiktokSearch", "summary": "TikTok Search", "description": "Search TikTok for videos matching a keyword query. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "string", "description": "Search query" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "20", "videos": [ { "video_id": "7356291048572839174", "description": "Easy 15-minute pasta recipe #cooking #recipes #foodtok", "create_time": 1712345678, "author": { "unique_id": "chefmaria", "nickname": "Chef Maria", "avatar": "https://p16-sign.tiktokcdn.com/..." }, "statistics": { "play_count": 2450000, "digg_count": 185000, "comment_count": 3200, "share_count": 12500 }, "video": { "duration": 45, "cover": "https://p16-sign.tiktokcdn.com/...", "play_addr": "https://v16-webapp.tiktok.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/search-challenge": { "post": { "operationId": "tiktokSearchChallenge", "summary": "Search Challenges", "description": "Search TikTok for challenges (hashtag challenges) matching a keyword query. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "string", "description": "Search query for challenges" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "20", "challenges": [ { "challenge_id": "1677534536829953", "challenge_name": "dancechallenge", "description": "Show us your best moves!", "video_count": 48500000, "view_count": 125000000000, "cover": "https://p16-sign.tiktokcdn.com/..." } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/search-photo": { "post": { "operationId": "tiktokSearchPhoto", "summary": "Search Photos", "description": "Search TikTok for photo posts matching a keyword query. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "string", "description": "Search query for photo posts" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "20", "photos": [ { "video_id": "7389012345678901234", "description": "Hidden gems in Bali #travel #photography", "create_time": 1712456789, "author": { "unique_id": "traveler_jake", "nickname": "Jake Travels", "avatar": "https://p16-sign.tiktokcdn.com/..." }, "images": [ "https://p16-sign.tiktokcdn.com/image1.jpg", "https://p16-sign.tiktokcdn.com/image2.jpg" ], "statistics": { "digg_count": 45000, "comment_count": 890, "share_count": 2300 } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/search-user": { "post": { "operationId": "tiktokSearchUser", "summary": "Search Users", "description": "Search TikTok for user accounts matching a keyword query. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "string", "description": "Search query for users" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "keywords" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "20", "users": [ { "unique_id": "chefmaria", "nickname": "Chef Maria", "avatar": "https://p16-sign.tiktokcdn.com/...", "signature": "Professional chef sharing quick recipes", "follower_count": 1250000, "following_count": 342, "video_count": 487, "is_verified": true } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/user": { "post": { "operationId": "tiktokUser", "summary": "User Profile", "description": "Get profile information for a TikTok user by their unique handle. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "unique_id": { "type": "string", "description": "TikTok username (without @)" } }, "required": [ "unique_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "user_id": "6842123456789012345", "unique_id": "chefmaria", "nickname": "Chef Maria", "avatar": "https://p16-sign.tiktokcdn.com/...", "signature": "Professional chef sharing quick recipes. New videos daily!", "is_verified": true, "region": "US", "language": "en", "follower_count": 1250000, "following_count": 342, "heart_count": 28500000, "video_count": 487, "digg_count": 12300 } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/user-favorites": { "post": { "operationId": "tiktokUserFavorites", "summary": "User Favorites", "description": "Get a list of videos that a TikTok user has favorited (bookmarked). Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "TikTok user ID (numeric)" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "user_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "1712345678", "videos": [ { "video_id": "7389012345678901234", "description": "The best chocolate cake recipe ever! #baking", "create_time": 1712456789, "author": { "unique_id": "bakingqueen", "nickname": "Baking Queen", "avatar": "https://p16-sign.tiktokcdn.com/..." }, "statistics": { "play_count": 5600000, "digg_count": 420000, "comment_count": 8900 }, "video": { "duration": 60, "cover": "https://p16-sign.tiktokcdn.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/user-followers": { "post": { "operationId": "tiktokUserFollowers", "summary": "User Followers", "description": "Get a list of followers for a TikTok user. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "TikTok user ID (numeric)" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "user_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "50", "followers": [ { "user_id": "6891234567890123456", "unique_id": "foodlover99", "nickname": "Food Lover", "avatar": "https://p16-sign.tiktokcdn.com/...", "signature": "I love cooking!", "follower_count": 1200, "is_verified": false } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/user-following": { "post": { "operationId": "tiktokUserFollowing", "summary": "User Following", "description": "Get a list of accounts that a TikTok user follows. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "TikTok user ID (numeric)" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "user_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "50", "following": [ { "user_id": "6891234567890123456", "unique_id": "gordonramsay", "nickname": "Gordon Ramsay", "avatar": "https://p16-sign.tiktokcdn.com/...", "signature": "Official TikTok of Gordon Ramsay", "follower_count": 45000000, "is_verified": true } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/user-posts": { "post": { "operationId": "tiktokUserPosts", "summary": "User Posts", "description": "Get a list of videos posted by a TikTok user. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "TikTok user ID (numeric)" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "user_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "1712345678", "videos": [ { "video_id": "7356291048572839174", "description": "Easy 15-minute pasta recipe #cooking #recipes", "create_time": 1712345678, "statistics": { "play_count": 2450000, "digg_count": 185000, "comment_count": 3200, "share_count": 12500 }, "video": { "duration": 45, "cover": "https://p16-sign.tiktokcdn.com/...", "play_addr": "https://v16-webapp.tiktok.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/user-reposts": { "post": { "operationId": "tiktokUserReposts", "summary": "User Reposts", "description": "Get a list of videos that a TikTok user has reposted. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string", "description": "TikTok user ID (numeric)" }, "cursor": { "type": "string", "description": "Pagination cursor from previous response" }, "count": { "type": "string", "description": "Number of results to return (pass as string, e.g. \"20\")", "default": "20" } }, "required": [ "user_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "has_more": true, "cursor": "1712345678", "videos": [ { "video_id": "7401234567890123456", "description": "This hack changed my life #lifehack", "create_time": 1712567890, "author": { "unique_id": "hackmaster", "nickname": "Hack Master", "avatar": "https://p16-sign.tiktokcdn.com/..." }, "statistics": { "play_count": 8900000, "digg_count": 650000, "comment_count": 12000 }, "video": { "duration": 30, "cover": "https://p16-sign.tiktokcdn.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/user-story": { "post": { "operationId": "tiktokUserStory", "summary": "User Story", "description": "Get the current story for a TikTok user. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "unique_id": { "type": "string", "description": "TikTok username (without @)" } }, "required": [ "unique_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "user_id": "6842123456789012345", "unique_id": "chefmaria", "stories": [ { "story_id": "7412345678901234567", "create_time": 1712678901, "expire_time": 1712765301, "video": { "duration": 15, "cover": "https://p16-sign.tiktokcdn.com/...", "play_addr": "https://v16-webapp.tiktok.com/..." } } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/tiktok/video": { "post": { "operationId": "tiktokVideo", "summary": "Video Details", "description": "Get full details for a TikTok video including metadata, statistics, and media URLs. Cost: $0.01/call.", "tags": [ "TikTok" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full TikTok video URL" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "video_id": "7356291048572839174", "description": "Easy 15-minute pasta recipe #cooking #recipes", "create_time": 1712345678, "author": { "unique_id": "chefmaria", "nickname": "Chef Maria", "avatar": "https://p16-sign.tiktokcdn.com/...", "is_verified": true }, "statistics": { "play_count": 2450000, "digg_count": 185000, "comment_count": 3200, "share_count": 12500, "collect_count": 89000 }, "video": { "duration": 45, "width": 1080, "height": 1920, "cover": "https://p16-sign.tiktokcdn.com/...", "play_addr": "https://v16-webapp.tiktok.com/...", "download_addr": "https://v16-webapp.tiktok.com/..." }, "music": { "id": "7123456789012345678", "title": "original sound", "author": "chefmaria", "cover": "https://p16-sign.tiktokcdn.com/...", "play_url": "https://sf16-ies-music.tiktokcdn.com/..." } } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel": { "post": { "operationId": "youtubeChannel", "summary": "Channel Home", "description": "Get channel homepage content from YouTube. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "title": "Google for Developers", "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", "channelHandle": "@GoogleDevelopers", "description": "Subscribe to join a community of creative developers and learn the latest in Google technology...", "subscriberCount": 2620000, "subscriberCountText": "2.62M", "videosCount": 6300, "videosCountText": "6.3K videos", "isFamilySafe": true, "isUnlisted": false, "tabs": [ "Home", "Videos", "Shorts", "Live", "Courses", "Playlists", "Posts", "Search" ], "avatar": [ { "url": "https://yt3.ggpht.com/...", "width": 48, "height": 48 } ], "banner": [ { "url": "https://yt3.ggpht.com/...", "width": 1060, "height": 175 } ] }, "data": [ { "type": "player", "videoId": "bc5X2iVyJc0", "title": "Add Gemini Live agents to your video conferencing with Fishjam", "description": "Adrian from Software Mansion walks through how to connect...", "viewCount": "3174", "publishedTimeText": "5 days ago" }, { "type": "video_listing", "title": "AI Tools & Innovations", "data": [ { "type": "video", "videoId": "zEMXCoqJodE", "title": "AI coding with Gemini CLI", "lengthText": "38:29", "viewCount": "40532" } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-about": { "post": { "operationId": "youtubeChannelAbout", "summary": "Channel About", "description": "Get channel description, links, and stats. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "description": "TED is a nonprofit devoted to spreading ideas...", "country": "United States", "subscriberCount": "24.5M", "viewCount": "10B", "joinedDate": "2006-06-27", "links": [ { "title": "Official site", "url": "https://ted.com" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-channels": { "post": { "operationId": "youtubeChannelChannels", "summary": "Featured Channels", "description": "Get featured and related channels from a YouTube channel. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "data": [ { "type": "channel", "channelId": "UCsooa4yRKGN_zEE8iknghZA", "title": "TED-Ed", "channelHandle": "@TEDEd", "subscriberCountText": "1.2M subscribers", "thumbnail": [ { "url": "https://yt3.ggpht.com/...", "width": 88, "height": 88 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-community": { "post": { "operationId": "youtubeChannelCommunity", "summary": "Channel Community", "description": "Get community posts from a YouTube channel. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "token": { "type": "string", "description": "Pagination token" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "channelId": "UCAuUUnT6oDeKwE6v1NGQxug" }, "data": [ { "postId": "UgkxMy8D54...", "authorText": "TED", "contentText": "What topic should we cover next?", "likeCount": 1234, "publishedTimeText": "3 days ago", "thumbnail": [ { "url": "https://yt3.ggpht.com/...", "width": 48, "height": 48 } ] } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-livestreams": { "post": { "operationId": "youtubeChannelLivestreams", "summary": "Channel Livestreams", "description": "List livestreams from a YouTube channel. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "sort_by": { "type": "string", "description": "Sort order", "default": "newest" }, "token": { "type": "string", "description": "Pagination token" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "channelId": "UCAuUUnT6oDeKwE6v1NGQxug" }, "data": [ { "type": "video", "videoId": "abc123", "title": "TED Live: Innovation Summit", "viewCountText": "250K views", "publishedTimeText": "Streamed 3 days ago", "lengthText": "2:15:30", "thumbnail": [ { "url": "https://i.ytimg.com/vi/abc123/hqdefault.jpg", "width": 168, "height": 94 } ] } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-playlists": { "post": { "operationId": "youtubeChannelPlaylists", "summary": "Channel Playlists", "description": "List playlists from a YouTube channel. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "token": { "type": "string", "description": "Pagination token" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "channelId": "UCAuUUnT6oDeKwE6v1NGQxug" }, "data": [ { "type": "playlist", "playlistId": "PLrAXtmErZgO...", "title": "The Most Popular TED Talks of All Time", "videoCount": "25", "thumbnail": [ { "url": "https://i.ytimg.com/vi/abc123/hqdefault.jpg", "width": 168, "height": 94 } ] } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-search": { "post": { "operationId": "youtubeChannelSearch", "summary": "Channel Search", "description": "Search within a specific YouTube channel. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "query": { "type": "string", "description": "Search query" }, "token": { "type": "string", "description": "Pagination token" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id", "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "data": [ { "type": "video", "videoId": "abc123", "title": "The future of artificial intelligence", "viewCountText": "2.3M views", "publishedTimeText": "1 year ago", "lengthText": "18:05", "thumbnail": [ { "url": "https://i.ytimg.com/vi/abc123/hqdefault.jpg", "width": 168, "height": 94 } ] } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-shorts": { "post": { "operationId": "youtubeChannelShorts", "summary": "Channel Shorts", "description": "List shorts from a YouTube channel. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "sort_by": { "type": "string", "description": "Sort order" }, "token": { "type": "string", "description": "Pagination token" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "channelId": "UCAuUUnT6oDeKwE6v1NGQxug" }, "data": [ { "type": "shorts", "videoId": "abc123", "title": "Quick Tip: Public Speaking", "viewCountText": "5M views", "thumbnail": [ { "url": "https://i.ytimg.com/vi/abc123/hqdefault.jpg", "width": 168, "height": 94 } ] } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-store": { "post": { "operationId": "youtubeChannelStore", "summary": "Channel Store", "description": "Get channel merchandise and store items. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "data": [ { "title": "Official Merch", "price": "$24.99", "url": "https://store.example.com/item", "thumbnail": [ { "url": "https://...", "width": 168, "height": 94 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/channel-videos": { "post": { "operationId": "youtubeChannelVideos", "summary": "Channel Videos", "description": "List all videos from a YouTube channel. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube channel ID" }, "sort_by": { "type": "string", "description": "Sort order", "default": "newest" }, "token": { "type": "string", "description": "Pagination token" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "channelId": "UCAuUUnT6oDeKwE6v1NGQxug", "title": "TED" }, "data": [ { "type": "video", "videoId": "abc123", "title": "The most important talk of the year", "viewCount": "1200000", "viewCountText": "1.2M views", "publishedTimeText": "2 weeks ago", "lengthText": "15:42", "thumbnail": [ { "url": "https://i.ytimg.com/vi/abc123/hqdefault.jpg", "width": 168, "height": 94 } ] } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/comments": { "post": { "operationId": "youtubeComments", "summary": "Video Comments", "description": "Fetch comments and replies for any YouTube video with pagination. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" }, "sort": { "type": "string", "description": "Sort: top or new", "default": "top" }, "token": { "type": "string", "description": "Continuation token for pagination" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "commentsCount": "2433931", "continuation": "Eg0SC...", "data": [ { "commentId": "Ugzge340dBgB75hWBm54AaABAg", "authorText": "@YouTube", "authorChannelId": "UCBR8-60-B28hp2BmDPdntcQ", "authorIsChannelOwner": false, "authorThumbnail": [ { "url": "https://yt3.ggpht.com/...=s88-c-k-c0x00ffffff-no-rj", "width": 88, "height": 88 } ], "textDisplay": "can confirm: he never gave us up", "likesCount": "223K", "replyCount": "961", "publishDate": "2025-05-13", "publishedAt": "2025-05-13T00:00:00Z", "publishedTimeText": "11 months ago", "replyToken": "Eg0SC...", "isVerified": true, "isArtist": false, "isCreator": false }, { "commentId": "UgxIOV-sXAchpKX94cB4AaABAg", "authorText": "@ochkalov", "authorChannelId": "UCtbyFPryy7J4DR4xh5CRCvA", "authorIsChannelOwner": false, "textDisplay": "1987 : normal song \r\n2026 : national anthem of the universe", "likesCount": "126K", "replyCount": "933", "publishDate": "2020-04-13", "publishedAt": "2020-04-13T00:00:00Z", "publishedTimeText": "6 years ago (edited)", "isVerified": false } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/hashtag": { "post": { "operationId": "youtubeHashtag", "summary": "Hashtag Videos", "description": "Get videos for any YouTube hashtag with metadata. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "description": "Hashtag (without #)" }, "token": { "type": "string", "description": "Continuation token for pagination" } }, "required": [ "tag" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "hashtag": "#programming", "hashtagInfoText": "1.5M videos · 253K channels" }, "continuation": "4qmF...", "data": [ { "type": "video", "videoId": "naNcmnKskUE", "title": "Programming Basics Explained", "channelTitle": "Programming with Mosh", "channelId": "UCWv7vMbMWH4-V0ZXdmDpPBA", "channelHandle": "@programmingwithmosh", "channelBadges": [ "Verified" ], "isVerifiedChannel": true, "description": "", "viewCount": "500000", "viewCountText": "500K views", "publishDate": "2026-01-13", "publishedAt": "2026-01-13T00:00:00Z", "publishedTimeText": "3 months ago", "lengthText": "11:31", "thumbnail": [ { "url": "https://i.ytimg.com/vi/naNcmnKskUE/hqdefault.jpg", "width": 168, "height": 94 } ], "richThumbnail": [ { "url": "https://i.ytimg.com/an_webp/naNcmnKskUE/mqdefault_6s.webp", "width": 320, "height": 180 } ], "channelThumbnail": [ { "url": "https://yt3.ggpht.com/...=s68-c-k-c0x00ffffff-no-rj", "width": 68, "height": 68 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/home": { "post": { "operationId": "youtubeHome", "summary": "Home Feed", "description": "Get the YouTube homepage feed with algorithmically recommended videos. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "geo": { "type": "string", "description": "Country code (e.g. US)" }, "lang": { "type": "string", "description": "Language code (e.g. en)" }, "token": { "type": "string", "description": "Continuation token for pagination" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "filters": [ { "filter": "All" }, { "filter": "Music", "continuation": "4qmF..." }, { "filter": "News", "continuation": "4qmF..." } ], "continuation": "4qmF...", "data": [ { "type": "video", "videoId": "LhpZJwUboeI", "title": "Samay Raina - STILL ALIVE (Full Special)", "channelTitle": "Samay Raina", "channelId": "UCAov2BBv1ZJav0c_yHEciAw", "channelHandle": "@SamayRainaOfficial", "description": "", "viewCountText": "46M views", "publishDate": "2026-04-07", "publishedAt": "2026-04-07T00:00:00Z", "publishedTimeText": "6 days ago" }, { "type": "shorts_listing", "data": [ { "videoId": "...", "title": "Short Title", "viewCountText": "1.2M views" } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/hype": { "post": { "operationId": "youtubeHype", "summary": "YouTube Hype", "description": "Get the trending hype leaderboard by category on YouTube. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "geo": { "type": "string", "description": "Country code", "default": "US" }, "lang": { "type": "string", "description": "Language code" }, "token": { "type": "string", "description": "Pagination token" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "data": [ { "type": "video", "videoId": "jNM0fCbU7mU", "title": "Street Catz (Pilot)", "channelTitle": "GameBoyCat", "hypeText": "#1 hyped", "lengthText": "6:11", "thumbnail": [ { "url": "https://i.ytimg.com/vi_webp/jNM0fCbU7mU/mqdefault.webp", "width": 320, "height": 180 } ] }, { "type": "video", "videoId": "X6dUhg44Ph0", "title": "Criminal Ties | Season 1 - Ep. 9", "channelTitle": "drikathebaby", "hypeText": "#2 hyped", "lengthText": "59:10", "thumbnail": [ { "url": "https://i.ytimg.com/vi_webp/X6dUhg44Ph0/mqdefault.webp", "width": 320, "height": 180 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/metadata": { "post": { "operationId": "youtubeMetadata", "summary": "YouTube Metadata", "description": "Get live view and like counts for a YouTube video in real-time. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "id": "dQw4w9WgXcQ", "viewCount": "1762287921", "viewCountText": "1,762,287,921 views", "likeCount": 18936262, "likeCountText": "18M" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/playlist": { "post": { "operationId": "youtubePlaylist", "summary": "Playlist", "description": "Get playlist details and all videos in a YouTube playlist. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube playlist ID" }, "token": { "type": "string", "description": "Continuation token for pagination" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "playlistId": "PLRqwX-V7Uu6ZiZxtDDRCi6uhfTH4FilpH", "title": "Coding Challenges", "channelTitle": "The Coding Train", "channelId": "UCvjgXvBlbQiydffZU7m1_aw", "channelHandle": "@TheCodingTrain", "description": "Is it the gravy train or a train wreck? Watch me take on some viewer submitted coding projects!", "videoCount": 245, "videoCountText": "245 videos", "viewCount": 2704837, "viewCountText": "2,704,837 views", "lastUpdated": "Last updated on Aug 18, 2024" }, "continuation": "4qmF...", "data": [ { "videoId": "17WoOqgXsRM", "title": "Coding Challenge 1: Starfield Simulation", "channelTitle": "The Coding Train", "channelId": "UCvjgXvBlbQiydffZU7m1_aw", "channelHandle": "@TheCodingTrain", "index": "1", "isPlayable": true, "lengthSeconds": "834", "lengthText": "13:54", "viewCount": 1300000, "viewCountText": "1.3M views", "videoInfo": "1.3M views • 10 years ago", "publishDate": "2016-04-13", "publishedAt": "2016-04-13T00:00:00Z", "publishedTimeText": "10 years ago", "thumbnail": [ { "url": "https://i.ytimg.com/vi/17WoOqgXsRM/hqdefault.jpg", "width": 168, "height": 94 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/post": { "post": { "operationId": "youtubePost", "summary": "Community Post", "description": "Get details for a YouTube community post. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube post ID" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "postId": "UgkxMy8D54...", "channelTitle": "Creator", "channelId": "UCxyz...", "contentText": "What video should I make next?", "likeCount": 5432, "replyCount": 890, "publishedTimeText": "2 days ago", "thumbnail": [ { "url": "https://yt3.ggpht.com/...", "width": 48, "height": 48 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/post-comments": { "post": { "operationId": "youtubePostComments", "summary": "Post Comments", "description": "Get comments on a YouTube community post. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube post ID" }, "sort": { "type": "string", "description": "Sort order", "default": "top" }, "token": { "type": "string", "description": "Pagination token" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "data": [ { "commentId": "Ugxyz...", "authorText": "@User123", "authorChannelId": "UCxyz...", "authorThumbnail": [ { "url": "https://yt3.ggpht.com/...", "width": 88, "height": 88 } ], "textDisplay": "Great idea!", "likesCount": "42", "replyCount": "3", "publishedTimeText": "1 day ago" } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/related": { "post": { "operationId": "youtubeRelated", "summary": "Related Videos", "description": "Get related/recommended videos for any YouTube video. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" }, "token": { "type": "string", "description": "Continuation token for pagination" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "meta": { "videoId": "dQw4w9WgXcQ", "title": "Rick Astley - Never Gonna Give You Up", "viewCount": "1756095483", "channelTitle": "Rick Astley" }, "data": [ { "type": "video", "videoId": "abc123", "title": "Related Video Title", "channelTitle": "Channel Name", "viewCount": "5000000", "lengthText": "4:12" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/resolve": { "post": { "operationId": "youtubeResolve", "summary": "URL Resolver", "description": "Resolve any YouTube URL to its video, channel, or playlist ID. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Any YouTube URL" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "videoId": "dQw4w9WgXcQ", "webPageType": "WEB_PAGE_TYPE_WATCH" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/screenshot": { "post": { "operationId": "youtubeScreenshot", "summary": "YouTube Screenshot", "description": "Capture a screenshot of a YouTube video at a specific timestamp. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" }, "timestamp": { "type": "string", "description": "Time in HH:MM:SS format", "default": "00:00:50" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "link": [ "https://screenshot-url.jpg" ], "status": "done" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/search": { "post": { "operationId": "youtubeSearch", "summary": "YouTube Search", "description": "Search YouTube for videos, channels, and playlists with rich metadata. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query" }, "type": { "type": "string", "description": "Filter: video, channel, playlist", "default": "all" }, "sort": { "type": "string", "description": "Sort: upload_date, view_count, rating", "default": "relevance" }, "duration": { "type": "string", "description": "Duration filter" }, "upload_date": { "type": "string", "description": "Upload date filter" }, "features": { "type": "string", "description": "Feature filter" }, "geo": { "type": "string", "description": "Country code (e.g. US)" }, "lang": { "type": "string", "description": "Language code (e.g. en)" }, "token": { "type": "string", "description": "Continuation token for pagination" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "estimatedResults": "675836", "continuation": "EqQD...", "data": [ { "type": "video", "videoId": "ZVnjOPwW4ZA", "title": "Next js Tutorial for Beginners | Nextjs 13 (App Router) with TypeScript", "channelTitle": "Programming with Mosh", "channelId": "UCWv7vMbMWH4-V0ZXdmDpPBA", "channelHandle": "@programmingwithmosh", "channelBadges": [ "Verified" ], "isVerifiedChannel": true, "description": "Master Next.js 13 and build amazing full-stack apps! This beginner-friendly tutorial covers the new App Router, TypeScript, and ...", "viewCount": "1275546", "viewCountText": "1,275,546 views", "publishDate": "2024-04-13", "publishedAt": "2024-04-13T00:00:00Z", "publishedTimeText": "2 years ago", "lengthText": "1:02:55", "thumbnail": [ { "url": "https://i.ytimg.com/vi/ZVnjOPwW4ZA/hq720.jpg", "width": 360, "height": 202 }, { "url": "https://i.ytimg.com/vi/ZVnjOPwW4ZA/hq720.jpg", "width": 720, "height": 404 } ], "richThumbnail": [ { "url": "https://i.ytimg.com/an_webp/ZVnjOPwW4ZA/mqdefault_6s.webp", "width": 320, "height": 180 } ], "channelThumbnail": [ { "url": "https://yt3.ggpht.com/...=s68-c-k-c0x00ffffff-no-rj", "width": 68, "height": 68 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/shorts": { "post": { "operationId": "youtubeShorts", "summary": "YouTube Shorts Feed", "description": "Get a shorts sequence/feed for infinite scroll. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "string", "description": "Continuation token from previous response" } }, "required": [ "params" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "data": [ { "type": "shorts", "videoId": "abc123", "title": "Wait for the ending...", "viewCountText": "1.2M views", "thumbnail": [ { "url": "https://i.ytimg.com/vi/abc123/hqdefault.jpg", "width": 168, "height": 94 } ] } ], "continuation": "4qmF..." } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/shorts-info": { "post": { "operationId": "youtubeShortsInfo", "summary": "Shorts Info", "description": "Get details for a YouTube Short. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video/short ID" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "id": "abc123", "title": "Funny Short", "channelTitle": "Creator", "channelId": "UCxyz...", "viewCount": "5000000", "likeCount": 250000, "description": "Wait till the end!", "publishDate": "2026-03-15" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/subtitles": { "post": { "operationId": "youtubeSubtitles", "summary": "YouTube Subtitles", "description": "List available subtitle tracks for a YouTube video. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "format": "srv1", "subtitles": [ { "languageName": "English", "languageCode": "en", "isTranslatable": true, "url": "https://www.youtube.com/api/timedtext?v=dQw4w9WgXcQ&lang=en&fmt=srv1" }, { "languageName": "English (auto-generated)", "languageCode": "en", "isTranslatable": true, "url": "https://www.youtube.com/api/timedtext?v=dQw4w9WgXcQ&kind=asr&lang=en&fmt=srv1" }, { "languageName": "Japanese", "languageCode": "ja", "isTranslatable": true, "url": "https://www.youtube.com/api/timedtext?v=dQw4w9WgXcQ&lang=ja&fmt=srv1" } ], "translationLanguages": [ { "languageCode": "af", "languageName": "Afrikaans" }, { "languageCode": "sq", "languageName": "Albanian" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/suggest": { "post": { "operationId": "youtubeSuggest", "summary": "YouTube Suggest", "description": "Get search autocomplete suggestions from YouTube. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "query": "nextjs", "suggestions": [ "next js", "next js 16", "next js conf", "next js project", "nextjs auth", "next js supabase", "next js 15", "next js app", "next js prisma", "next js cve", "nextjs blog", "next js ai", "next js vs react", "next js conf 2025" ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/transcript": { "post": { "operationId": "youtubeTranscript", "summary": "YouTube Transcript", "description": "Get the full video transcript with timestamps. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" }, "lang": { "type": "string", "description": "Language code", "default": "en" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "id": "dQw4w9WgXcQ", "selected": { "languageCode": "en", "title": "English (auto-generated)" }, "languageMenu": { "languageCode": "es-419", "title": "Spanish (Latin America)" }, "transcript": [ { "startMs": "320", "endMs": "14580", "startTime": "0:00", "text": "[Music]" }, { "startMs": "18800", "endMs": "25960", "startTime": "0:18", "text": "We're no strangers to" }, { "startMs": "21800", "endMs": "29119", "startTime": "0:21", "text": "love. You know the rules and so do" } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/trending": { "post": { "operationId": "youtubeTrending", "summary": "Trending Videos", "description": "Get trending YouTube videos by country and category. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "geo": { "type": "string", "description": "Country code (e.g. US, GB, IN)" }, "type": { "type": "string", "description": "Category: now, music, gaming, movies", "default": "now" }, "lang": { "type": "string", "description": "Language code" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "data": [ { "type": "video", "videoId": "XelMqi0jlvk", "title": "Christmas Songs Playlist - Top 2 Hour Christmas Songs", "channelId": "UCn0JHLJWiO3_Y5xfNPcF_Ug", "channelTitle": "Christmas Songs and Carols - Love to Sing", "description": "Enjoy the festive classic Top Christmas Songs...", "viewCount": "15200000", "commentCount": "61", "likeCount": "85000", "publishedTimeText": "3 months ago", "publishedAt": "2026-01-13T00:00:00Z", "lengthText": "2:05:32", "thumbnail": [ { "url": "https://i.ytimg.com/vi/XelMqi0jlvk/hq720.jpg", "width": 720, "height": 404 } ], "richThumbnail": [ { "url": "https://i.ytimg.com/an_webp/XelMqi0jlvk/mqdefault_6s.webp", "width": 320, "height": 180 } ] } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/video": { "post": { "operationId": "youtubeVideo", "summary": "Video Details", "description": "Get full metadata for any YouTube video including title, views, likes, and formats. Cost: $0.02/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" }, "geo": { "type": "string", "description": "Country code for geo-specific results" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "status": "OK", "id": "dQw4w9WgXcQ", "title": "Rick Astley - Never Gonna Give You Up (Official Video) (4K Remaster)", "lengthSeconds": 213, "keywords": [ "rick astley", "Never Gonna Give You Up", "rickroll" ], "channelTitle": "Rick Astley", "channelId": "UCuAXFkgsw1L7xaCfnd5JJOw", "description": "The official video for \"Never Gonna Give You Up\" by Rick Astley...", "viewCount": 1762255485, "allowRatings": true, "isLiveContent": false, "isPrivate": false, "thumbnail": [ { "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/default.jpg", "width": 120, "height": 90 }, { "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg", "width": 1920, "height": 1080 } ], "formats": [ { "itag": 18, "mimeType": "video/mp4", "quality": "medium", "qualityLabel": "360p", "width": 640, "height": 360, "url": "https://redirector.googlevideo.com/videoplayback?..." } ], "adaptiveFormats": [ { "itag": 313, "mimeType": "video/webm; codecs=\"vp9\"", "quality": "hd2160", "qualityLabel": "2160p", "width": 3840, "height": 2160, "fps": 25, "bitrate": 18076636, "contentLength": "358608461", "url": "https://redirector.googlevideo.com/videoplayback?..." } ], "captions": { "captionTracks": [ { "languageCode": "en", "kind": "asr" } ] }, "storyboards": [ { "url": "https://...", "width": 48, "height": 27 } ] } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/youtube/video-info": { "post": { "operationId": "youtubeVideoInfo", "summary": "Video Info", "description": "Get full video metadata without streaming URLs. Cost: $0.01/call.", "tags": [ "YouTube" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "YouTube video ID" }, "geo": { "type": "string", "description": "Country code for geo-specific results" }, "lang": { "type": "string", "description": "Language code" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "data": {} } }, "example": { "ok": true, "data": { "id": "dQw4w9WgXcQ", "title": "Rick Astley - Never Gonna Give You Up", "channelTitle": "Rick Astley", "viewCount": "1758165530", "publishDate": "2009-10-25" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } } }