{"openapi":"3.1.0","info":{"title":"EcommDataHub API","version":"2026-08-27","summary":"Structured, real-time marketplace data over one REST API.","description":"Every request carries your access key in the `X-API-Key` header and is billed in credits ($1 = 1,000 credits); each operation lists its rate under `x-edh-credits`.\n\n**Versioning.** API versions are path segments (`/amazon/v2/…`). A deprecated endpoint keeps working and answers with `Deprecation`, `Sunset` and `Link: <successor>; rel=\"successor-version\"` headers at least 90 days before its sunset date; after that date it returns `410 ENDPOINT_SUNSET` naming the successor.\n\n**Errors.** Every non-2xx response is `{ok:false, error:{code, message, details}}` — see `components.schemas.Error` for the code list. Rate-limit state is on every response as `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`.","termsOfService":"https://www.ecommdatahub.com/legal/terms/","contact":{"name":"EcommDataHub support","email":"support@ecommdatahub.com","url":"https://www.ecommdatahub.com/support/"}},"externalDocs":{"description":"API reference","url":"https://www.ecommdatahub.com/docs/"},"servers":[{"url":"https://api.gw.ecommdatahub.com","description":"Customer gateway"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Amazon DataHub","description":"Products, offers, reviews & rankings"},{"name":"eBay DataHub","description":"Listings, sold history & seller data"},{"name":"Walmart DataHub","description":"Product catalog & store availability"},{"name":"Shopify DataHub","description":"Storefront catalogs & price tracking"},{"name":"AliExpress DataHub","description":"Catalog, pricing & shipping data"},{"name":"Etsy DataHub","description":"Handmade listings & shop stats"},{"name":"Taobao DataHub","description":"Taobao & Tmall items, translated"}],"paths":{"/amazon/v2/products/search":{"get":{"operationId":"get_amazon_v2_products_search","tags":["Amazon DataHub"],"summary":"Product search","description":"Search the Amazon catalog by keyword.","parameters":[{"name":"q","in":"query","required":true,"description":"Search keywords","schema":{"type":"string"},"example":"wireless earbuds"},{"name":"marketplace","in":"query","required":false,"description":"Marketplace country code","schema":{"type":"string"},"example":"us"},{"name":"page","in":"query","required":false,"description":"Result page","schema":{"type":"string"},"example":"1"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"page":1,"items":[{"asin":"B0C1XKX7Z4","price":29.99,"title":"Wireless Earbuds X2","currency":"USD"}],"total":18234}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":2,"per_plan":{"payg":5,"starter":4,"growth":3,"scale":2},"cap_period":"day"}}},"/amazon/v2/products/detail":{"get":{"operationId":"get_amazon_v2_products_detail","tags":["Amazon DataHub"],"summary":"Product detail","description":"Full product record for one ASIN.","parameters":[{"name":"asin","in":"query","required":true,"description":"Product ASIN","schema":{"type":"string"},"example":"B0C1XKX7Z4"},{"name":"marketplace","in":"query","required":false,"description":"Marketplace country code","schema":{"type":"string"},"example":"us"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"asin":"B0C1XKX7Z4","brand":"Auria","price":29.99,"title":"Wireless Earbuds X2","rating":4.6,"in_stock":true,"reviews_count":12873}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/amazon/v2/reviews/list":{"get":{"operationId":"get_amazon_v2_reviews_list","tags":["Amazon DataHub"],"summary":"Reviews list","description":"Paginated reviews for a product.","parameters":[{"name":"asin","in":"query","required":true,"description":"Product ASIN","schema":{"type":"string"},"example":"B0C1XKX7Z4"},{"name":"page","in":"query","required":false,"description":"Result page","schema":{"type":"string"},"example":"1"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"total":12873,"reviews":[{"id":"R1K4","title":"Great value","rating":5,"verified":true}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/amazon/v2/products/offers":{"get":{"operationId":"get_amazon_v2_products_offers","tags":["Amazon DataHub"],"summary":"Offers","description":"Buy-box and third-party offers for an ASIN.","parameters":[{"name":"asin","in":"query","required":true,"description":"Product ASIN","schema":{"type":"string"},"example":"B0C1XKX7Z4"},{"name":"condition","in":"query","required":false,"description":"new | used | any","schema":{"type":"string"},"example":"new"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"asin":"B0C1XKX7Z4","total":7,"buybox":{"price":29.99,"seller":"Auria Official"},"offers":[{"price":28.5,"seller":"TechDeals","condition":"new"}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/amazon/v2/bestsellers/list":{"get":{"operationId":"get_amazon_v2_bestsellers_list","tags":["Amazon DataHub"],"summary":"Best sellers","description":"Category best-seller ranks, updated hourly.","parameters":[{"name":"category","in":"query","required":true,"description":"Category node id or slug","schema":{"type":"string"},"example":"electronics"},{"name":"marketplace","in":"query","required":false,"description":"Marketplace country code","schema":{"type":"string"},"example":"us"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"items":[{"asin":"B0C8PLX2M4","rank":1,"title":"Wireless Earbuds, 48H Playtime"}],"category":"electronics","updated_at":"2026-08-27T10:00:00Z"}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.6,"per_plan":{"payg":4,"starter":3.2,"growth":2.4,"scale":1.6},"cap_period":"day"}}},"/ebay/v2/listings/search":{"get":{"operationId":"get_ebay_v2_listings_search","tags":["eBay DataHub"],"summary":"Listing search","description":"Search live or sold eBay listings.","parameters":[{"name":"q","in":"query","required":true,"description":"Search keywords","schema":{"type":"string"},"example":"vintage camera"},{"name":"sold","in":"query","required":false,"description":"true = sold listings","schema":{"type":"string"},"example":"false"},{"name":"condition","in":"query","required":false,"description":"new | used | any","schema":{"type":"string"},"example":"any"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"total":932,"listings":[{"id":"295712345","price":45,"title":"Vintage Camera AE-1","ends_in":"2h 14m"}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.6,"per_plan":{"payg":4,"starter":3.2,"growth":2.4,"scale":1.6},"cap_period":"day"}}},"/ebay/v2/listings/detail":{"get":{"operationId":"get_ebay_v2_listings_detail","tags":["eBay DataHub"],"summary":"Listing detail","description":"Full item detail including shipping and returns.","parameters":[{"name":"item_id","in":"query","required":true,"description":"eBay item id","schema":{"type":"string"},"example":"295712345"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"price":45,"title":"Vintage Camera AE-1","item_id":"295712345","returns":"30 days","shipping":{"cost":5.9,"days":"3-5"}}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/ebay/v2/sold/history":{"get":{"operationId":"get_ebay_v2_sold_history","tags":["eBay DataHub"],"summary":"Sold history","description":"Realized prices for comparable items, 90 days.","parameters":[{"name":"q","in":"query","required":true,"description":"Item keywords or id","schema":{"type":"string"},"example":"vintage camera ae-1"},{"name":"days","in":"query","required":false,"description":"Lookback window (max 90)","schema":{"type":"string"},"example":"90"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"count":184,"median":30.5,"series":[{"date":"2026-08-01","price":31.99},{"date":"2026-08-15","price":29.99}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":2,"per_plan":{"payg":5,"starter":4,"growth":3,"scale":2},"cap_period":"day"}}},"/ebay/v2/sellers/profile":{"get":{"operationId":"get_ebay_v2_sellers_profile","tags":["eBay DataHub"],"summary":"Seller profile","description":"Feedback score, ratings breakdown, store info.","parameters":[{"name":"seller_id","in":"query","required":true,"description":"Seller username","schema":{"type":"string"},"example":"topdeals_uk"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"seller_id":"topdeals_uk","items_sold":48211,"feedback_pct":99.1,"member_since":"2014"}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/walmart/v2/products/search":{"get":{"operationId":"get_walmart_v2_products_search","tags":["Walmart DataHub"],"summary":"Product search","description":"Search the Walmart catalog.","parameters":[{"name":"q","in":"query","required":true,"description":"Search keywords","schema":{"type":"string"},"example":"air fryer"},{"name":"page","in":"query","required":false,"description":"Result page","schema":{"type":"string"},"example":"1"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"items":[{"id":"WM-55231","price":24.88,"title":"6-Quart Air Fryer","currency":"USD"}],"total":1287}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.6,"per_plan":{"payg":4,"starter":3.2,"growth":2.4,"scale":1.6},"cap_period":"day"}}},"/walmart/v2/products/detail":{"get":{"operationId":"get_walmart_v2_products_detail","tags":["Walmart DataHub"],"summary":"Product detail","description":"Item detail with pricing and media.","parameters":[{"name":"item_id","in":"query","required":true,"description":"Walmart item id","schema":{"type":"string"},"example":"WM-55231"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"WM-55231","price":24.88,"title":"6-Quart Air Fryer","rating":4.4,"in_stock":true}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/walmart/v2/stores/availability":{"get":{"operationId":"get_walmart_v2_stores_availability","tags":["Walmart DataHub"],"summary":"Store availability","description":"In-store stock by zip code.","parameters":[{"name":"item_id","in":"query","required":true,"description":"Walmart item id","schema":{"type":"string"},"example":"WM-55231"},{"name":"zip","in":"query","required":true,"description":"US zip code","schema":{"type":"string"},"example":"94105"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"stores":[{"qty":6,"stock":"in_stock","store":"San Francisco #2280"}],"item_id":"WM-55231"}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":2,"per_plan":{"payg":5,"starter":4,"growth":3,"scale":2},"cap_period":"day"}}},"/walmart/v2/reviews/list":{"get":{"operationId":"get_walmart_v2_reviews_list","tags":["Walmart DataHub"],"summary":"Reviews list","description":"Paginated customer reviews.","parameters":[{"name":"item_id","in":"query","required":true,"description":"Walmart item id","schema":{"type":"string"},"example":"WM-55231"},{"name":"page","in":"query","required":false,"description":"Result page","schema":{"type":"string"},"example":"1"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"total":812,"reviews":[{"title":"Works great","rating":5}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/shopify/v2/products/list":{"get":{"operationId":"get_shopify_v2_products_list","tags":["Shopify DataHub"],"summary":"Products list","description":"Full public catalog for a shop domain.","parameters":[{"name":"shop","in":"query","required":true,"description":"Shop domain","schema":{"type":"string"},"example":"allbirds.com"},{"name":"page","in":"query","required":false,"description":"Result page","schema":{"type":"string"},"example":"1"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"page":1,"shop":"allbirds.com","items":[{"id":"8837120","price":{"value":98,"currency":"USD"},"title":"Wool Runner","in_stock":true}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/shopify/v2/products/detail":{"get":{"operationId":"get_shopify_v2_products_detail","tags":["Shopify DataHub"],"summary":"Product detail","description":"Variants, options, images, availability.","parameters":[{"name":"shop","in":"query","required":true,"description":"Shop domain","schema":{"type":"string"},"example":"allbirds.com"},{"name":"product_id","in":"query","required":true,"description":"Product id or handle","schema":{"type":"string"},"example":"wool-runner"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"8837120","title":"Wool Runner","variants":[{"sku":"WR-M-9","price":98,"available":true}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/shopify/v2/collections/list":{"get":{"operationId":"get_shopify_v2_collections_list","tags":["Shopify DataHub"],"summary":"Collections","description":"Collections with product membership.","parameters":[{"name":"shop","in":"query","required":true,"description":"Shop domain","schema":{"type":"string"},"example":"allbirds.com"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"collections":[{"title":"Men's Shoes","handle":"mens-shoes","products":42}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/shopify/v2/products/history":{"get":{"operationId":"get_shopify_v2_products_history","tags":["Shopify DataHub"],"summary":"Price history","description":"Tracked price changes, 12 months.","parameters":[{"name":"shop","in":"query","required":true,"description":"Shop domain","schema":{"type":"string"},"example":"allbirds.com"},{"name":"product_id","in":"query","required":true,"description":"Product id or handle","schema":{"type":"string"},"example":"wool-runner"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"series":[{"date":"2026-05-01","price":110},{"date":"2026-08-01","price":98}],"product":"wool-runner"}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":2,"per_plan":{"payg":5,"starter":4,"growth":3,"scale":2},"cap_period":"day"}}},"/aliexpress/v2/products/search":{"get":{"operationId":"get_aliexpress_v2_products_search","tags":["AliExpress DataHub"],"summary":"Product search","description":"Keyword search with ship-from filters.","parameters":[{"name":"q","in":"query","required":true,"description":"Search keywords","schema":{"type":"string"},"example":"usb c hub"},{"name":"ship_from","in":"query","required":false,"description":"Warehouse country code","schema":{"type":"string"},"example":"cn"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"items":[{"id":"ALX-2231","price":12.4,"title":"7-in-1 USB-C Hub","currency":"USD"}],"total":5211}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.6,"per_plan":{"payg":4,"starter":2,"growth":1.6,"scale":1.6},"cap_period":"day"}}},"/aliexpress/v2/products/detail":{"get":{"operationId":"get_aliexpress_v2_products_detail","tags":["AliExpress DataHub"],"summary":"Product detail","description":"SKU matrix, tiered pricing, seller info.","parameters":[{"name":"product_id","in":"query","required":true,"description":"Product id","schema":{"type":"string"},"example":"ALX-2231"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"ALX-2231","skus":[{"sku":"grey","price":12.4,"stock":1834}],"title":"7-in-1 USB-C Hub","seller":{"name":"HubStore","rating":97.8}}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2,"growth":1.6,"scale":1.2},"cap_period":"day"}}},"/aliexpress/v2/logistics/estimate":{"get":{"operationId":"get_aliexpress_v2_logistics_estimate","tags":["AliExpress DataHub"],"summary":"Shipping estimate","description":"Lanes, cost and delivery window by country.","parameters":[{"name":"product_id","in":"query","required":true,"description":"Product id","schema":{"type":"string"},"example":"ALX-2231"},{"name":"country","in":"query","required":true,"description":"Destination country code","schema":{"type":"string"},"example":"de"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"options":[{"cost":2.14,"days":"12-18","carrier":"Cainiao"}],"product_id":"ALX-2231"}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/aliexpress/v2/sellers/ratings":{"get":{"operationId":"get_aliexpress_v2_sellers_ratings","tags":["AliExpress DataHub"],"summary":"Seller ratings","description":"Store scores and dispute rates.","parameters":[{"name":"seller_id","in":"query","required":true,"description":"Store id","schema":{"type":"string"},"example":"HubStore"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"followers":12894,"seller_id":"HubStore","disputes_pct":0.4,"positive_pct":97.8}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/etsy/v2/listings/search":{"get":{"operationId":"get_etsy_v2_listings_search","tags":["Etsy DataHub"],"summary":"Listing search","description":"Keyword search with category filters.","parameters":[{"name":"q","in":"query","required":true,"description":"Search keywords","schema":{"type":"string"},"example":"ceramic mug"},{"name":"sort","in":"query","required":false,"description":"relevance | newest | price","schema":{"type":"string"},"example":"relevance"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"total":3411,"listings":[{"id":"ET-99812","shop":"ClayAndCo","price":18.5,"title":"Handmade Ceramic Mug"}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/etsy/v2/listings/detail":{"get":{"operationId":"get_etsy_v2_listings_detail","tags":["Etsy DataHub"],"summary":"Listing detail","description":"Full listing with materials and variants.","parameters":[{"name":"listing_id","in":"query","required":true,"description":"Listing id","schema":{"type":"string"},"example":"ET-99812"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"ET-99812","title":"Handmade Ceramic Mug","variants":[{"name":"12oz","price":18.5}],"materials":["stoneware"]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/etsy/v2/shops/stats":{"get":{"operationId":"get_etsy_v2_shops_stats","tags":["Etsy DataHub"],"summary":"Shop stats","description":"Sales counts, admirers, shop age.","parameters":[{"name":"shop_id","in":"query","required":true,"description":"Shop name","schema":{"type":"string"},"example":"ClayAndCo"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"shop":"ClayAndCo","sales":20411,"since":"2017","admirers":3120}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}},"/etsy/v2/reviews/list":{"get":{"operationId":"get_etsy_v2_reviews_list","tags":["Etsy DataHub"],"summary":"Reviews list","description":"Paginated shop and listing reviews.","parameters":[{"name":"shop_id","in":"query","required":true,"description":"Shop name","schema":{"type":"string"},"example":"ClayAndCo"},{"name":"page","in":"query","required":false,"description":"Result page","schema":{"type":"string"},"example":"1"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"total":1834,"reviews":[{"rating":5,"comment":"Beautiful glaze"}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":0.8,"per_plan":{"payg":2,"starter":1.6,"growth":1.2,"scale":0.8},"cap_period":"day"}}},"/taobao/v2/products/search":{"get":{"operationId":"get_taobao_v2_products_search","tags":["Taobao DataHub"],"summary":"Product search","description":"Keyword search with optional EN translation.","parameters":[{"name":"q","in":"query","required":true,"description":"Search keywords","schema":{"type":"string"},"example":"bluetooth speaker"},{"name":"translate","in":"query","required":false,"description":"Translate fields to language code","schema":{"type":"string"},"example":"en"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"items":[{"id":"TB-778201","price":{"value":89,"currency":"CNY"},"title":"蓝牙音箱 Bluetooth Speaker"}],"total":40211}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":2.4,"per_plan":{"payg":6,"starter":4.8,"growth":3.6,"scale":2.4},"cap_period":"day"}}},"/taobao/v2/products/detail":{"get":{"operationId":"get_taobao_v2_products_detail","tags":["Taobao DataHub"],"summary":"Product detail","description":"SKU matrix, promos, seller and shop data.","parameters":[{"name":"item_id","in":"query","required":true,"description":"Taobao item id","schema":{"type":"string"},"example":"TB-778201"},{"name":"translate","in":"query","required":false,"description":"Translate fields to language code","schema":{"type":"string"},"example":"en"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"TB-778201","shop":{"name":"声动旗舰店","rating":4.9},"skus":[{"name":"black","price_cny":89,"price_usd":12.3}],"title":"Bluetooth Speaker"}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.6,"per_plan":{"payg":4,"starter":3.2,"growth":2.4,"scale":1.6},"cap_period":"day"}}},"/taobao/v2/products/image-search":{"get":{"operationId":"get_taobao_v2_products_image_search","tags":["Taobao DataHub"],"summary":"Image search","description":"Find items matching an uploaded image.","parameters":[{"name":"image_url","in":"query","required":true,"description":"Public image URL","schema":{"type":"string"},"example":"https://example.com/speaker.jpg"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"matches":[{"id":"TB-778201","price":{"value":89,"currency":"CNY"},"title":"蓝牙音箱 Bluetooth Speaker","similarity":0.94}]}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":4,"per_plan":{"payg":10,"starter":8,"growth":6,"scale":4},"cap_period":"day"}}},"/taobao/v2/sellers/profile":{"get":{"operationId":"get_taobao_v2_sellers_profile","tags":["Taobao DataHub"],"summary":"Seller profile","description":"Shop ratings, DSR scores, years active.","parameters":[{"name":"shop_id","in":"query","required":true,"description":"Shop id or name","schema":{"type":"string"},"example":"声动旗舰店"}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"$ref":"#/components/headers/X-Credits-Charged"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"dsr":{"desc":4.9,"service":4.8,"logistics":4.9},"shop":"声动旗舰店","years":7}}}},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"410":{"$ref":"#/components/responses/Error410"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}},"x-edh-credits":{"from":1.2,"per_plan":{"payg":3,"starter":2.4,"growth":1.8,"scale":1.2},"cap_period":"day"}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Access key from the console (`edh_live_…`). Keys are scoped per service."}},"schemas":{"Error":{"type":"object","required":["ok","error"],"properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","ACCOUNT_INACTIVE","KEY_SCOPE_FORBIDDEN","KEY_IP_FORBIDDEN","UNKNOWN_ENDPOINT","NOT_SUBSCRIBED","PAYMENT_FAILED","INSUFFICIENT_CREDITS","QUOTA_EXHAUSTED","RATE_LIMITED","NODE_SYNCING","NODE_UNAVAILABLE","ENDPOINT_SUNSET"],"description":"- `UNAUTHENTICATED` (401): The X-API-Key header is missing, malformed or unknown. Send a valid access key; create or rotate one in the console under Keys.\n- `ACCOUNT_INACTIVE` (403): The account behind the key is suspended or under review. Check your inbox for the reason and contact support.\n- `KEY_SCOPE_FORBIDDEN` (403): The key is not scoped to this service. Use a key whose scopes include the service, or create one that does.\n- `KEY_IP_FORBIDDEN` (403): The request came from an address outside the key's IP allowlist. Call from an allowed address or edit the allowlist on the key.\n- `UNKNOWN_ENDPOINT` (404): No endpoint at this path/version (or one your plan cannot see). Compare the path with this reference; private endpoints need a plan that includes them.\n- `NOT_SUBSCRIBED` (402): No active subscription for this service. Subscribe in the console — pay-as-you-go has no monthly fee.\n- `PAYMENT_FAILED` (402): A renewal payment failed and access is paused until it succeeds. Update the card under Billing; access resumes on the next successful charge.\n- `INSUFFICIENT_CREDITS` (402): The monthly quota is used up and the credit wallet is empty. Top up credits (or enable auto top-up) — the request is retried as soon as credits exist.\n- `QUOTA_EXHAUSTED` (429): A hard plan quota or per-endpoint cap was reached for this window. Wait for the window to reset (see the error details) or move to a larger plan.\n- `RATE_LIMITED` (429): More requests per second than the plan allows. Back off using Retry-After and the X-RateLimit-* headers, then retry.\n- `NODE_SYNCING` (503): The gateway node that took the request is still loading its state. Retry after a few seconds — other nodes may already answer.\n- `NODE_UNAVAILABLE` (503): The gateway node cannot reach its state store. Retry with exponential backoff; the status page shows fleet health.\n- `ENDPOINT_SUNSET` (410): This endpoint version was retired after its announced sunset date. Migrate to the successor named in the Link header and in error.details.replacement."},"message":{"type":"string"},"details":{"type":"object","additionalProperties":true,"description":"Code-specific context (e.g. `retry_after`, `balance_credits`, `replacement`)."}}}}}},"responses":{"Error401":{"description":"Error — `error.code` is one of `UNAUTHENTICATED`","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"ok":false,"error":{"code":"UNAUTHENTICATED","message":"The X-API-Key header is missing, malformed or unknown.","details":{}}}}}},"Error403":{"description":"Error — `error.code` is one of `ACCOUNT_INACTIVE`, `KEY_SCOPE_FORBIDDEN`, `KEY_IP_FORBIDDEN`","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"ok":false,"error":{"code":"ACCOUNT_INACTIVE","message":"The account behind the key is suspended or under review.","details":{}}}}}},"Error404":{"description":"Error — `error.code` is one of `UNKNOWN_ENDPOINT`","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"ok":false,"error":{"code":"UNKNOWN_ENDPOINT","message":"No endpoint at this path/version (or one your plan cannot see).","details":{}}}}}},"Error402":{"description":"Error — `error.code` is one of `NOT_SUBSCRIBED`, `PAYMENT_FAILED`, `INSUFFICIENT_CREDITS`","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"ok":false,"error":{"code":"NOT_SUBSCRIBED","message":"No active subscription for this service.","details":{}}}}}},"Error429":{"description":"Error — `error.code` is one of `QUOTA_EXHAUSTED`, `RATE_LIMITED`","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"ok":false,"error":{"code":"QUOTA_EXHAUSTED","message":"A hard plan quota or per-endpoint cap was reached for this window.","details":{}}}}}},"Error503":{"description":"Error — `error.code` is one of `NODE_SYNCING`, `NODE_UNAVAILABLE`","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"ok":false,"error":{"code":"NODE_SYNCING","message":"The gateway node that took the request is still loading its state.","details":{}}}}}},"Error410":{"description":"Error — `error.code` is one of `ENDPOINT_SUNSET`","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"ok":false,"error":{"code":"ENDPOINT_SUNSET","message":"This endpoint version was retired after its announced sunset date.","details":{}}}}}}},"headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Requests allowed in the current window"},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Requests left in the current window"},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Unix time the window resets"},"X-Credits-Charged":{"schema":{"type":"number"},"description":"Credits billed for this request"},"Deprecation":{"schema":{"type":"string"},"description":"RFC 9745 — present once the endpoint is deprecated"},"Sunset":{"schema":{"type":"string"},"description":"RFC 8594 — HTTP date after which the endpoint answers 410 ENDPOINT_SUNSET"},"Link":{"schema":{"type":"string"},"description":"`<successor>; rel=\"successor-version\"` for deprecated endpoints"}}}}