{"items":[{"type":"link","label":"kwery API Reference","link":"/api-reference","routeSlug":"/api-reference","content":{"contentType":"overview","meta":{"name":"kwery API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api-reference.json","url":"/_bundle/api-reference.json?download"},{"kind":"download","label":"api-reference.yaml","url":"/_bundle/api-reference.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://kwery.co"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"python","title":"Python","lang":"Python"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"ruby","title":"Ruby","lang":"Ruby"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"kwery API Reference (4.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time price data across major European and global marketplaces."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New here? Start with the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.kwery.co/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guides"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — getting started,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication, webhooks, and per-source field reference."},"children":[]}]}]}]}],"sectionId":"/api-reference"}],"sectionId":"/api-reference"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/try-it-no-account-needed"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it — no account needed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mock server"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is built into this reference: send requests to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://docs.kwery.co/_mock/api-reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and get back correctly-shaped example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responses — no signup, no API key (any dummy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header passes),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and no credits consumed. Select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock server"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Servers panel and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code samples switch to it automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://docs.kwery.co/_mock/api-reference/job \\\n  -H \"Authorization: Bearer test123\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"source\":\"idealo\",\"country\":\"de\",\"key\":\"gtin\",\"values\":[\"4006381333962\"]}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://docs.kwery.co/_mock/api-reference/job \\\n  -H \"Authorization: Bearer test123\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"source\":\"idealo\",\"country\":\"de\",\"key\":\"gtin\",\"values\":[\"4006381333962\"]}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data returned is static example data from this specification, not a live"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"crawl — but the response shapes are exactly what production returns, so you can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"build and test your integration end-to-end before creating an account."},"children":[]}]}]}]}],"sectionId":"/api-reference/section/try-it-no-account-needed"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/source-and-key-reference"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source and key reference"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each source supports a fixed set of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"determines what goes in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported countries"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idealo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de at uk (gb) fr it es"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idealo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idealo product ID (numeric)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de at uk (gb) fr it es"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idealo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de at uk (gb) fr it es"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idealo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pzn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pharmacy product number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amazon"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us ca mx br uk (gb) de at ch es fr it jp in ae au nl se pl be sg tr"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amazon"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amazon ASIN (10 chars)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us ca mx br uk (gb) de at ch es fr it jp in ae au nl se pl be sg tr"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amazon"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us ca mx br uk (gb) de at ch es fr it jp in ae au nl se pl be sg tr"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us de uk (gb) au at br ca cz dk fr in ie it jp mx no pl nz nl ru sg za es se fi ch tr ar cl co be gr hu pt ro sk hk id il my ph sa kr tw th ua vn ae"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Shopping product ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us de uk (gb) au at br ca cz dk fr in ie it jp mx no pl nz nl ru sg za es se fi ch tr ar cl co be gr hu pt ro sk hk id il my ph sa kr tw th ua vn ae"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pipe-separated product record — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us de uk (gb) au at br ca cz dk fr in ie it jp mx no pl nz nl ru sg za es se fi ch tr ar cl co be gr hu pt ro sk hk id il my ph sa kr tw th ua vn ae"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ebay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"au at be ca fr de ie it hk my nl pl sg es ch uk (gb) us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ebay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eBay item ID (numeric)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"au at be ca fr de ie it hk my nl pl sg es ch uk (gb) us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ebay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"au at be ca fr de ie it hk my nl pl sg es ch uk (gb) us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kaufland"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de cz sk pl at fr it"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kaufland"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kaufland product ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de cz sk pl at fr it"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kaufland"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de cz sk pl at fr it"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otto"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otto"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otto product ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billiger"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billiger"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billiger.de product ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billiger"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guenstiger"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guenstiger"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guenstiger.de product ID (numeric)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guenstiger"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walmart"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walmart"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Walmart item ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walmart"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / UPC / GTIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lidl"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de at fr it nl pl uk …"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lidl"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lidl product ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de at fr it nl pl uk …"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aliexpress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aliexpress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AliExpress product ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rakuten"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jp"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rakuten"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rakuten item ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jp"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uk (gb)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are two codes for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" UK marketplace —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pass either one, it is not a separate locale. For Amazon, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"served from the amazon.de storefront with Austria/Switzerland localization."},"children":[]}]}]}]}]}],"sectionId":"/api-reference/section/source-and-key-reference"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign up at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://kwery.co"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"kwery.co"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the dashboard issues your API key. Send it on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every data-API request as either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_..."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-api-key: kwy_live_..."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy/enterprise accounts provisioned before self-serve may still use HTTP Basic"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(username + password) or a Bearer JWT issued directly by us. See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access is controlled per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pair. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not subscribed to source"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error means your account is not provisioned for the requested combination."},"children":[]}]}]}]}],"sectionId":"/api-reference/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/response-envelope"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation errors return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 200"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"error\": true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Always check the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field before consuming a response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{ \"error\": true, \"message\": \"country not supported by source\" }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ \"error\": true, \"message\": \"country not supported by source\" }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Infrastructure errors (auth, 5xx) use standard HTTP status codes."},"children":[]}]}]}]}],"sectionId":"/api-reference/section/response-envelope"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/stream-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For large batches (up to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100 000 values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), use the Stream endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are pushed to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as they complete — no polling needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — submit values with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results arrive at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in batches as they complete"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /stream/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — optional progress check"},"children":[]}]}]}]}]}],"sectionId":"/api-reference/section/stream-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/batch-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For standard batches (up to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 000 values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), use the Batch endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are retained for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"72 hours"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /job"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — submit a list of values, receive a job ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — poll until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — retrieve structured results"},"children":[]}]}]}]}]}],"sectionId":"/api-reference/section/batch-api"}]}]}},{"type":"link","label":"Try it — no account needed","link":"/api-reference/section/try-it-no-account-needed","routeSlug":"/api-reference/section/try-it-no-account-needed","content":null},{"type":"link","label":"Source and key reference","link":"/api-reference/section/source-and-key-reference","routeSlug":"/api-reference/section/source-and-key-reference","content":null},{"type":"link","label":"Authentication","link":"/api-reference/section/authentication","routeSlug":"/api-reference/section/authentication","content":null},{"type":"link","label":"Response envelope","link":"/api-reference/section/response-envelope","routeSlug":"/api-reference/section/response-envelope","content":null},{"type":"link","label":"Stream API","link":"/api-reference/section/stream-api","routeSlug":"/api-reference/section/stream-api","content":null},{"type":"link","label":"Batch API","link":"/api-reference/section/batch-api","routeSlug":"/api-reference/section/batch-api","content":null},{"type":"separator","label":"Stream API","content":null},{"type":"group","label":"Stream endpoints","link":"/api-reference/stream","routeSlug":"/api-reference/stream","items":[{"label":"Submit a stream job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/stream/submitstreamjob","routeSlug":"/api-reference/stream/submitstreamjob","metadata":{"seo":{"title":"Submit a Stream Job — kwery Docs","description":"Submit a large batch for incremental webhook delivery. Results arepushed to callback_url in batches as they complete."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Submit a Stream Job — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /stream — submit up to 100,000 values with webhook delivery as results complete."},"children":[]}]}]}]},"meta":{"sourceId":"submitStreamJob","name":"Submit a stream job","isWebhook":false,"pointer":"/paths/~1stream/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a stream job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a large batch for incremental webhook delivery. Results are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pushed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in batches as they complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"stream/submitstreamjob/request/webhook-payload","deepLinkHash":"/stream/submitstreamjob#stream/submitstreamjob/request/webhook-payload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook payload"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"job_id\": \"...\",\n  \"client_ref\": \"...\",\n  \"batch_sequence\": 1,\n  \"is_final\": false,\n  \"results\": [ ... ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"job_id\": \"...\",\n  \"client_ref\": \"...\",\n  \"batch_sequence\": 1,\n  \"is_final\": false,\n  \"results\": [ ... ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"stream/submitstreamjob/request/signature-verification","deepLinkHash":"/stream/submitstreamjob#stream/submitstreamjob/request/signature-verification"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each delivery is signed with HMAC-SHA256. Verify using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned at submission:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Signature: sha256=<hex digest>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Signature: sha256=<hex digest>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HMAC-SHA256(webhook_secret, raw_request_body)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and compare."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"stream/submitstreamjob/request/fallback","deepLinkHash":"/stream/submitstreamjob#stream/submitstreamjob/request/fallback"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fallback"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If webhook delivery fails after all retries, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /stream/{id}/replay-all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to re-queue dead-lettered deliveries, or retrieve results directly via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /stream/{id}/results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"stream/submitstreamjob/request/limits","deepLinkHash":"/stream/submitstreamjob#stream/submitstreamjob/request/limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100 000"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_batch_size"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job timeout"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 440 min"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 440 min"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StreamSubmitRequest","exampleIds":["paths/~1stream/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/StreamSubmitRequest","exampleIds":["paths/~1stream/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1stream/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stream","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StreamSubmitRequest","exampleIds":["paths/~1stream/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403"],"pointer":"/stream","href":"stream/submitstreamjob","openApiOperationId":"submitStreamJob","summary":"Submit a stream job","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"schemaId":"components/schemas/StreamSubmitRequest","exampleIds":["paths/~1stream/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StreamSubmitRequest","exampleIds":["paths/~1stream/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Stream job created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1stream/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_17","exampleIds":["paths/~1stream/post/responses/200/content/application~1json/example"]},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1stream/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_17","exampleIds":["paths/~1stream/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1stream/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stream/submitstreamjob"}],"panels":[]}]},"httpPath":"/stream"},{"label":"Stream job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/stream/getstreamjob","routeSlug":"/api-reference/stream/getstreamjob","metadata":{"seo":{"title":"Stream Job Status — kwery Docs","description":"Returns progress counters for a stream job. Poll to track completion without consuming webhook deliveries."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Stream Job Status — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /stream/{id} — progress counters for a running stream job."},"children":[]}]}]}]},"meta":{"sourceId":"getStreamJob","name":"Stream job status","isWebhook":false,"pointer":"/paths/~1stream~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stream job status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns progress counters for a stream job. Poll to track completion\nwithout consuming webhook deliveries.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the stream job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1stream~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stream/{id}","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/stream/{id}","href":"stream/getstreamjob","openApiOperationId":"getStreamJob","summary":"Stream job status","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Stream job status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1stream~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_19","exampleIds":["paths/~1stream~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1stream~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","exampleIds":["paths/~1stream~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1stream~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stream/getstreamjob"}],"panels":[]}]},"httpPath":"/stream/{id}"},{"label":"Poll stream results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/stream/getstreamresults","routeSlug":"/api-reference/stream/getstreamresults","metadata":{"seo":{"title":"Poll Stream Results — kwery Docs","description":"Retrieve completed results without relying on webhook delivery.Useful as a fallback or when callback_url was not provided."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Poll Stream Results — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /stream/{id}/results — polling fallback for stream webhook deliveries."},"children":[]}]}]}]},"meta":{"sourceId":"getStreamResults","name":"Poll stream results","isWebhook":false,"pointer":"/paths/~1stream~1{id}~1results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll stream results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve completed results without relying on webhook delivery."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful as a fallback or when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was not provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offset/limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — page through results in completion order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch lookup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — request a specific webhook delivery batch by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sequence number (useful for reconciling against webhook history)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the stream job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1stream~1{id}~1results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_20","description":"Number of results to skip."},{"name":"limit","in":"query","schemaId":"schema_21","description":"Maximum results to return."},{"name":"batch","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return results from a specific delivery batch (1-based)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overrides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1stream~1{id}~1results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stream/{id}/results","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[{"name":"offset","in":"query","schemaId":"schema_20"},{"name":"limit","in":"query","schemaId":"schema_21"},{"name":"batch","in":"query","schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/stream/{id}/results","href":"stream/getstreamresults","openApiOperationId":"getStreamResults","summary":"Poll stream results","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1stream~1{id}~1results/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1results/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stream/getstreamresults"}],"panels":[]}]},"httpPath":"/stream/{id}/results"},{"label":"Replay dead-lettered deliveries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/stream/replayalldeliveries","routeSlug":"/api-reference/stream/replayalldeliveries","metadata":{"seo":{"title":"Replay Dead-Lettered Deliveries — kwery Docs","description":"Re-enqueues all dead_lettered webhook deliveries for this job.Use after fixing a webhook endpoint that was temporarily unreachable."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Replay Dead-Lettered Deliveries — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /stream/{id}/replay-all — re-send every failed webhook delivery of a job."},"children":[]}]}]}]},"meta":{"sourceId":"replayAllDeliveries","name":"Replay dead-lettered deliveries","isWebhook":false,"pointer":"/paths/~1stream~1{id}~1replay-all/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replay dead-lettered deliveries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-enqueues all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dead_lettered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook deliveries for this job."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use after fixing a webhook endpoint that was temporarily unreachable."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the stream job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1stream~1{id}~1replay-all/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1stream~1{id}~1replay-all/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stream/{id}/replay-all","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"}},"responseCodes":["200","401","403"],"pointer":"/stream/{id}/replay-all","href":"stream/replayalldeliveries","openApiOperationId":"replayAllDeliveries","summary":"Replay dead-lettered deliveries","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Number of deliveries re-enqueued","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1stream~1{id}~1replay-all/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1replay-all/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stream/replayalldeliveries"}],"panels":[]}]},"httpPath":"/stream/{id}/replay-all"},{"label":"List webhook delivery history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/stream/listdeliveries","routeSlug":"/api-reference/stream/listdeliveries","metadata":{"seo":{"title":"Webhook Delivery History — kwery Docs","description":"Returns the last 200 webhook delivery attempts for this job, newest first. Useful for diagnosing delivery failures."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Webhook Delivery History — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /stream/{id}/deliveries — list webhook deliveries and their status."},"children":[]}]}]}]},"meta":{"sourceId":"listDeliveries","name":"List webhook delivery history","isWebhook":false,"pointer":"/paths/~1stream~1{id}~1deliveries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhook delivery history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the last 200 webhook delivery attempts for this job, newest first.\nUseful for diagnosing delivery failures.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the stream job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1stream~1{id}~1deliveries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_26","description":"Filter by delivery status."}],"pointer":"/paths/~1stream~1{id}~1deliveries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stream/{id}/deliveries","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[{"name":"status","in":"query","schemaId":"schema_26"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/stream/{id}/deliveries","href":"stream/listdeliveries","openApiOperationId":"listDeliveries","summary":"List webhook delivery history","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delivery history","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1stream~1{id}~1deliveries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1{id}~1deliveries/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stream/listdeliveries"}],"panels":[]}]},"httpPath":"/stream/{id}/deliveries"},{"label":"Replay a single delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/stream/replaysingledelivery","routeSlug":"/api-reference/stream/replaysingledelivery","metadata":{"seo":{"title":"Replay a Delivery — kwery Docs","description":"Re-enqueues a single dead_lettered delivery. Use when onlyspecific batches need to be retried."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Replay a Delivery — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /stream/deliveries/{delivery_id}/replay — re-send one webhook delivery."},"children":[]}]}]}]},"meta":{"sourceId":"replaySingleDelivery","name":"Replay a single delivery","isWebhook":false,"pointer":"/paths/~1stream~1deliveries~1{delivery_id}~1replay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replay a single delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-enqueues a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dead_lettered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delivery. Use when only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific batches need to be retried."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"delivery_id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the delivery record.","required":true}],"pointer":"/paths/~1stream~1deliveries~1{delivery_id}~1replay/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1stream~1deliveries~1{delivery_id}~1replay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stream/deliveries/{delivery_id}/replay","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"delivery_id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"}},"responseCodes":["200","401","403"],"pointer":"/stream/deliveries/{delivery_id}/replay","href":"stream/replaysingledelivery","openApiOperationId":"replaySingleDelivery","summary":"Replay a single delivery","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stream/replaysingledelivery"}],"panels":[]}]},"httpPath":"/stream/deliveries/{delivery_id}/replay"}],"content":{"contentType":"group","meta":{"name":"stream"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stream endpoints","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Large-scale crawls with incremental webhook delivery. Supports up to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100 000 values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per job. Results are pushed to your endpoint as they"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete — no polling required."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stream","summary":"Submit a stream job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stream/submitstreamjob","deprecated":false},{"title":"/stream/{id}","summary":"Stream job status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stream/getstreamjob","deprecated":false},{"title":"/stream/{id}/results","summary":"Poll stream results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stream/getstreamresults","deprecated":false},{"title":"/stream/{id}/replay-all","summary":"Replay dead-lettered deliveries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stream/replayalldeliveries","deprecated":false},{"title":"/stream/{id}/deliveries","summary":"List webhook delivery history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stream/listdeliveries","deprecated":false},{"title":"/stream/deliveries/{delivery_id}/replay","summary":"Replay a single delivery","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stream/replaysingledelivery","deprecated":false}]}]}]}]}},{"type":"separator","label":"Batch API","content":null},{"type":"group","label":"Batch endpoints","link":"/api-reference/jobs","routeSlug":"/api-reference/jobs","items":[{"label":"Submit a batch job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jobs/submitjob","routeSlug":"/api-reference/jobs/submitjob","metadata":{"seo":{"title":"Submit a Batch Job — kwery Docs","description":"Submit a list of values to crawl. Returns immediately with a jobobject; results are assembled asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Submit a Batch Job — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /job — submit up to 1,000 values for crawling and get a job id to poll."},"children":[]}]}]}]},"meta":{"sourceId":"submitJob","name":"Submit a batch job","isWebhook":false,"pointer":"/paths/~1job/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a batch job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a list of values to crawl. Returns immediately with a job"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object; results are assembled asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request schema is discriminated on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Select the source tab"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"below to see the valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"topic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values for that source."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobSubmitRequest","exampleIds":["paths/~1job/post/requestBody/content/application~1json/examples/idealo_gtin","paths/~1job/post/requestBody/content/application~1json/examples/amazon_asin_with_offers","paths/~1job/post/requestBody/content/application~1json/examples/google_term","paths/~1job/post/requestBody/content/application~1json/examples/google_product","paths/~1job/post/requestBody/content/application~1json/examples/ebay_gtin","paths/~1job/post/requestBody/content/application~1json/examples/kaufland_offers","paths/~1job/post/requestBody/content/application~1json/examples/guenstiger_term"]}},"schemaId":"components/schemas/JobSubmitRequest","exampleIds":["paths/~1job/post/requestBody/content/application~1json/examples/idealo_gtin","paths/~1job/post/requestBody/content/application~1json/examples/amazon_asin_with_offers","paths/~1job/post/requestBody/content/application~1json/examples/google_term","paths/~1job/post/requestBody/content/application~1json/examples/google_product","paths/~1job/post/requestBody/content/application~1json/examples/ebay_gtin","paths/~1job/post/requestBody/content/application~1json/examples/kaufland_offers","paths/~1job/post/requestBody/content/application~1json/examples/guenstiger_term"],"pointer":"/paths/~1job/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/job","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobSubmitRequest","exampleIds":["paths/~1job/post/requestBody/content/application~1json/examples/idealo_gtin","paths/~1job/post/requestBody/content/application~1json/examples/amazon_asin_with_offers","paths/~1job/post/requestBody/content/application~1json/examples/google_term","paths/~1job/post/requestBody/content/application~1json/examples/google_product","paths/~1job/post/requestBody/content/application~1json/examples/ebay_gtin","paths/~1job/post/requestBody/content/application~1json/examples/kaufland_offers","paths/~1job/post/requestBody/content/application~1json/examples/guenstiger_term"]}},"responseCodes":["200","401","403"],"pointer":"/job","href":"jobs/submitjob","openApiOperationId":"submitJob","summary":"Submit a batch job","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"schemaId":"components/schemas/JobSubmitRequest","exampleIds":["paths/~1job/post/requestBody/content/application~1json/examples/idealo_gtin","paths/~1job/post/requestBody/content/application~1json/examples/amazon_asin_with_offers","paths/~1job/post/requestBody/content/application~1json/examples/google_term","paths/~1job/post/requestBody/content/application~1json/examples/google_product","paths/~1job/post/requestBody/content/application~1json/examples/ebay_gtin","paths/~1job/post/requestBody/content/application~1json/examples/kaufland_offers","paths/~1job/post/requestBody/content/application~1json/examples/guenstiger_term"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobSubmitRequest","exampleIds":["paths/~1job/post/requestBody/content/application~1json/examples/idealo_gtin","paths/~1job/post/requestBody/content/application~1json/examples/amazon_asin_with_offers","paths/~1job/post/requestBody/content/application~1json/examples/google_term","paths/~1job/post/requestBody/content/application~1json/examples/google_product","paths/~1job/post/requestBody/content/application~1json/examples/ebay_gtin","paths/~1job/post/requestBody/content/application~1json/examples/kaufland_offers","paths/~1job/post/requestBody/content/application~1json/examples/guenstiger_term"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job created. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — validation failures"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"also return HTTP 200."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1job/post/responses/200/content/application~1json/examples/success","paths/~1job/post/responses/200/content/application~1json/examples/validation_error","paths/~1job/post/responses/200/content/application~1json/examples/wait","paths/~1job/post/responses/200/content/application~1json/examples/wait_timed_out"]}},"schemaId":"schema_29","exampleIds":["paths/~1job/post/responses/200/content/application~1json/examples/success","paths/~1job/post/responses/200/content/application~1json/examples/validation_error","paths/~1job/post/responses/200/content/application~1json/examples/wait","paths/~1job/post/responses/200/content/application~1json/examples/wait_timed_out"]},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1job/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_29","exampleIds":["paths/~1job/post/responses/200/content/application~1json/examples/success","paths/~1job/post/responses/200/content/application~1json/examples/validation_error","paths/~1job/post/responses/200/content/application~1json/examples/wait","paths/~1job/post/responses/200/content/application~1json/examples/wait_timed_out"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1job/post/responses/200/content/application~1json/examples/success","paths/~1job/post/responses/200/content/application~1json/examples/validation_error","paths/~1job/post/responses/200/content/application~1json/examples/wait","paths/~1job/post/responses/200/content/application~1json/examples/wait_timed_out"]}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/submitjob"}],"panels":[]}]},"httpPath":"/job"},{"label":"Poll job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jobs/getjob","routeSlug":"/api-reference/jobs/getjob","metadata":{"seo":{"title":"Poll Job Status — kwery Docs","description":"Returns current status and progress counters."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Poll Job Status — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /job/{id} — check whether a batch job is finished, with optional wait."},"children":[]}]}]}]},"meta":{"sourceId":"getJob","name":"Poll job status","isWebhook":false,"pointer":"/paths/~1job~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll job status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns current status and progress counters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status lifecycle:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"working"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1job~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/job/{id}","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/job/{id}","href":"jobs/getjob","openApiOperationId":"getJob","summary":"Poll job status","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30","exampleIds":["paths/~1job~1{id}/get/responses/200/content/application~1json/examples/working","paths/~1job~1{id}/get/responses/200/content/application~1json/examples/finished"]}},"schemaId":"schema_30","exampleIds":["paths/~1job~1{id}/get/responses/200/content/application~1json/examples/working","paths/~1job~1{id}/get/responses/200/content/application~1json/examples/finished"]},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1job~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_30","exampleIds":["paths/~1job~1{id}/get/responses/200/content/application~1json/examples/working","paths/~1job~1{id}/get/responses/200/content/application~1json/examples/finished"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30","exampleIds":["paths/~1job~1{id}/get/responses/200/content/application~1json/examples/working","paths/~1job~1{id}/get/responses/200/content/application~1json/examples/finished"]}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjob"}],"panels":[]}]},"httpPath":"/job/{id}"},{"label":"Update an interval job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jobs/updatejob","routeSlug":"/api-reference/jobs/updatejob","metadata":{"seo":{"title":"Update an Interval Job — kwery Docs","description":"Replaces the value list and parameters of an existing interval job.All previous results for this job are cleared."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Update an Interval Job — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT /job/{id} — change the values or schedule of a recurring job."},"children":[]}]}]}]},"meta":{"sourceId":"updateJob","name":"Update an interval job","isWebhook":false,"pointer":"/paths/~1job~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an interval job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the value list and parameters of an existing "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interval job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All previous results for this job are cleared."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the fields listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JobUpdateRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omitted fields retain their current values."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1job~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobUpdateRequest"}},"schemaId":"components/schemas/JobUpdateRequest","pointer":"/paths/~1job~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/job/{id}","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobUpdateRequest"}},"responseCodes":["200","401","403"],"pointer":"/job/{id}","href":"jobs/updatejob","openApiOperationId":"updateJob","summary":"Update an interval job","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"schemaId":"components/schemas/JobUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated job or error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29"},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1job~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/put/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/updatejob"}],"panels":[]}]},"httpPath":"/job/{id}"},{"label":"Delete an interval job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jobs/deletejob","routeSlug":"/api-reference/jobs/deletejob","metadata":{"seo":{"title":"Delete an Interval Job — kwery Docs","description":"Permanently deletes a job and all its results. Only interval jobs can be deleted via this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Delete an Interval Job — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE /job/{id} — stop and remove a recurring job."},"children":[]}]}]}]},"meta":{"sourceId":"deleteJob","name":"Delete an interval job","isWebhook":false,"pointer":"/paths/~1job~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an interval job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently deletes a job and all its results. Only interval jobs\ncan be deleted via this endpoint.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1job~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/job/{id}","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/job/{id}","href":"jobs/deletejob","openApiOperationId":"deleteJob","summary":"Delete an interval job","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deletion confirmed or error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31"},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1job~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}/delete/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/deletejob"}],"panels":[]}]},"httpPath":"/job/{id}"},{"label":"Download results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/jobs/downloadjob","routeSlug":"/api-reference/jobs/downloadjob","metadata":{"seo":{"title":"Download Results — kwery Docs","description":"Returns the complete result set for a finished job."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Download Results — kwery Docs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /job/{id}/download — fetch the full results payload for a finished job."},"children":[]}]}]}]},"meta":{"sourceId":"downloadJob","name":"Download results","isWebhook":false,"pointer":"/paths/~1job~1{id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the complete result set for a finished job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are cached after the first download; subsequent requests are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"served from cache regardless of result size."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Append "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the URL or pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?format=csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive a CSV file."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are retained for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"72 hours"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from job creation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."}]},{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"MongoDB ObjectId of the job.","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1"}],"pointer":"/paths/~1job~1{id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"format","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response format. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1job~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/job/{id}/download","servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"64f1c2d3e4b5a6c7d8e9f0a1","schemaId":"schema_18"}],"query":[{"name":"format","in":"query","schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/job/{id}/download","href":"jobs/downloadjob","openApiOperationId":"downloadJob","summary":"Download results","securityGroups":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"BasicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference","description":"Mock server","isMockServer":true},{"url":"https://api.kwery.co","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Full result set","mediaType":"application/json","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobDownloadResponse","exampleIds":["paths/~1job~1{id}~1download/get/responses/200/content/application~1json/example"]},"text/csv":{"schemaId":"schema_33"}},"schemaId":"components/schemas/JobDownloadResponse","exampleIds":["paths/~1job~1{id}~1download/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Missing or invalid credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Authenticated but not subscribed to this source/country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1job~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobDownloadResponse","exampleIds":["paths/~1job~1{id}~1download/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobDownloadResponse","exampleIds":["paths/~1job~1{id}~1download/get/responses/200/content/application~1json/example"]},"text/csv":{"schemaId":"schema_33"}}},{"code":"401","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpError","exampleIds":["paths/~1job~1{id}~1download/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/downloadjob"}],"panels":[]}]},"httpPath":"/job/{id}/download"}],"content":{"contentType":"group","meta":{"name":"jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch endpoints","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard batches up to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 000 values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Poll for results, then download."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are retained for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"72 hours"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/job","summary":"Submit a batch job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jobs/submitjob","deprecated":false},{"title":"/job/{id}","summary":"Poll job status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjob","deprecated":false},{"title":"/job/{id}","summary":"Update an interval job","prefix":{"name":"put","color":"put"},"badges":[],"link":"/jobs/updatejob","deprecated":false},{"title":"/job/{id}","summary":"Delete an interval job","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/jobs/deletejob","deprecated":false},{"title":"/job/{id}/download","summary":"Download results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/downloadjob","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/JobSubmitRequest":{"id":"components/schemas/JobSubmitRequest","kind":"json-schema","title":"JobSubmitRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each source has its own valid set of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"topic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/IdealoJobRequest"},{"$ref":"#/components/schemas/AmazonJobRequest"},{"$ref":"#/components/schemas/GoogleJobRequest"},{"$ref":"#/components/schemas/EbayJobRequest"}],"discriminator":{"propertyName":"source","mapping":{"idealo":"#/components/schemas/IdealoJobRequest","amazon":"#/components/schemas/AmazonJobRequest","google":"#/components/schemas/GoogleJobRequest","ebay":"#/components/schemas/EbayJobRequest"}}}},"components/schemas/JobRequestBase":{"id":"components/schemas/JobRequestBase","kind":"json-schema","title":"JobRequestBase","data":{"type":"object","required":["source","country","values"],"description":"Fields shared across all job submission requests.","properties":{"source":{"type":"string","enum":["idealo","amazon","google","ebay","kaufland","otto","billiger","guenstiger","walmart","lidl","aliexpress","rakuten"]},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (lowercase).","example":"de"},"key":{"type":"string","default":"term","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of values being submitted. Valid values depend on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"topic":{"type":"string","default":"search","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing mode. Valid values depend on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"values":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values to query. Maximum "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per request. Duplicates are removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma-separated string is also accepted as a convenience form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"a,b,c\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"a\",\"b\",\"c\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), but is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" compatible with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — product values contain commas internally."},"children":[]}]}]}],"example":["4006381333962","4719512101148"]},"max_pages":{"type":"integer","minimum":1,"maximum":10,"default":1,"description":"Number of result pages to fetch per value. Applicable to Idealo and Amazon.\nIgnored by Google and eBay.\n"},"max_age":{"type":"integer","minimum":0,"maximum":259200,"default":1200,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum acceptable age of a result, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in seconds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (20 minutes). Maximum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"259200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (3 days) — the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retention period for results; larger values are clamped."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value was already crawled inside this window, the stored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"result is returned without re-crawling it and the response is not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charged. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to always force a fresh crawl."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available on eligible accounts; elsewhere every value is always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"crawled fresh."},"children":[]}]}]}]},"sort_by":{"type":"string","default":"ranking_descending","description":"Sort order for offers within each result."},"timeout":{"type":"integer","minimum":1,"maximum":1440,"default":1440,"description":"Job hard timeout in minutes. The job is forcibly finished with\nwhatever partial results exist after this time. Default: 1 440 (24 h).\n"},"callback_url":{"type":"string","format":"uri","nullable":true,"description":"Webhook URL to receive results when the job finishes.\nFor incremental push delivery, use the Stream endpoint instead.\n"},"not_found_max_age":{"type":"integer","minimum":1,"default":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many days a not-found cache entry is honoured before the product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is re-queried. Applies to GTIN and PZN lookups (Idealo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pzn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amazon "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Google "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to force a fresh lookup"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the next job after a single day. Ignored for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys."},"children":[]}]}]}]},"include_meta":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", each result carries a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provenance block — the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"crawl trail ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.crawls[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") with URL, HTTP status, timing and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"observation timestamp per fetch. See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/audit-and-provenance"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit & provenance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"wait":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"boolean"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold the request open for up to this many seconds ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"maximum, 120) and, if the job finishes in time, return the results"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inline — the response gains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array identical to what"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" serves. If the job is still running when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the wait elapses, the normal job object is returned with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wait_timed_out: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; keep waiting with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}?wait=N"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or poll "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as usual. Accepts exactly one value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(more returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"error\": true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); leave it off for batches."},"children":[]}]}]}]}}}},"components/schemas/IdealoJobRequest":{"id":"components/schemas/IdealoJobRequest","kind":"json-schema","title":"IdealoJobRequest","data":{"description":"Idealo job submission.","allOf":[{"$ref":"#/components/schemas/JobRequestBase"},{"type":"object","required":["source"],"properties":{"source":{"type":"string","enum":["idealo"]},"country":{"type":"string","description":"Supported Idealo countries.","enum":["de","at","uk","gb","fr","it","es"],"example":"de"},"key":{"type":"string","enum":["term","id","gtin","pzn"],"default":"term","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values format"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search query"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idealo product ID (numeric string)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13 barcode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pzn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pharmacy product number (DE only)"},"children":[]}]}]}]}]}]}]},"topic":{"type":"string","enum":["search","convert","remove_conversions"],"default":"search","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard price search — returns offers from all sellers (default)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"convert"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolve GTIN to Idealo product ID only; no price data returned"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_conversions"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clear cached GTIN→ID mappings for the submitted GTINs"},"children":[]}]}]}]}]}]}]},"fetch_seller_names":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", seller detail pages are crawled for marketplace offer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sellers whose names are not yet in the database. Seller names already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cached in the database are always applied regardless of this flag."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enabling this adds one additional request per unresolved seller,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billed at the standard rate."},"children":[]}]}]}]}}}]}},"components/schemas/AmazonJobRequest":{"id":"components/schemas/AmazonJobRequest","kind":"json-schema","title":"AmazonJobRequest","data":{"description":"Amazon job submission.","allOf":[{"$ref":"#/components/schemas/JobRequestBase"},{"type":"object","required":["source"],"properties":{"source":{"type":"string","enum":["amazon"]},"country":{"type":"string","description":"Amazon marketplace country code.","enum":["us","ca","mx","br","uk","gb","de","at","ch","es","fr","it","jp","in","ae","au","nl","se","pl","be","sg","tr"],"example":"de"},"key":{"type":"string","enum":["term","asin","gtin"],"default":"term","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values format"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search query"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amazon ASIN — 10-character alphanumeric identifier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13 — resolved to ASIN internally before fetching"},"children":[]}]}]}]}]}]}]},"topic":{"type":"string","enum":["search","search_and_offers","remove_conversions"],"default":"search","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard product search (default)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search_and_offers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch all seller offers from the Amazon Offer Listing page (AOD)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_conversions"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clear cached GTIN→ASIN mappings for the submitted GTINs"},"children":[]}]}]}]}]}]}]}}}]}},"components/schemas/GoogleJobRequest":{"id":"components/schemas/GoogleJobRequest","kind":"json-schema","title":"GoogleJobRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Shopping job submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns a list of matching product cards from a keyword search."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fetches a specific product page using a Google Shopping product ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"catalogid:…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productid:…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fetches a product page using a pipe-separated record"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This is the recommended key when you have a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product title, retailer deeplink, or size and want to anchor the Google"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query to a specific listing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be an array"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the string shorthand is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not compatible because "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"||"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separators may contain characters that conflict"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with comma-splitting."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/JobRequestBase"},{"type":"object","required":["source"],"properties":{"source":{"type":"string","enum":["google"]},"country":{"type":"string","description":"Supported Google Shopping countries.","enum":["de","at","ch","fr","it","es","uk","gb","us","au","ca","nl","be","pl","se","no","dk"],"example":"de"},"key":{"type":"string","enum":["term","id","product"],"default":"term","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result shape"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of product cards ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleTermContent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Shopping product ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full product page with seller offers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductContent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — pipe-separated record"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full product page with seller offers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductContent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}]}]}]},"topic":{"type":"string","enum":["search"],"default":"search","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for Google Shopping."},"children":[]}]}]}]},"values":{"type":"array","items":{"$ref":"#/components/schemas/GoogleProductValue"},"maxItems":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", each element must be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" string."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", any plain string is valid — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductValue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type so the schema remains compatible."},"children":[]}]}]}]}}}]}},"components/schemas/EbayJobRequest":{"id":"components/schemas/EbayJobRequest","kind":"json-schema","title":"EbayJobRequest","data":{"description":"eBay job submission.","allOf":[{"$ref":"#/components/schemas/JobRequestBase"},{"type":"object","required":["source"],"properties":{"source":{"type":"string","enum":["ebay"]},"country":{"type":"string","description":"Supported eBay countries.","enum":["de","at","fr","it","es","uk","gb","us","au","ca"],"example":"de"},"key":{"type":"string","enum":["term","id","gtin"],"default":"term","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values format"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search query"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eBay item ID (numeric string)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN / GTIN-13 barcode"},"children":[]}]}]}]}]}]}]},"topic":{"type":"string","enum":["search","remove_conversions"],"default":"search","description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard listing search (default)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_conversions"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clear cached GTIN mappings for the submitted GTINs"},"children":[]}]}]}]}]}]}]}}}]}},"components/schemas/GoogleProductValue":{"id":"components/schemas/GoogleProductValue","kind":"json-schema","title":"GoogleProductValue","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"||"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-separated product record used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Google Shopping."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"title||brand||gtin||price||deeplink||size\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"title||brand||gtin||price||deeplink||size\n"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effect on Google query"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Forms the base of the Google search query."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brand"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational only — not sent to Google."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational only — not sent to Google."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational only — not sent to Google."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deeplink"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retailer product URL. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hostname"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is extracted and appended to the query, anchoring results to that seller."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Size or variant string — appended to the query."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effective Google query:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{title} [{retailer_hostname}] [{size}]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trailing empty fields and their separators may be omitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title only (minimum):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Sony WH-1000XM5\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Sony WH-1000XM5\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title + deeplink to anchor to a specific retailer:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Sony WH-1000XM5||||https://www.amazon.de/dp/B09XS7JWHH\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Sony WH-1000XM5||||https://www.amazon.de/dp/B09XS7JWHH\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full record:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Tissot T-Touch Expert Solar||Tissot||7611608277942||850.00||https://www.zeitlounge.de/tissot-t-touch-expert-solar||\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Tissot T-Touch Expert Solar||Tissot||7611608277942||850.00||https://www.zeitlounge.de/tissot-t-touch-expert-solar||\n"},"children":[]}]}],"example":"Tissot T-Touch Expert Solar||Tissot||7611608277942||850.00||https://www.zeitlounge.de/tissot-t-touch-expert-solar||"}},"components/schemas/JobUpdateRequest":{"id":"components/schemas/JobUpdateRequest","kind":"json-schema","title":"JobUpdateRequest","data":{"type":"object","description":"Fields that can be updated on an interval job. Omitted fields retain current values.","properties":{"values":{"type":"array","items":{"type":"string"},"maxItems":1000},"max_pages":{"type":"integer","minimum":1,"maximum":10},"max_age":{"type":"integer","minimum":0},"sort_by":{"type":"string"},"topic":{"type":"string"},"timeout":{"type":"integer","minimum":1,"maximum":1440}}}},"components/schemas/StreamSubmitRequest":{"id":"components/schemas/StreamSubmitRequest","kind":"json-schema","title":"StreamSubmitRequest","data":{"description":"Stream job submission. Accepts the same source/key/country combinations\nas a batch job, plus stream-specific delivery parameters.\n","allOf":[{"$ref":"#/components/schemas/JobRequestBase"},{"type":"object","required":["callback_url"],"properties":{"callback_url":{"type":"string","format":"uri","description":"Endpoint to receive incremental result batches."},"client_ref":{"type":"string","nullable":true,"description":"Opaque reference string echoed in every webhook payload and in\nthe status response. Use to correlate jobs with your own records.\n","example":"batch-2026-04-03"},"delivery_batch_size":{"type":"integer","minimum":1,"maximum":200,"default":100,"description":"Number of results per webhook delivery."},"include_meta":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", each result includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provenance block"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"describing how the data was gathered — the crawl chain with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL, HTTP status, timing, and observation timestamps."},"children":[]}]}]}]},"fetch_seller_names":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idealo only. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", seller detail pages are crawled for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"marketplace offer sellers whose names are not yet in the database."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seller names already cached in the database are always applied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regardless of this flag."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enabling this adds one additional request per unresolved seller,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billed at the standard rate."},"children":[]}]}]}]},"values":{"type":"array","items":{"type":"string"},"maxItems":100000,"description":"Up to 100 000 values."}}}]}},"components/schemas/JobSubmitResponse":{"id":"components/schemas/JobSubmitResponse","kind":"json-schema","title":"JobSubmitResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"job":{"$ref":"#/components/schemas/Job"},"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when the request carried "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wait"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the job settled in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time. Same items as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/JobResult"}},"wait_timed_out":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when the request carried "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wait"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the job was still"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"running when the wait elapsed. Keep waiting with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /job/{id}?wait=N"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or poll."},"children":[]}]}]}]}}}},"components/schemas/JobStatusResponse":{"id":"components/schemas/JobStatusResponse","kind":"json-schema","title":"JobStatusResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"job":{"type":"object","properties":{"_id":{"type":"string"},"status":{"$ref":"#/components/schemas/JobStatus"},"done":{"type":"integer","description":"Values with a result so far."},"all":{"type":"integer","description":"Total values in this job."}}}}}},"components/schemas/JobDownloadResponse":{"id":"components/schemas/JobDownloadResponse","kind":"json-schema","title":"JobDownloadResponse","data":{"type":"object","properties":{"job_id":{"type":"string"},"status":{"$ref":"#/components/schemas/JobStatus"},"results":{"type":"array","items":{"$ref":"#/components/schemas/JobResult"}}}}},"components/schemas/StreamSubmitResponse":{"id":"components/schemas/StreamSubmitResponse","kind":"json-schema","title":"StreamSubmitResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"job_id":{"type":"string"},"webhook_secret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"32-byte hex secret for verifying webhook signatures."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store securely — not retrievable after submission."},"children":[]}]}]}]},"client_ref":{"type":"string","nullable":true}}}},"components/schemas/StreamStatusResponse":{"id":"components/schemas/StreamStatusResponse","kind":"json-schema","title":"StreamStatusResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"job_id":{"type":"string"},"status":{"$ref":"#/components/schemas/JobStatus"},"source":{"type":"string"},"country":{"type":"string"},"values_total":{"type":"integer","description":"Total values submitted."},"values_done":{"type":"integer","description":"Values with a result (success or error)."},"values_errors":{"type":"integer","description":"Values that resulted in an error."},"is_final":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when all values have been processed."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":"string","format":"date-time","nullable":true},"client_ref":{"type":"string","nullable":true}}}},"components/schemas/StreamResultsResponse":{"id":"components/schemas/StreamResultsResponse","kind":"json-schema","title":"StreamResultsResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"job_id":{"type":"string"},"values_total":{"type":"integer"},"values_done":{"type":"integer"},"values_errors":{"type":"integer"},"is_final":{"type":"boolean"},"offset":{"type":"integer"},"limit":{"type":"integer"},"count":{"type":"integer","description":"Number of results in this page."},"results":{"type":"array","items":{"$ref":"#/components/schemas/StreamResult"}}}}},"components/schemas/DeliveriesResponse":{"id":"components/schemas/DeliveriesResponse","kind":"json-schema","title":"DeliveriesResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"deliveries":{"type":"array","items":{"$ref":"#/components/schemas/Delivery"}}}}},"components/schemas/Job":{"id":"components/schemas/Job","kind":"json-schema","title":"Job","data":{"type":"object","properties":{"_id":{"type":"string","description":"MongoDB ObjectId."},"source":{"type":"string","enum":["idealo","amazon","google","ebay","kaufland","otto","billiger","guenstiger","walmart","lidl","aliexpress","rakuten"]},"country":{"type":"string","example":"de"},"key":{"type":"string","example":"gtin"},"topic":{"type":"string","example":"search"},"values":{"type":"array","items":{"type":"string"}},"max_pages":{"type":"integer"},"max_age":{"type":"integer"},"timeout":{"type":"integer","description":"Timeout in minutes."},"status":{"$ref":"#/components/schemas/JobStatus"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"type":"string","enum":["new","working","finished","failed"],"description":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created, queued for processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"working"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Crawls in progress"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All results assembled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timed out or unrecoverable error"},"children":[]}]}]}]}]}]}]}},"components/schemas/JobResult":{"id":"components/schemas/JobResult","kind":"json-schema","title":"JobResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result for a single input value."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one offer found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product has no listings on this source/country (a completed lookup — billed when freshly crawled, free when re-served from the not-found cache)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source currently unavailable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transient crawl failure — may succeed on retry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeout"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Crawl did not complete within the job timeout"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input is malformed (invalid GTIN checksum, bad ASIN format)"},"children":[]}]}]}]}]}]}],"properties":{"key":{"type":"string","description":"The input value this result corresponds to.","example":"4006381333962"},"success":{"type":"boolean"},"reason":{"type":"string","nullable":true,"enum":["not found","source currently unavailable","timeout","parameter_invalid",null]},"content":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source-specific result payload. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shape depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idealo → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IdealoContent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amazon → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonContent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleTermContent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoogleProductContent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eBay → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EbayContent"},"children":[]}]}]}]}],"oneOf":[{"$ref":"#/components/schemas/IdealoContent"},{"$ref":"#/components/schemas/AmazonContent"},{"$ref":"#/components/schemas/GoogleTermContent"},{"$ref":"#/components/schemas/GoogleProductContent"},{"$ref":"#/components/schemas/EbayContent"}]},"served_from":{"type":"string","enum":["live","cache"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — at least one fetch was made for this job. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cache"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"result was re-served from a cached observation without a fetch."},"children":[]}]}]}],"example":"live"},"observed_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the data was observed (UTC): the last fetch for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cached observation's date for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cache"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when nothing was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"observed (failed lookup) or the cache date is unknown."},"children":[]}]}]}],"example":"2026-09-08T10:00:00.000Z"},"trust":{"$ref":"#/components/schemas/Trust"},"meta":{"$ref":"#/components/schemas/ResultMeta"}}}},"components/schemas/IdealoContent":{"id":"components/schemas/IdealoContent","kind":"json-schema","title":"IdealoContent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idealo product result ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pzn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Product lookups ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pzn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") focus on offers; the page-only metadata fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rating_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available_since"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are populated on keyword "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results only. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is populated for product results in German markets ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Idealo product ID.","example":"205062515"},"name":{"type":"string","example":"Festool Bit PZ1 -25/10"},"url":{"type":"string","format":"uri"},"category_ids":{"type":"array","items":{"type":"string"},"description":"Primary category id(s) for the product.","example":["3308"]},"rating":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keyword "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results only."},"children":[]}]}]}],"example":4.7},"rating_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keyword "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results only."},"children":[]}]}]}],"example":150},"categories":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category name(s). Product results: German markets ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") only."},"children":[]}]}]}],"example":["Tintenstrahldrucker"]},"available_since":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the product appeared on Idealo. Keyword "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results only."},"children":[]}]}]}],"example":"2023-05-12"},"price_min":{"type":"number","format":"float","example":4.9},"price_max":{"type":"number","format":"float","example":19.85},"price_avg":{"type":"number","format":"float","example":12.34},"offers_count":{"type":"integer","example":5},"offers":{"type":"array","items":{"$ref":"#/components/schemas/IdealoOffer"}}}}},"components/schemas/IdealoOffer":{"id":"components/schemas/IdealoOffer","kind":"json-schema","title":"IdealoOffer","data":{"type":"object","properties":{"position":{"type":"integer","example":1},"price":{"type":"number","format":"float","example":4.9},"currency":{"type":"string","example":"EUR"},"shipping":{"type":"number","format":"float","nullable":true,"example":5.95},"total":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price + shipping."},"children":[]}]}]}],"example":10.85},"seller_name":{"type":"string","example":"mima.de"},"seller_url":{"type":"string","format":"uri"},"seller_type":{"type":"string","enum":["standalone-shop","marketplace-shop"]},"marketplace_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marketplace-shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Amazon"},"seller_rating":{"type":"number","format":"float","nullable":true},"seller_rating_count":{"type":"integer","nullable":true},"voucher":{"type":"boolean"},"free_return":{"type":"boolean","nullable":true},"availability_code":{"type":"string","enum":["green","orange","red"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"green"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = in stock, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = limited, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"red"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = out of stock."},"children":[]}]}]}]},"availability_text":{"type":"string","example":"sofort lieferbar, 1 - 3 Werktage"}}}},"components/schemas/AmazonContent":{"id":"components/schemas/AmazonContent","kind":"json-schema","title":"AmazonContent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amazon product result ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ASIN (unified schema — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every source)."},"children":[]}]}]}],"example":"B0847ZTV5Q"},"name":{"type":"string"},"brand_name":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"price_min":{"type":"number","format":"float"},"price_max":{"type":"number","format":"float"},"buybox":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy-box snapshot — the same object shape on Amazon, Walmart, and Kaufland (unified schema)."},"children":[]}]}]}],"properties":{"price":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy-box price. On a Prime-exclusive deal this is the regular (non-Prime) price; the Prime price is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prime_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":27.99},"seller_name":{"type":"string","nullable":true,"description":"Seller currently winning the buy box.","example":"Amazon.de"},"seller_id":{"type":"string","nullable":true,"example":"A3JWKAKR8XB7XF"}}},"seller_type":{"type":"string","enum":["amazon","fba","fbm"],"description":"Fulfilment of the buy-box seller."},"is_prime":{"type":"boolean","description":"True when the buy box carries a Prime-exclusive price."},"prime_price":{"type":"number","format":"float","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Prime-exclusive price when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_prime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, else null."},"children":[]}]}]}]},"offers_count":{"type":"integer"},"offers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"topic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search_and_offers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AmazonOffer"}}}}},"components/schemas/AmazonOffer":{"id":"components/schemas/AmazonOffer","kind":"json-schema","title":"AmazonOffer","data":{"type":"object","properties":{"price":{"type":"number","format":"float"},"currency":{"type":"string","example":"EUR"},"seller_name":{"type":"string"},"seller_id":{"type":"string"},"is_prime":{"type":"boolean"},"condition":{"type":"string","example":"New"},"shipping":{"type":"number","format":"float","nullable":true}}}},"components/schemas/GoogleTermContent":{"id":"components/schemas/GoogleTermContent","kind":"json-schema","title":"GoogleTermContent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Shopping result for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Contains a list of product cards"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"matching the search query. Each card is a distinct product — not a single"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seller listing."},"children":[]}]}]}],"properties":{"offers_count":{"type":"integer","description":"Number of product cards returned."},"offers":{"type":"array","items":{"$ref":"#/components/schemas/GoogleProductCard"}}}}},"components/schemas/GoogleProductCard":{"id":"components/schemas/GoogleProductCard","kind":"json-schema","title":"GoogleProductCard","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A product card from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search. Represents a product, not a seller."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in a follow-up job to get full"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seller offers for that product."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"Product name."},"gid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Shopping product ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"catalogid:…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productid:…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch the full product page."},"children":[]}]}]}],"example":"catalogid:7294553093490218809"},"url":{"type":"string","format":"uri","description":"URL of the Google Shopping product page."},"price":{"type":"number","format":"float","description":"Lowest listed price for this product."},"currency":{"type":"string","example":"EUR"},"shipping":{"type":"number","format":"float","nullable":true},"condition":{"type":"string","nullable":true},"seller":{"type":"string","description":"Name of the seller shown on the card.","nullable":true},"seller_url":{"type":"string","format":"uri","nullable":true},"rating":{"type":"number","format":"float","nullable":true},"rating_count":{"type":"string","nullable":true}}}},"components/schemas/GoogleProductContent":{"id":"components/schemas/GoogleProductContent","kind":"json-schema","title":"GoogleProductContent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Shopping result for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Contains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full product data with all seller offers from the product page."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Google Shopping product ID.","example":"7294553093490218809"},"name":{"type":"string","example":"Tissot T-Touch Expert Solar"},"brand_name":{"type":"string","nullable":true,"example":"Tissot"},"description":{"type":"string","nullable":true},"url":{"type":"string","format":"uri","description":"Canonical Google Shopping product URL."},"rating":{"type":"number","format":"float","nullable":true},"rating_count":{"type":"integer","nullable":true},"price_min":{"type":"number","format":"float"},"price_max":{"type":"number","format":"float"},"price_avg":{"type":"number","format":"float"},"offers_count":{"type":"integer"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/GoogleSellerOffer"}}}}},"components/schemas/GoogleSellerOffer":{"id":"components/schemas/GoogleSellerOffer","kind":"json-schema","title":"GoogleSellerOffer","data":{"type":"object","description":"A seller listing from a Google Shopping product page.","properties":{"seller_name":{"type":"string"},"seller_url":{"type":"string","format":"uri","nullable":true},"price":{"type":"number","format":"float"},"currency":{"type":"string","example":"EUR"},"shipping":{"type":"number","format":"float","nullable":true},"total":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price + shipping."},"children":[]}]}]}],"nullable":true},"condition":{"type":"string","nullable":true},"position":{"type":"integer"},"seller_rating":{"type":"number","format":"float","nullable":true},"seller_rating_count":{"type":"integer","nullable":true}}}},"components/schemas/EbayContent":{"id":"components/schemas/EbayContent","kind":"json-schema","title":"EbayContent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eBay search result ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gtin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"offers_count":{"type":"integer"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/EbayOffer"}}}}},"components/schemas/EbayOffer":{"id":"components/schemas/EbayOffer","kind":"json-schema","title":"EbayOffer","data":{"type":"object","properties":{"id":{"type":"string","description":"eBay item ID."},"name":{"type":"string"},"price":{"type":"number","format":"float"},"currency":{"type":"string","example":"EUR"},"url":{"type":"string","format":"uri"},"shipping":{"type":"number","format":"float","nullable":true},"condition":{"type":"string","example":"Neu | Gewerblich"},"position":{"type":"integer"},"seller_name":{"type":"string","nullable":true}}}},"components/schemas/StreamResult":{"id":"components/schemas/StreamResult","kind":"json-schema","title":"StreamResult","data":{"type":"object","description":"A single result item from the stream results endpoint.","properties":{"_id":{"type":"string"},"result":{"$ref":"#/components/schemas/JobResult"},"source":{"type":"string"},"country":{"type":"string"},"index":{"type":"integer","description":"0-based position of this value in the original submission."},"completed_at":{"type":"string","format":"date-time"}}}},"components/schemas/Delivery":{"id":"components/schemas/Delivery","kind":"json-schema","title":"Delivery","data":{"type":"object","description":"Webhook delivery record.","properties":{"_id":{"type":"string"},"job_id":{"type":"string"},"status":{"type":"string","enum":["pending","delivered","dead_lettered"]},"batch_sequence":{"type":"integer","description":"1-based sequence number of this delivery batch."},"result_count":{"type":"integer","description":"Number of results in this delivery."},"http_status":{"type":"integer","nullable":true,"description":"HTTP status returned by the webhook endpoint."},"error":{"type":"string","nullable":true,"description":"Error message if delivery failed."},"createdAt":{"type":"string","format":"date-time"},"deliveredAt":{"type":"string","format":"date-time","nullable":true}}}},"components/schemas/AccountJob":{"id":"components/schemas/AccountJob","kind":"json-schema","title":"AccountJob","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One row of the org's request history ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/account/jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"id":{"type":"string","example":"68b9c2f1a4d3e5b6c7d8e9f0"},"source":{"type":"string","example":"idealo"},"country":{"type":"string","example":"de"},"key":{"type":"string","example":"gtin"},"topic":{"type":"string","example":"search"},"status":{"type":"string","enum":["new","working","finished","failed"]},"reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure / force-finish reason when set (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeout_partial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"values_count":{"type":"integer","description":"Values submitted with the job.","example":250},"results_count":{"type":"integer","nullable":true},"errors_count":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed lookups (timeout, blocked, parse error …) — never charged."},"children":[]}]}]}]},"resolved_count":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lookups that returned a product ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results_count − errors_count − not_found_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":240},"not_found_count":{"type":"integer","nullable":true,"description":"Lookups answered \"not found\"; free when served from cache, billed when freshly crawled.","example":8},"credits_charged":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits debited for this job — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a failed job and for jobs whose"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lookups were all free (cache hits / errors); "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while a job is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"still running or once neither the debit nor the results are available."},"children":[]}]}]}],"example":250},"is_stream":{"type":"boolean"},"client_ref":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":"string","format":"date-time","nullable":true},"duration_ms":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission → finished, in milliseconds."},"children":[]}]}]}]}}}},"components/schemas/AccountDelivery":{"id":"components/schemas/AccountDelivery","kind":"json-schema","title":"AccountDelivery","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One webhook delivery (batch) of a job ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/account/jobs/{id}/deliveries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"id":{"type":"string","example":"68be1a0c9f2d4e7b8a1c2d3e"},"attempt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempts made so far on this batch (1 = first try; max 5)."},"children":[]}]}]}],"example":3},"status":{"type":"string","enum":["pending","delivered","failed","dead_lettered"]},"http_status":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status the callback URL answered on the last attempt; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a network error."},"children":[]}]}]}],"example":503},"error":{"type":"string","nullable":true,"example":"non-2xx: 503"},"batch_sequence":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1-based batch number within the job — gaps mean a batch is missing on the receiver."},"children":[]}]}]}],"example":4},"result_count":{"type":"integer","nullable":true,"description":"Results embedded in this batch.","example":100},"first_attempted_at":{"type":"string","format":"date-time","nullable":true},"last_attempted_at":{"type":"string","format":"date-time","nullable":true},"next_attempt_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled retry while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation and business-logic errors return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 200"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check this field before consuming the response."},"children":[]}]}]}],"properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"country not supported by source"}}}},"components/schemas/HttpError":{"id":"components/schemas/HttpError","kind":"json-schema","title":"HttpError","data":{"type":"object","description":"Infrastructure-level error (4xx / 5xx).","properties":{"error":{"type":"string","example":"user not found"},"message":{"type":"string","nullable":true}}}},"components/schemas/Trust":{"id":"components/schemas/Trust","kind":"json-schema","title":"Trust","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence score attached to every result. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a weighted average"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(0–1) of the five "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/trust"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trust"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for interpretation."},"children":[]}]}]}],"properties":{"score":{"type":"number","format":"float","minimum":0,"maximum":1,"description":"Overall confidence, 0 (do not trust) to 1 (fully trusted).","example":0.81},"components":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The five sub-scores that make up "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", each 0–1."},"children":[]}]}]}],"properties":{"identity":{"type":"number","format":"float","description":"Is this the requested product? (weight 0.25)","example":1},"completeness":{"type":"number","format":"float","description":"Are the expected fields populated? (weight 0.20)","example":0.85},"price_integrity":{"type":"number","format":"float","description":"Pricing consistent and outlier-free? (weight 0.25)","example":0.7},"offer_contamination":{"type":"number","format":"float","description":"Fraction of offers that are clean. (weight 0.15)","example":0.9},"freshness":{"type":"number","format":"float","description":"Recency of the data; decays with age. (weight 0.15)","example":0.55}}},"flagged_offers":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indices into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content.offers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of offers flagged as price outliers."},"children":[]}]}]}],"example":[2,5]}}}},"components/schemas/ResultMeta":{"id":"components/schemas/ResultMeta","kind":"json-schema","title":"ResultMeta","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provenance metadata. Present only when the job was submitted with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_meta: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"crawls":{"type":"array","description":"One entry per fetch that contributed to this result.","items":{"$ref":"#/components/schemas/CrawlProvenance"}},"partial":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google only. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the marketplace reports more sellers than"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"were gathered in this snapshot. Absent for other sources."},"children":[]}]}]}]}}}},"components/schemas/CrawlProvenance":{"id":"components/schemas/CrawlProvenance","kind":"json-schema","title":"CrawlProvenance","data":{"type":"object","description":"Provenance for a single fetch behind a result.","properties":{"crawl_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable ID for this individual fetch — quote it to support."},"children":[]}]}]}],"example":"9f1c2d3e4b5a6c7d8e9f0a1b"},"url":{"type":"string","format":"uri","description":"The exact URL that was fetched."},"http_status":{"type":"integer","example":200},"duration_ms":{"type":"integer","description":"Fetch round-trip time, in milliseconds.","example":2341},"observed_at":{"type":"string","format":"date-time","description":"When the data was observed (UTC)."},"geo":{"type":"string","description":"Country the request was made from.","example":"de"},"job_type":{"type":"string","description":"Internal crawl step that produced this fetch.","example":"idealo.search"}}}},"components/schemas/ChangeEventType":{"id":"components/schemas/ChangeEventType","kind":"json-schema","title":"ChangeEventType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of a change-event webhook. See the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/change-events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide."},"children":[]}]}]}],"enum":["product.changed","price.delta","buybox.change","stock.update","product.resolved","product.unavailable"]}},"components/schemas/FieldChange":{"id":"components/schemas/FieldChange","kind":"json-schema","title":"FieldChange","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single changed field, as an old → new pair."},"children":[]}]}]}],"properties":{"old":{"description":"Previous value."},"new":{"description":"Current value."}}}},"components/schemas/ChangeEventPayload":{"id":"components/schemas/ChangeEventPayload","kind":"json-schema","title":"ChangeEventPayload","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body of a change-event webhook "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Delivered to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the same HMAC signing and retry behaviour as stream deliveries (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delta_only: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are sent."},"children":[]}]}]}],"properties":{"event":{"$ref":"#/components/schemas/ChangeEventType"},"delivered_at":{"type":"string","format":"date-time"},"product":{"type":"object","description":"Identity of the product that changed.","properties":{"source":{"type":"string","example":"idealo"},"country":{"type":"string","example":"de"},"key":{"type":"string","example":"gtin"},"value":{"type":"string","example":"4006381333962"},"name":{"type":"string","example":"Fissler Original-Profi Collection"}}},"changes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields that changed, each an old → new pair. Keys depend on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offer_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buybox_seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buybox_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absent for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which report a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transition rather than a field moving."},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/FieldChange"}}}}},"schema_17":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/StreamSubmitResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/StreamStatusResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1000,"default":100},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/StreamResultsResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"oneOf":[{"type":"object","properties":{"error":{"type":"boolean","example":false},"replayed":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliveries moved back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":3}}},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"string","enum":["pending","delivered","dead_lettered"]},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/DeliveriesResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"oneOf":[{"type":"object","properties":{"error":{"type":"boolean","example":false},"message":{"type":"string","example":"delivery re-enqueued"}}},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/JobSubmitResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/JobStatusResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"oneOf":[{"type":"object","properties":{"error":{"type":"boolean","example":false},"message":{"type":"string","example":"job 64f1c2d3e4b5a6c7d8e9f0a1 removed"}}},{"$ref":"#/components/schemas/ErrorResponse"}]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"string","enum":["json","csv"]},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"string","description":"CSV with one row per result value."},"id":"schema_33"}},"exampleStore":{"paths/~1stream/post/requestBody/content/application~1json/example":{"value":{"source":"idealo","country":"de","key":"gtin","values":["4006381333962","4719512101148"],"callback_url":"https://your-server.example.com/webhooks/prices","client_ref":"batch-2026-04-03","delivery_batch_size":50},"id":"paths/~1stream/post/requestBody/content/application~1json/example"},"paths/~1stream/post/responses/200/content/application~1json/example":{"value":{"error":false,"job_id":"64f1c2d3e4b5a6c7d8e9f0a1","webhook_secret":"a3f8c2d1e9b4...","client_ref":"batch-2026-04-03"},"id":"paths/~1stream/post/responses/200/content/application~1json/example"},"paths/~1stream/post/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1stream/post/responses/401/content/application~1json/example"},"paths/~1stream/post/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1stream/post/responses/403/content/application~1json/example"},"paths/~1stream~1{id}/get/responses/200/content/application~1json/example":{"value":{"error":false,"job_id":"64f1c2d3e4b5a6c7d8e9f0a1","status":"working","source":"idealo","country":"de","values_total":1000,"values_done":452,"values_errors":3,"is_final":false,"created_at":"2026-04-03T10:00:00.000Z","finished_at":null,"client_ref":"batch-2026-04-03"},"id":"paths/~1stream~1{id}/get/responses/200/content/application~1json/example"},"paths/~1stream~1{id}/get/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1stream~1{id}/get/responses/401/content/application~1json/example"},"paths/~1stream~1{id}/get/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1stream~1{id}/get/responses/403/content/application~1json/example"},"paths/~1stream~1{id}~1results/get/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1stream~1{id}~1results/get/responses/401/content/application~1json/example"},"paths/~1stream~1{id}~1results/get/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1stream~1{id}~1results/get/responses/403/content/application~1json/example"},"paths/~1stream~1{id}~1replay-all/post/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1stream~1{id}~1replay-all/post/responses/401/content/application~1json/example"},"paths/~1stream~1{id}~1replay-all/post/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1stream~1{id}~1replay-all/post/responses/403/content/application~1json/example"},"paths/~1stream~1{id}~1deliveries/get/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1stream~1{id}~1deliveries/get/responses/401/content/application~1json/example"},"paths/~1stream~1{id}~1deliveries/get/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1stream~1{id}~1deliveries/get/responses/403/content/application~1json/example"},"paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/401/content/application~1json/example"},"paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1stream~1deliveries~1{delivery_id}~1replay/post/responses/403/content/application~1json/example"},"paths/~1job/post/requestBody/content/application~1json/examples/idealo_gtin":{"value":{"source":"idealo","country":"de","key":"gtin","values":["4006381333962","4719512101148"]},"key":"idealo_gtin","summary":"Idealo — GTIN lookup","id":"paths/~1job/post/requestBody/content/application~1json/examples/idealo_gtin"},"paths/~1job/post/requestBody/content/application~1json/examples/amazon_asin_with_offers":{"value":{"source":"amazon","country":"de","key":"asin","values":["B0847ZTV5Q"],"topic":"search_and_offers"},"key":"amazon_asin_with_offers","summary":"Amazon — ASIN with all seller offers","id":"paths/~1job/post/requestBody/content/application~1json/examples/amazon_asin_with_offers"},"paths/~1job/post/requestBody/content/application~1json/examples/google_term":{"value":{"source":"google","country":"de","key":"term","values":["Tissot T-Touch Expert Solar"]},"key":"google_term","summary":"Google Shopping — keyword search","id":"paths/~1job/post/requestBody/content/application~1json/examples/google_term"},"paths/~1job/post/requestBody/content/application~1json/examples/google_product":{"value":{"source":"google","country":"de","key":"product","values":["Tissot T-Touch Expert Solar||Tissot||7611608277942||850.00||https://www.zeitlounge.de/tissot-t-touch-expert-solar||","Seiko Prospex Alpinist||Seiko||4954628232342||450.00||||"]},"key":"google_product","summary":"Google Shopping — product record lookup","id":"paths/~1job/post/requestBody/content/application~1json/examples/google_product"},"paths/~1job/post/requestBody/content/application~1json/examples/ebay_gtin":{"value":{"source":"ebay","country":"de","key":"gtin","values":["4006381333962"]},"key":"ebay_gtin","summary":"eBay — GTIN search","id":"paths/~1job/post/requestBody/content/application~1json/examples/ebay_gtin"},"paths/~1job/post/requestBody/content/application~1json/examples/kaufland_offers":{"value":{"source":"kaufland","country":"cz","key":"gtin","topic":"search_and_offers","values":["4006381333962"]},"key":"kaufland_offers","summary":"Kaufland — GTIN search with seller offers (Czech market)","id":"paths/~1job/post/requestBody/content/application~1json/examples/kaufland_offers"},"paths/~1job/post/requestBody/content/application~1json/examples/guenstiger_term":{"value":{"source":"guenstiger","country":"de","key":"term","topic":"search_and_offers","values":["Tissot T-Touch Expert Solar"]},"key":"guenstiger_term","summary":"Guenstiger — keyword search with offers","id":"paths/~1job/post/requestBody/content/application~1json/examples/guenstiger_term"},"paths/~1job/post/responses/200/content/application~1json/examples/success":{"value":{"error":false,"job":{"_id":"64f1c2d3e4b5a6c7d8e9f0a1","source":"idealo","country":"de","key":"gtin","topic":"search","values":["4006381333962"],"max_pages":1,"max_age":1200,"timeout":1440,"status":"new","createdAt":"2026-04-03T10:00:00.000Z"}},"key":"success","summary":"success","id":"paths/~1job/post/responses/200/content/application~1json/examples/success"},"paths/~1job/post/responses/200/content/application~1json/examples/validation_error":{"value":{"error":true,"message":"country not supported by source"},"key":"validation_error","summary":"validation_error","id":"paths/~1job/post/responses/200/content/application~1json/examples/validation_error"},"paths/~1job/post/responses/200/content/application~1json/examples/wait":{"value":{"error":false,"job":{"_id":"64f1c2d3e4b5a6c7d8e9f0a1","source":"idealo","country":"de","key":"gtin","topic":"search","values":["4006381333962"],"max_pages":1,"max_age":1200,"timeout":1440,"status":"finished","createdAt":"2026-04-03T10:00:00.000Z"},"results":[{"key":"4006381333962","success":true,"reason":null,"content":{"product_id":"205062515","name":"Festool Bit PZ1 -25/10","price_min":4.9,"price_max":19.85,"price_avg":12.34,"offers_count":5,"offers":[{"position":1,"price":4.9,"currency":"EUR","seller_name":"mima.de","seller_url":"https://www.mima.de","shipping":5.95,"total":10.85}]},"served_from":"live","observed_at":"2026-04-03T10:00:04.000Z","trust":{"score":0.92,"components":{"identity":1,"completeness":0.89,"price_integrity":0.95,"offer_contamination":1,"freshness":0.75},"flagged_offers":[]}}]},"key":"wait","summary":"`wait` settled — results inline","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock server: send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-redocly-response-body-example: wait"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape instead of the default job object."},"children":[]}]}]}],"id":"paths/~1job/post/responses/200/content/application~1json/examples/wait"},"paths/~1job/post/responses/200/content/application~1json/examples/wait_timed_out":{"value":{"error":false,"job":{"_id":"64f1c2d3e4b5a6c7d8e9f0a1","source":"idealo","country":"de","key":"gtin","topic":"search","values":["4006381333962"],"status":"working","createdAt":"2026-04-03T10:00:00.000Z"},"wait_timed_out":true},"key":"wait_timed_out","summary":"`wait` elapsed — job still running","id":"paths/~1job/post/responses/200/content/application~1json/examples/wait_timed_out"},"paths/~1job/post/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1job/post/responses/401/content/application~1json/example"},"paths/~1job/post/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1job/post/responses/403/content/application~1json/example"},"paths/~1job~1{id}/get/responses/200/content/application~1json/examples/working":{"value":{"error":false,"job":{"_id":"64f1c2d3e4b5a6c7d8e9f0a1","status":"working","done":45,"all":100}},"key":"working","summary":"working","id":"paths/~1job~1{id}/get/responses/200/content/application~1json/examples/working"},"paths/~1job~1{id}/get/responses/200/content/application~1json/examples/finished":{"value":{"error":false,"job":{"_id":"64f1c2d3e4b5a6c7d8e9f0a1","status":"finished","done":100,"all":100}},"key":"finished","summary":"finished","id":"paths/~1job~1{id}/get/responses/200/content/application~1json/examples/finished"},"paths/~1job~1{id}/get/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1job~1{id}/get/responses/401/content/application~1json/example"},"paths/~1job~1{id}/get/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1job~1{id}/get/responses/403/content/application~1json/example"},"paths/~1job~1{id}/put/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1job~1{id}/put/responses/401/content/application~1json/example"},"paths/~1job~1{id}/put/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1job~1{id}/put/responses/403/content/application~1json/example"},"paths/~1job~1{id}/delete/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1job~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1job~1{id}/delete/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1job~1{id}/delete/responses/403/content/application~1json/example"},"paths/~1job~1{id}~1download/get/responses/200/content/application~1json/example":{"value":{"job_id":"64f1c2d3e4b5a6c7d8e9f0a1","status":"finished","results":[{"key":"4006381333962","success":true,"reason":null,"content":{"product_id":"205062515","name":"Festool Bit PZ1 -25/10","price_min":4.9,"price_max":19.85,"price_avg":12.34,"offers_count":5,"offers":[{"position":1,"price":4.9,"currency":"EUR","seller_name":"mima.de","seller_url":"https://www.mima.de","shipping":5.95,"total":10.85}]}},{"key":"0000000000000","success":false,"reason":"not found"}]},"id":"paths/~1job~1{id}~1download/get/responses/200/content/application~1json/example"},"paths/~1job~1{id}~1download/get/responses/401/content/application~1json/example":{"value":{"error":"unauthorized"},"id":"paths/~1job~1{id}~1download/get/responses/401/content/application~1json/example"},"paths/~1job~1{id}~1download/get/responses/403/content/application~1json/example":{"value":{"error":"forbidden"},"id":"paths/~1job~1{id}~1download/get/responses/403/content/application~1json/example"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT issued by your account. Valid for 24 hours."},"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic","description":"HTTP Basic authentication with your account username and password."},"DashboardAuth":{"id":"DashboardAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"kwery.co dashboard session token (Supabase). Used by the dashboard UI\nfor account/keys/billing endpoints.\n"},"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your data-API key, format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May also be sent as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer kwy_live_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"x-api-key"}},"servers":[{"url":"/_mock/api-reference","isMockServer":true,"description":"Mock server"},{"url":"https://api.kwery.co","description":"Production"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"JavaScript"},{"lang":"Python"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"},{"lang":"Ruby"}]},"mockServer":{"url":"/_mock/api-reference","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api-reference.json?download"},{"url":"/_bundle/api-reference.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"kwery API Reference","description":"Real-time price data across major European and global marketplaces.\n\nNew here? Start with the **[Guides](https://docs.kwery.co/)** — getting started,\nauthentication, webhooks, and per-source field reference.\n\n## Try it — no account needed\n\nA **mock server** is built into this reference: send requests to\n`https://docs.kwery.co/_mock/api-reference` and get back correctly-shaped example\nresponses — no signup, no API key (any dummy `Authorization` header passes),\nand no credits consumed. Select **Mock server** in the Servers panel and the\ncode samples switch to it automatically.\n\n```bash\ncurl -X POST https://docs.kwery.co/_mock/api-reference/job \\\n  -H \"Authorization: Bearer test123\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"source\":\"idealo\",\"country\":\"de\",\"key\":\"gtin\",\"values\":[\"4006381333962\"]}'\n```\n\nThe data returned is static example data from this specification, not a live\ncrawl — but the response shapes are exactly what production returns, so you can\nbuild and test your integration end-to-end before creating an account.\n\n## Source and key reference\n\nEach source supports a fixed set of `key` types. The `key` field\ndetermines what goes in `values`.\n\n| Source | Key | Values format | Supported countries |\n|--------|-----|---------------|---------------------|\n| `idealo` | `term` | Free-text search | de at uk (gb) fr it es |\n| `idealo` | `id` | Idealo product ID (numeric) | de at uk (gb) fr it es |\n| `idealo` | `gtin` | EAN / GTIN-13 | de at uk (gb) fr it es |\n| `idealo` | `pzn` | Pharmacy product number | de |\n| `amazon` | `term` | Free-text search | us ca mx br uk (gb) de at ch es fr it jp in ae au nl se pl be sg tr |\n| `amazon` | `asin` | Amazon ASIN (10 chars) | us ca mx br uk (gb) de at ch es fr it jp in ae au nl se pl be sg tr |\n| `amazon` | `gtin` | EAN / GTIN-13 | us ca mx br uk (gb) de at ch es fr it jp in ae au nl se pl be sg tr |\n| `google` | `term` | Free-text search | us de uk (gb) au at br ca cz dk fr in ie it jp mx no pl nz nl ru sg za es se fi ch tr ar cl co be gr hu pt ro sk hk id il my ph sa kr tw th ua vn ae |\n| `google` | `id` | Google Shopping product ID | us de uk (gb) au at br ca cz dk fr in ie it jp mx no pl nz nl ru sg za es se fi ch tr ar cl co be gr hu pt ro sk hk id il my ph sa kr tw th ua vn ae |\n| `google` | `product` | Pipe-separated product record — see `GoogleProductValue` | us de uk (gb) au at br ca cz dk fr in ie it jp mx no pl nz nl ru sg za es se fi ch tr ar cl co be gr hu pt ro sk hk id il my ph sa kr tw th ua vn ae |\n| `ebay` | `term` | Free-text search | au at be ca fr de ie it hk my nl pl sg es ch uk (gb) us |\n| `ebay` | `id` | eBay item ID (numeric) | au at be ca fr de ie it hk my nl pl sg es ch uk (gb) us |\n| `ebay` | `gtin` | EAN / GTIN-13 | au at be ca fr de ie it hk my nl pl sg es ch uk (gb) us |\n| `kaufland` | `term` | Free-text search | de cz sk pl at fr it |\n| `kaufland` | `id` | Kaufland product ID | de cz sk pl at fr it |\n| `kaufland` | `gtin` | EAN / GTIN-13 | de cz sk pl at fr it |\n| `otto` | `term` | Free-text search | de |\n| `otto` | `id` | Otto product ID | de |\n| `billiger` | `term` | Free-text search | de |\n| `billiger` | `id` | billiger.de product ID | de |\n| `billiger` | `gtin` | EAN / GTIN-13 | de |\n| `guenstiger` | `term` | Free-text search | de |\n| `guenstiger` | `id` | guenstiger.de product ID (numeric) | de |\n| `guenstiger` | `gtin` | EAN / GTIN-13 | de |\n| `walmart` | `term` | Free-text search | us |\n| `walmart` | `id` | Walmart item ID | us |\n| `walmart` | `gtin` | EAN / UPC / GTIN | us |\n| `lidl` | `term` | Free-text search | de at fr it nl pl uk … |\n| `lidl` | `id` | Lidl product ID | de at fr it nl pl uk … |\n| `aliexpress` | `term` | Free-text search | us |\n| `aliexpress` | `id` | AliExpress product ID | us |\n| `rakuten` | `term` | Free-text search | jp |\n| `rakuten` | `id` | Rakuten item ID | jp |\n\n> `uk (gb)` means `uk` and `gb` are two codes for the **same** UK marketplace —\n> pass either one, it is not a separate locale. For Amazon, `at` and `ch` are\n> served from the amazon.de storefront with Austria/Switzerland localization.\n\n## Authentication\n\nSign up at [kwery.co](https://kwery.co); the dashboard issues your API key. Send it on\nevery data-API request as either:\n- **Bearer** — `Authorization: Bearer kwy_live_...`\n- **API key header** — `x-api-key: kwy_live_...`\n\nLegacy/enterprise accounts provisioned before self-serve may still use HTTP Basic\n(username + password) or a Bearer JWT issued directly by us. See\n[Authentication](guides/authentication.md) for details.\n\nAccess is controlled per `source.country` pair. A `not subscribed to source`\nerror means your account is not provisioned for the requested combination.\n\n## Response envelope\n\nValidation errors return **HTTP 200** with `\"error\": true`. Always check the\n`error` field before consuming a response:\n\n```json\n{ \"error\": true, \"message\": \"country not supported by source\" }\n```\n\nInfrastructure errors (auth, 5xx) use standard HTTP status codes.\n\n## Stream API\n\nFor large batches (up to **100 000 values**), use the Stream endpoint.\nResults are pushed to your `callback_url` as they complete — no polling needed.\n\n1. `POST /stream` — submit values with a `callback_url`\n2. Results arrive at `callback_url` in batches as they complete\n3. `GET /stream/{id}` — optional progress check\n\n## Batch API\n\nFor standard batches (up to **1 000 values**), use the Batch endpoint.\nResults are retained for **72 hours**.\n\n1. `POST /job` — submit a list of values, receive a job ID\n2. `GET /job/{id}` — poll until `status` is `finished`\n3. `GET /job/{id}/download` — retrieve structured results\n"}},"baseSlug":"/api-reference","routesMapping":{}}