{"openapi":"3.1.0","info":{"title":"Piloterr API Reference","description":"Complete API reference documentation.","version":"1.0.0"},"servers":[{"url":"https://api.piloterr.com","description":"API Server"}],"paths":{"/v2/redfin/search":{"get":{"summary":"Redfin Search","description":"Search for-sale homes on Redfin from a city, neighborhood, or county link. Each listing url includes the market id to pass to the property endpoint.\n\n**Credit cost:** 1 credit per call","operationId":"get-redfin-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Redfin for-sale link for a city, neighborhood, or county.\n\n**Example (city):**\n\n    https://www.redfin.com/city/16163/WA/Seattle\n\n**Example (neighborhood):**\n\n    https://www.redfin.com/neighborhood/56947/WA/Seattle/Capitol-Hill\n\n**Example (county):**\n\n    https://www.redfin.com/county/118/WA/King-County\n\n**JSON:** each results[].url includes region_id and region_type from that link. City is region_type 6, neighborhood is 1, county is 5. A home link, zip link, or /filter/ link returns 400.","schema":{"type":"string","description":"Redfin for-sale link for a city, neighborhood, or county.\n\n**Example (city):**\n\n    https://www.redfin.com/city/16163/WA/Seattle\n\n**Example (neighborhood):**\n\n    https://www.redfin.com/neighborhood/56947/WA/Seattle/Capitol-Hill\n\n**Example (county):**\n\n    https://www.redfin.com/county/118/WA/King-County\n\n**JSON:** each results[].url includes region_id and region_type from that link. City is region_type 6, neighborhood is 1, county is 5. A home link, zip link, or /filter/ link returns 400."}},{"name":"page","in":"query","required":false,"description":"Page of the for-sale feed, from 1.\n\n**Example:**\n\n    2\n\n**Default:** the page already in the link, otherwise 1.\n\n**JSON:** page 2 rewrites the path to /page-2, sets pagination.page to 2, and sets pagination.next to the next link when the page is full. pagination.total_results and pagination.total_pages stay null. Overrides a page already in the link.","schema":{"type":"number","description":"Page of the for-sale feed, from 1.\n\n**Example:**\n\n    2\n\n**Default:** the page already in the link, otherwise 1.\n\n**JSON:** page 2 rewrites the path to /page-2, sets pagination.page to 2, and sets pagination.next to the next link when the page is full. pagination.total_results and pagination.total_pages stay null. Overrides a page already in the link."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns results and pagination.\ntrue returns {\"result\": \"<gis json>\"} and omits the parsed listings.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns results and pagination.\ntrue returns {\"result\": \"<gis json>\"} and omits the parsed listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"hoa":{"type":"integer"},"url":{"type":"string"},"zip":{"type":"string"},"beds":{"type":"integer"},"city":{"type":"string"},"sqft":{"type":"integer"},"unit":{"type":"string"},"baths":{"type":"integer"},"price":{"type":"integer"},"state":{"type":"string"},"mls_id":{"type":"string"},"status":{"type":"string"},"street":{"type":"string"},"remarks":{"type":"string"},"latitude":{"type":"number"},"lot_size":{"nullable":true},"is_redfin":{"type":"boolean"},"key_facts":{"type":"array","items":{"type":"string"}},"longitude":{"type":"number"},"agent_name":{"type":"string"},"listing_id":{"type":"integer"},"open_house":{"nullable":true},"year_built":{"type":"integer"},"broker_name":{"type":"string"},"has_3d_tour":{"type":"boolean"},"hoa_display":{"type":"string"},"photo_count":{"type":"integer"},"property_id":{"type":"integer"},"listing_tags":{"type":"array","items":{"type":"string"}},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"price_per_sqft":{"type":"integer"},"is_early_access":{"type":"boolean"},"has_virtual_tour":{"type":"boolean"},"price_per_sqft_display":{"type":"string"},"has_interactive_floorplan":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Seattle for-sale page, 1120 8th Ave unit 1603":{"value":{"results":[{"hoa":825,"url":"https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6","zip":"98101","beds":2,"city":"Seattle","sqft":1050,"unit":"#1603","baths":2,"price":526500,"state":"WA","mls_id":"2573739","status":"Active","street":"1120 8th Ave #1603","remarks":"Live in the heart of First Hill with convenience, comfort, and city access at your doorstep. This spacious, freshly painted, condo is filled with natural light! The expansive living area is anchored by a cozy fireplace and a wall of floor-to-ceiling windows that open to a private juliet balcony, providing views during the day, and sparkling city lights at night. The primary suite boasts a large closet and private bath, while the spacious second bedroom provides the flexibility of a guest room, home office, or both. Enjoy the added comfort of A/C and in-unit washer/dryer, and the convenience of an oversized parking space in a secure garage and an additional storage unit. Seneca 8 amenities i","latitude":47.6092374,"lot_size":null,"is_redfin":true,"key_facts":["Secure garage","Cozy fireplace","In-unit washer dryer"],"longitude":-122.3293587,"agent_name":"Kiley Lazarus","listing_id":224286680,"open_house":null,"year_built":1970,"broker_name":"Redfin","has_3d_tour":true,"hoa_display":"$825","photo_count":30,"property_id":14602,"listing_tags":["PRIVATE JULIET BALCONY","COZY FIREPLACE","FLOOR-TO-CEILING WINDOWS","IN-UNIT WASHER DRYER","OVERSIZED PARKING SPACE","SECURE GARAGE"],"neighborhood":"First Hill","price_display":"$526,500","property_type":"condo","price_per_sqft":501,"is_early_access":false,"has_virtual_tour":true,"price_per_sqft_display":"$501","has_interactive_floorplan":false}],"pagination":{"next":"https://www.redfin.com/city/16163/WA/Seattle/page-2","page":1,"per_page":40,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Redfin Search","description":"Search for-sale homes on Redfin from a city, neighborhood, or county link. Each listing url includes the market id to pass to the property endpoint.\n\n**Credit cost:** 1 credit per call","operationId":"post-redfin-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Redfin for-sale link for a city, neighborhood, or county.\n\n**Example (city):**\n\n    https://www.redfin.com/city/16163/WA/Seattle\n\n**Example (neighborhood):**\n\n    https://www.redfin.com/neighborhood/56947/WA/Seattle/Capitol-Hill\n\n**Example (county):**\n\n    https://www.redfin.com/county/118/WA/King-County\n\n**JSON:** each results[].url includes region_id and region_type from that link. City is region_type 6, neighborhood is 1, county is 5. A home link, zip link, or /filter/ link returns 400.","schema":{"type":"string","description":"Redfin for-sale link for a city, neighborhood, or county.\n\n**Example (city):**\n\n    https://www.redfin.com/city/16163/WA/Seattle\n\n**Example (neighborhood):**\n\n    https://www.redfin.com/neighborhood/56947/WA/Seattle/Capitol-Hill\n\n**Example (county):**\n\n    https://www.redfin.com/county/118/WA/King-County\n\n**JSON:** each results[].url includes region_id and region_type from that link. City is region_type 6, neighborhood is 1, county is 5. A home link, zip link, or /filter/ link returns 400."}},{"name":"page","in":"query","required":false,"description":"Page of the for-sale feed, from 1.\n\n**Example:**\n\n    2\n\n**Default:** the page already in the link, otherwise 1.\n\n**JSON:** page 2 rewrites the path to /page-2, sets pagination.page to 2, and sets pagination.next to the next link when the page is full. pagination.total_results and pagination.total_pages stay null. Overrides a page already in the link.","schema":{"type":"number","description":"Page of the for-sale feed, from 1.\n\n**Example:**\n\n    2\n\n**Default:** the page already in the link, otherwise 1.\n\n**JSON:** page 2 rewrites the path to /page-2, sets pagination.page to 2, and sets pagination.next to the next link when the page is full. pagination.total_results and pagination.total_pages stay null. Overrides a page already in the link."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns results and pagination.\ntrue returns {\"result\": \"<gis json>\"} and omits the parsed listings.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns results and pagination.\ntrue returns {\"result\": \"<gis json>\"} and omits the parsed listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"hoa":{"type":"integer"},"url":{"type":"string"},"zip":{"type":"string"},"beds":{"type":"integer"},"city":{"type":"string"},"sqft":{"type":"integer"},"unit":{"type":"string"},"baths":{"type":"integer"},"price":{"type":"integer"},"state":{"type":"string"},"mls_id":{"type":"string"},"status":{"type":"string"},"street":{"type":"string"},"remarks":{"type":"string"},"latitude":{"type":"number"},"lot_size":{"nullable":true},"is_redfin":{"type":"boolean"},"key_facts":{"type":"array","items":{"type":"string"}},"longitude":{"type":"number"},"agent_name":{"type":"string"},"listing_id":{"type":"integer"},"open_house":{"nullable":true},"year_built":{"type":"integer"},"broker_name":{"type":"string"},"has_3d_tour":{"type":"boolean"},"hoa_display":{"type":"string"},"photo_count":{"type":"integer"},"property_id":{"type":"integer"},"listing_tags":{"type":"array","items":{"type":"string"}},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"price_per_sqft":{"type":"integer"},"is_early_access":{"type":"boolean"},"has_virtual_tour":{"type":"boolean"},"price_per_sqft_display":{"type":"string"},"has_interactive_floorplan":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Seattle for-sale page, 1120 8th Ave unit 1603":{"value":{"results":[{"hoa":825,"url":"https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6","zip":"98101","beds":2,"city":"Seattle","sqft":1050,"unit":"#1603","baths":2,"price":526500,"state":"WA","mls_id":"2573739","status":"Active","street":"1120 8th Ave #1603","remarks":"Live in the heart of First Hill with convenience, comfort, and city access at your doorstep. This spacious, freshly painted, condo is filled with natural light! The expansive living area is anchored by a cozy fireplace and a wall of floor-to-ceiling windows that open to a private juliet balcony, providing views during the day, and sparkling city lights at night. The primary suite boasts a large closet and private bath, while the spacious second bedroom provides the flexibility of a guest room, home office, or both. Enjoy the added comfort of A/C and in-unit washer/dryer, and the convenience of an oversized parking space in a secure garage and an additional storage unit. Seneca 8 amenities i","latitude":47.6092374,"lot_size":null,"is_redfin":true,"key_facts":["Secure garage","Cozy fireplace","In-unit washer dryer"],"longitude":-122.3293587,"agent_name":"Kiley Lazarus","listing_id":224286680,"open_house":null,"year_built":1970,"broker_name":"Redfin","has_3d_tour":true,"hoa_display":"$825","photo_count":30,"property_id":14602,"listing_tags":["PRIVATE JULIET BALCONY","COZY FIREPLACE","FLOOR-TO-CEILING WINDOWS","IN-UNIT WASHER DRYER","OVERSIZED PARKING SPACE","SECURE GARAGE"],"neighborhood":"First Hill","price_display":"$526,500","property_type":"condo","price_per_sqft":501,"is_early_access":false,"has_virtual_tour":true,"price_per_sqft_display":"$501","has_interactive_floorplan":false}],"pagination":{"next":"https://www.redfin.com/city/16163/WA/Seattle/page-2","page":1,"per_page":40,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/redfin/property":{"get":{"summary":"Redfin Property","description":"Read one for-sale Redfin home. Pass the url from search, which already includes the market id. The response is a flat listing, the same fields as one search result.\n\n**Credit cost:** 1 credit per call","operationId":"get-redfin-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Redfin home link. Use the url returned by search.\n\n**Example:**\n\n    https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6\n\n**JSON:** one flat object with the same fields as a search result. property_id is the home in that url. A city, neighborhood, or county link returns 400.","schema":{"type":"string","description":"Redfin home link. Use the url returned by search.\n\n**Example:**\n\n    https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6\n\n**JSON:** one flat object with the same fields as a search result. property_id is the home in that url. A city, neighborhood, or county link returns 400."}},{"name":"region_id","in":"query","required":false,"description":"Market id. Required only when the home link does not already include region_id.\n\n**Examples:** 16163 Seattle, 56947 Capitol Hill, 118 King County.\n\n**JSON:** selects which for-sale feed is scanned. It does not rename fields. Omit it when query is the url from search.","schema":{"type":"number","description":"Market id. Required only when the home link does not already include region_id.\n\n**Examples:** 16163 Seattle, 56947 Capitol Hill, 118 King County.\n\n**JSON:** selects which for-sale feed is scanned. It does not rename fields. Omit it when query is the url from search."}},{"name":"region_type","in":"query","required":false,"description":"Required with region_id when the home link has no region_type.\n\n**Allowed:** 6 city, 1 neighborhood, 5 county.\n\n**JSON:** must match the market from search. A mismatch can return 404 because the home is not in that feed.","schema":{"type":"number","description":"Required with region_id when the home link has no region_type.\n\n**Allowed:** 6 city, 1 neighborhood, 5 county.\n\n**JSON:** must match the market from search. A mismatch can return 404 because the home is not in that feed."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the flat listing.\ntrue returns {\"result\": \"<gis json>\"}.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the flat listing.\ntrue returns {\"result\": \"<gis json>\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"hoa":{"type":"integer"},"url":{"type":"string"},"zip":{"type":"string"},"beds":{"type":"integer"},"city":{"type":"string"},"sqft":{"type":"integer"},"unit":{"type":"string"},"baths":{"type":"integer"},"price":{"type":"integer"},"state":{"type":"string"},"mls_id":{"type":"string"},"status":{"type":"string"},"street":{"type":"string"},"remarks":{"type":"string"},"latitude":{"type":"number"},"lot_size":{"nullable":true},"is_redfin":{"type":"boolean"},"key_facts":{"type":"array","items":{"type":"string"}},"longitude":{"type":"number"},"agent_name":{"type":"string"},"listing_id":{"type":"integer"},"open_house":{"nullable":true},"year_built":{"type":"integer"},"broker_name":{"type":"string"},"has_3d_tour":{"type":"boolean"},"hoa_display":{"type":"string"},"photo_count":{"type":"integer"},"property_id":{"type":"integer"},"listing_tags":{"type":"array","items":{"type":"string"}},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"price_per_sqft":{"type":"integer"},"is_early_access":{"type":"boolean"},"has_virtual_tour":{"type":"boolean"},"price_per_sqft_display":{"type":"string"},"has_interactive_floorplan":{"type":"boolean"}}},"examples":{"1120 8th Ave unit 1603, Seattle":{"value":{"hoa":825,"url":"https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6","zip":"98101","beds":2,"city":"Seattle","sqft":1050,"unit":"#1603","baths":2,"price":526500,"state":"WA","mls_id":"2573739","status":"Active","street":"1120 8th Ave #1603","remarks":"Live in the heart of First Hill with convenience, comfort, and city access at your doorstep. This spacious, freshly painted, condo is filled with natural light! The expansive living area is anchored by a cozy fireplace and a wall of floor-to-ceiling windows that open to a private juliet balcony, providing views during the day, and sparkling city lights at night. The primary suite boasts a large closet and private bath, while the spacious second bedroom provides the flexibility of a guest room, home office, or both. Enjoy the added comfort of A/C and in-unit washer/dryer, and the convenience of an oversized parking space in a secure garage and an additional storage unit. Seneca 8 amenities i","latitude":47.6092374,"lot_size":null,"is_redfin":true,"key_facts":["Secure garage","Cozy fireplace","In-unit washer dryer"],"longitude":-122.3293587,"agent_name":"Kiley Lazarus","listing_id":224286680,"open_house":null,"year_built":1970,"broker_name":"Redfin","has_3d_tour":true,"hoa_display":"$825","photo_count":30,"property_id":14602,"listing_tags":["PRIVATE JULIET BALCONY","COZY FIREPLACE","FLOOR-TO-CEILING WINDOWS","IN-UNIT WASHER DRYER","OVERSIZED PARKING SPACE","SECURE GARAGE"],"neighborhood":"First Hill","price_display":"$526,500","property_type":"condo","price_per_sqft":501,"is_early_access":false,"has_virtual_tour":true,"price_per_sqft_display":"$501","has_interactive_floorplan":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Redfin Property","description":"Read one for-sale Redfin home. Pass the url from search, which already includes the market id. The response is a flat listing, the same fields as one search result.\n\n**Credit cost:** 1 credit per call","operationId":"post-redfin-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Redfin home link. Use the url returned by search.\n\n**Example:**\n\n    https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6\n\n**JSON:** one flat object with the same fields as a search result. property_id is the home in that url. A city, neighborhood, or county link returns 400.","schema":{"type":"string","description":"Redfin home link. Use the url returned by search.\n\n**Example:**\n\n    https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6\n\n**JSON:** one flat object with the same fields as a search result. property_id is the home in that url. A city, neighborhood, or county link returns 400."}},{"name":"region_id","in":"query","required":false,"description":"Market id. Required only when the home link does not already include region_id.\n\n**Examples:** 16163 Seattle, 56947 Capitol Hill, 118 King County.\n\n**JSON:** selects which for-sale feed is scanned. It does not rename fields. Omit it when query is the url from search.","schema":{"type":"number","description":"Market id. Required only when the home link does not already include region_id.\n\n**Examples:** 16163 Seattle, 56947 Capitol Hill, 118 King County.\n\n**JSON:** selects which for-sale feed is scanned. It does not rename fields. Omit it when query is the url from search."}},{"name":"region_type","in":"query","required":false,"description":"Required with region_id when the home link has no region_type.\n\n**Allowed:** 6 city, 1 neighborhood, 5 county.\n\n**JSON:** must match the market from search. A mismatch can return 404 because the home is not in that feed.","schema":{"type":"number","description":"Required with region_id when the home link has no region_type.\n\n**Allowed:** 6 city, 1 neighborhood, 5 county.\n\n**JSON:** must match the market from search. A mismatch can return 404 because the home is not in that feed."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the flat listing.\ntrue returns {\"result\": \"<gis json>\"}.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the flat listing.\ntrue returns {\"result\": \"<gis json>\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"hoa":{"type":"integer"},"url":{"type":"string"},"zip":{"type":"string"},"beds":{"type":"integer"},"city":{"type":"string"},"sqft":{"type":"integer"},"unit":{"type":"string"},"baths":{"type":"integer"},"price":{"type":"integer"},"state":{"type":"string"},"mls_id":{"type":"string"},"status":{"type":"string"},"street":{"type":"string"},"remarks":{"type":"string"},"latitude":{"type":"number"},"lot_size":{"nullable":true},"is_redfin":{"type":"boolean"},"key_facts":{"type":"array","items":{"type":"string"}},"longitude":{"type":"number"},"agent_name":{"type":"string"},"listing_id":{"type":"integer"},"open_house":{"nullable":true},"year_built":{"type":"integer"},"broker_name":{"type":"string"},"has_3d_tour":{"type":"boolean"},"hoa_display":{"type":"string"},"photo_count":{"type":"integer"},"property_id":{"type":"integer"},"listing_tags":{"type":"array","items":{"type":"string"}},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"price_per_sqft":{"type":"integer"},"is_early_access":{"type":"boolean"},"has_virtual_tour":{"type":"boolean"},"price_per_sqft_display":{"type":"string"},"has_interactive_floorplan":{"type":"boolean"}}},"examples":{"1120 8th Ave unit 1603, Seattle":{"value":{"hoa":825,"url":"https://www.redfin.com/WA/Seattle/1120-8th-Ave-98101/unit-1603/home/14602?region_id=16163&region_type=6","zip":"98101","beds":2,"city":"Seattle","sqft":1050,"unit":"#1603","baths":2,"price":526500,"state":"WA","mls_id":"2573739","status":"Active","street":"1120 8th Ave #1603","remarks":"Live in the heart of First Hill with convenience, comfort, and city access at your doorstep. This spacious, freshly painted, condo is filled with natural light! The expansive living area is anchored by a cozy fireplace and a wall of floor-to-ceiling windows that open to a private juliet balcony, providing views during the day, and sparkling city lights at night. The primary suite boasts a large closet and private bath, while the spacious second bedroom provides the flexibility of a guest room, home office, or both. Enjoy the added comfort of A/C and in-unit washer/dryer, and the convenience of an oversized parking space in a secure garage and an additional storage unit. Seneca 8 amenities i","latitude":47.6092374,"lot_size":null,"is_redfin":true,"key_facts":["Secure garage","Cozy fireplace","In-unit washer dryer"],"longitude":-122.3293587,"agent_name":"Kiley Lazarus","listing_id":224286680,"open_house":null,"year_built":1970,"broker_name":"Redfin","has_3d_tour":true,"hoa_display":"$825","photo_count":30,"property_id":14602,"listing_tags":["PRIVATE JULIET BALCONY","COZY FIREPLACE","FLOOR-TO-CEILING WINDOWS","IN-UNIT WASHER DRYER","OVERSIZED PARKING SPACE","SECURE GARAGE"],"neighborhood":"First Hill","price_display":"$526,500","property_type":"condo","price_per_sqft":501,"is_early_access":false,"has_virtual_tour":true,"price_per_sqft_display":"$501","has_interactive_floorplan":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/immoscout24ch/search":{"get":{"summary":"ImmoScout24 Switzerland Search","description":"Search ImmoScout24.ch listings by city or search URL and retrieve the CHF price, rooms, living area, and address. Property pages are not available.\n\n**Credit cost:** 2 credits per call","operationId":"get-immoscout24ch-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Swiss city or a full ImmoScout24.ch search URL.\n\n**Example (city):**\n\n    zurich\n\n**Example (search URL):**\n\n    https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich\n\n**JSON:** a city opens apartments for rent unless offer_type or property_type is set. results[].offer_type is rent and results[].price is the monthly gross rent in CHF. A listing URL such as /mieten/{id} returns 400. Property pages are not available.","schema":{"type":"string","description":"Swiss city or a full ImmoScout24.ch search URL.\n\n**Example (city):**\n\n    zurich\n\n**Example (search URL):**\n\n    https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich\n\n**JSON:** a city opens apartments for rent unless offer_type or property_type is set. results[].offer_type is rent and results[].price is the monthly gross rent in CHF. A listing URL such as /mieten/{id} returns 400. Property pages are not available."}},{"name":"offer_type","in":"query","required":false,"description":"rent or buy.\n\n**Default:** rent when query is a city. A search URL keeps its path unless this is set.\n\n**Aliases:** mieten, kaufen, sale (sale means buy).\n\n**JSON:** rent sets results[].offer_type to rent and price to the monthly gross rent. buy sets offer_type to buy and price to the sale price.","schema":{"type":"string","description":"rent or buy.\n\n**Default:** rent when query is a city. A search URL keeps its path unless this is set.\n\n**Aliases:** mieten, kaufen, sale (sale means buy).\n\n**JSON:** rent sets results[].offer_type to rent and price to the monthly gross rent. buy sets offer_type to buy and price to the sale price."}},{"name":"property_type","in":"query","required":false,"description":"apartment, house, or all.\n\n**Default:** apartment when query is a city. A search URL keeps its category unless this is set.\n\n**Aliases:** flat and wohnung mean apartment. haus means house. immobilien means all.\n\n**JSON:** apartment requests wohnung. house requests haus. all requests immobilien. results[].categories reflects that category.","schema":{"type":"string","description":"apartment, house, or all.\n\n**Default:** apartment when query is a city. A search URL keeps its category unless this is set.\n\n**Aliases:** flat and wohnung mean apartment. haus means house. immobilien means all.\n\n**JSON:** apartment requests wohnung. house requests haus. all requests immobilien. results[].categories reflects that category."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1. Page 1 omits pn. Page 2 sends pn=2.\n\n**JSON:** pagination.page is the page you asked for. pagination.next is the next search URL, or null on the last page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1. Page 1 omits pn. Page 2 sends pn=2.\n\n**JSON:** pagination.page is the page you asked for. pagination.next is the next search URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"floor":{"nullable":true},"price":{"type":"integer"},"rooms":{"type":"number"},"title":{"type":"string"},"canton":{"type":"string"},"street":{"type":"string"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number"},"locality":{"type":"string"},"bathrooms":{"type":"integer"},"image_url":{"type":"string"},"longitude":{"type":"number"},"price_net":{"nullable":true},"categories":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string"},"offer_type":{"type":"string"},"year_built":{"type":"integer"},"description":{"type":"string"},"extra_costs":{"nullable":true},"postal_code":{"type":"string"},"living_space":{"type":"integer"},"price_display":{"type":"string"},"ceiling_height":{"nullable":true},"price_interval":{"type":"string"},"year_renovated":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apartments for rent in Zurich":{"value":{"results":[{"id":"4002086198","url":"https://www.immoscout24.ch/mieten/4002086198","floor":null,"price":2257,"rooms":1.5,"title":"City Pop - Cosy Studio Apartments just next to HB Zürich","canton":"ZH","street":"Militärstrasse 106","currency":"CHF","features":["has_cable_tv","has_dishwasher","has_elevator","has_garage","has_nice_view","has_parking","is_ground_floor_raised","is_quiet"],"latitude":47.375904371673,"locality":"Zürich","bathrooms":1,"image_url":"https://cdn.immoscout24.ch/listings/v2/e335city/4002086198/image/92c334cb2a581eeda57f107e6b2d3fd3.jpg","longitude":8.518085354726,"price_net":null,"categories":["apartment","flat"],"created_at":"2025-04-07T14:53:38.768Z","offer_type":"rent","year_built":2025,"description":"Wir bieten zentral gelegene Apartments im Gebäude City Pop Zurich City an der Militarstrasse 106, 8004 Zürich an, die zwischen 19 und 46 Quadratmeter gross sind.","extra_costs":null,"postal_code":"8004","living_space":24,"price_display":"CHF 2'257","ceiling_height":null,"price_interval":"month","year_renovated":2025}],"pagination":{"next":"https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich?pn=2","page":1,"per_page":20,"total_pages":50,"total_results":1222}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ImmoScout24 Switzerland Search","description":"Search ImmoScout24.ch listings by city or search URL and retrieve the CHF price, rooms, living area, and address. Property pages are not available.\n\n**Credit cost:** 2 credits per call","operationId":"post-immoscout24ch-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Swiss city or a full ImmoScout24.ch search URL.\n\n**Example (city):**\n\n    zurich\n\n**Example (search URL):**\n\n    https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich\n\n**JSON:** a city opens apartments for rent unless offer_type or property_type is set. results[].offer_type is rent and results[].price is the monthly gross rent in CHF. A listing URL such as /mieten/{id} returns 400. Property pages are not available.","schema":{"type":"string","description":"Swiss city or a full ImmoScout24.ch search URL.\n\n**Example (city):**\n\n    zurich\n\n**Example (search URL):**\n\n    https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich\n\n**JSON:** a city opens apartments for rent unless offer_type or property_type is set. results[].offer_type is rent and results[].price is the monthly gross rent in CHF. A listing URL such as /mieten/{id} returns 400. Property pages are not available."}},{"name":"offer_type","in":"query","required":false,"description":"rent or buy.\n\n**Default:** rent when query is a city. A search URL keeps its path unless this is set.\n\n**Aliases:** mieten, kaufen, sale (sale means buy).\n\n**JSON:** rent sets results[].offer_type to rent and price to the monthly gross rent. buy sets offer_type to buy and price to the sale price.","schema":{"type":"string","description":"rent or buy.\n\n**Default:** rent when query is a city. A search URL keeps its path unless this is set.\n\n**Aliases:** mieten, kaufen, sale (sale means buy).\n\n**JSON:** rent sets results[].offer_type to rent and price to the monthly gross rent. buy sets offer_type to buy and price to the sale price."}},{"name":"property_type","in":"query","required":false,"description":"apartment, house, or all.\n\n**Default:** apartment when query is a city. A search URL keeps its category unless this is set.\n\n**Aliases:** flat and wohnung mean apartment. haus means house. immobilien means all.\n\n**JSON:** apartment requests wohnung. house requests haus. all requests immobilien. results[].categories reflects that category.","schema":{"type":"string","description":"apartment, house, or all.\n\n**Default:** apartment when query is a city. A search URL keeps its category unless this is set.\n\n**Aliases:** flat and wohnung mean apartment. haus means house. immobilien means all.\n\n**JSON:** apartment requests wohnung. house requests haus. all requests immobilien. results[].categories reflects that category."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1. Page 1 omits pn. Page 2 sends pn=2.\n\n**JSON:** pagination.page is the page you asked for. pagination.next is the next search URL, or null on the last page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1. Page 1 omits pn. Page 2 sends pn=2.\n\n**JSON:** pagination.page is the page you asked for. pagination.next is the next search URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"floor":{"nullable":true},"price":{"type":"integer"},"rooms":{"type":"number"},"title":{"type":"string"},"canton":{"type":"string"},"street":{"type":"string"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number"},"locality":{"type":"string"},"bathrooms":{"type":"integer"},"image_url":{"type":"string"},"longitude":{"type":"number"},"price_net":{"nullable":true},"categories":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string"},"offer_type":{"type":"string"},"year_built":{"type":"integer"},"description":{"type":"string"},"extra_costs":{"nullable":true},"postal_code":{"type":"string"},"living_space":{"type":"integer"},"price_display":{"type":"string"},"ceiling_height":{"nullable":true},"price_interval":{"type":"string"},"year_renovated":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apartments for rent in Zurich":{"value":{"results":[{"id":"4002086198","url":"https://www.immoscout24.ch/mieten/4002086198","floor":null,"price":2257,"rooms":1.5,"title":"City Pop - Cosy Studio Apartments just next to HB Zürich","canton":"ZH","street":"Militärstrasse 106","currency":"CHF","features":["has_cable_tv","has_dishwasher","has_elevator","has_garage","has_nice_view","has_parking","is_ground_floor_raised","is_quiet"],"latitude":47.375904371673,"locality":"Zürich","bathrooms":1,"image_url":"https://cdn.immoscout24.ch/listings/v2/e335city/4002086198/image/92c334cb2a581eeda57f107e6b2d3fd3.jpg","longitude":8.518085354726,"price_net":null,"categories":["apartment","flat"],"created_at":"2025-04-07T14:53:38.768Z","offer_type":"rent","year_built":2025,"description":"Wir bieten zentral gelegene Apartments im Gebäude City Pop Zurich City an der Militarstrasse 106, 8004 Zürich an, die zwischen 19 und 46 Quadratmeter gross sind.","extra_costs":null,"postal_code":"8004","living_space":24,"price_display":"CHF 2'257","ceiling_height":null,"price_interval":"month","year_renovated":2025}],"pagination":{"next":"https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich?pn=2","page":1,"per_page":20,"total_pages":50,"total_results":1222}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rsonline/search":{"get":{"summary":"RS Online Search","description":"Search RS Online UK by keyword or category. Pound prices keep the amount printed on the page.\n\n**Credit cost:** 2 credits per call","operationId":"get-rsonline-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.\n\nKeyword\n\n```\nconnector\n```\n\nCategory link\n\n```\nhttps://uk.rs-online.com/web/c/connectors/\n```","schema":{"type":"string","description":"A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.\n\nKeyword\n\n```\nconnector\n```\n\nCategory link\n\n```\nhttps://uk.rs-online.com/web/c/connectors/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400.","schema":{"type":"number","minimum":1,"description":"Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"mpn":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"pack_size":{"type":"integer"},"product_id":{"type":"string"},"stock_status":{"type":"string"},"price_display":{"type":"string"},"rs_stock_number":{"type":"string"},"minimum_order_qty":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"WAGO 221 splice connector on RS Online UK":{"value":{"results":[{"mpn":"221-2401","url":"https://uk.rs-online.com/web/p/splice-connectors/0303327","brand":"WAGO","price":4.95,"title":"WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG","category":"Splice Connectors","currency":"GBP","in_stock":true,"image_url":"https://media.rs-online.com/t_large/Y0303327-01.jpg","pack_size":10,"product_id":"0303327","stock_status":"IN_STOCK","price_display":"£4.95","rs_stock_number":"030-3327","minimum_order_qty":1}],"pagination":{"next":"https://uk.rs-online.com/web/c/?searchTerm=connector&pn=2","page":1,"per_page":20,"total_pages":3220,"total_results":64395}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"RS Online Search","description":"Search RS Online UK by keyword or category. Pound prices keep the amount printed on the page.\n\n**Credit cost:** 2 credits per call","operationId":"post-rsonline-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.\n\nKeyword\n\n```\nconnector\n```\n\nCategory link\n\n```\nhttps://uk.rs-online.com/web/c/connectors/\n```","schema":{"type":"string","description":"A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.\n\nKeyword\n\n```\nconnector\n```\n\nCategory link\n\n```\nhttps://uk.rs-online.com/web/c/connectors/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400.","schema":{"type":"number","minimum":1,"description":"Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"mpn":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"pack_size":{"type":"integer"},"product_id":{"type":"string"},"stock_status":{"type":"string"},"price_display":{"type":"string"},"rs_stock_number":{"type":"string"},"minimum_order_qty":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"WAGO 221 splice connector on RS Online UK":{"value":{"results":[{"mpn":"221-2401","url":"https://uk.rs-online.com/web/p/splice-connectors/0303327","brand":"WAGO","price":4.95,"title":"WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG","category":"Splice Connectors","currency":"GBP","in_stock":true,"image_url":"https://media.rs-online.com/t_large/Y0303327-01.jpg","pack_size":10,"product_id":"0303327","stock_status":"IN_STOCK","price_display":"£4.95","rs_stock_number":"030-3327","minimum_order_qty":1}],"pagination":{"next":"https://uk.rs-online.com/web/c/?searchTerm=connector&pn=2","page":1,"per_page":20,"total_pages":3220,"total_results":64395}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rsonline/product":{"get":{"summary":"RS Online Product","description":"Read one RS Online UK product URL, including the RS stock number, manufacturer part, and pound price.\n\n**Credit cost:** 2 credits per call","operationId":"get-rsonline-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.\n\nProduct link\n\n```\nhttps://uk.rs-online.com/web/p/splice-connectors/0303327\n```","schema":{"type":"string","description":"A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.\n\nProduct link\n\n```\nhttps://uk.rs-online.com/web/p/splice-connectors/0303327\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces the product object with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces the product object with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"brand_url":{"type":"string"},"image_url":{"type":"string"},"pack_size":{"type":"integer"},"categories":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"description":{"type":"string"},"rohs_status":{"type":"string"},"price_breaks":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"quantity":{"type":"integer"},"price_display":{"type":"string"},"indicative_price":{"type":"number"},"indicative_price_display":{"type":"string"}}}},"stock_status":{"type":"string"},"datasheet_url":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"rs_stock_number":{"type":"string"},"unit_of_measure":{"type":"string"},"minimum_order_qty":{"type":"integer"}}},"examples":{"WAGO 221 splice connector on RS Online UK":{"value":{"mpn":"221-2401","url":"https://uk.rs-online.com/web/p/splice-connectors/0303327","brand":"WAGO","price":4.95,"title":"WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG","images":["https://media.rs-online.com/t_large/Y0303327-01.jpg","https://media.rs-online.com/t_thumb/Y0303327-01.jpg"],"category":"Splice Connectors","currency":"GBP","in_stock":true,"brand_url":"https://uk.rs-online.com/web/b/wago","image_url":"https://media.rs-online.com/t_large/Y0303327-01.jpg","pack_size":10,"categories":["Electronic Components, Power & Connectors","Connectors","Wire Terminals & Splices","Splice Connectors"],"product_id":"0303327","description":"The Wago inline splicing connector with levers (2-conductor, maximum 4 mm²) features tool-free connection for solid, stranded, and fine-stranded conductors (0.2 to 4 mm²). Its slim design saves space, and it is ideal for North American installations with 12 AWG capability. The lever technology enables easy connection and disconnection.","rohs_status":"EXEMPT","price_breaks":[{"price":4.95,"quantity":1,"price_display":"£4.95","indicative_price":0.495,"indicative_price_display":"£0.495"},{"price":4.56,"quantity":5,"price_display":"£4.56","indicative_price":0.456,"indicative_price_display":"£0.456"},{"price":4.01,"quantity":10,"price_display":"£4.01","indicative_price":0.401,"indicative_price_display":"£0.401"}],"stock_status":"In Stock","datasheet_url":"https://docs.rs-online.com/54b0/A700000012773609.pdf","price_display":"£4.95","specifications":[{"name":"Brand","value":"WAGO"},{"name":"Splice Type","value":"Wire Splice"},{"name":"Product Type","value":"Splice Connector"},{"name":"Series","value":"221"}],"rs_stock_number":"030-3327","unit_of_measure":"1 Pack of 10","minimum_order_qty":1}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"RS Online Product","description":"Read one RS Online UK product URL, including the RS stock number, manufacturer part, and pound price.\n\n**Credit cost:** 2 credits per call","operationId":"post-rsonline-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.\n\nProduct link\n\n```\nhttps://uk.rs-online.com/web/p/splice-connectors/0303327\n```","schema":{"type":"string","description":"A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.\n\nProduct link\n\n```\nhttps://uk.rs-online.com/web/p/splice-connectors/0303327\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces the product object with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces the product object with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"brand_url":{"type":"string"},"image_url":{"type":"string"},"pack_size":{"type":"integer"},"categories":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"description":{"type":"string"},"rohs_status":{"type":"string"},"price_breaks":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"quantity":{"type":"integer"},"price_display":{"type":"string"},"indicative_price":{"type":"number"},"indicative_price_display":{"type":"string"}}}},"stock_status":{"type":"string"},"datasheet_url":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"rs_stock_number":{"type":"string"},"unit_of_measure":{"type":"string"},"minimum_order_qty":{"type":"integer"}}},"examples":{"WAGO 221 splice connector on RS Online UK":{"value":{"mpn":"221-2401","url":"https://uk.rs-online.com/web/p/splice-connectors/0303327","brand":"WAGO","price":4.95,"title":"WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG","images":["https://media.rs-online.com/t_large/Y0303327-01.jpg","https://media.rs-online.com/t_thumb/Y0303327-01.jpg"],"category":"Splice Connectors","currency":"GBP","in_stock":true,"brand_url":"https://uk.rs-online.com/web/b/wago","image_url":"https://media.rs-online.com/t_large/Y0303327-01.jpg","pack_size":10,"categories":["Electronic Components, Power & Connectors","Connectors","Wire Terminals & Splices","Splice Connectors"],"product_id":"0303327","description":"The Wago inline splicing connector with levers (2-conductor, maximum 4 mm²) features tool-free connection for solid, stranded, and fine-stranded conductors (0.2 to 4 mm²). Its slim design saves space, and it is ideal for North American installations with 12 AWG capability. The lever technology enables easy connection and disconnection.","rohs_status":"EXEMPT","price_breaks":[{"price":4.95,"quantity":1,"price_display":"£4.95","indicative_price":0.495,"indicative_price_display":"£0.495"},{"price":4.56,"quantity":5,"price_display":"£4.56","indicative_price":0.456,"indicative_price_display":"£0.456"},{"price":4.01,"quantity":10,"price_display":"£4.01","indicative_price":0.401,"indicative_price_display":"£0.401"}],"stock_status":"In Stock","datasheet_url":"https://docs.rs-online.com/54b0/A700000012773609.pdf","price_display":"£4.95","specifications":[{"name":"Brand","value":"WAGO"},{"name":"Splice Type","value":"Wire Splice"},{"name":"Product Type","value":"Splice Connector"},{"name":"Series","value":"221"}],"rs_stock_number":"030-3327","unit_of_measure":"1 Pack of 10","minimum_order_qty":1}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/domaincomau/property":{"get":{"summary":"Domain.com.au Property","description":"Read one Domain.com.au listing from its URL. The response is a flat object with price, address, agency, and photos.\n\n**Credit cost:** 2 credits per call","operationId":"get-domaincomau-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain listing URL. The path ends with the listing id.\n\n**Example:**\n\n    https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032\n\n**JSON:** one flat object. id is the listing id from the path. A search URL returns 400.","schema":{"type":"string","description":"Domain listing URL. The path ends with the listing id.\n\n**Example:**\n\n    https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032\n\n**JSON:** one flat object. id is the listing id from the path. A search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"agents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"photo":{"type":"string"},"profile_url":{"type":"string"}}}},"images":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"street":{"type":"string"},"suburb":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"headline":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"agency_id":{"type":"integer"},"bathrooms":{"type":"integer"},"carspaces":{"type":"integer"},"listed_at":{"type":"string"},"longitude":{"type":"number"},"price_max":{"nullable":true},"agency_url":{"type":"string"},"auction_at":{"nullable":true},"promo_type":{"type":"string"},"updated_at":{"type":"string"},"agency_name":{"type":"string"},"description":{"type":"string"},"property_id":{"type":"string"},"sale_method":{"type":"string"},"unit_number":{"type":"string"},"agency_phone":{"type":"string"},"listing_mode":{"type":"string"},"price_period":{"nullable":true},"land_area_sqm":{"nullable":true},"price_display":{"type":"string"},"property_type":{"type":"string"},"street_number":{"type":"string"},"agency_website":{"type":"string"},"inspection_end":{"type":"string"},"inspection_start":{"type":"string"},"building_area_sqm":{"nullable":true}}},"examples":{"7D/27-31 Ocean Street N, Bondi":{"value":{"id":2021178032,"url":"https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032","image":"https://rimh2.domainstatic.com.au/Oq0vqQyOB632hw2pt9TRSB5RRag=/fit-in/1920x1080/filters:format(webp):quality(85):no_upscale()/2021178032_1_1_260923_012858-w4134-h2756","price":1750000,"state":"NSW","agents":[{"name":"Danny Taylor","email":"dtaylor@raywhite.com","phone":"0417400553","photo":"https://rimh2.domainstatic.com.au/vJmYCfoQPL0ciW3j9VpuWPHXaPw=/180x180/filters:format(webp):quality(85):no_upscale()/https://images.domain.com.au/img/425/contact_2005423.png?date=639287874683470000","profile_url":"https://www.domain.com.au/real-estate-agent/danny-taylor-2005423"},{"name":"Nathan Ryland","email":"nryland@raywhite.com","phone":"0435959161","photo":"https://rimh2.domainstatic.com.au/IPkCuwpWLumzeCAm4bCRagVZNIw=/180x180/filters:format(webp):quality(85):no_upscale()/https://images.domain.com.au/img/425/contact_1822769.png?date=639288820005100000","profile_url":"https://www.domain.com.au/real-estate-agent/nathan-ryland-1822769"}],"images":["https://rimh2.domainstatic.com.au/Oq0vqQyOB632hw2pt9TRSB5RRag=/fit-in/1920x1080/filters:format(webp):quality(85):no_upscale()/2021178032_1_1_260923_012858-w4134-h2756","https://rimh2.domainstatic.com.au/YC4YQ75EMRylMceVgtaGBVGHTeE=/fit-in/1920x1080/filters:format(webp):quality(85):no_upscale()/2021178032_2_1_260923_012858-w4134-h2756"],"status":"live","street":"Ocean Street N","suburb":"Bondi","address":"7D/27-31 Ocean Street N, Bondi NSW 2026","bedrooms":2,"currency":"AUD","headline":"Elevated Apartment In The North East Corner With Ocean And Harbour Views","latitude":-33.8918989,"postcode":"2026","agency_id":425,"bathrooms":1,"carspaces":1,"listed_at":"2026-09-23T11:29:00+10:00","longitude":151.2623893,"price_max":null,"agency_url":"https://www.domain.com.au/real-estate-agencies/raywhitedoublebay-425/","auction_at":null,"promo_type":"premium_plus","updated_at":"2026-10-23T09:38:50.46","agency_name":"Ray White Double Bay","description":"Poised in a rare north east corner position, this updated apartment delivers a generous design capturing elevated views spanning over to both the harbour and azure ocean's horizon.","property_id":"CF-0183-PL","sale_method":"private_treaty","unit_number":"7D","agency_phone":"02 93639999","listing_mode":"sale","price_period":null,"land_area_sqm":null,"price_display":"$1,750,000","property_type":"Apartment / Unit / Flat","street_number":"27-31","agency_website":"https://raywhitedoublebay.com/","inspection_end":"2026-10-31T13:30:00","inspection_start":"2026-10-31T13:00:00","building_area_sqm":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Domain.com.au Property","description":"Read one Domain.com.au listing from its URL. The response is a flat object with price, address, agency, and photos.\n\n**Credit cost:** 2 credits per call","operationId":"post-domaincomau-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain listing URL. The path ends with the listing id.\n\n**Example:**\n\n    https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032\n\n**JSON:** one flat object. id is the listing id from the path. A search URL returns 400.","schema":{"type":"string","description":"Domain listing URL. The path ends with the listing id.\n\n**Example:**\n\n    https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032\n\n**JSON:** one flat object. id is the listing id from the path. A search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"agents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"photo":{"type":"string"},"profile_url":{"type":"string"}}}},"images":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"street":{"type":"string"},"suburb":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"headline":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"agency_id":{"type":"integer"},"bathrooms":{"type":"integer"},"carspaces":{"type":"integer"},"listed_at":{"type":"string"},"longitude":{"type":"number"},"price_max":{"nullable":true},"agency_url":{"type":"string"},"auction_at":{"nullable":true},"promo_type":{"type":"string"},"updated_at":{"type":"string"},"agency_name":{"type":"string"},"description":{"type":"string"},"property_id":{"type":"string"},"sale_method":{"type":"string"},"unit_number":{"type":"string"},"agency_phone":{"type":"string"},"listing_mode":{"type":"string"},"price_period":{"nullable":true},"land_area_sqm":{"nullable":true},"price_display":{"type":"string"},"property_type":{"type":"string"},"street_number":{"type":"string"},"agency_website":{"type":"string"},"inspection_end":{"type":"string"},"inspection_start":{"type":"string"},"building_area_sqm":{"nullable":true}}},"examples":{"7D/27-31 Ocean Street N, Bondi":{"value":{"id":2021178032,"url":"https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032","image":"https://rimh2.domainstatic.com.au/Oq0vqQyOB632hw2pt9TRSB5RRag=/fit-in/1920x1080/filters:format(webp):quality(85):no_upscale()/2021178032_1_1_260923_012858-w4134-h2756","price":1750000,"state":"NSW","agents":[{"name":"Danny Taylor","email":"dtaylor@raywhite.com","phone":"0417400553","photo":"https://rimh2.domainstatic.com.au/vJmYCfoQPL0ciW3j9VpuWPHXaPw=/180x180/filters:format(webp):quality(85):no_upscale()/https://images.domain.com.au/img/425/contact_2005423.png?date=639287874683470000","profile_url":"https://www.domain.com.au/real-estate-agent/danny-taylor-2005423"},{"name":"Nathan Ryland","email":"nryland@raywhite.com","phone":"0435959161","photo":"https://rimh2.domainstatic.com.au/IPkCuwpWLumzeCAm4bCRagVZNIw=/180x180/filters:format(webp):quality(85):no_upscale()/https://images.domain.com.au/img/425/contact_1822769.png?date=639288820005100000","profile_url":"https://www.domain.com.au/real-estate-agent/nathan-ryland-1822769"}],"images":["https://rimh2.domainstatic.com.au/Oq0vqQyOB632hw2pt9TRSB5RRag=/fit-in/1920x1080/filters:format(webp):quality(85):no_upscale()/2021178032_1_1_260923_012858-w4134-h2756","https://rimh2.domainstatic.com.au/YC4YQ75EMRylMceVgtaGBVGHTeE=/fit-in/1920x1080/filters:format(webp):quality(85):no_upscale()/2021178032_2_1_260923_012858-w4134-h2756"],"status":"live","street":"Ocean Street N","suburb":"Bondi","address":"7D/27-31 Ocean Street N, Bondi NSW 2026","bedrooms":2,"currency":"AUD","headline":"Elevated Apartment In The North East Corner With Ocean And Harbour Views","latitude":-33.8918989,"postcode":"2026","agency_id":425,"bathrooms":1,"carspaces":1,"listed_at":"2026-09-23T11:29:00+10:00","longitude":151.2623893,"price_max":null,"agency_url":"https://www.domain.com.au/real-estate-agencies/raywhitedoublebay-425/","auction_at":null,"promo_type":"premium_plus","updated_at":"2026-10-23T09:38:50.46","agency_name":"Ray White Double Bay","description":"Poised in a rare north east corner position, this updated apartment delivers a generous design capturing elevated views spanning over to both the harbour and azure ocean's horizon.","property_id":"CF-0183-PL","sale_method":"private_treaty","unit_number":"7D","agency_phone":"02 93639999","listing_mode":"sale","price_period":null,"land_area_sqm":null,"price_display":"$1,750,000","property_type":"Apartment / Unit / Flat","street_number":"27-31","agency_website":"https://raywhitedoublebay.com/","inspection_end":"2026-10-31T13:30:00","inspection_start":"2026-10-31T13:00:00","building_area_sqm":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/domaincomau/search":{"get":{"summary":"Domain.com.au Search","description":"Search Domain.com.au by suburb. mode is sale, rent, or sold. page starts at 1. Each card has a dollar price and a price label rebuilt from that amount.\n\n**Credit cost:** 2 credits per call","operationId":"get-domaincomau-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Suburb with state and postcode, a location slug, or a Domain search URL.\n\n**Example:**\n\n    Bondi NSW 2026\n\n**Slug:** bondi-nsw-2026\n\n**JSON:** a place uses mode (default sale) and returns for-sale cards. A search URL keeps its /sale/, /rent/, or /sold-listings/ path, so mode is ignored. A property URL returns 400.","schema":{"type":"string","description":"Suburb with state and postcode, a location slug, or a Domain search URL.\n\n**Example:**\n\n    Bondi NSW 2026\n\n**Slug:** bondi-nsw-2026\n\n**JSON:** a place uses mode (default sale) and returns for-sale cards. A search URL keeps its /sale/, /rent/, or /sold-listings/ path, so mode is ignored. A property URL returns 400."}},{"name":"mode","in":"query","required":false,"description":"sale, rent, or sold when query is a place.\n\n**Default:** sale.\n\n**Aliases:** buy and for-sale become sale. rental and lease become rent.\n\n**JSON:** sale uses /sale/. rent uses /rent/ and sets price_period to week when the card is weekly. sold uses /sold-listings/. Ignored when query is already a search URL.","schema":{"type":"string","default":"sale","description":"sale, rent, or sold when query is a place.\n\n**Default:** sale.\n\n**Aliases:** buy and for-sale become sale. rental and lease become rent.\n\n**JSON:** sale uses /sale/. rent uses /rent/ and sets price_period to week when the card is weekly. sold uses /sold-listings/. Ignored when query is already a search URL."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1, which omits page from the Domain URL and sets pagination.page to 1.\n\n**JSON:** page 2 sends page=2. pagination.next is the next Domain URL, or null on the last page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1, which omits page from the Domain URL and sets pagination.page to 1.\n\n**JSON:** page 2 sends page=2. pagination.next is the next Domain URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"tag":{"nullable":true},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"agents":{"type":"array","items":{"type":"string"}},"suburb":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"bathrooms":{"type":"integer"},"carspaces":{"type":"integer"},"longitude":{"type":"number"},"price_max":{"nullable":true},"auction_at":{"nullable":true},"promo_type":{"type":"string"},"agency_name":{"type":"string"},"listing_type":{"type":"string"},"price_period":{"nullable":true},"land_area_sqm":{"nullable":true},"price_display":{"type":"string"},"property_type":{"type":"string"},"inspection_end":{"type":"string"},"inspection_start":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Bondi sale, 7D/27-31 Ocean Street N":{"value":{"results":[{"id":2021178032,"tag":null,"url":"https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032","image":"https://rimh2.domainstatic.com.au/KAIUr4MxPgKd34aNY5ZXvaragds=/720x540/filters:format(webp):quality(85)/2021178032_1_1_260923_012858-w4134-h2756","price":1750000,"state":"NSW","title":"7D/27-31 Ocean Street N, Bondi NSW 2026","agents":["Danny Taylor","Nathan Ryland"],"suburb":"Bondi","address":"7D/27-31 Ocean Street N, Bondi NSW 2026","bedrooms":2,"currency":"AUD","latitude":-33.8919,"postcode":"2026","bathrooms":1,"carspaces":1,"longitude":151.26239,"price_max":null,"auction_at":null,"promo_type":"premium_plus","agency_name":"Ray White Double Bay","listing_type":"listing","price_period":null,"land_area_sqm":null,"price_display":"$1,750,000","property_type":"Apartment / Unit / Flat","inspection_end":"2026-10-31T13:30:00","inspection_start":"2026-10-31T13:00:00"}],"pagination":{"next":"https://www.domain.com.au/sale/bondi-nsw-2026/?page=2","page":1,"per_page":20,"total_pages":17,"total_results":351}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Domain.com.au Search","description":"Search Domain.com.au by suburb. mode is sale, rent, or sold. page starts at 1. Each card has a dollar price and a price label rebuilt from that amount.\n\n**Credit cost:** 2 credits per call","operationId":"post-domaincomau-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Suburb with state and postcode, a location slug, or a Domain search URL.\n\n**Example:**\n\n    Bondi NSW 2026\n\n**Slug:** bondi-nsw-2026\n\n**JSON:** a place uses mode (default sale) and returns for-sale cards. A search URL keeps its /sale/, /rent/, or /sold-listings/ path, so mode is ignored. A property URL returns 400.","schema":{"type":"string","description":"Suburb with state and postcode, a location slug, or a Domain search URL.\n\n**Example:**\n\n    Bondi NSW 2026\n\n**Slug:** bondi-nsw-2026\n\n**JSON:** a place uses mode (default sale) and returns for-sale cards. A search URL keeps its /sale/, /rent/, or /sold-listings/ path, so mode is ignored. A property URL returns 400."}},{"name":"mode","in":"query","required":false,"description":"sale, rent, or sold when query is a place.\n\n**Default:** sale.\n\n**Aliases:** buy and for-sale become sale. rental and lease become rent.\n\n**JSON:** sale uses /sale/. rent uses /rent/ and sets price_period to week when the card is weekly. sold uses /sold-listings/. Ignored when query is already a search URL.","schema":{"type":"string","default":"sale","description":"sale, rent, or sold when query is a place.\n\n**Default:** sale.\n\n**Aliases:** buy and for-sale become sale. rental and lease become rent.\n\n**JSON:** sale uses /sale/. rent uses /rent/ and sets price_period to week when the card is weekly. sold uses /sold-listings/. Ignored when query is already a search URL."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1, which omits page from the Domain URL and sets pagination.page to 1.\n\n**JSON:** page 2 sends page=2. pagination.next is the next Domain URL, or null on the last page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1, which omits page from the Domain URL and sets pagination.page to 1.\n\n**JSON:** page 2 sends page=2. pagination.next is the next Domain URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"tag":{"nullable":true},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"agents":{"type":"array","items":{"type":"string"}},"suburb":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"bathrooms":{"type":"integer"},"carspaces":{"type":"integer"},"longitude":{"type":"number"},"price_max":{"nullable":true},"auction_at":{"nullable":true},"promo_type":{"type":"string"},"agency_name":{"type":"string"},"listing_type":{"type":"string"},"price_period":{"nullable":true},"land_area_sqm":{"nullable":true},"price_display":{"type":"string"},"property_type":{"type":"string"},"inspection_end":{"type":"string"},"inspection_start":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Bondi sale, 7D/27-31 Ocean Street N":{"value":{"results":[{"id":2021178032,"tag":null,"url":"https://www.domain.com.au/7d-27-31-ocean-street-n-bondi-nsw-2026-2021178032","image":"https://rimh2.domainstatic.com.au/KAIUr4MxPgKd34aNY5ZXvaragds=/720x540/filters:format(webp):quality(85)/2021178032_1_1_260923_012858-w4134-h2756","price":1750000,"state":"NSW","title":"7D/27-31 Ocean Street N, Bondi NSW 2026","agents":["Danny Taylor","Nathan Ryland"],"suburb":"Bondi","address":"7D/27-31 Ocean Street N, Bondi NSW 2026","bedrooms":2,"currency":"AUD","latitude":-33.8919,"postcode":"2026","bathrooms":1,"carspaces":1,"longitude":151.26239,"price_max":null,"auction_at":null,"promo_type":"premium_plus","agency_name":"Ray White Double Bay","listing_type":"listing","price_period":null,"land_area_sqm":null,"price_display":"$1,750,000","property_type":"Apartment / Unit / Flat","inspection_end":"2026-10-31T13:30:00","inspection_start":"2026-10-31T13:00:00"}],"pagination":{"next":"https://www.domain.com.au/sale/bondi-nsw-2026/?page=2","page":1,"per_page":20,"total_pages":17,"total_results":351}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rightmove/property":{"get":{"summary":"Rightmove Property","description":"Read one Rightmove property from its URL or numeric id. The response is a flat object with price, tenure, floor area, stations, and the agent.\n\n**Credit cost:** 2 credits per call","operationId":"get-rightmove-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Rightmove property URL or the numeric id.\n\n**Example (URL):**\n\n    https://www.rightmove.co.uk/properties/172438235\n\n**Example (id):**\n\n    172438235\n\n**JSON:** both forms return one flat object. id and url match that property. There is no results wrapper. A search URL returns 400.","schema":{"type":"string","description":"Rightmove property URL or the numeric id.\n\n**Example (URL):**\n\n    https://www.rightmove.co.uk/properties/172438235\n\n**Example (id):**\n\n    172438235\n\n**JSON:** both forms return one flat object. id and url match that property. There is no results wrapper. A search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}}},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"tenure":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"summary":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"published":{"type":"boolean"},"floorplans":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"country_code":{"type":"string"},"key_features":{"type":"array","items":{"type":"string"}},"price_display":{"type":"string"},"property_type":{"type":"string"},"floor_area_sqm":{"type":"integer"},"listing_update":{"type":"string"},"price_per_sqft":{"type":"number"},"floor_area_sqft":{"type":"integer"},"price_frequency":{"nullable":true},"price_qualifier":{"nullable":true},"council_tax_band":{"type":"string"},"nearest_stations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"unit":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"distance":{"type":"number"}}}},"transaction_type":{"type":"string"},"annual_ground_rent":{"nullable":true},"annual_service_charge":{"type":"number"},"lease_years_remaining":{"type":"integer"},"price_per_sqft_display":{"type":"string"},"annual_ground_rent_display":{"nullable":true},"annual_service_charge_display":{"type":"string"}}},"examples":{"Upper Richmond Road, London, SW15":{"value":{"id":172438235,"url":"https://www.rightmove.co.uk/properties/172438235","agent":{"url":"https://www.rightmove.co.uk/estate-agents/agent/Winkworth/Putney-49971.html","logo":"https://media.rightmove.co.uk/partner-logo/67287-LOGO-1765970428.jpeg","name":"Winkworth, Putney","phone":"020 3823 6033"},"price":415000,"title":"2 bedroom apartment for sale in Upper Richmond Road, London, SW15","images":["https://media.rightmove.co.uk/property-photo/4bf25c0d8/172438235/4bf25c0d8416e36a76dab44d47d9b6db.jpeg","https://media.rightmove.co.uk/property-photo/bf7743c77/172438235/bf7743c77a6ee8e0c192d0b506574601.jpeg","https://media.rightmove.co.uk/property-photo/2148eca7f/172438235/2148eca7f70dcdfe570a630b7536cdc1.jpeg"],"tenure":"LEASEHOLD","address":"Upper Richmond Road, London, SW15","channel":"RES_BUY","summary":"2 bedroom apartment","bedrooms":2,"currency":"GBP","latitude":51.463123,"postcode":"SW15 6TP","bathrooms":1,"longitude":-0.226337,"published":true,"floorplans":["https://media.rightmove.co.uk/property-floorplan/67a75dd94/172438235/67a75dd94f8c38272d40a8d7fea9c9f5.jpeg"],"description":"This well-presented two-bedroom flat is situated on the third floor of an attractive Art Deco, purpose-built mansion block and is served by a lift for added convenience. The property offers a bright and spacious open-plan reception, dining and kitchen area, creating an ideal space for both everyday living and entertaining. There are two well-proportioned bedrooms and a modern bathroom, all arranged to provide a comfortable and practical layout.\nThe development is secure and well maintained, with a concierge service enhancing both convenience and peace of mind. Each flat also benefits from its own basement storage area, providing valuable additional space. Residents enjoy a friendly and welcoming community atmosphere, adding to the appeal of this established mansion block. Combining period character with practical modern living, this apartment is well suited to professionals, downsizers or investors alike.\nLocation:\nOrmonde Court is conveniently situated on the Upper Richmond Road close to Putney Leisure Centre and Putney High Street. This idyllic location affords numerous bus routes, and is within easy reach of both Putney Mainline Station (National Rail) and East Putney Underground Station (District Line) affording swift West End and City communications. Putney High Street offers excellent multiple and specialist shopping facilities.","country_code":"GB","key_features":["Two Bedrooms","Kitchen/Reception/Dining Room","One Bathroom","Concierge","Art Deco Mansion Block"],"price_display":"£415,000","property_type":"Apartment","floor_area_sqm":63,"listing_update":"Reduced today","price_per_sqft":612.09,"floor_area_sqft":678,"price_frequency":null,"price_qualifier":null,"council_tax_band":"D","nearest_stations":[{"name":"Putney Station","unit":"miles","types":["NATIONAL_TRAIN"],"distance":0.46},{"name":"East Putney Station","unit":"miles","types":["LONDON_UNDERGROUND"],"distance":0.72},{"name":"Barnes Station","unit":"miles","types":["NATIONAL_TRAIN"],"distance":0.73}],"transaction_type":"BUY","annual_ground_rent":null,"annual_service_charge":6218.28,"lease_years_remaining":173,"price_per_sqft_display":"£612.09","annual_ground_rent_display":null,"annual_service_charge_display":"£6,218.28"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rightmove Property","description":"Read one Rightmove property from its URL or numeric id. The response is a flat object with price, tenure, floor area, stations, and the agent.\n\n**Credit cost:** 2 credits per call","operationId":"post-rightmove-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Rightmove property URL or the numeric id.\n\n**Example (URL):**\n\n    https://www.rightmove.co.uk/properties/172438235\n\n**Example (id):**\n\n    172438235\n\n**JSON:** both forms return one flat object. id and url match that property. There is no results wrapper. A search URL returns 400.","schema":{"type":"string","description":"Rightmove property URL or the numeric id.\n\n**Example (URL):**\n\n    https://www.rightmove.co.uk/properties/172438235\n\n**Example (id):**\n\n    172438235\n\n**JSON:** both forms return one flat object. id and url match that property. There is no results wrapper. A search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}}},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"tenure":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"summary":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"published":{"type":"boolean"},"floorplans":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"country_code":{"type":"string"},"key_features":{"type":"array","items":{"type":"string"}},"price_display":{"type":"string"},"property_type":{"type":"string"},"floor_area_sqm":{"type":"integer"},"listing_update":{"type":"string"},"price_per_sqft":{"type":"number"},"floor_area_sqft":{"type":"integer"},"price_frequency":{"nullable":true},"price_qualifier":{"nullable":true},"council_tax_band":{"type":"string"},"nearest_stations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"unit":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"distance":{"type":"number"}}}},"transaction_type":{"type":"string"},"annual_ground_rent":{"nullable":true},"annual_service_charge":{"type":"number"},"lease_years_remaining":{"type":"integer"},"price_per_sqft_display":{"type":"string"},"annual_ground_rent_display":{"nullable":true},"annual_service_charge_display":{"type":"string"}}},"examples":{"Upper Richmond Road, London, SW15":{"value":{"id":172438235,"url":"https://www.rightmove.co.uk/properties/172438235","agent":{"url":"https://www.rightmove.co.uk/estate-agents/agent/Winkworth/Putney-49971.html","logo":"https://media.rightmove.co.uk/partner-logo/67287-LOGO-1765970428.jpeg","name":"Winkworth, Putney","phone":"020 3823 6033"},"price":415000,"title":"2 bedroom apartment for sale in Upper Richmond Road, London, SW15","images":["https://media.rightmove.co.uk/property-photo/4bf25c0d8/172438235/4bf25c0d8416e36a76dab44d47d9b6db.jpeg","https://media.rightmove.co.uk/property-photo/bf7743c77/172438235/bf7743c77a6ee8e0c192d0b506574601.jpeg","https://media.rightmove.co.uk/property-photo/2148eca7f/172438235/2148eca7f70dcdfe570a630b7536cdc1.jpeg"],"tenure":"LEASEHOLD","address":"Upper Richmond Road, London, SW15","channel":"RES_BUY","summary":"2 bedroom apartment","bedrooms":2,"currency":"GBP","latitude":51.463123,"postcode":"SW15 6TP","bathrooms":1,"longitude":-0.226337,"published":true,"floorplans":["https://media.rightmove.co.uk/property-floorplan/67a75dd94/172438235/67a75dd94f8c38272d40a8d7fea9c9f5.jpeg"],"description":"This well-presented two-bedroom flat is situated on the third floor of an attractive Art Deco, purpose-built mansion block and is served by a lift for added convenience. The property offers a bright and spacious open-plan reception, dining and kitchen area, creating an ideal space for both everyday living and entertaining. There are two well-proportioned bedrooms and a modern bathroom, all arranged to provide a comfortable and practical layout.\nThe development is secure and well maintained, with a concierge service enhancing both convenience and peace of mind. Each flat also benefits from its own basement storage area, providing valuable additional space. Residents enjoy a friendly and welcoming community atmosphere, adding to the appeal of this established mansion block. Combining period character with practical modern living, this apartment is well suited to professionals, downsizers or investors alike.\nLocation:\nOrmonde Court is conveniently situated on the Upper Richmond Road close to Putney Leisure Centre and Putney High Street. This idyllic location affords numerous bus routes, and is within easy reach of both Putney Mainline Station (National Rail) and East Putney Underground Station (District Line) affording swift West End and City communications. Putney High Street offers excellent multiple and specialist shopping facilities.","country_code":"GB","key_features":["Two Bedrooms","Kitchen/Reception/Dining Room","One Bathroom","Concierge","Art Deco Mansion Block"],"price_display":"£415,000","property_type":"Apartment","floor_area_sqm":63,"listing_update":"Reduced today","price_per_sqft":612.09,"floor_area_sqft":678,"price_frequency":null,"price_qualifier":null,"council_tax_band":"D","nearest_stations":[{"name":"Putney Station","unit":"miles","types":["NATIONAL_TRAIN"],"distance":0.46},{"name":"East Putney Station","unit":"miles","types":["LONDON_UNDERGROUND"],"distance":0.72},{"name":"Barnes Station","unit":"miles","types":["NATIONAL_TRAIN"],"distance":0.73}],"transaction_type":"BUY","annual_ground_rent":null,"annual_service_charge":6218.28,"lease_years_remaining":173,"price_per_sqft_display":"£612.09","annual_ground_rent_display":null,"annual_service_charge_display":"£6,218.28"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/loopnet/search":{"get":{"summary":"LoopNet Search","description":"Search LoopNet commercial listings by city or by a results URL.\n\n**Status:** Inactive\n\n**Credit cost:** 1 credit per call","operationId":"get-loopnet-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. City and state, for example New York, NY, or a LoopNet search URL such as https://www.loopnet.com/search/commercial-real-estate/new-york-ny/for-sale/. A listing URL is rejected.\n\n**Examples:**\n\n    New York, NY\n","schema":{"type":"string","description":"Required. City and state, for example New York, NY, or a LoopNet search URL such as https://www.loopnet.com/search/commercial-real-estate/new-york-ny/for-sale/. A listing URL is rejected.\n\n**Examples:**\n\n    New York, NY\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"units":{"type":"integer"},"address":{"type":"string"},"country":{"type":"string"},"summary":{"type":"string"},"cap_rate":{"type":"number"},"currency":{"type":"string"},"lot_count":{"nullable":true},"listing_id":{"type":"string"},"year_built":{"nullable":true},"broker_name":{"type":"string"},"postal_code":{"type":"string"},"listing_tier":{"type":"string"},"listing_type":{"type":"string"},"starting_bid":{"nullable":true},"bid_increment":{"nullable":true},"price_display":{"type":"string"},"property_type":{"type":"string"},"broker_company":{"type":"string"},"lot_size_acres":{"nullable":true},"property_count":{"nullable":true},"year_renovated":{"nullable":true},"lot_size_display":{"nullable":true},"property_subtype":{"type":"string"},"transaction_type":{"type":"string"},"building_size_sqft":{"nullable":true},"starting_bid_display":{"nullable":true},"bid_increment_display":{"nullable":true},"building_size_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"New York for sale, 484 Amsterdam Ave":{"value":{"results":[{"url":"https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/","city":"New York","image":"https://images1.loopnet.com/i2/n72IA42dlAZTU0D5kvXnJ81X-x2jGvgVig2wkZ0zIkk/117/image.jpg","price":8900000,"state":"NY","title":"484 Amsterdam Ave","units":13,"address":"New York, NY 10024","country":"US","summary":"Five-story residential walk-up on the Upper West Side featuring 12 residential apartments, a ground-floor commercial unit, and recent renovations.","cap_rate":5.12,"currency":"USD","lot_count":null,"listing_id":"31379002","year_built":null,"broker_name":"Michelle Blake","postal_code":"10024","listing_tier":"platinum","listing_type":"PropertyForSale","starting_bid":null,"bid_increment":null,"price_display":"$8,900,000","property_type":"Multifamily","broker_company":"Keyah Enterprises, Inc","lot_size_acres":null,"property_count":null,"year_renovated":null,"lot_size_display":null,"property_subtype":"Apartment","transaction_type":"ForSale","building_size_sqft":null,"starting_bid_display":null,"bid_increment_display":null,"building_size_display":null}],"pagination":{"next":"https://www.loopnet.com/search/commercial-real-estate/new-york-ny/for-sale/2/","page":1,"per_page":40,"total_pages":null,"total_results":750}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LoopNet Search","description":"Search LoopNet commercial listings by city or by a results URL.\n\n**Status:** Inactive\n\n**Credit cost:** 1 credit per call","operationId":"post-loopnet-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. City and state, for example New York, NY, or a LoopNet search URL such as https://www.loopnet.com/search/commercial-real-estate/new-york-ny/for-sale/. A listing URL is rejected.\n\n**Examples:**\n\n    New York, NY\n","schema":{"type":"string","description":"Required. City and state, for example New York, NY, or a LoopNet search URL such as https://www.loopnet.com/search/commercial-real-estate/new-york-ny/for-sale/. A listing URL is rejected.\n\n**Examples:**\n\n    New York, NY\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"units":{"type":"integer"},"address":{"type":"string"},"country":{"type":"string"},"summary":{"type":"string"},"cap_rate":{"type":"number"},"currency":{"type":"string"},"lot_count":{"nullable":true},"listing_id":{"type":"string"},"year_built":{"nullable":true},"broker_name":{"type":"string"},"postal_code":{"type":"string"},"listing_tier":{"type":"string"},"listing_type":{"type":"string"},"starting_bid":{"nullable":true},"bid_increment":{"nullable":true},"price_display":{"type":"string"},"property_type":{"type":"string"},"broker_company":{"type":"string"},"lot_size_acres":{"nullable":true},"property_count":{"nullable":true},"year_renovated":{"nullable":true},"lot_size_display":{"nullable":true},"property_subtype":{"type":"string"},"transaction_type":{"type":"string"},"building_size_sqft":{"nullable":true},"starting_bid_display":{"nullable":true},"bid_increment_display":{"nullable":true},"building_size_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"New York for sale, 484 Amsterdam Ave":{"value":{"results":[{"url":"https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/","city":"New York","image":"https://images1.loopnet.com/i2/n72IA42dlAZTU0D5kvXnJ81X-x2jGvgVig2wkZ0zIkk/117/image.jpg","price":8900000,"state":"NY","title":"484 Amsterdam Ave","units":13,"address":"New York, NY 10024","country":"US","summary":"Five-story residential walk-up on the Upper West Side featuring 12 residential apartments, a ground-floor commercial unit, and recent renovations.","cap_rate":5.12,"currency":"USD","lot_count":null,"listing_id":"31379002","year_built":null,"broker_name":"Michelle Blake","postal_code":"10024","listing_tier":"platinum","listing_type":"PropertyForSale","starting_bid":null,"bid_increment":null,"price_display":"$8,900,000","property_type":"Multifamily","broker_company":"Keyah Enterprises, Inc","lot_size_acres":null,"property_count":null,"year_renovated":null,"lot_size_display":null,"property_subtype":"Apartment","transaction_type":"ForSale","building_size_sqft":null,"starting_bid_display":null,"bid_increment_display":null,"building_size_display":null}],"pagination":{"next":"https://www.loopnet.com/search/commercial-real-estate/new-york-ny/for-sale/2/","page":1,"per_page":40,"total_pages":null,"total_results":750}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/loopnet/property":{"get":{"summary":"LoopNet Property","description":"Read one LoopNet commercial listing from its URL.\n\n**Status:** Inactive\n\n**Credit cost:** 1 credit per call","operationId":"get-loopnet-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. LoopNet listing URL from search, for example https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/. A keyword is rejected.","schema":{"type":"string","description":"Required. LoopNet listing URL from search, for example https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"facts":{"nullable":true},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"units":{"type":"integer"},"address":{"type":"string"},"stories":{"type":"integer"},"cap_rate":{"type":"number"},"currency":{"type":"string"},"location":{"type":"string"},"subtitle":{"type":"string"},"sale_type":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"listing_id":{"type":"string"},"year_built":{"type":"integer"},"broker_name":{"type":"string"},"description":{"type":"string"},"postal_code":{"type":"string"},"broker_phone":{"type":"string"},"broker_title":{"type":"string"},"date_modified":{"type":"string"},"lot_size_sqft":{"nullable":true},"parcel_number":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"broker_company":{"type":"string"},"building_class":{"type":"string"},"date_on_market":{"type":"string"},"lot_size_acres":{"type":"number"},"price_per_unit":{"type":"integer"},"year_renovated":{"nullable":true},"apartment_style":{"type":"string"},"land_assessment":{"type":"integer"},"lot_size_display":{"type":"string"},"property_subtype":{"type":"string"},"total_assessment":{"type":"integer"},"average_occupancy":{"type":"string"},"building_size_sqft":{"type":"integer"},"building_size_display":{"type":"string"},"improvement_assessment":{"type":"integer"},"price_per_unit_display":{"type":"string"}}},"examples":{"484 Amsterdam Ave, New York":{"value":{"url":"https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/","city":"New York","facts":null,"image":"https://images1.loopnet.com/i2/n72IA42dlAZTU0D5kvXnJx5jWiOEDcDJTlFcnzTFdjY/112/image.jpg","price":8900000,"state":"NY","title":"484 Amsterdam Ave","units":11,"address":"484 Amsterdam Ave, New York, NY 10024","stories":5,"cap_rate":5.12,"currency":"USD","location":"New York, NY 10024","subtitle":"11 Unit Apartment Building","sale_type":"Investment","highlights":["484 Amsterdam Avenue presents an attractive investment opportunity for a 12-unit Upper West Side residential walk-up in excellent condition.","Featuring a high-demand unit mix with four one-bedroom, one-bath units, seven two-bedroom, one-bath units, and a two-bedroom, two-bath penthouse.","Ideally situated between 83rd and 84th Streets with convenient access to two neighboring subway stations and Broadway and Amsterdam Avenue buses."],"listing_id":"31379002","year_built":1900,"broker_name":"Michelle Blake","description":"484 Amsterdam Avenue is a five-story walk-up on Manhattan's Upper West Side. The 19,176-square-foot building contains 12 residential apartments, a commercial space, and a basement.","postal_code":"10024","broker_phone":"(347) 386-0107","broker_title":"Principle Broker","date_modified":"2025-03-10","lot_size_sqft":null,"parcel_number":"1231-0031","price_display":"$8,900,000","property_type":"Multifamily","broker_company":"Keyah Enterprises, Inc","building_class":"C","date_on_market":"4/1/2024","lot_size_acres":0.06,"price_per_unit":809091,"year_renovated":null,"apartment_style":"Mid-Rise","land_assessment":348300,"lot_size_display":"0.06 AC","property_subtype":"Apartment","total_assessment":1906110,"average_occupancy":"100%","building_size_sqft":10850,"building_size_display":"10,850 SF","improvement_assessment":1557810,"price_per_unit_display":"$809,091"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LoopNet Property","description":"Read one LoopNet commercial listing from its URL.\n\n**Status:** Inactive\n\n**Credit cost:** 1 credit per call","operationId":"post-loopnet-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. LoopNet listing URL from search, for example https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/. A keyword is rejected.","schema":{"type":"string","description":"Required. LoopNet listing URL from search, for example https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"facts":{"nullable":true},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"units":{"type":"integer"},"address":{"type":"string"},"stories":{"type":"integer"},"cap_rate":{"type":"number"},"currency":{"type":"string"},"location":{"type":"string"},"subtitle":{"type":"string"},"sale_type":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"listing_id":{"type":"string"},"year_built":{"type":"integer"},"broker_name":{"type":"string"},"description":{"type":"string"},"postal_code":{"type":"string"},"broker_phone":{"type":"string"},"broker_title":{"type":"string"},"date_modified":{"type":"string"},"lot_size_sqft":{"nullable":true},"parcel_number":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"broker_company":{"type":"string"},"building_class":{"type":"string"},"date_on_market":{"type":"string"},"lot_size_acres":{"type":"number"},"price_per_unit":{"type":"integer"},"year_renovated":{"nullable":true},"apartment_style":{"type":"string"},"land_assessment":{"type":"integer"},"lot_size_display":{"type":"string"},"property_subtype":{"type":"string"},"total_assessment":{"type":"integer"},"average_occupancy":{"type":"string"},"building_size_sqft":{"type":"integer"},"building_size_display":{"type":"string"},"improvement_assessment":{"type":"integer"},"price_per_unit_display":{"type":"string"}}},"examples":{"484 Amsterdam Ave, New York":{"value":{"url":"https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/","city":"New York","facts":null,"image":"https://images1.loopnet.com/i2/n72IA42dlAZTU0D5kvXnJx5jWiOEDcDJTlFcnzTFdjY/112/image.jpg","price":8900000,"state":"NY","title":"484 Amsterdam Ave","units":11,"address":"484 Amsterdam Ave, New York, NY 10024","stories":5,"cap_rate":5.12,"currency":"USD","location":"New York, NY 10024","subtitle":"11 Unit Apartment Building","sale_type":"Investment","highlights":["484 Amsterdam Avenue presents an attractive investment opportunity for a 12-unit Upper West Side residential walk-up in excellent condition.","Featuring a high-demand unit mix with four one-bedroom, one-bath units, seven two-bedroom, one-bath units, and a two-bedroom, two-bath penthouse.","Ideally situated between 83rd and 84th Streets with convenient access to two neighboring subway stations and Broadway and Amsterdam Avenue buses."],"listing_id":"31379002","year_built":1900,"broker_name":"Michelle Blake","description":"484 Amsterdam Avenue is a five-story walk-up on Manhattan's Upper West Side. The 19,176-square-foot building contains 12 residential apartments, a commercial space, and a basement.","postal_code":"10024","broker_phone":"(347) 386-0107","broker_title":"Principle Broker","date_modified":"2025-03-10","lot_size_sqft":null,"parcel_number":"1231-0031","price_display":"$8,900,000","property_type":"Multifamily","broker_company":"Keyah Enterprises, Inc","building_class":"C","date_on_market":"4/1/2024","lot_size_acres":0.06,"price_per_unit":809091,"year_renovated":null,"apartment_style":"Mid-Rise","land_assessment":348300,"lot_size_display":"0.06 AC","property_subtype":"Apartment","total_assessment":1906110,"average_occupancy":"100%","building_size_sqft":10850,"building_size_display":"10,850 SF","improvement_assessment":1557810,"price_per_unit_display":"$809,091"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/realestatecomau/search":{"get":{"summary":"realestate.com.au Search","description":"Search realestate.com.au buy, rent, or sold results. A place such as Sydney, NSW defaults to homes for sale. Each card has price, address, rooms, and a property URL.\n\n**Credit cost:** 2 credits per call","operationId":"get-realestatecomau-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Place or a realestate.com.au results URL.\n\n**Example:**\n\n    Sydney, NSW\n\n**JSON:** a place with the default channel buy sets results[].channel to buy and requests /buy/in-sydney,+nsw/list-1. A buy, rent, or sold results URL keeps its path. A property URL is rejected. Property lookup is not available.","schema":{"type":"string","description":"Place or a realestate.com.au results URL.\n\n**Example:**\n\n    Sydney, NSW\n\n**JSON:** a place with the default channel buy sets results[].channel to buy and requests /buy/in-sydney,+nsw/list-1. A buy, rent, or sold results URL keeps its path. A property URL is rejected. Property lookup is not available."}},{"name":"channel","in":"query","required":false,"description":"buy, rent, or sold. Used when query is a place.\n\n**Default:** buy. Empty also means buy.\n\n**Aliases:** sale and for-sale mean buy. rental and lease mean rent.\n\n**JSON:** sets results[].channel and the path (/buy/, /rent/, or /sold/). A results URL keeps its own path.","schema":{"type":"string","description":"buy, rent, or sold. Used when query is a place.\n\n**Default:** buy. Empty also means buy.\n\n**Aliases:** sale and for-sale mean buy. rental and lease mean rent.\n\n**JSON:** sets results[].channel and the path (/buy/, /rent/, or /sold/). A results URL keeps its own path."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1, which requests /list-1 and sets pagination.page to 1.\n\n**JSON:** page 2 rewrites the path to /list-2. pagination.next is the next results URL, or null on the last page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1, which requests /list-1 and sets pagination.page to 1.\n\n**JSON:** page 2 rewrites the path to /list-2. pagination.next is the next results URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"badge":{"nullable":true},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"suburb":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"postcode":{"type":"string"},"bathrooms":{"type":"integer"},"price_max":{"nullable":true},"agent_name":{"type":"string"},"car_spaces":{"type":"integer"},"agency_name":{"type":"string"},"building_size":{"type":"integer"},"price_display":{"type":"string"},"property_type":{"type":"string"},"building_size_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Sydney NSW homes for sale":{"value":{"results":[{"id":149690532,"url":"https://www.realestate.com.au/property-apartment-nsw-sydney-149690532","badge":null,"image":"https://i2.au.reastatic.net/800x600/0912e9a1bea76a94ba5a397b993767175e6714ec2a59081478ee67d3f622b4cb/image.jpg","price":4000000,"state":"NSW","suburb":"Sydney","address":"Level 22/6 Watermans Quay, Sydney, NSW 2000","channel":"buy","bedrooms":2,"currency":"AUD","postcode":"2000","bathrooms":2,"price_max":null,"agent_name":"Leanne Pan","car_spaces":1,"agency_name":"Ray White Residential - Sydney CBD","building_size":107,"price_display":"$4,000,000","property_type":"Apartment","building_size_display":"107m²"}],"pagination":{"next":"https://www.realestate.com.au/buy/in-sydney,+nsw/list-2","page":1,"per_page":25,"total_pages":25,"total_results":604}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"realestate.com.au Search","description":"Search realestate.com.au buy, rent, or sold results. A place such as Sydney, NSW defaults to homes for sale. Each card has price, address, rooms, and a property URL.\n\n**Credit cost:** 2 credits per call","operationId":"post-realestatecomau-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Place or a realestate.com.au results URL.\n\n**Example:**\n\n    Sydney, NSW\n\n**JSON:** a place with the default channel buy sets results[].channel to buy and requests /buy/in-sydney,+nsw/list-1. A buy, rent, or sold results URL keeps its path. A property URL is rejected. Property lookup is not available.","schema":{"type":"string","description":"Place or a realestate.com.au results URL.\n\n**Example:**\n\n    Sydney, NSW\n\n**JSON:** a place with the default channel buy sets results[].channel to buy and requests /buy/in-sydney,+nsw/list-1. A buy, rent, or sold results URL keeps its path. A property URL is rejected. Property lookup is not available."}},{"name":"channel","in":"query","required":false,"description":"buy, rent, or sold. Used when query is a place.\n\n**Default:** buy. Empty also means buy.\n\n**Aliases:** sale and for-sale mean buy. rental and lease mean rent.\n\n**JSON:** sets results[].channel and the path (/buy/, /rent/, or /sold/). A results URL keeps its own path.","schema":{"type":"string","description":"buy, rent, or sold. Used when query is a place.\n\n**Default:** buy. Empty also means buy.\n\n**Aliases:** sale and for-sale mean buy. rental and lease mean rent.\n\n**JSON:** sets results[].channel and the path (/buy/, /rent/, or /sold/). A results URL keeps its own path."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1, which requests /list-1 and sets pagination.page to 1.\n\n**JSON:** page 2 rewrites the path to /list-2. pagination.next is the next results URL, or null on the last page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1, which requests /list-1 and sets pagination.page to 1.\n\n**JSON:** page 2 rewrites the path to /list-2. pagination.next is the next results URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"badge":{"nullable":true},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"suburb":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"postcode":{"type":"string"},"bathrooms":{"type":"integer"},"price_max":{"nullable":true},"agent_name":{"type":"string"},"car_spaces":{"type":"integer"},"agency_name":{"type":"string"},"building_size":{"type":"integer"},"price_display":{"type":"string"},"property_type":{"type":"string"},"building_size_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Sydney NSW homes for sale":{"value":{"results":[{"id":149690532,"url":"https://www.realestate.com.au/property-apartment-nsw-sydney-149690532","badge":null,"image":"https://i2.au.reastatic.net/800x600/0912e9a1bea76a94ba5a397b993767175e6714ec2a59081478ee67d3f622b4cb/image.jpg","price":4000000,"state":"NSW","suburb":"Sydney","address":"Level 22/6 Watermans Quay, Sydney, NSW 2000","channel":"buy","bedrooms":2,"currency":"AUD","postcode":"2000","bathrooms":2,"price_max":null,"agent_name":"Leanne Pan","car_spaces":1,"agency_name":"Ray White Residential - Sydney CBD","building_size":107,"price_display":"$4,000,000","property_type":"Apartment","building_size_display":"107m²"}],"pagination":{"next":"https://www.realestate.com.au/buy/in-sydney,+nsw/list-2","page":1,"per_page":25,"total_pages":25,"total_results":604}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bestbuy/product/reviews":{"get":{"summary":"Best Buy Reviews","description":"Get customer reviews for a Best Buy product URL: rating, review text, author, photos and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-bestbuy-product-reviews","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Best Buy product URL or reviews URL.\n\nExample:\n\n    https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5/sku/12104931/reviews\n\nA product URL is rewritten to the reviews page. A search URL returns 400.","schema":{"type":"string","description":"Best Buy product URL or reviews URL.\n\nExample:\n\n    https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5/sku/12104931/reviews\n\nA product URL is rewritten to the reviews page. A search URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Default 1. A value above 1 overrides page on the Best Buy URL. If this stays at 1, a page already on the URL is kept.","schema":{"type":"number","description":"Page number, starting at 1. Default 1. A value above 1 overrides page on the Best Buy URL. If this stays at 1, a page already on the URL is kept."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the rendered HTML instead of JSON. Default false.","schema":{"type":"boolean","description":"When true, return the rendered HTML instead of JSON. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"body":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"region":{"type":"string"},"review_id":{"type":"string"},"days_owned":{"type":"integer"},"product_url":{"type":"string"},"product_name":{"type":"string"},"submitted_at":{"type":"string"},"helpful_count":{"type":"integer"},"is_recommended":{"type":"boolean"},"is_incentivized":{"type":"boolean"},"not_helpful_count":{"type":"integer"},"is_verified_purchase":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Nest Doorbell reviews (US)":{"value":{"results":[{"sku":"6642763","body":"Great doorbell with excellent 2K video quality. The picture is sharp day and night, motion detection is accurate, and alerts are fast and reliable. Installation was easy since it’s wired, and the Google Home app works smoothly for live view and event history. Sleek design and solid performance overall. Highly recommended.","title":"Google - Nest Doorbell (wired, 3rd gen)","author":"ToddT","images":["https://pisces.bbystatic.com/image2/BestBuy_US/ugc/photos/thumbnail/1456b7b0bb89940e15b132d7a564bf06.jpg"],"rating":5,"region":"com","review_id":"db6638f9-ba34-3be3-a3b2-732603c78ea8","days_owned":49,"product_url":"https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5","product_name":"Google - Nest Doorbell (wired, 3rd gen) - Latest Model - 2K Video and Gemini - Hazel","submitted_at":"2025-12-28T09:51:35.000-06:00","helpful_count":0,"is_recommended":true,"is_incentivized":true,"not_helpful_count":0,"is_verified_purchase":true}],"pagination":{"next":"https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5/sku/12104931/reviews?intl=nosplash&page=2","page":1,"per_page":20,"total_pages":19,"total_results":365}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Best Buy Reviews","description":"Get customer reviews for a Best Buy product URL: rating, review text, author, photos and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-bestbuy-product-reviews","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Best Buy product URL or reviews URL.\n\nExample:\n\n    https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5/sku/12104931/reviews\n\nA product URL is rewritten to the reviews page. A search URL returns 400.","schema":{"type":"string","description":"Best Buy product URL or reviews URL.\n\nExample:\n\n    https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5/sku/12104931/reviews\n\nA product URL is rewritten to the reviews page. A search URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Default 1. A value above 1 overrides page on the Best Buy URL. If this stays at 1, a page already on the URL is kept.","schema":{"type":"number","description":"Page number, starting at 1. Default 1. A value above 1 overrides page on the Best Buy URL. If this stays at 1, a page already on the URL is kept."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the rendered HTML instead of JSON. Default false.","schema":{"type":"boolean","description":"When true, return the rendered HTML instead of JSON. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"body":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"region":{"type":"string"},"review_id":{"type":"string"},"days_owned":{"type":"integer"},"product_url":{"type":"string"},"product_name":{"type":"string"},"submitted_at":{"type":"string"},"helpful_count":{"type":"integer"},"is_recommended":{"type":"boolean"},"is_incentivized":{"type":"boolean"},"not_helpful_count":{"type":"integer"},"is_verified_purchase":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Nest Doorbell reviews (US)":{"value":{"results":[{"sku":"6642763","body":"Great doorbell with excellent 2K video quality. The picture is sharp day and night, motion detection is accurate, and alerts are fast and reliable. Installation was easy since it’s wired, and the Google Home app works smoothly for live view and event history. Sleek design and solid performance overall. Highly recommended.","title":"Google - Nest Doorbell (wired, 3rd gen)","author":"ToddT","images":["https://pisces.bbystatic.com/image2/BestBuy_US/ugc/photos/thumbnail/1456b7b0bb89940e15b132d7a564bf06.jpg"],"rating":5,"region":"com","review_id":"db6638f9-ba34-3be3-a3b2-732603c78ea8","days_owned":49,"product_url":"https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5","product_name":"Google - Nest Doorbell (wired, 3rd gen) - Latest Model - 2K Video and Gemini - Hazel","submitted_at":"2025-12-28T09:51:35.000-06:00","helpful_count":0,"is_recommended":true,"is_incentivized":true,"not_helpful_count":0,"is_verified_purchase":true}],"pagination":{"next":"https://www.bestbuy.com/product/google-nest-doorbell-wired-3rd-gen-latest-model-2k-video-and-gemini-hazel/J39TC8J8W5/sku/12104931/reviews?intl=nosplash&page=2","page":1,"per_page":20,"total_pages":19,"total_results":365}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zoro/product":{"get":{"summary":"Zoro Product","description":"Get a Zoro product page: title, brand, USD price, Zoro number, manufacturer number, images, and specifications.\n\n**Credit cost:** 2 credits per call","operationId":"get-zoro-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Zoro product URL, or a path that contains `/i/G...`.\n\n**Example:**\n\n```\nhttps://www.zoro.com/3m-safety-glasses-securefit-200-series-scotchgard-anti-fog-frameless-blue-temples-clear-lens-sf201sgaf-blu/i/G1937045/\n```\n\nA search URL returns 400.","schema":{"type":"string","description":"Zoro product URL, or a path that contains `/i/G...`.\n\n**Example:**\n\n```\nhttps://www.zoro.com/3m-safety-glasses-securefit-200-series-scotchgard-anti-fog-frameless-blue-temples-clear-lens-sf201sgaf-blu/i/G1937045/\n```\n\nA search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the rendered HTML as `{\"result\": \"...\"}` instead of JSON.","schema":{"type":"boolean","description":"When true, return the rendered HTML as `{\"result\": \"...\"}` instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"mfr_no":{"type":"string"},"zoro_no":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"price_unit":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"object","properties":{"Item":{"type":"string"},"MFR #":{"type":"string"},"UPC #":{"type":"string"},"Gender":{"type":"string"},"Series":{"type":"string"},"Zoro #":{"type":"string"},"Features":{"type":"string"},"Used For":{"type":"string"},"Arm Color":{"type":"string"},"Standards":{"type":"string"},"Foam Lined":{"type":"string"},"Frame Type":{"type":"string"},"Hinge Type":{"type":"string"},"Lens Color":{"type":"string"},"Application":{"type":"string"},"Frame Color":{"type":"string"},"Frame Style":{"type":"string"},"Arm Material":{"type":"string"},"Arm Tip Type":{"type":"string"},"Eyewear Size":{"type":"string"},"Lens Coating":{"type":"string"},"Lens Material":{"type":"string"},"UV Protection":{"type":"string"},"Frame Material":{"type":"string"},"Metal Detectable":{"type":"string"},"X-Ray Detectable":{"type":"string"},"Adjustable Pieces":{"type":"string"},"Country of Origin":{"type":"string"},"Photochromatic Lens":{"type":"string"},"Temple Tip Features":{"type":"string"},"Includes Brow Lining":{"type":"string"},"Nose Bridge Material":{"type":"string"},"Temple Adjustment Type":{"type":"string"},"Temple-to-Temple Width":{"type":"string"},"Includes Eye Socket Lining":{"type":"string"},"Meets High Impact Standard":{"type":"string"},"For Small Heads Designation":{"type":"string"},"Includes Anti-Fog Lens Coating":{"type":"string"},"Includes Polarized Lens Coating":{"type":"string"},"Includes Scratch-Resistant Lens Coating":{"type":"string"},"Ultra-Violet Scale Protection Designation":{"type":"string"},"Infra-Red Light Scale Protection Designation":{"type":"string"}}}}},"examples":{"3M SecureFit SF201SGAF-BLU":{"value":{"url":"https://www.zoro.com/3m-safety-glasses-securefit-200-series-scotchgard-anti-fog-frameless-blue-temples-clear-lens-sf201sgaf-blu/i/G1937045/","gtin":"076308944872","brand":"3M","image":"https://www.zoro.com/static/cms/product/large/490a8043-20d5-41d6-9c12-44adaae21e83.jpeg","price":8.99,"title":"Safety Glasses, SecureFit 200 Series, Scotchgard Anti-Fog, Frameless, Blue Temples, Clear Lens","images":["https://www.zoro.com/static/cms/product/large/490a8043-20d5-41d6-9c12-44adaae21e83.jpeg","https://www.zoro.com/static/cms/product/large/Grainger_493X64xx2xx5a17d9.jpeg","https://www.zoro.com/static/cms/product/large/Grainger_493X64xxAS01xx29c38a.jpeg","https://www.zoro.com/static/cms/product/large/db6a92db-fa24-4dfa-9b4b-5da0f9676b7c.jpeg","https://www.zoro.com/static/cms/product/large/Grainger_493X64xx3xx30127e.jpeg"],"mfr_no":"SF201SGAF-BLU","zoro_no":"G1937045","currency":"USD","in_stock":true,"price_unit":"ea","breadcrumbs":[{"url":"https://www.zoro.com/safety/c/z1/","name":"Safety"},{"url":"https://www.zoro.com/personal-protective-equipment-ppe/c/13/","name":"Personal Protective Equipment (PPE)"},{"url":"https://www.zoro.com/eye-protection/c/4447/","name":"Eye Protection"},{"url":"https://www.zoro.com/safety-glasses/c/6214/","name":"Safety Glasses"}],"description":"Safety Glasses, Series SecureFit(TM) 200, Gender Unisex, Lens Color Clear, Polarized Lens No, Lens Coating Scotchgard(TM) Anti-Fog, No Foam Lined, Eyewear Frame Design Traditional, Eyewear Frame Style Frameless, Frame Color Clear, Eyewear Size Universal, Frame Material Polycarbonate, Lens Material Polycarbonate, Temple Color Blue, Temple Style Pressure Diffusion, Photochromatic Lens No, Metal Detectable No, X-Ray Detectable No, UV Protection 99.9 Percent, Includes Not Applicable","price_display":"$8.99","specifications":{"Item":"Safety Glasses","MFR #":"SF201SGAF-BLU","UPC #":"076308944872","Gender":"Unisex","Series":"SecureFit 200","Zoro #":"G1937045","Features":"3M™ Pressure Diffusion Temple Technology; Impact-resistant Lens","Used For":"Assembly, Construction, Food & Beverage Manufacturing, General Manufacturing, Repair & Operation (MO)","Arm Color":"Blue","Standards":"ANSI-ISEA Z87.1-2020, CSA Z94.3","Foam Lined":"No","Frame Type":"Frameless","Hinge Type":"Barrel","Lens Color":"Clear","Application":"General Purpose","Frame Color":"Blue","Frame Style":"Wraparound","Arm Material":"Xylex","Arm Tip Type":"Wraparound","Eyewear Size":"Universal","Lens Coating":"Scotchgard Anti-Fog & Anti-Scratch","Lens Material":"Polycarbonate","UV Protection":"99.99% UVA/UVB","Frame Material":"Polycarbonate","Metal Detectable":"No","X-Ray Detectable":"No","Adjustable Pieces":"Temple","Country of Origin":"Taiwan, Province of China","Photochromatic Lens":"No","Temple Tip Features":"Flexible","Includes Brow Lining":"No","Nose Bridge Material":"Polycarbonate","Temple Adjustment Type":"Pressure Diffusion","Temple-to-Temple Width":"5 1/2 in","Includes Eye Socket Lining":"No","Meets High Impact Standard":"High Impact Standard ANSI Z87+","For Small Heads Designation":"Not Rated for Small Heads","Includes Anti-Fog Lens Coating":"Yes","Includes Polarized Lens Coating":"No","Includes Scratch-Resistant Lens Coating":"Yes","Ultra-Violet Scale Protection Designation":"U6","Infra-Red Light Scale Protection Designation":"R0"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zoro Product","description":"Get a Zoro product page: title, brand, USD price, Zoro number, manufacturer number, images, and specifications.\n\n**Credit cost:** 2 credits per call","operationId":"post-zoro-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Zoro product URL, or a path that contains `/i/G...`.\n\n**Example:**\n\n```\nhttps://www.zoro.com/3m-safety-glasses-securefit-200-series-scotchgard-anti-fog-frameless-blue-temples-clear-lens-sf201sgaf-blu/i/G1937045/\n```\n\nA search URL returns 400.","schema":{"type":"string","description":"Zoro product URL, or a path that contains `/i/G...`.\n\n**Example:**\n\n```\nhttps://www.zoro.com/3m-safety-glasses-securefit-200-series-scotchgard-anti-fog-frameless-blue-temples-clear-lens-sf201sgaf-blu/i/G1937045/\n```\n\nA search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the rendered HTML as `{\"result\": \"...\"}` instead of JSON.","schema":{"type":"boolean","description":"When true, return the rendered HTML as `{\"result\": \"...\"}` instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"mfr_no":{"type":"string"},"zoro_no":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"price_unit":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"object","properties":{"Item":{"type":"string"},"MFR #":{"type":"string"},"UPC #":{"type":"string"},"Gender":{"type":"string"},"Series":{"type":"string"},"Zoro #":{"type":"string"},"Features":{"type":"string"},"Used For":{"type":"string"},"Arm Color":{"type":"string"},"Standards":{"type":"string"},"Foam Lined":{"type":"string"},"Frame Type":{"type":"string"},"Hinge Type":{"type":"string"},"Lens Color":{"type":"string"},"Application":{"type":"string"},"Frame Color":{"type":"string"},"Frame Style":{"type":"string"},"Arm Material":{"type":"string"},"Arm Tip Type":{"type":"string"},"Eyewear Size":{"type":"string"},"Lens Coating":{"type":"string"},"Lens Material":{"type":"string"},"UV Protection":{"type":"string"},"Frame Material":{"type":"string"},"Metal Detectable":{"type":"string"},"X-Ray Detectable":{"type":"string"},"Adjustable Pieces":{"type":"string"},"Country of Origin":{"type":"string"},"Photochromatic Lens":{"type":"string"},"Temple Tip Features":{"type":"string"},"Includes Brow Lining":{"type":"string"},"Nose Bridge Material":{"type":"string"},"Temple Adjustment Type":{"type":"string"},"Temple-to-Temple Width":{"type":"string"},"Includes Eye Socket Lining":{"type":"string"},"Meets High Impact Standard":{"type":"string"},"For Small Heads Designation":{"type":"string"},"Includes Anti-Fog Lens Coating":{"type":"string"},"Includes Polarized Lens Coating":{"type":"string"},"Includes Scratch-Resistant Lens Coating":{"type":"string"},"Ultra-Violet Scale Protection Designation":{"type":"string"},"Infra-Red Light Scale Protection Designation":{"type":"string"}}}}},"examples":{"3M SecureFit SF201SGAF-BLU":{"value":{"url":"https://www.zoro.com/3m-safety-glasses-securefit-200-series-scotchgard-anti-fog-frameless-blue-temples-clear-lens-sf201sgaf-blu/i/G1937045/","gtin":"076308944872","brand":"3M","image":"https://www.zoro.com/static/cms/product/large/490a8043-20d5-41d6-9c12-44adaae21e83.jpeg","price":8.99,"title":"Safety Glasses, SecureFit 200 Series, Scotchgard Anti-Fog, Frameless, Blue Temples, Clear Lens","images":["https://www.zoro.com/static/cms/product/large/490a8043-20d5-41d6-9c12-44adaae21e83.jpeg","https://www.zoro.com/static/cms/product/large/Grainger_493X64xx2xx5a17d9.jpeg","https://www.zoro.com/static/cms/product/large/Grainger_493X64xxAS01xx29c38a.jpeg","https://www.zoro.com/static/cms/product/large/db6a92db-fa24-4dfa-9b4b-5da0f9676b7c.jpeg","https://www.zoro.com/static/cms/product/large/Grainger_493X64xx3xx30127e.jpeg"],"mfr_no":"SF201SGAF-BLU","zoro_no":"G1937045","currency":"USD","in_stock":true,"price_unit":"ea","breadcrumbs":[{"url":"https://www.zoro.com/safety/c/z1/","name":"Safety"},{"url":"https://www.zoro.com/personal-protective-equipment-ppe/c/13/","name":"Personal Protective Equipment (PPE)"},{"url":"https://www.zoro.com/eye-protection/c/4447/","name":"Eye Protection"},{"url":"https://www.zoro.com/safety-glasses/c/6214/","name":"Safety Glasses"}],"description":"Safety Glasses, Series SecureFit(TM) 200, Gender Unisex, Lens Color Clear, Polarized Lens No, Lens Coating Scotchgard(TM) Anti-Fog, No Foam Lined, Eyewear Frame Design Traditional, Eyewear Frame Style Frameless, Frame Color Clear, Eyewear Size Universal, Frame Material Polycarbonate, Lens Material Polycarbonate, Temple Color Blue, Temple Style Pressure Diffusion, Photochromatic Lens No, Metal Detectable No, X-Ray Detectable No, UV Protection 99.9 Percent, Includes Not Applicable","price_display":"$8.99","specifications":{"Item":"Safety Glasses","MFR #":"SF201SGAF-BLU","UPC #":"076308944872","Gender":"Unisex","Series":"SecureFit 200","Zoro #":"G1937045","Features":"3M™ Pressure Diffusion Temple Technology; Impact-resistant Lens","Used For":"Assembly, Construction, Food & Beverage Manufacturing, General Manufacturing, Repair & Operation (MO)","Arm Color":"Blue","Standards":"ANSI-ISEA Z87.1-2020, CSA Z94.3","Foam Lined":"No","Frame Type":"Frameless","Hinge Type":"Barrel","Lens Color":"Clear","Application":"General Purpose","Frame Color":"Blue","Frame Style":"Wraparound","Arm Material":"Xylex","Arm Tip Type":"Wraparound","Eyewear Size":"Universal","Lens Coating":"Scotchgard Anti-Fog & Anti-Scratch","Lens Material":"Polycarbonate","UV Protection":"99.99% UVA/UVB","Frame Material":"Polycarbonate","Metal Detectable":"No","X-Ray Detectable":"No","Adjustable Pieces":"Temple","Country of Origin":"Taiwan, Province of China","Photochromatic Lens":"No","Temple Tip Features":"Flexible","Includes Brow Lining":"No","Nose Bridge Material":"Polycarbonate","Temple Adjustment Type":"Pressure Diffusion","Temple-to-Temple Width":"5 1/2 in","Includes Eye Socket Lining":"No","Meets High Impact Standard":"High Impact Standard ANSI Z87+","For Small Heads Designation":"Not Rated for Small Heads","Includes Anti-Fog Lens Coating":"Yes","Includes Polarized Lens Coating":"No","Includes Scratch-Resistant Lens Coating":"Yes","Ultra-Violet Scale Protection Designation":"U6","Infra-Red Light Scale Protection Designation":"R0"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zoro/search":{"get":{"summary":"Zoro Search","description":"Search Zoro by keyword or category URL. Returns product cards with USD price, brand, Zoro number, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-zoro-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Zoro search or category URL. Empty, another host, or a product URL returns 400. A keyword builds /search?q=.... Each card has price as a USD number and price_display as the dollar string.\n\nKeyword\n\n```\nsafety glasses\n```\n\nSearch URL\n\n```\nhttps://www.zoro.com/search?q=safety+glasses\n```\n\nCategory URL\n\n```\nhttps://www.zoro.com/safety-glasses/c/6214/\n```","schema":{"type":"string","description":"Keyword, or a Zoro search or category URL. Empty, another host, or a product URL returns 400. A keyword builds /search?q=.... Each card has price as a USD number and price_display as the dollar string.\n\nKeyword\n\n```\nsafety glasses\n```\n\nSearch URL\n\n```\nhttps://www.zoro.com/search?q=safety+glasses\n```\n\nCategory URL\n\n```\nhttps://www.zoro.com/safety-glasses/c/6214/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1. Page 2 adds page=2, sets pagination.page to 2, and returns the next cards. pagination.next is the next page URL, or null on the last page. A value below 1 returns 400.","schema":{"type":"number","description":"Page number starting at 1. Omit it for page 1. Page 2 adds page=2, sets pagination.page to 2, and returns the next cards. pagination.next is the next page URL, or null on the last page. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"mfr_no":{"type":"string"},"rating":{"type":"number"},"zoro_no":{"type":"string"},"currency":{"type":"string"},"price_unit":{"type":"string"},"review_count":{"type":"integer"},"package_price":{"type":"number"},"price_display":{"type":"string"},"package_quantity":{"type":"integer"},"package_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"BearKat (BK1) safety glasses":{"value":{"results":[{"url":"https://www.zoro.com/mcr-safety-bearkat-bk1-safety-glasses-duramass-hard-coat-clear-lens-non-slip-temple-frameless-bk110/i/G2426514/","brand":"Mcr Safety","image":"https://www.zoro.com/static/cms/product/full/7e6737c8-0823-4e5f-9c53-2002b0476883.jpeg","price":1.39,"title":"BearKat (BK1), Safety Glasses, Duramass Hard Coat, Clear Lens, Non-Slip Temple, Frameless","mfr_no":"BK110","rating":4.86,"zoro_no":"G2426514","currency":"USD","price_unit":"ea","review_count":49,"package_price":16.68,"price_display":"$1.39","package_quantity":12,"package_price_display":"$16.68"}],"pagination":{"next":"https://www.zoro.com/safety-glasses/c/6214/?q=safety+glasses&page=2","page":1,"per_page":36,"total_pages":null,"total_results":3000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zoro Search","description":"Search Zoro by keyword or category URL. Returns product cards with USD price, brand, Zoro number, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-zoro-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Zoro search or category URL. Empty, another host, or a product URL returns 400. A keyword builds /search?q=.... Each card has price as a USD number and price_display as the dollar string.\n\nKeyword\n\n```\nsafety glasses\n```\n\nSearch URL\n\n```\nhttps://www.zoro.com/search?q=safety+glasses\n```\n\nCategory URL\n\n```\nhttps://www.zoro.com/safety-glasses/c/6214/\n```","schema":{"type":"string","description":"Keyword, or a Zoro search or category URL. Empty, another host, or a product URL returns 400. A keyword builds /search?q=.... Each card has price as a USD number and price_display as the dollar string.\n\nKeyword\n\n```\nsafety glasses\n```\n\nSearch URL\n\n```\nhttps://www.zoro.com/search?q=safety+glasses\n```\n\nCategory URL\n\n```\nhttps://www.zoro.com/safety-glasses/c/6214/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1. Page 2 adds page=2, sets pagination.page to 2, and returns the next cards. pagination.next is the next page URL, or null on the last page. A value below 1 returns 400.","schema":{"type":"number","description":"Page number starting at 1. Omit it for page 1. Page 2 adds page=2, sets pagination.page to 2, and returns the next cards. pagination.next is the next page URL, or null on the last page. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"mfr_no":{"type":"string"},"rating":{"type":"number"},"zoro_no":{"type":"string"},"currency":{"type":"string"},"price_unit":{"type":"string"},"review_count":{"type":"integer"},"package_price":{"type":"number"},"price_display":{"type":"string"},"package_quantity":{"type":"integer"},"package_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"BearKat (BK1) safety glasses":{"value":{"results":[{"url":"https://www.zoro.com/mcr-safety-bearkat-bk1-safety-glasses-duramass-hard-coat-clear-lens-non-slip-temple-frameless-bk110/i/G2426514/","brand":"Mcr Safety","image":"https://www.zoro.com/static/cms/product/full/7e6737c8-0823-4e5f-9c53-2002b0476883.jpeg","price":1.39,"title":"BearKat (BK1), Safety Glasses, Duramass Hard Coat, Clear Lens, Non-Slip Temple, Frameless","mfr_no":"BK110","rating":4.86,"zoro_no":"G2426514","currency":"USD","price_unit":"ea","review_count":49,"package_price":16.68,"price_display":"$1.39","package_quantity":12,"package_price_display":"$16.68"}],"pagination":{"next":"https://www.zoro.com/safety-glasses/c/6214/?q=safety+glasses&page=2","page":1,"per_page":36,"total_pages":null,"total_results":3000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/shopify/catalog":{"get":{"summary":"Shopify Catalog","description":"List products from a Shopify shop. query is the shop domain or a URL on that shop. page and limit choose the slice.\n\n**Credit cost:** 1 credit per call","operationId":"get-shopify-catalog","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected.","schema":{"type":"string","description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null.","schema":{"type":"number","description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null."}},{"name":"limit","in":"query","required":false,"description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null.","schema":{"type":"number","description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"image":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"}}},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"}}}},"vendor":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"}}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"grams":{"type":"integer"},"price":{"type":"number"},"title":{"type":"string"},"option1":{"type":"string"},"option2":{"nullable":true},"option3":{"nullable":true},"available":{"type":"boolean"},"price_display":{"type":"string"},"compare_at_price":{"nullable":true},"compare_at_price_display":{"nullable":true}}}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Decathlon catalog, first product":{"value":{"results":[{"id":8209730371646,"url":"https://www.decathlon.com/products/men-s-hiking-jacket-mh500-brown","tags":["Down Jackets","FAMILY: 11413","GENDER: MEN'S","Men","Men's","MODEL: 8943726","NATURE_ID: 25032","New","OneProductMigration","PRODUCT_TYPE:   Padded Jacket","SPORT: mountain trekking","SUPER_MODEL: 362762"],"image":{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_61e4eded-7b52-4c7e-b922-fdfec444efd1.jpg?v=1793283479","width":969,"height":969,"position":1},"title":"Quechua Men’s MH500 Synthetic Puffer Jacket","handle":"men-s-hiking-jacket-mh500-brown","images":[{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_61e4eded-7b52-4c7e-b922-fdfec444efd1.jpg?v=1793283479","width":969,"height":969,"position":1},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_81cfeb13-15fb-4730-a3f1-cfb30cd8bf58.jpg?v=1793283479","width":969,"height":969,"position":2},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_3dd23a97-fcb7-4d04-bdb6-ca888c2d245a.jpg?v=1793283479","width":969,"height":969,"position":3},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_9e3d1445-c382-4f3e-8db8-7066695630c1.jpg?v=1793283479","width":969,"height":969,"position":4},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_d890c30c-dc0c-4ae1-b26a-51be87a45b90.jpg?v=1793283479","width":969,"height":969,"position":5},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_369047ee-4680-41dd-b28f-f9e0b613968e.jpg?v=1793283479","width":969,"height":969,"position":6},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_8767ccae-471e-49f1-a0ad-bdab8c5928a6.jpg?v=1793283479","width":969,"height":969,"position":7},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_17936e65-04e6-46ba-ac28-1eebd651dc03.jpg?v=1793283479","width":969,"height":969,"position":8}],"vendor":"Quechua","options":[{"name":"Size","values":["S","2XL","M","3XL","L","XL"],"position":1}],"variants":[{"id":43182120337470,"sku":"5544385","grams":440,"price":69.99,"title":"S","option1":"S","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43182140358718,"sku":"5544389","grams":548,"price":69.99,"title":"2XL","option1":"2XL","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43182160216126,"sku":"5544386","grams":456,"price":69.99,"title":"M","option1":"M","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43194906083390,"sku":"5544390","grams":564,"price":69.99,"title":"3XL","option1":"3XL","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43194907426878,"sku":"5544387","grams":472,"price":69.99,"title":"L","option1":"L","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43194910769214,"sku":"5544388","grams":502,"price":69.99,"title":"XL","option1":"XL","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null}],"created_at":"2026-08-10T07:57:16-07:00","updated_at":"2026-10-30T10:41:35-07:00","description":"When the temperature drops, this down jacket is your perfect companion, offering warmth, slim fit, a hood and ideal comfort for your excursions or everyday wear","product_type":"Padded Jacket","published_at":"2026-10-29T06:59:49-07:00"}],"pagination":{"next":"https://www.decathlon.com/products.json?limit=1&page=2","page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Shopify Catalog","description":"List products from a Shopify shop. query is the shop domain or a URL on that shop. page and limit choose the slice.\n\n**Credit cost:** 1 credit per call","operationId":"post-shopify-catalog","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected.","schema":{"type":"string","description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null.","schema":{"type":"number","description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null."}},{"name":"limit","in":"query","required":false,"description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null.","schema":{"type":"number","description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"image":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"}}},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"}}}},"vendor":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"}}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"grams":{"type":"integer"},"price":{"type":"number"},"title":{"type":"string"},"option1":{"type":"string"},"option2":{"nullable":true},"option3":{"nullable":true},"available":{"type":"boolean"},"price_display":{"type":"string"},"compare_at_price":{"nullable":true},"compare_at_price_display":{"nullable":true}}}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Decathlon catalog, first product":{"value":{"results":[{"id":8209730371646,"url":"https://www.decathlon.com/products/men-s-hiking-jacket-mh500-brown","tags":["Down Jackets","FAMILY: 11413","GENDER: MEN'S","Men","Men's","MODEL: 8943726","NATURE_ID: 25032","New","OneProductMigration","PRODUCT_TYPE:   Padded Jacket","SPORT: mountain trekking","SUPER_MODEL: 362762"],"image":{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_61e4eded-7b52-4c7e-b922-fdfec444efd1.jpg?v=1793283479","width":969,"height":969,"position":1},"title":"Quechua Men’s MH500 Synthetic Puffer Jacket","handle":"men-s-hiking-jacket-mh500-brown","images":[{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_61e4eded-7b52-4c7e-b922-fdfec444efd1.jpg?v=1793283479","width":969,"height":969,"position":1},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_81cfeb13-15fb-4730-a3f1-cfb30cd8bf58.jpg?v=1793283479","width":969,"height":969,"position":2},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_3dd23a97-fcb7-4d04-bdb6-ca888c2d245a.jpg?v=1793283479","width":969,"height":969,"position":3},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_9e3d1445-c382-4f3e-8db8-7066695630c1.jpg?v=1793283479","width":969,"height":969,"position":4},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_d890c30c-dc0c-4ae1-b26a-51be87a45b90.jpg?v=1793283479","width":969,"height":969,"position":5},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_369047ee-4680-41dd-b28f-f9e0b613968e.jpg?v=1793283479","width":969,"height":969,"position":6},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_8767ccae-471e-49f1-a0ad-bdab8c5928a6.jpg?v=1793283479","width":969,"height":969,"position":7},{"alt":null,"src":"https://cdn.shopify.com/s/files/1/1330/6287/files/default_17936e65-04e6-46ba-ac28-1eebd651dc03.jpg?v=1793283479","width":969,"height":969,"position":8}],"vendor":"Quechua","options":[{"name":"Size","values":["S","2XL","M","3XL","L","XL"],"position":1}],"variants":[{"id":43182120337470,"sku":"5544385","grams":440,"price":69.99,"title":"S","option1":"S","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43182140358718,"sku":"5544389","grams":548,"price":69.99,"title":"2XL","option1":"2XL","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43182160216126,"sku":"5544386","grams":456,"price":69.99,"title":"M","option1":"M","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43194906083390,"sku":"5544390","grams":564,"price":69.99,"title":"3XL","option1":"3XL","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43194907426878,"sku":"5544387","grams":472,"price":69.99,"title":"L","option1":"L","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null},{"id":43194910769214,"sku":"5544388","grams":502,"price":69.99,"title":"XL","option1":"XL","option2":null,"option3":null,"available":true,"price_display":"69.99","compare_at_price":null,"compare_at_price_display":null}],"created_at":"2026-08-10T07:57:16-07:00","updated_at":"2026-10-30T10:41:35-07:00","description":"When the temperature drops, this down jacket is your perfect companion, offering warmth, slim fit, a hood and ideal comfort for your excursions or everyday wear","product_type":"Padded Jacket","published_at":"2026-10-29T06:59:49-07:00"}],"pagination":{"next":"https://www.decathlon.com/products.json?limit=1&page=2","page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/shopify/collections":{"get":{"summary":"Shopify Collections","description":"List collections from a Shopify shop. query is the shop domain or a URL on that shop. page and limit choose the slice.\n\n**Credit cost:** 1 credit per call","operationId":"get-shopify-collections","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected.","schema":{"type":"string","description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null.","schema":{"type":"number","description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null."}},{"name":"limit","in":"query","required":false,"description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null.","schema":{"type":"number","description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"image":{"nullable":true},"title":{"type":"string"},"handle":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"products_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Decathlon collections, first collection":{"value":{"results":[{"id":261040504894,"url":"https://www.decathlon.com/collections/camping-tents-2-3-person","image":null,"title":"2-Person Tents","handle":"camping-tents-2-3-person","updated_at":"2026-10-29T04:06:55-07:00","description":"<h2><span>The perfect 2-person tent for camping</span></h2>\n<p dir=\"ltr\"><span>Embark on your next outdoor adventure with a Decathlon 2-person tent that’s tailored for comfort and practicality. Lightweight and easy to carry, these tents ensure a hassle-free experience for creating lasting memories in a cozy space.</span></p>\n<h2 dir=\"ltr\"><span>Versatility for every journey</span></h2>\n<p dir=\"ltr\"><span>Our 2-person camping tents feature top-notch insulation, ventilation, and waterproofing. Ideal for any adventure, these small but comfortable tents offer reliable protection and performance. Find the perfect tent for your outdoor excursions, and explore our </span><a href=\"https://www.decathlon.com/collections/3-person-camping-tents\"><span>3-person tents</span></a><span> if you need more space.</span></p>\n<h2 dir=\"ltr\"><span>Portability and practicality</span></h2>\n<p dir=\"ltr\"><span>Travel effortlessly with Decathlon’s 2-person tents. They’re lightweight, compact, easy to store, and quick to set up. Perfect for any trip intensity, these tents are made from durable performance materials. Pair our tents with camping mattresses and other </span><a href=\"https://www.decathlon.com/collections/tent-accessories\"><span>accessories</span></a><span> for an optimal camping experience.</span></p>\n<h2 dir=\"ltr\"><span>Innovative cooling and insulating features</span></h2>\n<p dir=\"ltr\"><span>Stay comfortable with advanced ventilation and insulation technologies, featuring a flysheet and effective ventilation that keeps the interior cool and dark. Browse our sleeping bags and easy-to-transport </span><a href=\"https://www.decathlon.com/collections/blackout-tents\"><span>blackout camping tents</span></a><span> for additional comfort in various climates.</span></p>\n<h2 dir=\"ltr\"><span>Robust windproofing and waterproofing</span></h2>\n<p dir=\"ltr\"><span>Our 2-person camping tents are built to endure adverse weather, including rain and strong winds. For extra comfort, explore our inflatable camping pillows to enhance your camping setup. Their lightweight design lets you easily carry them without compromising your performance.</span></p>\n<h2 dir=\"ltr\"><span>Decathlon: Your go-to for outdoor gear</span></h2>\n<p>Decathlon provides everything needed for unforgettable outdoor adventures. With our durable <a href=\"https://www.decathlon.com/collections/camping-tents\">camping tents</a> and extensive range of camping gear, you’ll be prepared for any environment. Discover our collection and embark on your next incredible nature experience.</p>\n<!---->","published_at":"2021-04-15T12:37:52-07:00","products_count":2}],"pagination":{"next":"https://www.decathlon.com/collections.json?limit=1&page=2","page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Shopify Collections","description":"List collections from a Shopify shop. query is the shop domain or a URL on that shop. page and limit choose the slice.\n\n**Credit cost:** 1 credit per call","operationId":"post-shopify-collections","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected.","schema":{"type":"string","description":"Shop domain or a URL on that shop.\n\n**Example:**\n\n    https://www.decathlon.com\n\n**Notes:**\n- `decathlon.com`, `https://www.decathlon.com`, and a product or collection link on that host all select the same shop.\n- `page` starts at 1. Omit it to read the first page.\n- `limit` is the page size. Default 30. Maximum 250.\n- `shopify.com` and `apps.shopify.com` are rejected."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null.","schema":{"type":"number","description":"Page number, starting at 1.\n\n**Example:**\n\n    2\n\n**Notes:**\n- Omit `page` to read page 1.\n- `page=2` returns the next slice of the same `limit`.\n- The shop does not publish a total, so keep following `pagination.next` until it is null."}},{"name":"limit","in":"query","required":false,"description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null.","schema":{"type":"number","description":"How many items to return on this page.\n\n**Example:**\n\n    30\n\n**Notes:**\n- Default is 30 when `limit` is omitted.\n- Maximum is 250.\n- When the page contains `limit` items, `pagination.next` is the next shop JSON URL.\n- When the page is shorter, `pagination.next` is null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"image":{"nullable":true},"title":{"type":"string"},"handle":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"products_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Decathlon collections, first collection":{"value":{"results":[{"id":261040504894,"url":"https://www.decathlon.com/collections/camping-tents-2-3-person","image":null,"title":"2-Person Tents","handle":"camping-tents-2-3-person","updated_at":"2026-10-29T04:06:55-07:00","description":"<h2><span>The perfect 2-person tent for camping</span></h2>\n<p dir=\"ltr\"><span>Embark on your next outdoor adventure with a Decathlon 2-person tent that’s tailored for comfort and practicality. Lightweight and easy to carry, these tents ensure a hassle-free experience for creating lasting memories in a cozy space.</span></p>\n<h2 dir=\"ltr\"><span>Versatility for every journey</span></h2>\n<p dir=\"ltr\"><span>Our 2-person camping tents feature top-notch insulation, ventilation, and waterproofing. Ideal for any adventure, these small but comfortable tents offer reliable protection and performance. Find the perfect tent for your outdoor excursions, and explore our </span><a href=\"https://www.decathlon.com/collections/3-person-camping-tents\"><span>3-person tents</span></a><span> if you need more space.</span></p>\n<h2 dir=\"ltr\"><span>Portability and practicality</span></h2>\n<p dir=\"ltr\"><span>Travel effortlessly with Decathlon’s 2-person tents. They’re lightweight, compact, easy to store, and quick to set up. Perfect for any trip intensity, these tents are made from durable performance materials. Pair our tents with camping mattresses and other </span><a href=\"https://www.decathlon.com/collections/tent-accessories\"><span>accessories</span></a><span> for an optimal camping experience.</span></p>\n<h2 dir=\"ltr\"><span>Innovative cooling and insulating features</span></h2>\n<p dir=\"ltr\"><span>Stay comfortable with advanced ventilation and insulation technologies, featuring a flysheet and effective ventilation that keeps the interior cool and dark. Browse our sleeping bags and easy-to-transport </span><a href=\"https://www.decathlon.com/collections/blackout-tents\"><span>blackout camping tents</span></a><span> for additional comfort in various climates.</span></p>\n<h2 dir=\"ltr\"><span>Robust windproofing and waterproofing</span></h2>\n<p dir=\"ltr\"><span>Our 2-person camping tents are built to endure adverse weather, including rain and strong winds. For extra comfort, explore our inflatable camping pillows to enhance your camping setup. Their lightweight design lets you easily carry them without compromising your performance.</span></p>\n<h2 dir=\"ltr\"><span>Decathlon: Your go-to for outdoor gear</span></h2>\n<p>Decathlon provides everything needed for unforgettable outdoor adventures. With our durable <a href=\"https://www.decathlon.com/collections/camping-tents\">camping tents</a> and extensive range of camping gear, you’ll be prepared for any environment. Discover our collection and embark on your next incredible nature experience.</p>\n<!---->","published_at":"2021-04-15T12:37:52-07:00","products_count":2}],"pagination":{"next":"https://www.decathlon.com/collections.json?limit=1&page=2","page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fashionphile/product":{"get":{"summary":"Fashionphile Product","description":"Load one Fashionphile product from a handle or a product URL. Keywords and search URLs belong on the search endpoint.\n\n**Credit cost:** 1 credit per call","operationId":"get-fashionphile-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product handle or a fashionphile.com product URL. The request reads products/{handle}.js and returns one flat product. price is the USD amount and price_display is that amount rebuilt as a dollar string.\n\nHandle\n\n```\nceline-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nProduct URL\n\n```\nhttps://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nA keyword, search URL, collection URL, or products.json returns 400.","schema":{"type":"string","description":"Product handle or a fashionphile.com product URL. The request reads products/{handle}.js and returns one flat product. price is the USD amount and price_display is that amount rebuilt as a dollar string.\n\nHandle\n\n```\nceline-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nProduct URL\n\n```\nhttps://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nA keyword, search URL, collection URL, or products.json returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces the product object with result, the raw Shopify JSON text.","schema":{"type":"boolean","description":"Default false. true replaces the product object with result, the raw Shopify JSON text."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"price":{"type":"integer"},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}}},"vendor":{"type":"string"},"barcode":{"type":"string"},"currency":{"type":"string"},"available":{"type":"boolean"},"created_at":{"type":"string"},"description":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Celine Supple Shiny Lambskin Little New Luggage Black":{"value":{"id":16185286066479,"sku":"1978804","url":"https://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804","tags":["amazon-market-template","Editor's Picks","Quiet Luxury","Shop All Gifts","tiktok-market-template-shoulder-bags","updated-1793357078","US"],"price":2095,"title":"Supple Shiny Lambskin Little New Luggage Black","handle":"celine-supple-shiny-lambskin-little-new-luggage-black-1978804","images":[{"url":"https://cdn.shopify.com/s/files/1/0894/3186/7695/files/4d8ef446e96a2ae61bde572ba8d24150.jpg?v=1790192118","width":1500,"height":1500}],"vendor":"Celine","barcode":"000019788043","currency":"USD","available":true,"created_at":"2026-09-23T12:35:13-07:00","description":"This is an authentic CELINE Supple Shiny Lambskin Little New Luggage in Black. This chic tote offers a new take on the iconic luggage handbag style, crafted of luxurious lambskin leather within a structured and spacious silhouette in black.","product_type":"Bags","published_at":"2026-09-23T12:35:17-07:00","price_display":"$2,095.00"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fashionphile Product","description":"Load one Fashionphile product from a handle or a product URL. Keywords and search URLs belong on the search endpoint.\n\n**Credit cost:** 1 credit per call","operationId":"post-fashionphile-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product handle or a fashionphile.com product URL. The request reads products/{handle}.js and returns one flat product. price is the USD amount and price_display is that amount rebuilt as a dollar string.\n\nHandle\n\n```\nceline-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nProduct URL\n\n```\nhttps://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nA keyword, search URL, collection URL, or products.json returns 400.","schema":{"type":"string","description":"Product handle or a fashionphile.com product URL. The request reads products/{handle}.js and returns one flat product. price is the USD amount and price_display is that amount rebuilt as a dollar string.\n\nHandle\n\n```\nceline-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nProduct URL\n\n```\nhttps://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804\n```\n\nA keyword, search URL, collection URL, or products.json returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces the product object with result, the raw Shopify JSON text.","schema":{"type":"boolean","description":"Default false. true replaces the product object with result, the raw Shopify JSON text."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"price":{"type":"integer"},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}}},"vendor":{"type":"string"},"barcode":{"type":"string"},"currency":{"type":"string"},"available":{"type":"boolean"},"created_at":{"type":"string"},"description":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Celine Supple Shiny Lambskin Little New Luggage Black":{"value":{"id":16185286066479,"sku":"1978804","url":"https://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804","tags":["amazon-market-template","Editor's Picks","Quiet Luxury","Shop All Gifts","tiktok-market-template-shoulder-bags","updated-1793357078","US"],"price":2095,"title":"Supple Shiny Lambskin Little New Luggage Black","handle":"celine-supple-shiny-lambskin-little-new-luggage-black-1978804","images":[{"url":"https://cdn.shopify.com/s/files/1/0894/3186/7695/files/4d8ef446e96a2ae61bde572ba8d24150.jpg?v=1790192118","width":1500,"height":1500}],"vendor":"Celine","barcode":"000019788043","currency":"USD","available":true,"created_at":"2026-09-23T12:35:13-07:00","description":"This is an authentic CELINE Supple Shiny Lambskin Little New Luggage in Black. This chic tote offers a new take on the iconic luggage handbag style, crafted of luxurious lambskin leather within a structured and spacious silhouette in black.","product_type":"Bags","published_at":"2026-09-23T12:35:17-07:00","price_display":"$2,095.00"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fashionphile/search":{"get":{"summary":"Fashionphile Search","description":"Search Fashionphile by keywords, a search URL, a collection URL, or a products.json URL. A product handle or product URL belongs on the product endpoint.\n\n**Credit cost:** 1 credit per call","operationId":"get-fashionphile-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keywords, a Fashionphile search URL, a collection URL, or a products.json URL. Empty returns 400.\n\nKeyword. Calls search/suggest.json. Up to 10 products, pagination.per_page is 10, and pagination.next is null.\n\n```\nceline\n```\n\nCollection. 30 products per page. page selects the slice, and pagination.next is the next catalog URL when the page is full.\n\n```\nhttps://www.fashionphile.com/collections/handbags\n```\n\nFull catalog.\n\n```\nhttps://www.fashionphile.com/products.json\n```\n\nA product handle or product URL returns 400. Use /v2/fashionphile/product.","schema":{"type":"string","description":"Keywords, a Fashionphile search URL, a collection URL, or a products.json URL. Empty returns 400.\n\nKeyword. Calls search/suggest.json. Up to 10 products, pagination.per_page is 10, and pagination.next is null.\n\n```\nceline\n```\n\nCollection. 30 products per page. page selects the slice, and pagination.next is the next catalog URL when the page is full.\n\n```\nhttps://www.fashionphile.com/collections/handbags\n```\n\nFull catalog.\n\n```\nhttps://www.fashionphile.com/products.json\n```\n\nA product handle or product URL returns 400. Use /v2/fashionphile/product."}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1.\n\nOn a keyword search, only page 1 returns products. Page 2 and above return 404, and pagination.next stays null.\n\nOn a collection or products.json URL, page sets pagination.page and which 30-product slice comes back. A value below 1 returns 400.","schema":{"type":"number","description":"Page number starting at 1. Omit it for page 1.\n\nOn a keyword search, only page 1 returns products. Page 2 and above return 404, and pagination.next stays null.\n\nOn a collection or products.json URL, page sets pagination.page and which 30-product slice comes back. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the raw Shopify JSON text.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the raw Shopify JSON text."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"handle":{"type":"string"},"vendor":{"type":"string"},"currency":{"type":"string"},"available":{"type":"boolean"},"product_type":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Celine Supple Shiny Lambskin Little New Luggage Black":{"value":{"results":[{"id":16185286066479,"url":"https://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804","tags":["amazon-market-template","Editor's Picks","Quiet Luxury","Shop All Gifts","tiktok-market-template-shoulder-bags","updated-1793357078","US"],"image":"https://cdn.shopify.com/s/files/1/0894/3186/7695/files/4d8ef446e96a2ae61bde572ba8d24150.jpg?v=1790192118","price":2095,"title":"Supple Shiny Lambskin Little New Luggage Black","handle":"celine-supple-shiny-lambskin-little-new-luggage-black-1978804","vendor":"Celine","currency":"USD","available":true,"product_type":"Bags","price_display":"$2,095.00"}],"pagination":{"next":null,"page":1,"per_page":10,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fashionphile Search","description":"Search Fashionphile by keywords, a search URL, a collection URL, or a products.json URL. A product handle or product URL belongs on the product endpoint.\n\n**Credit cost:** 1 credit per call","operationId":"post-fashionphile-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keywords, a Fashionphile search URL, a collection URL, or a products.json URL. Empty returns 400.\n\nKeyword. Calls search/suggest.json. Up to 10 products, pagination.per_page is 10, and pagination.next is null.\n\n```\nceline\n```\n\nCollection. 30 products per page. page selects the slice, and pagination.next is the next catalog URL when the page is full.\n\n```\nhttps://www.fashionphile.com/collections/handbags\n```\n\nFull catalog.\n\n```\nhttps://www.fashionphile.com/products.json\n```\n\nA product handle or product URL returns 400. Use /v2/fashionphile/product.","schema":{"type":"string","description":"Keywords, a Fashionphile search URL, a collection URL, or a products.json URL. Empty returns 400.\n\nKeyword. Calls search/suggest.json. Up to 10 products, pagination.per_page is 10, and pagination.next is null.\n\n```\nceline\n```\n\nCollection. 30 products per page. page selects the slice, and pagination.next is the next catalog URL when the page is full.\n\n```\nhttps://www.fashionphile.com/collections/handbags\n```\n\nFull catalog.\n\n```\nhttps://www.fashionphile.com/products.json\n```\n\nA product handle or product URL returns 400. Use /v2/fashionphile/product."}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1.\n\nOn a keyword search, only page 1 returns products. Page 2 and above return 404, and pagination.next stays null.\n\nOn a collection or products.json URL, page sets pagination.page and which 30-product slice comes back. A value below 1 returns 400.","schema":{"type":"number","description":"Page number starting at 1. Omit it for page 1.\n\nOn a keyword search, only page 1 returns products. Page 2 and above return 404, and pagination.next stays null.\n\nOn a collection or products.json URL, page sets pagination.page and which 30-product slice comes back. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the raw Shopify JSON text.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the raw Shopify JSON text."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"handle":{"type":"string"},"vendor":{"type":"string"},"currency":{"type":"string"},"available":{"type":"boolean"},"product_type":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Celine Supple Shiny Lambskin Little New Luggage Black":{"value":{"results":[{"id":16185286066479,"url":"https://www.fashionphile.com/products/celine-supple-shiny-lambskin-little-new-luggage-black-1978804","tags":["amazon-market-template","Editor's Picks","Quiet Luxury","Shop All Gifts","tiktok-market-template-shoulder-bags","updated-1793357078","US"],"image":"https://cdn.shopify.com/s/files/1/0894/3186/7695/files/4d8ef446e96a2ae61bde572ba8d24150.jpg?v=1790192118","price":2095,"title":"Supple Shiny Lambskin Little New Luggage Black","handle":"celine-supple-shiny-lambskin-little-new-luggage-black-1978804","vendor":"Celine","currency":"USD","available":true,"product_type":"Bags","price_display":"$2,095.00"}],"pagination":{"next":null,"page":1,"per_page":10,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/idealista/provinces":{"get":{"summary":"Idealista Provinces","description":"List the 50 Spanish provinces Idealista shows for homes for sale. Each row includes the sale search URL to pass as query to Idealista Search. Madrid is madrid-provincia.\n\n**Credit cost:** 3 credits per call","operationId":"get-idealista-provinces","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"region":{"type":"string"},"listing_count":{"type":"integer"}}}}}},"examples":{"Madrid province":{"value":{"results":[{"url":"https://www.idealista.com/venta-viviendas/madrid-provincia/","name":"Madrid","slug":"madrid-provincia","region":"Comunidad de Madrid","listing_count":34094}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Idealista Provinces","description":"List the 50 Spanish provinces Idealista shows for homes for sale. Each row includes the sale search URL to pass as query to Idealista Search. Madrid is madrid-provincia.\n\n**Credit cost:** 3 credits per call","operationId":"post-idealista-provinces","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"region":{"type":"string"},"listing_count":{"type":"integer"}}}}}},"examples":{"Madrid province":{"value":{"results":[{"url":"https://www.idealista.com/venta-viviendas/madrid-provincia/","name":"Madrid","slug":"madrid-provincia","region":"Comunidad de Madrid","listing_count":34094}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/imoveisweb/property":{"get":{"summary":"ImoveisWeb Property","description":"Read one Imobiliária Aquários listing from its imoveisweb.com.br URL. price_display is rebuilt from the asking amount.\n\n**Credit cost:** 1 credit per call","operationId":"get-imoveisweb-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Listing URL from search.\n\n**Example:**\n\n    https://www.imoveisweb.com.br/imoveis/casas/3151/\n\n**JSON:** one flat object. id is the listing code. A catalog URL such as casas.htm returns 400.","schema":{"type":"string","description":"Listing URL from search.\n\n**Example:**\n\n    https://www.imoveisweb.com.br/imoveis/casas/3151/\n\n**JSON:** one flat object. id is the listing code. A catalog URL such as casas.htm returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"locality":{"type":"string"},"operation":{"type":"string"},"description":{"type":"string"},"area_display":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"}}},"examples":{"Chacara 766, Extrema":{"value":{"id":"766","url":"https://www.imoveisweb.com.br/imoveis/chacaras/766/","area":4000,"city":"Extrema","image":"https://www.imoveisweb.com.br/imoveis/chacaras/766/01.jpg","price":2100000,"state":"MG","title":"Grande oportunidade! 4.000,00 m² em perímetro urbano, excelente para investidor construir condomínio vertical ou horizontal (casas ou apartamentos), galpão ou...","images":["https://www.imoveisweb.com.br/imoveis/chacaras/766/01.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/02.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/03.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/04.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/05.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/06.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/07.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/08.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/09.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/10.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/11.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/12.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/13.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/14.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/15.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/16.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/17.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/18.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/19.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/20.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/21.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/22.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/23.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/24.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/25.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/26.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/27.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/28.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/29.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/30.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/31.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/32.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/33.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/34.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/35.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/36.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/37.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/38.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/39.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/40.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/41.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/42.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/43.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/44.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/45.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/46.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/47.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/48.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/49.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/50.jpg"],"currency":"BRL","locality":"Extrema - MG","operation":"venda","description":"Grande oportunidade! 4.000,00 m² em perímetro urbano, excelente para investidor construir condomínio vertical ou horizontal (casas ou apartamentos), galpão ou uma bela chácara para morar, próximo ao centro, prefeitura, bairro em crescimento, imóvel todo murado, com casa sede ampla, contendo 2 dormitórios, 1 suíte, sala de jantar, sala visita, cozinha, área gourmet com churrasqueira e cozinha, piscina, churrasqueira, casa de empregado, pomar, toda gramada.","area_display":"4.000 m²","price_display":"R$ 2.100.000","property_type":"chacaras"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ImoveisWeb Property","description":"Read one Imobiliária Aquários listing from its imoveisweb.com.br URL. price_display is rebuilt from the asking amount.\n\n**Credit cost:** 1 credit per call","operationId":"post-imoveisweb-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Listing URL from search.\n\n**Example:**\n\n    https://www.imoveisweb.com.br/imoveis/casas/3151/\n\n**JSON:** one flat object. id is the listing code. A catalog URL such as casas.htm returns 400.","schema":{"type":"string","description":"Listing URL from search.\n\n**Example:**\n\n    https://www.imoveisweb.com.br/imoveis/casas/3151/\n\n**JSON:** one flat object. id is the listing code. A catalog URL such as casas.htm returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"locality":{"type":"string"},"operation":{"type":"string"},"description":{"type":"string"},"area_display":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"}}},"examples":{"Chacara 766, Extrema":{"value":{"id":"766","url":"https://www.imoveisweb.com.br/imoveis/chacaras/766/","area":4000,"city":"Extrema","image":"https://www.imoveisweb.com.br/imoveis/chacaras/766/01.jpg","price":2100000,"state":"MG","title":"Grande oportunidade! 4.000,00 m² em perímetro urbano, excelente para investidor construir condomínio vertical ou horizontal (casas ou apartamentos), galpão ou...","images":["https://www.imoveisweb.com.br/imoveis/chacaras/766/01.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/02.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/03.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/04.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/05.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/06.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/07.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/08.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/09.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/10.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/11.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/12.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/13.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/14.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/15.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/16.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/17.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/18.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/19.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/20.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/21.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/22.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/23.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/24.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/25.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/26.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/27.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/28.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/29.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/30.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/31.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/32.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/33.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/34.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/35.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/36.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/37.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/38.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/39.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/40.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/41.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/42.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/43.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/44.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/45.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/46.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/47.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/48.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/49.jpg","https://www.imoveisweb.com.br/imoveis/chacaras/766/50.jpg"],"currency":"BRL","locality":"Extrema - MG","operation":"venda","description":"Grande oportunidade! 4.000,00 m² em perímetro urbano, excelente para investidor construir condomínio vertical ou horizontal (casas ou apartamentos), galpão ou uma bela chácara para morar, próximo ao centro, prefeitura, bairro em crescimento, imóvel todo murado, com casa sede ampla, contendo 2 dormitórios, 1 suíte, sala de jantar, sala visita, cozinha, área gourmet com churrasqueira e cozinha, piscina, churrasqueira, casa de empregado, pomar, toda gramada.","area_display":"4.000 m²","price_display":"R$ 2.100.000","property_type":"chacaras"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/imoveisweb/search":{"get":{"summary":"ImoveisWeb Search","description":"Search the Imobiliária Aquários catalog on imoveisweb.com.br. Pass a catalog name such as casas. price_display is rebuilt from the asking amount.\n\n**Credit cost:** 1 credit per call","operationId":"get-imoveisweb-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Catalog name or an ImoveisWeb results URL. This is Imobiliária Aquários, not ZonaProp.\n\n**Example:**\n\n    casas\n\n**Allowed:** apartamentos, casas, lotes, chacaras, sitios, fazendas, terrenos, locacao. Accents are optional. rent and aluguel mean locacao.\n\n**JSON:** casas sets property_type to casas and operation to venda. locacao sets operation to locacao. A property URL returns 400. A bare place name such as extrema returns 400.","schema":{"type":"string","description":"Catalog name or an ImoveisWeb results URL. This is Imobiliária Aquários, not ZonaProp.\n\n**Example:**\n\n    casas\n\n**Allowed:** apartamentos, casas, lotes, chacaras, sitios, fazendas, terrenos, locacao. Accents are optional. rent and aluguel mean locacao.\n\n**JSON:** casas sets property_type to casas and operation to venda. locacao sets operation to locacao. A property URL returns 400. A bare place name such as extrema returns 400."}},{"name":"property_type","in":"query","required":false,"description":"Optional catalog when query is not already a catalog name.\n\n**Allowed:** the same names as query.\n\n**JSON:** sets results[].property_type. operation is locacao only for the rental catalog, otherwise venda. If both query and property_type name a catalog and they differ, the call returns 400.","schema":{"type":"string","description":"Optional catalog when query is not already a catalog name.\n\n**Allowed:** the same names as query.\n\n**JSON:** sets results[].property_type. operation is locacao only for the rental catalog, otherwise venda. If both query and property_type name a catalog and they differ, the call returns 400."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1, which requests casas.htm and sets pagination.page to 1.\n\n**JSON:** page 2 requests casas_02.htm. pagination.next is the next catalog URL, or null. On a paged catalog with an ellipsis, total_results and total_pages are null. per_page is the card count on that page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1, which requests casas.htm and sets pagination.page to 1.\n\n**JSON:** page 2 requests casas_02.htm. pagination.next is the next catalog URL, or null. On a paged catalog with an ellipsis, total_results and total_pages are null. per_page is the card count on that page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"currency":{"type":"string"},"locality":{"type":"string"},"operation":{"type":"string"},"description":{"type":"string"},"area_display":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Casas page 1, code 3151, Extrema":{"value":{"results":[{"id":"3151","url":"https://www.imoveisweb.com.br/imoveis/casas/3151/","area":534,"city":"Extrema","image":"https://www.imoveisweb.com.br/imoveis/casas/3151/destaque.jpg","price":450000,"state":"MG","title":"Casa próximo aos Bombeiros, contendo ponto comercial com 2 portas de aço e banheiro, 2 dormitórios, sala, cozinha, banheiro, lavanderia e quintal.","currency":"BRL","locality":"Extrema - MG","operation":"venda","description":"Casa próximo aos Bombeiros, contendo ponto comercial com 2 portas de aço e banheiro, 2 dormitórios, sala, cozinha, banheiro, lavanderia e quintal.","area_display":"534 m²","price_display":"R$ 450.000","property_type":"casas"}],"pagination":{"next":"https://www.imoveisweb.com.br/casas_02.htm","page":1,"per_page":79,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ImoveisWeb Search","description":"Search the Imobiliária Aquários catalog on imoveisweb.com.br. Pass a catalog name such as casas. price_display is rebuilt from the asking amount.\n\n**Credit cost:** 1 credit per call","operationId":"post-imoveisweb-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Catalog name or an ImoveisWeb results URL. This is Imobiliária Aquários, not ZonaProp.\n\n**Example:**\n\n    casas\n\n**Allowed:** apartamentos, casas, lotes, chacaras, sitios, fazendas, terrenos, locacao. Accents are optional. rent and aluguel mean locacao.\n\n**JSON:** casas sets property_type to casas and operation to venda. locacao sets operation to locacao. A property URL returns 400. A bare place name such as extrema returns 400.","schema":{"type":"string","description":"Catalog name or an ImoveisWeb results URL. This is Imobiliária Aquários, not ZonaProp.\n\n**Example:**\n\n    casas\n\n**Allowed:** apartamentos, casas, lotes, chacaras, sitios, fazendas, terrenos, locacao. Accents are optional. rent and aluguel mean locacao.\n\n**JSON:** casas sets property_type to casas and operation to venda. locacao sets operation to locacao. A property URL returns 400. A bare place name such as extrema returns 400."}},{"name":"property_type","in":"query","required":false,"description":"Optional catalog when query is not already a catalog name.\n\n**Allowed:** the same names as query.\n\n**JSON:** sets results[].property_type. operation is locacao only for the rental catalog, otherwise venda. If both query and property_type name a catalog and they differ, the call returns 400.","schema":{"type":"string","description":"Optional catalog when query is not already a catalog name.\n\n**Allowed:** the same names as query.\n\n**JSON:** sets results[].property_type. operation is locacao only for the rental catalog, otherwise venda. If both query and property_type name a catalog and they differ, the call returns 400."}},{"name":"page","in":"query","required":false,"description":"Page from 1.\n\n**Default:** 1, which requests casas.htm and sets pagination.page to 1.\n\n**JSON:** page 2 requests casas_02.htm. pagination.next is the next catalog URL, or null. On a paged catalog with an ellipsis, total_results and total_pages are null. per_page is the card count on that page.","schema":{"type":"number","default":"1","description":"Page from 1.\n\n**Default:** 1, which requests casas.htm and sets pagination.page to 1.\n\n**JSON:** page 2 requests casas_02.htm. pagination.next is the next catalog URL, or null. On a paged catalog with an ellipsis, total_results and total_pages are null. per_page is the card count on that page."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"currency":{"type":"string"},"locality":{"type":"string"},"operation":{"type":"string"},"description":{"type":"string"},"area_display":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Casas page 1, code 3151, Extrema":{"value":{"results":[{"id":"3151","url":"https://www.imoveisweb.com.br/imoveis/casas/3151/","area":534,"city":"Extrema","image":"https://www.imoveisweb.com.br/imoveis/casas/3151/destaque.jpg","price":450000,"state":"MG","title":"Casa próximo aos Bombeiros, contendo ponto comercial com 2 portas de aço e banheiro, 2 dormitórios, sala, cozinha, banheiro, lavanderia e quintal.","currency":"BRL","locality":"Extrema - MG","operation":"venda","description":"Casa próximo aos Bombeiros, contendo ponto comercial com 2 portas de aço e banheiro, 2 dormitórios, sala, cozinha, banheiro, lavanderia e quintal.","area_display":"534 m²","price_display":"R$ 450.000","property_type":"casas"}],"pagination":{"next":"https://www.imoveisweb.com.br/casas_02.htm","page":1,"per_page":79,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aliexpress/product/reviews":{"get":{"summary":"AliExpress Reviews","description":"AliExpress Reviews API: list buyer reviews for a product id or item URL. Each review includes author, star rating, text, date, and photos when the buyer attached them.\n\n**Credit cost:** 1 credit per call","operationId":"get-aliexpress-product-reviews","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"AliExpress product id or item URL.\n\n**Example (product id):**\n\n    1005001388303149\n\n**Example (item URL):**\n\n    https://www.aliexpress.com/item/1005001388303149.html\n\n**Notes:**\n- A numeric product id and a `/item/{id}.html` URL are both accepted.\n- Locale subdomains work (`es.`, `fr.`, `de.`, ...).\n- A feedback URL that already contains `productId` is accepted. If that URL includes `page` and you leave `page` at 1, the URL page is used.\n- Other domains return 400.","schema":{"type":"string","description":"AliExpress product id or item URL.\n\n**Example (product id):**\n\n    1005001388303149\n\n**Example (item URL):**\n\n    https://www.aliexpress.com/item/1005001388303149.html\n\n**Notes:**\n- A numeric product id and a `/item/{id}.html` URL are both accepted.\n- Locale subdomains work (`es.`, `fr.`, `de.`, ...).\n- A feedback URL that already contains `productId` is accepted. If that URL includes `page` and you leave `page` at 1, the URL page is used.\n- Other domains return 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Defaults to 1. The feed returns up to 20 reviews per page. `pagination.next` is the next page URL, or null on the last page.","schema":{"type":"number","description":"Page number, starting at 1. Defaults to 1. The feed returns up to 20 reviews per page. `pagination.next` is the next page URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw feed body as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw feed body as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"text":{"type":"string"},"author":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Buyer review for product 1005001388303149":{"value":{"results":[{"date":"27 Feb 2026","text":"очень понравился ребенку! пришел быстрее, чем ожидали, все работает, не очень шумный. рекомендую👍","author":"Б***а","images":["https://ae-pic-a1.aliexpress-media.com/kf/A23a05703ab0b4c5ea4a69b008c4da67fw.jpg"],"rating":5}],"pagination":{"next":"https://feedback.aliexpress.com/pc/searchEvaluation.do?productId=1005001388303149&lang=en_US&country=US&page=2&pageSize=20&filter=all&sort=complex_default","page":1,"per_page":20,"total_pages":2,"total_results":26}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"AliExpress Reviews","description":"AliExpress Reviews API: list buyer reviews for a product id or item URL. Each review includes author, star rating, text, date, and photos when the buyer attached them.\n\n**Credit cost:** 1 credit per call","operationId":"post-aliexpress-product-reviews","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"AliExpress product id or item URL.\n\n**Example (product id):**\n\n    1005001388303149\n\n**Example (item URL):**\n\n    https://www.aliexpress.com/item/1005001388303149.html\n\n**Notes:**\n- A numeric product id and a `/item/{id}.html` URL are both accepted.\n- Locale subdomains work (`es.`, `fr.`, `de.`, ...).\n- A feedback URL that already contains `productId` is accepted. If that URL includes `page` and you leave `page` at 1, the URL page is used.\n- Other domains return 400.","schema":{"type":"string","description":"AliExpress product id or item URL.\n\n**Example (product id):**\n\n    1005001388303149\n\n**Example (item URL):**\n\n    https://www.aliexpress.com/item/1005001388303149.html\n\n**Notes:**\n- A numeric product id and a `/item/{id}.html` URL are both accepted.\n- Locale subdomains work (`es.`, `fr.`, `de.`, ...).\n- A feedback URL that already contains `productId` is accepted. If that URL includes `page` and you leave `page` at 1, the URL page is used.\n- Other domains return 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Defaults to 1. The feed returns up to 20 reviews per page. `pagination.next` is the next page URL, or null on the last page.","schema":{"type":"number","description":"Page number, starting at 1. Defaults to 1. The feed returns up to 20 reviews per page. `pagination.next` is the next page URL, or null on the last page."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw feed body as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw feed body as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"text":{"type":"string"},"author":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Buyer review for product 1005001388303149":{"value":{"results":[{"date":"27 Feb 2026","text":"очень понравился ребенку! пришел быстрее, чем ожидали, все работает, не очень шумный. рекомендую👍","author":"Б***а","images":["https://ae-pic-a1.aliexpress-media.com/kf/A23a05703ab0b4c5ea4a69b008c4da67fw.jpg"],"rating":5}],"pagination":{"next":"https://feedback.aliexpress.com/pc/searchEvaluation.do?productId=1005001388303149&lang=en_US&country=US&page=2&pageSize=20&filter=all&sort=complex_default","page":1,"per_page":20,"total_pages":2,"total_results":26}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/expedia/flight":{"get":{"summary":"Expedia Flight","description":"Search Expedia flights by airport route and dates, or by a flight search URL. Each offer includes the airline, times, stops, and displayed price.\n\n**Credit cost:** 2 credits per call","operationId":"get-expedia-flight","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A route or a full Expedia Flights-Search URL. Empty, a route without two airport codes, or a non-Expedia URL returns 400. A full URL is opened as given. price stays the label on the offer. pagination.next is null.\n\nRoute\n\n```\nJFK-LAX\n```\n\nRoute with to\n\n```\nJFK to LAX\n```","schema":{"type":"string","description":"A route or a full Expedia Flights-Search URL. Empty, a route without two airport codes, or a non-Expedia URL returns 400. A full URL is opened as given. price stays the label on the offer. pagination.next is null.\n\nRoute\n\n```\nJFK-LAX\n```\n\nRoute with to\n\n```\nJFK to LAX\n```"}},{"name":"departure_date","in":"query","required":false,"description":"Departure as YYYY-MM-DD for a route. Omit it and the route uses 2026-11-15. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-15\n```","schema":{"type":"string","description":"Departure as YYYY-MM-DD for a route. Omit it and the route uses 2026-11-15. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-15\n```"}},{"name":"return_date","in":"query","required":false,"description":"Return date as YYYY-MM-DD. Omit it for a one-way trip. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-22\n```","schema":{"type":"string","description":"Return date as YYYY-MM-DD. Omit it for a one-way trip. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-22\n```"}},{"name":"adults","in":"query","required":false,"description":"Adult passengers for a route. Omit it and the request uses 1. Ignored when query is a full URL.\n\n```\n1\n```","schema":{"type":"number","description":"Adult passengers for a route. Omit it and the request uses 1. Ignored when query is a full URL.\n\n```\n1\n```"}},{"name":"cabin_class","in":"query","required":false,"description":"Label copied onto every result as cabin_class. Omit it and each result uses economy. It does not add a cabin filter to the Expedia URL.\n\n```\neconomy\n```","schema":{"type":"string","description":"Label copied onto every result as cabin_class. Omit it and each result uses economy. It does not add a cabin filter to the Expedia URL.\n\n```\neconomy\n```"}},{"name":"region","in":"query","required":false,"description":"Host for a route. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL.\n\n```\nus\n```","schema":{"type":"string","description":"Host for a route. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL.\n\n```\nus\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string"},"stops":{"type":"string"},"origin":{"type":"string"},"airline":{"type":"string"},"duration":{"type":"string"},"cabin_class":{"type":"string"},"destination":{"type":"string"},"arrival_time":{"type":"string"},"departure_time":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"JFK to LAX on 15 Nov 2026":{"value":{"results":[{"price":"$269","stops":"Nonstop","origin":"JFK","airline":"Delta","duration":"6h 13m","cabin_class":"economy","destination":"LAX","arrival_time":"6:33pm","departure_time":"3:20pm"}],"pagination":{"next":null,"page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Expedia Flight","description":"Search Expedia flights by airport route and dates, or by a flight search URL. Each offer includes the airline, times, stops, and displayed price.\n\n**Credit cost:** 2 credits per call","operationId":"post-expedia-flight","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A route or a full Expedia Flights-Search URL. Empty, a route without two airport codes, or a non-Expedia URL returns 400. A full URL is opened as given. price stays the label on the offer. pagination.next is null.\n\nRoute\n\n```\nJFK-LAX\n```\n\nRoute with to\n\n```\nJFK to LAX\n```","schema":{"type":"string","description":"A route or a full Expedia Flights-Search URL. Empty, a route without two airport codes, or a non-Expedia URL returns 400. A full URL is opened as given. price stays the label on the offer. pagination.next is null.\n\nRoute\n\n```\nJFK-LAX\n```\n\nRoute with to\n\n```\nJFK to LAX\n```"}},{"name":"departure_date","in":"query","required":false,"description":"Departure as YYYY-MM-DD for a route. Omit it and the route uses 2026-11-15. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-15\n```","schema":{"type":"string","description":"Departure as YYYY-MM-DD for a route. Omit it and the route uses 2026-11-15. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-15\n```"}},{"name":"return_date","in":"query","required":false,"description":"Return date as YYYY-MM-DD. Omit it for a one-way trip. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-22\n```","schema":{"type":"string","description":"Return date as YYYY-MM-DD. Omit it for a one-way trip. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.\n\n```\n2026-11-22\n```"}},{"name":"adults","in":"query","required":false,"description":"Adult passengers for a route. Omit it and the request uses 1. Ignored when query is a full URL.\n\n```\n1\n```","schema":{"type":"number","description":"Adult passengers for a route. Omit it and the request uses 1. Ignored when query is a full URL.\n\n```\n1\n```"}},{"name":"cabin_class","in":"query","required":false,"description":"Label copied onto every result as cabin_class. Omit it and each result uses economy. It does not add a cabin filter to the Expedia URL.\n\n```\neconomy\n```","schema":{"type":"string","description":"Label copied onto every result as cabin_class. Omit it and each result uses economy. It does not add a cabin filter to the Expedia URL.\n\n```\neconomy\n```"}},{"name":"region","in":"query","required":false,"description":"Host for a route. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL.\n\n```\nus\n```","schema":{"type":"string","description":"Host for a route. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL.\n\n```\nus\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string"},"stops":{"type":"string"},"origin":{"type":"string"},"airline":{"type":"string"},"duration":{"type":"string"},"cabin_class":{"type":"string"},"destination":{"type":"string"},"arrival_time":{"type":"string"},"departure_time":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"JFK to LAX on 15 Nov 2026":{"value":{"results":[{"price":"$269","stops":"Nonstop","origin":"JFK","airline":"Delta","duration":"6h 13m","cabin_class":"economy","destination":"LAX","arrival_time":"6:33pm","departure_time":"3:20pm"}],"pagination":{"next":null,"page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/petsmart/product":{"get":{"summary":"PetSmart Product","description":"Read one PetSmart product URL, including the selected size, dollar price, flavor, and item number.\n\n**Credit cost:** 1 credit per call","operationId":"get-petsmart-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A PetSmart product link.\n\nExample:\n\n```\nhttps://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html\n```\n\nA search link returns 400.","schema":{"type":"string","description":"A PetSmart product link.\n\nExample:\n\n```\nhttps://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html\n```\n\nA search link returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the parsed JSON.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the parsed JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"size":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"sizes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"selected":{"type":"boolean"}}}},"title":{"type":"string"},"flavor":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"gtin":{"type":"string"},"price":{"type":"number"},"in_stock":{"type":"boolean"},"selected":{"type":"boolean"},"price_display":{"type":"string"}}}},"description":{"type":"string"},"rating_count":{"type":"integer"},"price_display":{"type":"string"},"master_product_id":{"type":"string"}}},"examples":{"Purina Pro Plan 30 lb salmon and rice":{"value":{"id":"5252900","url":"https://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html","gtin":"0038100175526","size":"30 Lb","brand":"Purina Pro Plan","image":"https://s7d2.scene7.com/is/image/PetSmart/5252900?fmt=webp&wid=400&hei=400","price":77.99,"sizes":[{"label":"4 Lb","selected":false},{"label":"16 Lb","selected":false},{"label":"30 Lb","selected":true},{"label":"40 Lb","selected":false}],"title":"Purina Pro Plan Sensitive Skin and Stomach Dry Dog Food Adult Salmon & Rice Formula Digestive Health","flavor":"Salmon & Rice","rating":4.5,"currency":"USD","in_stock":true,"variants":[{"sku":"5252899","gtin":"0038100175458","price":54.99,"in_stock":true,"selected":false,"price_display":"$54.99"},{"sku":"5252900","gtin":"0038100175526","price":77.99,"in_stock":true,"selected":true,"price_display":"$77.99"},{"sku":"5339374","gtin":"0038100100757","price":20.68,"in_stock":true,"selected":false,"price_display":"$20.68"},{"sku":"5339575","gtin":"0038100100771","price":94.99,"in_stock":true,"selected":false,"price_display":"$94.99"}],"description":"Nurture your dog's sensitive skin and stomach with Purina Pro Plan Brand Dog Food Sensitive Skin and Stomach Salmon and Rice Formula adult dry dog food. Nutrient-rich salmon is the first ingredient.","rating_count":9221,"price_display":"$77.99","master_product_id":"36648"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PetSmart Product","description":"Read one PetSmart product URL, including the selected size, dollar price, flavor, and item number.\n\n**Credit cost:** 1 credit per call","operationId":"post-petsmart-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A PetSmart product link.\n\nExample:\n\n```\nhttps://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html\n```\n\nA search link returns 400.","schema":{"type":"string","description":"A PetSmart product link.\n\nExample:\n\n```\nhttps://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html\n```\n\nA search link returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the parsed JSON.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the parsed JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"size":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"sizes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"selected":{"type":"boolean"}}}},"title":{"type":"string"},"flavor":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"gtin":{"type":"string"},"price":{"type":"number"},"in_stock":{"type":"boolean"},"selected":{"type":"boolean"},"price_display":{"type":"string"}}}},"description":{"type":"string"},"rating_count":{"type":"integer"},"price_display":{"type":"string"},"master_product_id":{"type":"string"}}},"examples":{"Purina Pro Plan 30 lb salmon and rice":{"value":{"id":"5252900","url":"https://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html","gtin":"0038100175526","size":"30 Lb","brand":"Purina Pro Plan","image":"https://s7d2.scene7.com/is/image/PetSmart/5252900?fmt=webp&wid=400&hei=400","price":77.99,"sizes":[{"label":"4 Lb","selected":false},{"label":"16 Lb","selected":false},{"label":"30 Lb","selected":true},{"label":"40 Lb","selected":false}],"title":"Purina Pro Plan Sensitive Skin and Stomach Dry Dog Food Adult Salmon & Rice Formula Digestive Health","flavor":"Salmon & Rice","rating":4.5,"currency":"USD","in_stock":true,"variants":[{"sku":"5252899","gtin":"0038100175458","price":54.99,"in_stock":true,"selected":false,"price_display":"$54.99"},{"sku":"5252900","gtin":"0038100175526","price":77.99,"in_stock":true,"selected":true,"price_display":"$77.99"},{"sku":"5339374","gtin":"0038100100757","price":20.68,"in_stock":true,"selected":false,"price_display":"$20.68"},{"sku":"5339575","gtin":"0038100100771","price":94.99,"in_stock":true,"selected":false,"price_display":"$94.99"}],"description":"Nurture your dog's sensitive skin and stomach with Purina Pro Plan Brand Dog Food Sensitive Skin and Stomach Salmon and Rice Formula adult dry dog food. Nutrient-rich salmon is the first ingredient.","rating_count":9221,"price_display":"$77.99","master_product_id":"36648"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/petsmart/search":{"get":{"summary":"PetSmart Search","description":"Search PetSmart by keyword or search URL. Page through pet food, litter, and supplies with dollar prices.\n\n**Credit cost:** 1 credit per call","operationId":"get-petsmart-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word, or a PetSmart search link.\n\nExamples:\n\n```\ndog food\n```\n\n```\nhttps://www.petsmart.com/search/?q=dog+food\n```\n\nA product link returns 400.","schema":{"type":"string","description":"What to look for. A word, or a PetSmart search link.\n\nExamples:\n\n```\ndog food\n```\n\n```\nhttps://www.petsmart.com/search/?q=dog+food\n```\n\nA product link returns 400."}},{"name":"page","in":"query","required":false,"description":"Which page of results, starting at 1. Page 2 returns a different set of products.","schema":{"type":"number","minimum":1,"description":"Which page of results, starting at 1. Page 2 returns a different set of products."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the parsed JSON.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the parsed JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"price_max":{"nullable":true},"price_label":{"type":"string"},"rating_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"original_price":{"type":"number"},"master_product_id":{"type":"string"},"price_max_display":{"nullable":true},"original_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Purina Pro Plan card on dog food":{"value":{"results":[{"id":"5252900","url":"https://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html","brand":"Purina Pro Plan","image":"https://s7d2.scene7.com/is/image/PetSmart/5252900?$sclp-prd-main_large$&fmt=webp&qlt=80","price":20.68,"title":"Purina Pro Plan Sensitive Skin and Stomach Dry Dog Food Adult Salmon & Rice Formula Digestive Health","rating":4.5,"currency":"USD","in_stock":true,"price_max":null,"price_label":"Options from","rating_count":9221,"price_display":"$20.68","variant_count":4,"original_price":21.99,"master_product_id":"36648","price_max_display":null,"original_price_display":"$21.99"}],"pagination":{"next":"https://www.petsmart.com/search/?q=dog+food&page=2","page":1,"per_page":40,"total_pages":83,"total_results":3317}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PetSmart Search","description":"Search PetSmart by keyword or search URL. Page through pet food, litter, and supplies with dollar prices.\n\n**Credit cost:** 1 credit per call","operationId":"post-petsmart-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word, or a PetSmart search link.\n\nExamples:\n\n```\ndog food\n```\n\n```\nhttps://www.petsmart.com/search/?q=dog+food\n```\n\nA product link returns 400.","schema":{"type":"string","description":"What to look for. A word, or a PetSmart search link.\n\nExamples:\n\n```\ndog food\n```\n\n```\nhttps://www.petsmart.com/search/?q=dog+food\n```\n\nA product link returns 400."}},{"name":"page","in":"query","required":false,"description":"Which page of results, starting at 1. Page 2 returns a different set of products.","schema":{"type":"number","minimum":1,"description":"Which page of results, starting at 1. Page 2 returns a different set of products."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the parsed JSON.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the parsed JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"price_max":{"nullable":true},"price_label":{"type":"string"},"rating_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"original_price":{"type":"number"},"master_product_id":{"type":"string"},"price_max_display":{"nullable":true},"original_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Purina Pro Plan card on dog food":{"value":{"results":[{"id":"5252900","url":"https://www.petsmart.com/dog/food/dry-food/purina-pro-plan-sensitive-skin-and-stomach-dry-dog-food-adult-salmon-and-rice-formula-digestive-health-36648.html","brand":"Purina Pro Plan","image":"https://s7d2.scene7.com/is/image/PetSmart/5252900?$sclp-prd-main_large$&fmt=webp&qlt=80","price":20.68,"title":"Purina Pro Plan Sensitive Skin and Stomach Dry Dog Food Adult Salmon & Rice Formula Digestive Health","rating":4.5,"currency":"USD","in_stock":true,"price_max":null,"price_label":"Options from","rating_count":9221,"price_display":"$20.68","variant_count":4,"original_price":21.99,"master_product_id":"36648","price_max_display":null,"original_price_display":"$21.99"}],"pagination":{"next":"https://www.petsmart.com/search/?q=dog+food&page=2","page":1,"per_page":40,"total_pages":83,"total_results":3317}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/morele/search":{"get":{"summary":"Morele Search","description":"Search morele.net by keyword or search URL. Returns product cards with PLN prices and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-morele-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a full Morele search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlaptop\n```\n\n```\nhttps://www.morele.net/wyszukiwarka/?q=laptop\n```","schema":{"type":"string","description":"Keyword or a full Morele search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlaptop\n```\n\n```\nhttps://www.morele.net/wyszukiwarka/?q=laptop\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Page 2 asks Morele for the next screen of the same search.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number starting at 1. Page 2 asks Morele for the next screen of the same search."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"review_count":{"type":"integer"},"price_display":{"type":"string"},"installment_price":{"type":"number"},"installment_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"Search laptop on morele.net":{"value":{"results":[{"id":"6721152","url":"https://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/","name":"Laptop Lenovo Thinkbook 15 IIL (20SM000FPB)","brand":"Lenovo","price":3963.99,"rating":5,"currency":"PLN","image_url":"https://images.morele.net/i256/6721152_4_i256.jpg","highlights":[{"name":"Dedykowany układ graficzny","value":"Brak"},{"name":"Pamięć RAM (zainstalowana)","value":"8 GB"},{"name":"Procesor","value":"Intel Core i5-1035G1"},{"name":"Przekątna ekranu","value":"15.6\""},{"name":"System operacyjny","value":"Windows 10 Pro"}],"review_count":5,"price_display":"3 963,99 zł","installment_price":101.74,"installment_price_display":"101,74 zł"}],"pagination":{"next":"https://www.morele.net/wyszukiwarka/,,,,,,,,,,,,/2/?q=laptop","page":1,"per_page":30,"total_pages":50,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Morele Search","description":"Search morele.net by keyword or search URL. Returns product cards with PLN prices and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-morele-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a full Morele search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlaptop\n```\n\n```\nhttps://www.morele.net/wyszukiwarka/?q=laptop\n```","schema":{"type":"string","description":"Keyword or a full Morele search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlaptop\n```\n\n```\nhttps://www.morele.net/wyszukiwarka/?q=laptop\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Page 2 asks Morele for the next screen of the same search.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number starting at 1. Page 2 asks Morele for the next screen of the same search."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"review_count":{"type":"integer"},"price_display":{"type":"string"},"installment_price":{"type":"number"},"installment_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"Search laptop on morele.net":{"value":{"results":[{"id":"6721152","url":"https://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/","name":"Laptop Lenovo Thinkbook 15 IIL (20SM000FPB)","brand":"Lenovo","price":3963.99,"rating":5,"currency":"PLN","image_url":"https://images.morele.net/i256/6721152_4_i256.jpg","highlights":[{"name":"Dedykowany układ graficzny","value":"Brak"},{"name":"Pamięć RAM (zainstalowana)","value":"8 GB"},{"name":"Procesor","value":"Intel Core i5-1035G1"},{"name":"Przekątna ekranu","value":"15.6\""},{"name":"System operacyjny","value":"Windows 10 Pro"}],"review_count":5,"price_display":"3 963,99 zł","installment_price":101.74,"installment_price_display":"101,74 zł"}],"pagination":{"next":"https://www.morele.net/wyszukiwarka/,,,,,,,,,,,,/2/?q=laptop","page":1,"per_page":30,"total_pages":50,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/proshop/search":{"get":{"summary":"Proshop Search","description":"Search proshop.dk by keyword or search URL. Returns product cards with DKK prices and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-proshop-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a full Proshop search URL with s=. A product URL is rejected.\n\n**Examples:**\n\n```\nssd\n```\n\n```\nhttps://www.proshop.dk/?s=ssd\n```","schema":{"type":"string","description":"Keyword or a full Proshop search URL with s=. A product URL is rejected.\n\n**Examples:**\n\n```\nssd\n```\n\n```\nhttps://www.proshop.dk/?s=ssd\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Proshop sends this as pn.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number starting at 1. Proshop sends this as pn."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"summary":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"availability":{"type":"string"},"price_ex_vat":{"type":"integer"},"price_display":{"type":"string"},"price_ex_vat_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search ssd on proshop.dk":{"value":{"results":[{"id":"3071602","url":"https://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602","name":"Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5\"","price":580,"summary":"SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5\", SATA-600 tilslutning, farve: sort","currency":"DKK","in_stock":true,"image_url":"https://www.proshop.dk/Images/174x116/3071602_95234c5c86d9.jpg","availability":"På lager – Levering i morgen (bestil inden kl. 22)","price_ex_vat":464,"price_display":"580,00 kr.","price_ex_vat_display":"464,00 kr."}],"pagination":{"next":"https://www.proshop.dk/?s=ssd&pn=2","page":1,"per_page":25,"total_pages":95,"total_results":2364}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Proshop Search","description":"Search proshop.dk by keyword or search URL. Returns product cards with DKK prices and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-proshop-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a full Proshop search URL with s=. A product URL is rejected.\n\n**Examples:**\n\n```\nssd\n```\n\n```\nhttps://www.proshop.dk/?s=ssd\n```","schema":{"type":"string","description":"Keyword or a full Proshop search URL with s=. A product URL is rejected.\n\n**Examples:**\n\n```\nssd\n```\n\n```\nhttps://www.proshop.dk/?s=ssd\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Proshop sends this as pn.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number starting at 1. Proshop sends this as pn."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"summary":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"availability":{"type":"string"},"price_ex_vat":{"type":"integer"},"price_display":{"type":"string"},"price_ex_vat_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search ssd on proshop.dk":{"value":{"results":[{"id":"3071602","url":"https://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602","name":"Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5\"","price":580,"summary":"SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5\", SATA-600 tilslutning, farve: sort","currency":"DKK","in_stock":true,"image_url":"https://www.proshop.dk/Images/174x116/3071602_95234c5c86d9.jpg","availability":"På lager – Levering i morgen (bestil inden kl. 22)","price_ex_vat":464,"price_display":"580,00 kr.","price_ex_vat_display":"464,00 kr."}],"pagination":{"next":"https://www.proshop.dk/?s=ssd&pn=2","page":1,"per_page":25,"total_pages":95,"total_results":2364}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/morele/product":{"get":{"summary":"Morele Product","description":"Read one morele.net product page. Flat JSON with PLN price, EAN, specs, and availability.\n\n**Credit cost:** 1 credit per call","operationId":"get-morele-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Morele product URL, or a numeric product id.\n\n**Examples:**\n\n```\nhttps://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/\n```\n\n```\n6721152\n```","schema":{"type":"string","description":"Morele product URL, or a numeric product id.\n\n**Examples:**\n\n```\nhttps://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/\n```\n\n```\n6721152\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"mpn":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"price_net":{"type":"number"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}},"price_net_display":{"type":"string"}}},"examples":{"Lenovo ThinkBook 15 on morele.net":{"value":{"id":"6721152","ean":"194632480436","mpn":"20SM000FPB","url":"https://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/","name":"Laptop Lenovo Thinkbook 15 IIL (20SM000FPB)","brand":"Lenovo","price":3963.99,"images":["https://images.morele.net/i1064/6721152_4_i1064.jpg","https://images.morele.net/i80/6721152_5_i80.jpg","https://images.morele.net/i80/6721152_6_i80.jpg","https://images.morele.net/i80/6721152_7_i80.jpg","https://images.morele.net/i80/6721152_8_i80.jpg"],"rating":5,"currency":"PLN","in_stock":true,"image_url":"https://images.morele.net/i1064/6721152_4_i1064.jpg","price_net":3222.76,"breadcrumbs":[{"url":"https://www.morele.net/","name":"Morele.net"},{"url":"https://www.morele.net/laptopy/","name":"Laptopy"},{"url":"https://www.morele.net/laptopy/laptopy-i-tablety/","name":"Laptopy i tablety"},{"url":"https://www.morele.net/kategoria/laptopy-31/","name":"Laptopy"},{"name":"Laptop Lenovo Thinkbook 15 IIL (20SM000FPB)"}],"description":"Wyjątkowa wydajność i wygląd Wyposażony w procesor do poziomu Intel® Core™ 10 generacji i system Windows 10 Pro ThinkBook 15 działa płynnie i szybko reaguje na polecenia niezależnie od miejsca. Ten elegancki laptop biznesowy ma zaledwie 18,9 mm grubości i zwraca uwagę nowoczesnym wykończeniem w mineralnoszarym kolorze.","availability":"Ostatnia sztuka!","review_count":5,"price_display":"3 963,99 zł","specifications":[{"name":"Marka","group":"Produkt","value":"Lenovo"},{"name":"Kod producenta","group":"Produkt","value":"20SM000FPB"},{"name":"EAN","group":"Produkt","value":"194632480436"},{"name":"Typ","group":"Informacje podstawowe","value":"Laptop"},{"name":"Zastosowanie","group":"Informacje podstawowe","value":"Biznesowe , Multimedialne"},{"name":"Kolor","group":"Informacje podstawowe","value":"Szare"},{"name":"Procesor","group":"Procesor","value":"Intel Core i5-1035G1"},{"name":"Taktowanie procesora (bazowe/turbo)","group":"Procesor","value":"1 GHz / 3.6 GHz"},{"name":"Liczba rdzeni / wątków","group":"Procesor","value":"4/8"},{"name":"Pamięć RAM (zainstalowana)","group":"Pamięć","value":"8 GB"},{"name":"Pamięć RAM (maksymalna)","group":"Pamięć","value":"16 GB"},{"name":"Typ pamięci RAM","group":"Pamięć","value":"DDR4"},{"name":"Częstotliwość pamięci","group":"Pamięć","value":"2666 MHz"},{"name":"Liczba gniazd pamięci (ogółem/wolne)","group":"Pamięć","value":"1/0"},{"name":"Dysk SSD","group":"Dyski i napęd","value":"Brak"},{"name":"Dysk SSD M.2","group":"Dyski i napęd","value":"Brak"},{"name":"Dysk SSD M.2 PCIe","group":"Dyski i napęd","value":"256 GB"},{"name":"Zintegrowany układ graficzny","group":"Karta graficzna","value":"Intel UHD Graphics G1"},{"name":"Dedykowany układ graficzny","group":"Karta graficzna","value":"Brak"},{"name":"Przekątna ekranu","group":"Wyświetlacz","value":"15.6\""},{"name":"Rozdzielczość","group":"Wyświetlacz","value":"1920 x 1080 (Full HD)"},{"name":"Powłoka matrycy","group":"Wyświetlacz","value":"Matowa"},{"name":"Typ matrycy","group":"Wyświetlacz","value":"IPS"},{"name":"USB-C","group":"Porty","value":"2"},{"name":"WiFi","group":"Łączność","value":"802.11ax (gen. 6)"},{"name":"System operacyjny","group":"Oprogramowanie","value":"Windows 10 Pro"},{"name":"Waga [kg]","group":"Wymiary","value":"1.7"}],"price_net_display":"3 222,76 zł"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Morele Product","description":"Read one morele.net product page. Flat JSON with PLN price, EAN, specs, and availability.\n\n**Credit cost:** 1 credit per call","operationId":"post-morele-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Morele product URL, or a numeric product id.\n\n**Examples:**\n\n```\nhttps://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/\n```\n\n```\n6721152\n```","schema":{"type":"string","description":"Morele product URL, or a numeric product id.\n\n**Examples:**\n\n```\nhttps://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/\n```\n\n```\n6721152\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"mpn":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"price_net":{"type":"number"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}},"price_net_display":{"type":"string"}}},"examples":{"Lenovo ThinkBook 15 on morele.net":{"value":{"id":"6721152","ean":"194632480436","mpn":"20SM000FPB","url":"https://www.morele.net/laptop-lenovo-thinkbook-15-iil-20sm000fpb-6721152/","name":"Laptop Lenovo Thinkbook 15 IIL (20SM000FPB)","brand":"Lenovo","price":3963.99,"images":["https://images.morele.net/i1064/6721152_4_i1064.jpg","https://images.morele.net/i80/6721152_5_i80.jpg","https://images.morele.net/i80/6721152_6_i80.jpg","https://images.morele.net/i80/6721152_7_i80.jpg","https://images.morele.net/i80/6721152_8_i80.jpg"],"rating":5,"currency":"PLN","in_stock":true,"image_url":"https://images.morele.net/i1064/6721152_4_i1064.jpg","price_net":3222.76,"breadcrumbs":[{"url":"https://www.morele.net/","name":"Morele.net"},{"url":"https://www.morele.net/laptopy/","name":"Laptopy"},{"url":"https://www.morele.net/laptopy/laptopy-i-tablety/","name":"Laptopy i tablety"},{"url":"https://www.morele.net/kategoria/laptopy-31/","name":"Laptopy"},{"name":"Laptop Lenovo Thinkbook 15 IIL (20SM000FPB)"}],"description":"Wyjątkowa wydajność i wygląd Wyposażony w procesor do poziomu Intel® Core™ 10 generacji i system Windows 10 Pro ThinkBook 15 działa płynnie i szybko reaguje na polecenia niezależnie od miejsca. Ten elegancki laptop biznesowy ma zaledwie 18,9 mm grubości i zwraca uwagę nowoczesnym wykończeniem w mineralnoszarym kolorze.","availability":"Ostatnia sztuka!","review_count":5,"price_display":"3 963,99 zł","specifications":[{"name":"Marka","group":"Produkt","value":"Lenovo"},{"name":"Kod producenta","group":"Produkt","value":"20SM000FPB"},{"name":"EAN","group":"Produkt","value":"194632480436"},{"name":"Typ","group":"Informacje podstawowe","value":"Laptop"},{"name":"Zastosowanie","group":"Informacje podstawowe","value":"Biznesowe , Multimedialne"},{"name":"Kolor","group":"Informacje podstawowe","value":"Szare"},{"name":"Procesor","group":"Procesor","value":"Intel Core i5-1035G1"},{"name":"Taktowanie procesora (bazowe/turbo)","group":"Procesor","value":"1 GHz / 3.6 GHz"},{"name":"Liczba rdzeni / wątków","group":"Procesor","value":"4/8"},{"name":"Pamięć RAM (zainstalowana)","group":"Pamięć","value":"8 GB"},{"name":"Pamięć RAM (maksymalna)","group":"Pamięć","value":"16 GB"},{"name":"Typ pamięci RAM","group":"Pamięć","value":"DDR4"},{"name":"Częstotliwość pamięci","group":"Pamięć","value":"2666 MHz"},{"name":"Liczba gniazd pamięci (ogółem/wolne)","group":"Pamięć","value":"1/0"},{"name":"Dysk SSD","group":"Dyski i napęd","value":"Brak"},{"name":"Dysk SSD M.2","group":"Dyski i napęd","value":"Brak"},{"name":"Dysk SSD M.2 PCIe","group":"Dyski i napęd","value":"256 GB"},{"name":"Zintegrowany układ graficzny","group":"Karta graficzna","value":"Intel UHD Graphics G1"},{"name":"Dedykowany układ graficzny","group":"Karta graficzna","value":"Brak"},{"name":"Przekątna ekranu","group":"Wyświetlacz","value":"15.6\""},{"name":"Rozdzielczość","group":"Wyświetlacz","value":"1920 x 1080 (Full HD)"},{"name":"Powłoka matrycy","group":"Wyświetlacz","value":"Matowa"},{"name":"Typ matrycy","group":"Wyświetlacz","value":"IPS"},{"name":"USB-C","group":"Porty","value":"2"},{"name":"WiFi","group":"Łączność","value":"802.11ax (gen. 6)"},{"name":"System operacyjny","group":"Oprogramowanie","value":"Windows 10 Pro"},{"name":"Waga [kg]","group":"Wymiary","value":"1.7"}],"price_net_display":"3 222,76 zł"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/proshop/product":{"get":{"summary":"Proshop Product","description":"Read one proshop.dk product page. Flat JSON with DKK price, EAN, specs, and stock text.\n\n**Credit cost:** 1 credit per call","operationId":"get-proshop-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Proshop product id, or a product URL. The id is the last path segment.\n\n**Examples:**\n\n```\n3071602\n```\n\n```\nhttps://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602\n```","schema":{"type":"string","description":"Proshop product id, or a product URL. The id is the last path segment.\n\n**Examples:**\n\n```\n3071602\n```\n\n```\nhttps://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"summary":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"availability":{"type":"string"},"price_ex_vat":{"type":"integer"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"price_ex_vat_display":{"type":"string"}}},"examples":{"Verbatim Vi550 512GB on proshop.dk":{"value":{"id":"3071602","ean":"0023942493525","mpn":"49352","sku":"3071602","url":"https://www.proshop.dk/3071602","name":"Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5\"","brand":"Verbatim","price":580,"images":["https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg","https://www.proshop.dk/Images/915x900/3071602_349c4c4c7a0f.jpg","https://www.proshop.dk/Images/915x900/3071602_14c535b3fa39.jpg","https://www.proshop.dk/Images/915x900/3071602_ca0e5223d5b8.jpg"],"summary":"SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5\", SATA-600 tilslutning, farve: sort","currency":"DKK","in_stock":true,"image_url":"https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg","breadcrumbs":[{"url":"https://www.proshop.dk/","name":"Forside"},{"url":"https://www.proshop.dk/Hardware","name":"Hardware"},{"url":"https://www.proshop.dk/SSD","name":"SSD"},{"url":"https://www.proshop.dk/SSD/Verbatim","name":"Verbatim SSD"}],"availability":"15+ stk. på lager – Levering i morgen (bestil inden kl. 22)","price_ex_vat":464,"price_display":"580,00 kr.","specifications":[{"name":"Producent","value":"Verbatim"},{"name":"Varenummer","value":"3071602"},{"name":"Model","value":"49352"},{"name":"Ean","value":"0023942493525"},{"name":"Til producentens hjemmeside","value":"www.verbatim-europe.co.uk/en/prod/vi550-..."},{"name":"Produktbeskrivelse","value":"Verbatim Vi550 - SSD - 512 GB - SATA 6Gb/s"},{"name":"Type","value":"Solid state-drev - intern"},{"name":"Kapacitet","value":"512 GB"},{"name":"Model","value":"2.5\""},{"name":"Grænseflade","value":"SATA 6Gb/s"},{"name":"Dataoverførselshastighed","value":"600 MBps"},{"name":"Egenskaber","value":"3D NAND Technology, Phison PS3111 controller, S.M.A.R.T."},{"name":"Dimensioner (B x D x H)","value":"71 mm x 100 mm x 7 mm"},{"name":"Enhedstype","value":"Solid state-drev - intern"},{"name":"Bredde","value":"71 mm"},{"name":"Dybde","value":"100 mm"},{"name":"Højde","value":"7 mm"},{"name":"SSD-udholdenhed","value":"360 TB"},{"name":"Overføringshastighed, drev","value":"600 MBps (ekstern)"},{"name":"Intern datahastighed","value":"560 MBps (læs) / 535 MBps (skriv)"},{"name":"4KB Random Read","value":"75413 IOPS"},{"name":"4KB Random Write","value":"86756 IOPS"},{"name":"MTBF (forventet tid mellem fejl)","value":"2,000,000 timer"},{"name":"Interface","value":"1 x SATA 6 Gb/s"},{"name":"Kompatibel bås","value":"2.5\""},{"name":"Strømforbrug","value":"1430 mW (læs) 1670 mW (skriv) 320 mW (ledig)"},{"name":"Overensstemmelsesstandarder","value":"RoHS"},{"name":"Min. driftstemperatur","value":"0 °C"},{"name":"Maks. driftstemperatur","value":"70 °C"},{"name":"Min. lagertemperatur","value":"-40 °C"},{"name":"Maks. Opbevaringstemperatur","value":"85 °C"},{"name":"Modstandsdygtighed over for stød (operativ)","value":"1500 g @ 0,5 ms halvsinuskurve"}],"price_ex_vat_display":"464,00 kr."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Proshop Product","description":"Read one proshop.dk product page. Flat JSON with DKK price, EAN, specs, and stock text.\n\n**Credit cost:** 1 credit per call","operationId":"post-proshop-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Proshop product id, or a product URL. The id is the last path segment.\n\n**Examples:**\n\n```\n3071602\n```\n\n```\nhttps://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602\n```","schema":{"type":"string","description":"Proshop product id, or a product URL. The id is the last path segment.\n\n**Examples:**\n\n```\n3071602\n```\n\n```\nhttps://www.proshop.dk/SSD/Verbatim-Vi550-S3-SSD-512GB-SATA-600-25/3071602\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"summary":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"availability":{"type":"string"},"price_ex_vat":{"type":"integer"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"price_ex_vat_display":{"type":"string"}}},"examples":{"Verbatim Vi550 512GB on proshop.dk":{"value":{"id":"3071602","ean":"0023942493525","mpn":"49352","sku":"3071602","url":"https://www.proshop.dk/3071602","name":"Verbatim Vi550 S3 SSD - 512GB - SATA-600 - 2.5\"","brand":"Verbatim","price":580,"images":["https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg","https://www.proshop.dk/Images/915x900/3071602_349c4c4c7a0f.jpg","https://www.proshop.dk/Images/915x900/3071602_14c535b3fa39.jpg","https://www.proshop.dk/Images/915x900/3071602_ca0e5223d5b8.jpg"],"summary":"SSD (Solid State Drive), 512 GB, intern, overførselshastighed: 520 MB/s (læs) / 500 MB/s (skriv), IOPS: 75413 IOPS (læs) / 86756 IOPS (skriv), størrelse: 2.5\", SATA-600 tilslutning, farve: sort","currency":"DKK","in_stock":true,"image_url":"https://www.proshop.dk/Images/915x900/3071602_95234c5c86d9.jpg","breadcrumbs":[{"url":"https://www.proshop.dk/","name":"Forside"},{"url":"https://www.proshop.dk/Hardware","name":"Hardware"},{"url":"https://www.proshop.dk/SSD","name":"SSD"},{"url":"https://www.proshop.dk/SSD/Verbatim","name":"Verbatim SSD"}],"availability":"15+ stk. på lager – Levering i morgen (bestil inden kl. 22)","price_ex_vat":464,"price_display":"580,00 kr.","specifications":[{"name":"Producent","value":"Verbatim"},{"name":"Varenummer","value":"3071602"},{"name":"Model","value":"49352"},{"name":"Ean","value":"0023942493525"},{"name":"Til producentens hjemmeside","value":"www.verbatim-europe.co.uk/en/prod/vi550-..."},{"name":"Produktbeskrivelse","value":"Verbatim Vi550 - SSD - 512 GB - SATA 6Gb/s"},{"name":"Type","value":"Solid state-drev - intern"},{"name":"Kapacitet","value":"512 GB"},{"name":"Model","value":"2.5\""},{"name":"Grænseflade","value":"SATA 6Gb/s"},{"name":"Dataoverførselshastighed","value":"600 MBps"},{"name":"Egenskaber","value":"3D NAND Technology, Phison PS3111 controller, S.M.A.R.T."},{"name":"Dimensioner (B x D x H)","value":"71 mm x 100 mm x 7 mm"},{"name":"Enhedstype","value":"Solid state-drev - intern"},{"name":"Bredde","value":"71 mm"},{"name":"Dybde","value":"100 mm"},{"name":"Højde","value":"7 mm"},{"name":"SSD-udholdenhed","value":"360 TB"},{"name":"Overføringshastighed, drev","value":"600 MBps (ekstern)"},{"name":"Intern datahastighed","value":"560 MBps (læs) / 535 MBps (skriv)"},{"name":"4KB Random Read","value":"75413 IOPS"},{"name":"4KB Random Write","value":"86756 IOPS"},{"name":"MTBF (forventet tid mellem fejl)","value":"2,000,000 timer"},{"name":"Interface","value":"1 x SATA 6 Gb/s"},{"name":"Kompatibel bås","value":"2.5\""},{"name":"Strømforbrug","value":"1430 mW (læs) 1670 mW (skriv) 320 mW (ledig)"},{"name":"Overensstemmelsesstandarder","value":"RoHS"},{"name":"Min. driftstemperatur","value":"0 °C"},{"name":"Maks. driftstemperatur","value":"70 °C"},{"name":"Min. lagertemperatur","value":"-40 °C"},{"name":"Maks. Opbevaringstemperatur","value":"85 °C"},{"name":"Modstandsdygtighed over for stød (operativ)","value":"1500 g @ 0,5 ms halvsinuskurve"}],"price_ex_vat_display":"464,00 kr."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bhphotovideo/product":{"get":{"summary":"B&H Photo Video Product","description":"Read a B&H Photo Video product from its URL or id. Returns price, rating, specifications, and box contents.\n\n**Credit cost:** 1 credit per call","operationId":"get-bhphotovideo-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or id.\n\nExample:\n\n```\n1948568-REG\n```","schema":{"type":"string","description":"Product URL or id.\n\nExample:\n\n```\n1948568-REG\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}},"examples":{"SANDISK 128GB Extreme PRO on B&H":{"value":{"mpn":"SDSDXXJ-128G-GSCIN","sku":"SA128EPSD","url":"https://www.bhphotovideo.com/c/product/1948568-REG/sandisk_sdsdxxj_128g_gscin_128gb_extreme_pro_uhs_i.html","gtin":"619659184812","brand":"SANDISK","price":51.99,"title":"SANDISK 128GB Extreme PRO UHS-I SDXC Memory Card","rating":4.8,"currency":"USD","in_stock":true,"product_id":"1948568-REG","review_count":25,"price_display":"$51.99","original_price":52.99,"original_price_display":"$52.99"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"B&H Photo Video Product","description":"Read a B&H Photo Video product from its URL or id. Returns price, rating, specifications, and box contents.\n\n**Credit cost:** 1 credit per call","operationId":"post-bhphotovideo-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or id.\n\nExample:\n\n```\n1948568-REG\n```","schema":{"type":"string","description":"Product URL or id.\n\nExample:\n\n```\n1948568-REG\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}},"examples":{"SANDISK 128GB Extreme PRO on B&H":{"value":{"mpn":"SDSDXXJ-128G-GSCIN","sku":"SA128EPSD","url":"https://www.bhphotovideo.com/c/product/1948568-REG/sandisk_sdsdxxj_128g_gscin_128gb_extreme_pro_uhs_i.html","gtin":"619659184812","brand":"SANDISK","price":51.99,"title":"SANDISK 128GB Extreme PRO UHS-I SDXC Memory Card","rating":4.8,"currency":"USD","in_stock":true,"product_id":"1948568-REG","review_count":25,"price_display":"$51.99","original_price":52.99,"original_price_display":"$52.99"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bhphotovideo/search":{"get":{"summary":"B&H Photo Video Search","description":"Search B&H Photo Video by keyword or search URL. Returns BH numbers, dollar prices, and a next page URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-bhphotovideo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a bhphotovideo.com search URL.\n\nExample:\n\n```\nsandisk extreme pro\n```","schema":{"type":"string","description":"Keyword or a bhphotovideo.com search URL.\n\nExample:\n\n```\nsandisk extreme pro\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Example: 2.","schema":{"type":"number","description":"Page number, starting at 1. Example: 2."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"B&H search for sandisk extreme pro":{"value":{"results":[{"mpn":"SDSDXXJ-128G-GSCIN","sku":"SA128EPSD","url":"https://www.bhphotovideo.com/c/product/1948568-REG/sandisk_sdsdxxj_128g_gscin_128gb_extreme_pro_uhs_i.html","price":51.99,"title":"SANDISK 128GB Extreme PRO UHS-I SDXC Memory Card","currency":"USD","product_id":"1948568-REG","review_count":25,"price_display":"$51.99","original_price":52.99,"original_price_display":"$52.99"}],"pagination":{"next":"https://www.bhphotovideo.com/c/search?pn=2&q=sandisk%20extreme%20pro","page":1,"per_page":28,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"B&H Photo Video Search","description":"Search B&H Photo Video by keyword or search URL. Returns BH numbers, dollar prices, and a next page URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-bhphotovideo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a bhphotovideo.com search URL.\n\nExample:\n\n```\nsandisk extreme pro\n```","schema":{"type":"string","description":"Keyword or a bhphotovideo.com search URL.\n\nExample:\n\n```\nsandisk extreme pro\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Example: 2.","schema":{"type":"number","description":"Page number, starting at 1. Example: 2."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"B&H search for sandisk extreme pro":{"value":{"results":[{"mpn":"SDSDXXJ-128G-GSCIN","sku":"SA128EPSD","url":"https://www.bhphotovideo.com/c/product/1948568-REG/sandisk_sdsdxxj_128g_gscin_128gb_extreme_pro_uhs_i.html","price":51.99,"title":"SANDISK 128GB Extreme PRO UHS-I SDXC Memory Card","currency":"USD","product_id":"1948568-REG","review_count":25,"price_display":"$51.99","original_price":52.99,"original_price_display":"$52.99"}],"pagination":{"next":"https://www.bhphotovideo.com/c/search?pn=2&q=sandisk%20extreme%20pro","page":1,"per_page":28,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fressnapf/product":{"get":{"summary":"Fressnapf Product","description":"Read a Fressnapf Germany product sheet from its URL. Returns sku, GTIN, euro price, unit price, and pack variants.\n\n**Credit cost:** 1 credit per call","operationId":"get-fressnapf-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL on www.fressnapf.de.\n\nExample:\n\n```\nhttps://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/\n```","schema":{"type":"string","description":"Product URL on www.fressnapf.de.\n\nExample:\n\n```\nhttps://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string `false` stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string `false` stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"in_stock":{"type":"boolean"},"selected":{"type":"boolean"},"unit_price":{"type":"number"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}}},"brand_url":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"description":{"type":"string"},"delivery_time":{"type":"string"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}},"examples":{"ROYAL CANIN Maxi Adult 15 kg":{"value":{"sku":"1003112004","url":"https://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/","gtin":"3182550401937","brand":"ROYAL CANIN","price":64.49,"title":"ROYAL CANIN Maxi Adult 15 kg","category":"Hundefutter","currency":"EUR","in_stock":true,"variants":[{"url":"https://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/","name":"15 kg","price":64.49,"in_stock":true,"selected":true,"unit_price":4.3,"price_display":"64,49 €","unit_price_display":"4,30 €/kg"}],"brand_url":"https://www.fressnapf.de/c/marken/royal-canin/","image_url":"https://media.os.fressnapf.com/products-v2/a/b/2/3/ab239d62865ca238b683c5e1ac8c2955e5fbd044_1003112004__2_.jpeg?t=prod_l","product_id":"1003112004","unit_price":4.3,"description":"Art.Nr.: 1003112004 Alleinfuttermittel für Hunde.","delivery_time":"In 1 - 3 Tagen","price_display":"64,49 €","unit_price_display":"4,30 €/kg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fressnapf Product","description":"Read a Fressnapf Germany product sheet from its URL. Returns sku, GTIN, euro price, unit price, and pack variants.\n\n**Credit cost:** 1 credit per call","operationId":"post-fressnapf-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL on www.fressnapf.de.\n\nExample:\n\n```\nhttps://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/\n```","schema":{"type":"string","description":"Product URL on www.fressnapf.de.\n\nExample:\n\n```\nhttps://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string `false` stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string `false` stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"in_stock":{"type":"boolean"},"selected":{"type":"boolean"},"unit_price":{"type":"number"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}}},"brand_url":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"description":{"type":"string"},"delivery_time":{"type":"string"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}},"examples":{"ROYAL CANIN Maxi Adult 15 kg":{"value":{"sku":"1003112004","url":"https://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/","gtin":"3182550401937","brand":"ROYAL CANIN","price":64.49,"title":"ROYAL CANIN Maxi Adult 15 kg","category":"Hundefutter","currency":"EUR","in_stock":true,"variants":[{"url":"https://www.fressnapf.de/p/royal-canin-maxi-adult-15-kg-1003112004/","name":"15 kg","price":64.49,"in_stock":true,"selected":true,"unit_price":4.3,"price_display":"64,49 €","unit_price_display":"4,30 €/kg"}],"brand_url":"https://www.fressnapf.de/c/marken/royal-canin/","image_url":"https://media.os.fressnapf.com/products-v2/a/b/2/3/ab239d62865ca238b683c5e1ac8c2955e5fbd044_1003112004__2_.jpeg?t=prod_l","product_id":"1003112004","unit_price":4.3,"description":"Art.Nr.: 1003112004 Alleinfuttermittel für Hunde.","delivery_time":"In 1 - 3 Tagen","price_display":"64,49 €","unit_price_display":"4,30 €/kg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fressnapf/search":{"get":{"summary":"Fressnapf Search","description":"Search Fressnapf Germany by keyword or category URL. Returns product cards with euro prices and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-fressnapf-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a fressnapf.de search or category URL.\n\nExamples:\n\n```\nhalsband\n```\n\n```\nhttps://www.fressnapf.de/c/hund/hundefutter/\n```","schema":{"type":"string","description":"Keyword or a fressnapf.de search or category URL.\n\nExamples:\n\n```\nhalsband\n```\n\n```\nhttps://www.fressnapf.de/c/hund/hundefutter/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Example: 2.","schema":{"type":"number","description":"Page number, starting at 1. Example: 2."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Fressnapf search for reflektierendes halsband":{"value":{"results":[{"url":"https://www.fressnapf.de/p/beaphar-reflektierendes-zecken--und-flohschutzhalsband-1280089/","brand":"Beaphar","price":6.19,"title":"reflektierendes Zecken- und Flohschutzhalsband","rating":2.4,"currency":"EUR","image_url":"https://media.os.fressnapf.com/products-v2/4/e/0/6/4e06dfdb341c3e76a5a407dc5cf46fe87be656d9_1280089_0.jpg?f=webp&t=prodtp_s","product_id":"1280089","review_count":66,"price_display":"6,19 €"}],"pagination":{"next":"https://www.fressnapf.de/search/?currentPage=2&text=reflektierendes+halsband","page":1,"per_page":48,"total_pages":2,"total_results":54}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fressnapf Search","description":"Search Fressnapf Germany by keyword or category URL. Returns product cards with euro prices and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-fressnapf-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a fressnapf.de search or category URL.\n\nExamples:\n\n```\nhalsband\n```\n\n```\nhttps://www.fressnapf.de/c/hund/hundefutter/\n```","schema":{"type":"string","description":"Keyword or a fressnapf.de search or category URL.\n\nExamples:\n\n```\nhalsband\n```\n\n```\nhttps://www.fressnapf.de/c/hund/hundefutter/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Example: 2.","schema":{"type":"number","description":"Page number, starting at 1. Example: 2."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Fressnapf search for reflektierendes halsband":{"value":{"results":[{"url":"https://www.fressnapf.de/p/beaphar-reflektierendes-zecken--und-flohschutzhalsband-1280089/","brand":"Beaphar","price":6.19,"title":"reflektierendes Zecken- und Flohschutzhalsband","rating":2.4,"currency":"EUR","image_url":"https://media.os.fressnapf.com/products-v2/4/e/0/6/4e06dfdb341c3e76a5a407dc5cf46fe87be656d9_1280089_0.jpg?f=webp&t=prodtp_s","product_id":"1280089","review_count":66,"price_display":"6,19 €"}],"pagination":{"next":"https://www.fressnapf.de/search/?currentPage=2&text=reflektierendes+halsband","page":1,"per_page":48,"total_pages":2,"total_results":54}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bitiba/product":{"get":{"summary":"Bitiba Product","description":"Read one product from a live Bitiba shop, including the selected variant price and the pack list.\n\n**Credit cost:** 1 credit per call","operationId":"get-bitiba-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL, shop path, or product number. Example: 75036. A search link returns 400.","schema":{"type":"string","description":"Product URL, shop path, or product number. Example: 75036. A search link returns 400."}},{"name":"region","in":"query","required":false,"description":"Shop used when query is a number or a path. de is Germany (default).","schema":{"type":"string","default":"de","description":"Shop used when query is a number or a path. de is Germany (default)."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"brands":{"type":"array","items":{"type":"string"}},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"region":{"type":"string"},"reviews":{"type":"array","items":{"type":"object","properties":{"body":{"type":"string"},"date":{"type":"string"},"title":{"type":"string"},"votes":{"type":"integer"},"author":{"type":"string"},"rating":{"type":"integer"},"variant":{"type":"string"},"review_id":{"type":"integer"},"verified_purchase":{"type":"boolean"}}}},"summary":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"sku":{"type":"string"},"unit":{"type":"string"},"price":{"type":"number"},"badges":{"type":"array","items":{"type":"string"}},"seller":{"type":"string"},"currency":{"type":"string"},"available":{"type":"boolean"},"discounts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"price":{"type":"number"},"price_display":{"type":"string"}}}},"image_url":{"type":"string"},"article_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"supplement":{"type":"boolean"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"description":{"type":"string"},"constituents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"unit":{"type":"string"},"amount":{"type":"integer"}}}},"price_display":{"type":"string"},"delivery_max_days":{"type":"integer"},"delivery_min_days":{"type":"integer"},"unit_price_display":{"type":"string"}}}},"image_url":{"type":"string"},"is_choice":{"type":"boolean"},"price_max":{"type":"number"},"price_min":{"type":"number"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}},"description":{"type":"string"},"ingredients":{"type":"string"},"choice_label":{"nullable":true},"review_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"price_max_display":{"type":"string"},"price_min_display":{"type":"string"},"unit_price_display":{"type":"string"},"selected_variant_id":{"type":"string"},"feeding_recommendation":{"type":"string"}}},"examples":{"My Friend 15 kg class on bitiba.de":{"value":{"ean":"4015598322201","url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend/75036","unit":"kg","brand":"Bosch My Friend","price":23.49,"title":"My Friend Hundefutter","brands":["Bosch My Friend"],"images":["https://media.zooplus.com/bilder/8/800/13912_pla_my_friend_hundefutter_8.jpg"],"rating":5,"region":"de","reviews":[{"body":"Meine Old english Bulldogge bekommt hauptsächlich Fleisch vom Metzger und zwar Lamm und Rind, sowie diese Knochen. Dazu bekommt sie Nassfutter und hin und wieder dieses Trockenfutter von Bosch mit Vitamin D Tabletten, Lachsöl, sowie Biotin.Meist weicht es auf durch das Lachsöl bevor ich es verfüttere, aber sie frisst es gerne, lässt keine Krümel übrig. Also diese Sorte schmeckt ihr sehr gut. Als ich von Bosch Huhn als Geschmack orderte, verweigerte sie das Futter. Preis-Leistung ist auch top.","date":"2026-06-25","title":"Zufriedener Hund","votes":0,"author":"Jamila Al Badri Abidin Shammah","rating":4,"variant":"20 kg","review_id":15538425,"verified_purchase":false},{"body":"Das Futter ist Prima würde ich immer wieder empfehlen","date":"2025-12-05","title":"Super Produkt","votes":0,"author":"Janina Kaefer","rating":5,"variant":null,"review_id":15152485,"verified_purchase":false},{"body":"Meine Hündin hat 2 Brocken gefressen und danach das Futter nicht mehr angerührt. Als sie es auch am 2. Tag verweigert hat, habe ich anderes gekauft.","date":"2025-10-04","title":"Hungerstreik","votes":0,"author":null,"rating":1,"variant":null,"review_id":15067968,"verified_purchase":false},{"body":"Meine Hunde lieben das Bosch Futter keine Blähungen mehr vertragen es prima und fressen es gerne.\nAuch der Preis ist top da ich 4 Hunde habe.\nDanke für die zuverlässige Abbo Lieferung. Ihr seid ein tolles Team 🌷🙏🏻🫶🏼","date":"2025-02-22","title":"Top Zufrieden","votes":0,"author":"Tanja L.B","rating":5,"variant":null,"review_id":14468607,"verified_purchase":false},{"body":"Meine Fellnasen lieben und vor allem vertragen das Futter super. Es wird trocken sowie feucht ( mit lauwarmen Wasser angesetzt ) immer gern angenommen. Ein einheitliches Futter für alle, auch sensible Mägen vertragen es ausgesprochen gut.\nAbsolut empfehlenswert!!","date":"2022-07-12","title":"Super Trockenfutter","votes":1,"author":"Charly","rating":5,"variant":null,"review_id":9859173,"verified_purchase":false},{"body":"under Schäferhunf ist ganz wild nach dem Futter und leert seinen Napf sehr zügig, das Fell glänzt und rd ist sehr agil","date":"2022-02-03","title":"tolles Futter","votes":1,"author":null,"rating":5,"variant":null,"review_id":8704884,"verified_purchase":false},{"body":"Wir haben 2 Hunde aus dem Tierschutz und die sind ziemlich empfindlich was das Futter angeht. Aber mit diesem Futter ist das kein Problem. Und das beste ist sie mögen es wie verrückt.","date":"2021-07-17","title":"Gutes Futter","votes":2,"author":"Andreas Koburger","rating":5,"variant":null,"review_id":7536179,"verified_purchase":false},{"body":"Unsere Hunde Lieben es\nWir haben das Futter gefunden wo alle Hunde drauf stehen und das alle Fellnasen von uns sehr gut vertragen auf Dauer.\nPreis Leistung ist auch super\nNeue Bestellung ist schon wieder raus","date":"2021-05-03","title":"****** Gerne würde ich noch mehr Sterne Geben","votes":1,"author":"J. Krüger","rating":5,"variant":null,"review_id":7110542,"verified_purchase":false},{"body":"My Friend Hundefutter ein super Futter was ich schon über Jahre meinen Hunden Füttere","date":"2020-09-13","title":"Hundefutter","votes":3,"author":"Dirk Hoitsma","rating":5,"variant":null,"review_id":5569749,"verified_purchase":false},{"body":"Kaufe Tierfutter seit langem schon bei Bitiba .\nSeit längerem Zeit Füttere ich meine Erwachsene Hunde damit,,\n.. sehr gute Futter ....\nVon Preis her günstiger als bei Fressnapf..\nMy Friend Futter ist 1A ,Bitiba immer zuverläsig,sehr Gute Ware,Blitzversand,Bin sehr zufrieden mit,danke ihnen für solche Tierfutter Bedarf...\nPS,,,,Waldemar","date":"2020-07-18","title":"Große-Hunde- Rasse ,, Alabai ''","votes":1,"author":"Waldemar","rating":5,"variant":null,"review_id":5328008,"verified_purchase":false},{"body":"Füttere es seit Nov. 2015 - mache immer ein wenig Öl daran ....so schnell kann Mensch nicht schauen und weg ist es","date":"2020-06-16","title":"Gutes preiswertes Trockenfutter","votes":4,"author":"Heike H.","rating":5,"variant":null,"review_id":5231562,"verified_purchase":false},{"body":"Sehr gut meine Hunde lieben es und sehen super aus 👍","date":"2020-06-01","title":"Sehr zufrieden","votes":1,"author":"Ela","rating":5,"variant":null,"review_id":5207488,"verified_purchase":false},{"body":"Das Hundefutter finde ich garnicht gut mein Hund macht viele große Häufchen davon überwiegend sehr dünn und frisst das etwas festere wieder.","date":"2020-05-13","title":"Schlechte Auswirkungen auf den Hund","votes":2,"author":"Jack","rating":1,"variant":null,"review_id":5156174,"verified_purchase":false},{"body":"Das Futter ist sehr gut!\nMeine Hunde sind top fit vertragen es super und mögen es sehr gerne.","date":"2019-11-11","title":"Sehr zufrieden","votes":1,"author":"Ela","rating":5,"variant":null,"review_id":4766015,"verified_purchase":false},{"body":"Ich habe 3 Schäferhunde, die dieses Futter bekommen. Elli (7J.), Diva (12,5 J.), Drago( 12,5 J.). Bei der Futterumstellung hatten die Hunde Probleme mit Durchfall. Das war aber nach ein paar Tagen wieder okay. Ansonsten sehen die Drei perfekt aus, dass Fell glänzt super. Werde das Futter weiter bestellen.","date":"2019-08-29","title":"Qualität und Preis sehr gut","votes":1,"author":"Iris Braun","rating":4,"variant":null,"review_id":4613129,"verified_purchase":false},{"body":"Meine zwei Dackel vertragen dieses Futter ausgezeichnet ! Auch gut als Leckerli für Unterwegs geeignet, da die einzelnen Stückchen groß genug sind.","date":"2018-11-19","title":"Superfutter","votes":1,"author":"Dr. Neubert Claudia","rating":5,"variant":null,"review_id":4088354,"verified_purchase":false},{"body":"Vertragen meine Hunde sehr gut.\nSchnelle Lieferung.","date":"2018-05-07","title":"sehr gutes Futter","votes":0,"author":null,"rating":5,"variant":null,"review_id":3735634,"verified_purchase":false},{"body":"Mein Hund hat es sehr gut vertragen. Er ist relativ empfindlich . Der Preis ist unschlagbar .","date":"2018-04-23","title":"Gutes Futter","votes":1,"author":"Sabine","rating":5,"variant":null,"review_id":3709852,"verified_purchase":false},{"body":"Sehr gutes Hundefutter, kaum zu glauben, dass es so günstig ist. Es gefällt unsere Mischling zwischen Border Collie und Siberean Husky ziemlich gut. Nachdem wir gewechselt haben, ist ihr Fell weicher und geschmeidiger geworden, ihr Atem stinkt nicht mehr und ihr Stuhl ist ganz normal (in Konsistenz und Duft).","date":"2017-03-13","title":"Super Futter","votes":0,"author":null,"rating":5,"variant":null,"review_id":3015843,"verified_purchase":false},{"body":"Unsere Hunde fressen es gerne. Der Ältere, Rottweiler-Labbimix, hatte auch Probleme mit den Verdauungsdüften, der Jüngere, Labbi-Redriever, nicht, Seit wir das Futter anfeuchten, sind die Düfte ganz weg. Der Ältere hatte diese Beschwerden auch beim früheren Futter, jedoch nicht so stark. So haben wir das in den Griff bekommen. Vielleicht eine Anregung für Andere, das mal auszuprobieren. Für den Geschmachswechsel geben wir manchmal etwas Nassfutter mit dazu, das wir unterrühren.","date":"2016-12-15","title":"Gutes Futter, angefeuchtet keine Biogasanlage","votes":1,"author":"Wilhelmine Traut","rating":5,"variant":null,"review_id":2909916,"verified_purchase":false}],"summary":"Ausgewogene Vollnahrung für ausgewachsene Hunde mit normaler Aktivität, bekömmlich und sehr schmackhaft, moderater Energiegehalt, ohne künstliche Farb- oder Lockstoffe","category":"Hundefutter und Zubehör > Hundefutter Trockennahrung > My Friend","currency":"EUR","in_stock":true,"variants":[{"ean":"4015598322201","sku":"75036.2","unit":"kg","price":23.49,"badges":["autoshipment"],"seller":"zooplus","currency":"EUR","available":true,"discounts":[{"type":"AUTOSHIPMENT","label":"6%","price":22.08,"price_display":"22,08 €"}],"image_url":"https://media.zooplus.com/bilder/8/800/13912_pla_my_friend_hundefutter_8.jpg","article_id":"343803","attributes":[{"name":"Trockenfutter Verpackungsgröße pro Einheit","value":"> 10 kg"},{"name":"Hergestellt in","value":"Deutschland"},{"name":"Verpackungsart","value":"Futtersack"},{"name":"Lebensphase Hund","value":"Erwachsen (+1 Jahre)"},{"name":"Spezielle Futtereigenschaften","value":"Ohne künstliche Zusatzstoffe, Gentechnikfrei, Zuckerfrei"},{"name":"Futterart","value":"Trockenfutter"}],"supplement":false,"unit_price":1.17,"variant_id":"2","description":"20 kg","constituents":[{"name":"Rohprotein","unit":"%","amount":20},{"name":"Rohfett","unit":"%","amount":7},{"name":"Rohfaser","unit":"%","amount":3},{"name":"Rohasche","unit":"%","amount":7},{"name":"Kalzium","unit":"%","amount":1.2},{"name":"Phosphor","unit":"%","amount":1.1},{"name":"Kupfer","unit":"mg","amount":12}],"price_display":"23,49 €","delivery_max_days":4,"delivery_min_days":2,"unit_price_display":"1,17 € / kg"}],"image_url":"https://media.zooplus.com/bilder/8/800/13912_pla_my_friend_hundefutter_8.jpg","is_choice":false,"price_max":23.49,"price_min":23.49,"product_id":"75036","unit_price":1.17,"breadcrumbs":[{"url":"https://www.bitiba.de/","title":"bitiba.de"},{"url":"https://www.bitiba.de/shop/hunde","title":"Hundefutter und Zubehör"},{"url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken","title":"Hundefutter Trockennahrung"},{"url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend","title":"My Friend"},{"url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend/75036","title":"My Friend Hundefutter"}],"description":"My Friend Hundefutter ist ein Alleinfuttermittel für ausgewachsene Hunde aller Rassen. Ausschließlich erlesene, hochwertige Zutaten werden für dieses Futter verarbeitet, denn auch auf die Qualität der Rohstoffe kommt es an. Der Energiegehalt dieses Futters ist moderat und so gewählt, dass es zu keiner Überversorgung mit Energie kommt, und so ungewünschtes Übergewicht vermieden wird. My Friend Trockenfutter liefert alle lebenswichtigen Nährstoffe, Vitamine, Spurenelemente, essentiellen Fettsäuren, Ballaststoffe und Aminosäuren, die für eine ausgewogene und ganzheitliche Ernährung von Hunden wichtig sind. Dieses Futter enthält hochaufgeschlossene Komponenten und wertvolle Eiweißträger. Auf den Zusatz von künstlichen Farb- Konservierungs- und Lockstoffen wird bei diesem Futter verzichtet. Wertvolle Omega-3-Fettsäuren können helfen, die Haut- und Fellgesundheit zu verbessern. Die enthaltenen Ballaststoffe können die Darmtätigkeit fördern, und die Verdauung regulieren.\nMy Friend Hundefutter kann sowohl trocken als auch angefeuchtet gefüttert werden. Gerade etwas mäklige Hunde animiert eine angefeuchtete Trockennahrung zusätzlich zum Fressen.\nMy Friend Hundefutter stammt aus dem Hause Bosch, einem namhaften Familienunternehmen aus Deutschland. 50 Jahre Erfahrung in der Premium Trockenfutter-Herstellung fließen in dieses Produkt mit ein. Strenge Qualitätskontrollen sichern eine gleichbleibende, hohe Qualität.\nMy Friend Hundefutter im Überblick:\n- Für ausgewachsene Hunde aller Rassen mit normaler Aktivität\n- Futter aus dem Hause Bosch\n- Ausschließlich erlesene, qualitativ hochwertige Zutaten\n- Moderater Energiegehalt, zur Vermeidung von ungewünschter Gewichtszunahme\n- Enthält alle elementaren Nährstoffe, Vitamine, Spurenelemente, essentiellen Fettsäuren, Ballaststoffe und Aminosäuren\n- Enthält hochaufgeschlossene Komponenten und wertvolle Eiweißträger\n- Ohne künstliche Farb- Konservierungs- und Lockstoffe\n- Omega-3-Fettsäuren zur Unterstützung der Haut- und Fellgesundheit\n- Ballaststoffe können die Darmtätigkeit fördern, und die Verdauung regulieren\n- Ausgewogen und ganzheitlich\n- Kann trocken und angefeuchtet gefüttert werden","ingredients":"Zusammensetzung\nGetreide, Fleisch und tierische Nebenerzeugnisse, pflanzliche Nebenerzeugnisse, Öle und Fette, Mineralstoffe.\nZusatzstoffe\nErnährungsphysiologische Zusatzstoffe:\nVitamin A (10.000 IE/kg), Vitamin D3 (1.200 IE/kg), Vitamin E (50 mg/kg), Kupfer [als Kupfer-(II)-sulfat, Pentahydrat] (9 mg/kg), Zink [als Zinkoxid] (65 mg/kg), Jod [als Kalziumjodat, wasserfrei] (2 mg/kg), Selen [als Natriumselenit] (0,2 mg/kg).\nTechnologische Zusatzstoffe:\nAntioxidationsmittel.","choice_label":null,"review_count":65,"price_display":"23,49 €","variant_count":1,"price_max_display":"23,49 €","price_min_display":"23,49 €","unit_price_display":"1,17 € / kg","selected_variant_id":"2","feeding_recommendation":"Fütterungsempfehlung\nMy Friend Hundefutter ist ein Alleinfuttermittel.für Hunde.\nGewicht des Hundes\nTagesmenge in g\n3 - 5 kg\n65 - 95\n5 - 10 kg\n95 - 165\n10 - 15 kg\n165 - 220\n15 - 20 kg\n220 - 275\n20 - 25 kg\n275 - 325\n25 - 30 kg\n325 - 375\n30 - 40 kg\n375 - 465\n40 - 50 kg\n465 - 550\n50 - 60 kg\n550 - 630\n60 - 80 kg\n630 - 780"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Bitiba Product","description":"Read one product from a live Bitiba shop, including the selected variant price and the pack list.\n\n**Credit cost:** 1 credit per call","operationId":"post-bitiba-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL, shop path, or product number. Example: 75036. A search link returns 400.","schema":{"type":"string","description":"Product URL, shop path, or product number. Example: 75036. A search link returns 400."}},{"name":"region","in":"query","required":false,"description":"Shop used when query is a number or a path. de is Germany (default).","schema":{"type":"string","default":"de","description":"Shop used when query is a number or a path. de is Germany (default)."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"brands":{"type":"array","items":{"type":"string"}},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"region":{"type":"string"},"reviews":{"type":"array","items":{"type":"object","properties":{"body":{"type":"string"},"date":{"type":"string"},"title":{"type":"string"},"votes":{"type":"integer"},"author":{"type":"string"},"rating":{"type":"integer"},"variant":{"type":"string"},"review_id":{"type":"integer"},"verified_purchase":{"type":"boolean"}}}},"summary":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"sku":{"type":"string"},"unit":{"type":"string"},"price":{"type":"number"},"badges":{"type":"array","items":{"type":"string"}},"seller":{"type":"string"},"currency":{"type":"string"},"available":{"type":"boolean"},"discounts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"price":{"type":"number"},"price_display":{"type":"string"}}}},"image_url":{"type":"string"},"article_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"supplement":{"type":"boolean"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"description":{"type":"string"},"constituents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"unit":{"type":"string"},"amount":{"type":"integer"}}}},"price_display":{"type":"string"},"delivery_max_days":{"type":"integer"},"delivery_min_days":{"type":"integer"},"unit_price_display":{"type":"string"}}}},"image_url":{"type":"string"},"is_choice":{"type":"boolean"},"price_max":{"type":"number"},"price_min":{"type":"number"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}},"description":{"type":"string"},"ingredients":{"type":"string"},"choice_label":{"nullable":true},"review_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"price_max_display":{"type":"string"},"price_min_display":{"type":"string"},"unit_price_display":{"type":"string"},"selected_variant_id":{"type":"string"},"feeding_recommendation":{"type":"string"}}},"examples":{"My Friend 15 kg class on bitiba.de":{"value":{"ean":"4015598322201","url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend/75036","unit":"kg","brand":"Bosch My Friend","price":23.49,"title":"My Friend Hundefutter","brands":["Bosch My Friend"],"images":["https://media.zooplus.com/bilder/8/800/13912_pla_my_friend_hundefutter_8.jpg"],"rating":5,"region":"de","reviews":[{"body":"Meine Old english Bulldogge bekommt hauptsächlich Fleisch vom Metzger und zwar Lamm und Rind, sowie diese Knochen. Dazu bekommt sie Nassfutter und hin und wieder dieses Trockenfutter von Bosch mit Vitamin D Tabletten, Lachsöl, sowie Biotin.Meist weicht es auf durch das Lachsöl bevor ich es verfüttere, aber sie frisst es gerne, lässt keine Krümel übrig. Also diese Sorte schmeckt ihr sehr gut. Als ich von Bosch Huhn als Geschmack orderte, verweigerte sie das Futter. Preis-Leistung ist auch top.","date":"2026-06-25","title":"Zufriedener Hund","votes":0,"author":"Jamila Al Badri Abidin Shammah","rating":4,"variant":"20 kg","review_id":15538425,"verified_purchase":false},{"body":"Das Futter ist Prima würde ich immer wieder empfehlen","date":"2025-12-05","title":"Super Produkt","votes":0,"author":"Janina Kaefer","rating":5,"variant":null,"review_id":15152485,"verified_purchase":false},{"body":"Meine Hündin hat 2 Brocken gefressen und danach das Futter nicht mehr angerührt. Als sie es auch am 2. Tag verweigert hat, habe ich anderes gekauft.","date":"2025-10-04","title":"Hungerstreik","votes":0,"author":null,"rating":1,"variant":null,"review_id":15067968,"verified_purchase":false},{"body":"Meine Hunde lieben das Bosch Futter keine Blähungen mehr vertragen es prima und fressen es gerne.\nAuch der Preis ist top da ich 4 Hunde habe.\nDanke für die zuverlässige Abbo Lieferung. Ihr seid ein tolles Team 🌷🙏🏻🫶🏼","date":"2025-02-22","title":"Top Zufrieden","votes":0,"author":"Tanja L.B","rating":5,"variant":null,"review_id":14468607,"verified_purchase":false},{"body":"Meine Fellnasen lieben und vor allem vertragen das Futter super. Es wird trocken sowie feucht ( mit lauwarmen Wasser angesetzt ) immer gern angenommen. Ein einheitliches Futter für alle, auch sensible Mägen vertragen es ausgesprochen gut.\nAbsolut empfehlenswert!!","date":"2022-07-12","title":"Super Trockenfutter","votes":1,"author":"Charly","rating":5,"variant":null,"review_id":9859173,"verified_purchase":false},{"body":"under Schäferhunf ist ganz wild nach dem Futter und leert seinen Napf sehr zügig, das Fell glänzt und rd ist sehr agil","date":"2022-02-03","title":"tolles Futter","votes":1,"author":null,"rating":5,"variant":null,"review_id":8704884,"verified_purchase":false},{"body":"Wir haben 2 Hunde aus dem Tierschutz und die sind ziemlich empfindlich was das Futter angeht. Aber mit diesem Futter ist das kein Problem. Und das beste ist sie mögen es wie verrückt.","date":"2021-07-17","title":"Gutes Futter","votes":2,"author":"Andreas Koburger","rating":5,"variant":null,"review_id":7536179,"verified_purchase":false},{"body":"Unsere Hunde Lieben es\nWir haben das Futter gefunden wo alle Hunde drauf stehen und das alle Fellnasen von uns sehr gut vertragen auf Dauer.\nPreis Leistung ist auch super\nNeue Bestellung ist schon wieder raus","date":"2021-05-03","title":"****** Gerne würde ich noch mehr Sterne Geben","votes":1,"author":"J. Krüger","rating":5,"variant":null,"review_id":7110542,"verified_purchase":false},{"body":"My Friend Hundefutter ein super Futter was ich schon über Jahre meinen Hunden Füttere","date":"2020-09-13","title":"Hundefutter","votes":3,"author":"Dirk Hoitsma","rating":5,"variant":null,"review_id":5569749,"verified_purchase":false},{"body":"Kaufe Tierfutter seit langem schon bei Bitiba .\nSeit längerem Zeit Füttere ich meine Erwachsene Hunde damit,,\n.. sehr gute Futter ....\nVon Preis her günstiger als bei Fressnapf..\nMy Friend Futter ist 1A ,Bitiba immer zuverläsig,sehr Gute Ware,Blitzversand,Bin sehr zufrieden mit,danke ihnen für solche Tierfutter Bedarf...\nPS,,,,Waldemar","date":"2020-07-18","title":"Große-Hunde- Rasse ,, Alabai ''","votes":1,"author":"Waldemar","rating":5,"variant":null,"review_id":5328008,"verified_purchase":false},{"body":"Füttere es seit Nov. 2015 - mache immer ein wenig Öl daran ....so schnell kann Mensch nicht schauen und weg ist es","date":"2020-06-16","title":"Gutes preiswertes Trockenfutter","votes":4,"author":"Heike H.","rating":5,"variant":null,"review_id":5231562,"verified_purchase":false},{"body":"Sehr gut meine Hunde lieben es und sehen super aus 👍","date":"2020-06-01","title":"Sehr zufrieden","votes":1,"author":"Ela","rating":5,"variant":null,"review_id":5207488,"verified_purchase":false},{"body":"Das Hundefutter finde ich garnicht gut mein Hund macht viele große Häufchen davon überwiegend sehr dünn und frisst das etwas festere wieder.","date":"2020-05-13","title":"Schlechte Auswirkungen auf den Hund","votes":2,"author":"Jack","rating":1,"variant":null,"review_id":5156174,"verified_purchase":false},{"body":"Das Futter ist sehr gut!\nMeine Hunde sind top fit vertragen es super und mögen es sehr gerne.","date":"2019-11-11","title":"Sehr zufrieden","votes":1,"author":"Ela","rating":5,"variant":null,"review_id":4766015,"verified_purchase":false},{"body":"Ich habe 3 Schäferhunde, die dieses Futter bekommen. Elli (7J.), Diva (12,5 J.), Drago( 12,5 J.). Bei der Futterumstellung hatten die Hunde Probleme mit Durchfall. Das war aber nach ein paar Tagen wieder okay. Ansonsten sehen die Drei perfekt aus, dass Fell glänzt super. Werde das Futter weiter bestellen.","date":"2019-08-29","title":"Qualität und Preis sehr gut","votes":1,"author":"Iris Braun","rating":4,"variant":null,"review_id":4613129,"verified_purchase":false},{"body":"Meine zwei Dackel vertragen dieses Futter ausgezeichnet ! Auch gut als Leckerli für Unterwegs geeignet, da die einzelnen Stückchen groß genug sind.","date":"2018-11-19","title":"Superfutter","votes":1,"author":"Dr. Neubert Claudia","rating":5,"variant":null,"review_id":4088354,"verified_purchase":false},{"body":"Vertragen meine Hunde sehr gut.\nSchnelle Lieferung.","date":"2018-05-07","title":"sehr gutes Futter","votes":0,"author":null,"rating":5,"variant":null,"review_id":3735634,"verified_purchase":false},{"body":"Mein Hund hat es sehr gut vertragen. Er ist relativ empfindlich . Der Preis ist unschlagbar .","date":"2018-04-23","title":"Gutes Futter","votes":1,"author":"Sabine","rating":5,"variant":null,"review_id":3709852,"verified_purchase":false},{"body":"Sehr gutes Hundefutter, kaum zu glauben, dass es so günstig ist. Es gefällt unsere Mischling zwischen Border Collie und Siberean Husky ziemlich gut. Nachdem wir gewechselt haben, ist ihr Fell weicher und geschmeidiger geworden, ihr Atem stinkt nicht mehr und ihr Stuhl ist ganz normal (in Konsistenz und Duft).","date":"2017-03-13","title":"Super Futter","votes":0,"author":null,"rating":5,"variant":null,"review_id":3015843,"verified_purchase":false},{"body":"Unsere Hunde fressen es gerne. Der Ältere, Rottweiler-Labbimix, hatte auch Probleme mit den Verdauungsdüften, der Jüngere, Labbi-Redriever, nicht, Seit wir das Futter anfeuchten, sind die Düfte ganz weg. Der Ältere hatte diese Beschwerden auch beim früheren Futter, jedoch nicht so stark. So haben wir das in den Griff bekommen. Vielleicht eine Anregung für Andere, das mal auszuprobieren. Für den Geschmachswechsel geben wir manchmal etwas Nassfutter mit dazu, das wir unterrühren.","date":"2016-12-15","title":"Gutes Futter, angefeuchtet keine Biogasanlage","votes":1,"author":"Wilhelmine Traut","rating":5,"variant":null,"review_id":2909916,"verified_purchase":false}],"summary":"Ausgewogene Vollnahrung für ausgewachsene Hunde mit normaler Aktivität, bekömmlich und sehr schmackhaft, moderater Energiegehalt, ohne künstliche Farb- oder Lockstoffe","category":"Hundefutter und Zubehör > Hundefutter Trockennahrung > My Friend","currency":"EUR","in_stock":true,"variants":[{"ean":"4015598322201","sku":"75036.2","unit":"kg","price":23.49,"badges":["autoshipment"],"seller":"zooplus","currency":"EUR","available":true,"discounts":[{"type":"AUTOSHIPMENT","label":"6%","price":22.08,"price_display":"22,08 €"}],"image_url":"https://media.zooplus.com/bilder/8/800/13912_pla_my_friend_hundefutter_8.jpg","article_id":"343803","attributes":[{"name":"Trockenfutter Verpackungsgröße pro Einheit","value":"> 10 kg"},{"name":"Hergestellt in","value":"Deutschland"},{"name":"Verpackungsart","value":"Futtersack"},{"name":"Lebensphase Hund","value":"Erwachsen (+1 Jahre)"},{"name":"Spezielle Futtereigenschaften","value":"Ohne künstliche Zusatzstoffe, Gentechnikfrei, Zuckerfrei"},{"name":"Futterart","value":"Trockenfutter"}],"supplement":false,"unit_price":1.17,"variant_id":"2","description":"20 kg","constituents":[{"name":"Rohprotein","unit":"%","amount":20},{"name":"Rohfett","unit":"%","amount":7},{"name":"Rohfaser","unit":"%","amount":3},{"name":"Rohasche","unit":"%","amount":7},{"name":"Kalzium","unit":"%","amount":1.2},{"name":"Phosphor","unit":"%","amount":1.1},{"name":"Kupfer","unit":"mg","amount":12}],"price_display":"23,49 €","delivery_max_days":4,"delivery_min_days":2,"unit_price_display":"1,17 € / kg"}],"image_url":"https://media.zooplus.com/bilder/8/800/13912_pla_my_friend_hundefutter_8.jpg","is_choice":false,"price_max":23.49,"price_min":23.49,"product_id":"75036","unit_price":1.17,"breadcrumbs":[{"url":"https://www.bitiba.de/","title":"bitiba.de"},{"url":"https://www.bitiba.de/shop/hunde","title":"Hundefutter und Zubehör"},{"url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken","title":"Hundefutter Trockennahrung"},{"url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend","title":"My Friend"},{"url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend/75036","title":"My Friend Hundefutter"}],"description":"My Friend Hundefutter ist ein Alleinfuttermittel für ausgewachsene Hunde aller Rassen. Ausschließlich erlesene, hochwertige Zutaten werden für dieses Futter verarbeitet, denn auch auf die Qualität der Rohstoffe kommt es an. Der Energiegehalt dieses Futters ist moderat und so gewählt, dass es zu keiner Überversorgung mit Energie kommt, und so ungewünschtes Übergewicht vermieden wird. My Friend Trockenfutter liefert alle lebenswichtigen Nährstoffe, Vitamine, Spurenelemente, essentiellen Fettsäuren, Ballaststoffe und Aminosäuren, die für eine ausgewogene und ganzheitliche Ernährung von Hunden wichtig sind. Dieses Futter enthält hochaufgeschlossene Komponenten und wertvolle Eiweißträger. Auf den Zusatz von künstlichen Farb- Konservierungs- und Lockstoffen wird bei diesem Futter verzichtet. Wertvolle Omega-3-Fettsäuren können helfen, die Haut- und Fellgesundheit zu verbessern. Die enthaltenen Ballaststoffe können die Darmtätigkeit fördern, und die Verdauung regulieren.\nMy Friend Hundefutter kann sowohl trocken als auch angefeuchtet gefüttert werden. Gerade etwas mäklige Hunde animiert eine angefeuchtete Trockennahrung zusätzlich zum Fressen.\nMy Friend Hundefutter stammt aus dem Hause Bosch, einem namhaften Familienunternehmen aus Deutschland. 50 Jahre Erfahrung in der Premium Trockenfutter-Herstellung fließen in dieses Produkt mit ein. Strenge Qualitätskontrollen sichern eine gleichbleibende, hohe Qualität.\nMy Friend Hundefutter im Überblick:\n- Für ausgewachsene Hunde aller Rassen mit normaler Aktivität\n- Futter aus dem Hause Bosch\n- Ausschließlich erlesene, qualitativ hochwertige Zutaten\n- Moderater Energiegehalt, zur Vermeidung von ungewünschter Gewichtszunahme\n- Enthält alle elementaren Nährstoffe, Vitamine, Spurenelemente, essentiellen Fettsäuren, Ballaststoffe und Aminosäuren\n- Enthält hochaufgeschlossene Komponenten und wertvolle Eiweißträger\n- Ohne künstliche Farb- Konservierungs- und Lockstoffe\n- Omega-3-Fettsäuren zur Unterstützung der Haut- und Fellgesundheit\n- Ballaststoffe können die Darmtätigkeit fördern, und die Verdauung regulieren\n- Ausgewogen und ganzheitlich\n- Kann trocken und angefeuchtet gefüttert werden","ingredients":"Zusammensetzung\nGetreide, Fleisch und tierische Nebenerzeugnisse, pflanzliche Nebenerzeugnisse, Öle und Fette, Mineralstoffe.\nZusatzstoffe\nErnährungsphysiologische Zusatzstoffe:\nVitamin A (10.000 IE/kg), Vitamin D3 (1.200 IE/kg), Vitamin E (50 mg/kg), Kupfer [als Kupfer-(II)-sulfat, Pentahydrat] (9 mg/kg), Zink [als Zinkoxid] (65 mg/kg), Jod [als Kalziumjodat, wasserfrei] (2 mg/kg), Selen [als Natriumselenit] (0,2 mg/kg).\nTechnologische Zusatzstoffe:\nAntioxidationsmittel.","choice_label":null,"review_count":65,"price_display":"23,49 €","variant_count":1,"price_max_display":"23,49 €","price_min_display":"23,49 €","unit_price_display":"1,17 € / kg","selected_variant_id":"2","feeding_recommendation":"Fütterungsempfehlung\nMy Friend Hundefutter ist ein Alleinfuttermittel.für Hunde.\nGewicht des Hundes\nTagesmenge in g\n3 - 5 kg\n65 - 95\n5 - 10 kg\n95 - 165\n10 - 15 kg\n165 - 220\n15 - 20 kg\n220 - 275\n20 - 25 kg\n275 - 325\n25 - 30 kg\n325 - 375\n30 - 40 kg\n375 - 465\n40 - 50 kg\n465 - 550\n50 - 60 kg\n550 - 630\n60 - 80 kg\n630 - 780"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bitiba/search":{"get":{"summary":"Bitiba Search","description":"Search a live Bitiba country shop. Germany is the default. www.bitiba.com is closed and returns 400.\n\n**Credit cost:** 1 credit per call","operationId":"get-bitiba-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word such as hundefutter, or a Bitiba search link. A product link returns 400. www.bitiba.com returns 400.","schema":{"type":"string","description":"What to look for. A word such as hundefutter, or a Bitiba search link. A product link returns 400. www.bitiba.com returns 400."}},{"name":"region","in":"query","required":false,"description":"Country shop. de is Germany (default), fr is France, uk is the United Kingdom. gb means uk.","schema":{"type":"string","default":"de","description":"Country shop. de is Germany (default), fr is France, uk is the United Kingdom. gb means uk."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 uses p=2.","schema":{"type":"number","minimum":1,"description":"Page number, starting at 1. Page 2 uses p=2."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"brands":{"type":"array","items":{"type":"string"}},"images":{"type":"array","items":{"type":"string"}},"is_new":{"type":"boolean"},"rating":{"type":"number"},"region":{"type":"string"},"summary":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_alt":{"type":"string"},"image_url":{"type":"string"},"is_choice":{"type":"boolean"},"pet_types":{"type":"array","items":{"type":"string"}},"article_id":{"type":"string"},"is_reduced":{"type":"boolean"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"choice_label":{"nullable":true},"is_sponsored":{"type":"boolean"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"discount_label":{"nullable":true},"promotion_text":{"nullable":true},"reference_price":{"type":"number"},"delivery_max_days":{"type":"integer"},"delivery_min_days":{"type":"integer"},"unit_price_display":{"type":"string"},"variant_description":{"type":"string"},"reference_price_label":{"type":"string"},"reference_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"My Friend dog food on bitiba.de":{"value":{"results":[{"sku":"75036.2","url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend/75036?activeVariant=75036.2","unit":"kg","brand":"Bosch My Friend","price":23.49,"title":"My Friend Hundefutter","brands":["Bosch My Friend"],"images":["https://media.zooplus.com/bilder/8/400/13912_pla_my_friend_hundefutter_8.jpg"],"is_new":false,"rating":4.6,"region":"de","summary":"Ausgewogene Vollnahrung für ausgewachsene Hunde mit normaler Aktivität, bekömmlich und sehr schmackhaft, moderater Energiegehalt, ohne künstliche Farb- oder Lockstoffe","currency":"EUR","in_stock":true,"image_alt":"My Friend Hundefutter - 20 kg","image_url":"https://media.zooplus.com/bilder/8/400/13912_pla_my_friend_hundefutter_8.jpg","is_choice":false,"pet_types":["DOGS"],"article_id":"343803","is_reduced":true,"product_id":"75036","unit_price":1.17,"variant_id":"2","choice_label":null,"is_sponsored":false,"review_count":65,"price_display":"23,49 €","variant_count":1,"discount_label":null,"promotion_text":null,"reference_price":31.95,"delivery_max_days":4,"delivery_min_days":2,"unit_price_display":"1,17 €","variant_description":"20 kg","reference_price_label":"UVP","reference_price_display":"31,95 €"}],"pagination":{"next":"https://www.bitiba.de/search/results?q=hundefutter&p=2","page":1,"per_page":48,"total_pages":160,"total_results":7652}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Bitiba Search","description":"Search a live Bitiba country shop. Germany is the default. www.bitiba.com is closed and returns 400.\n\n**Credit cost:** 1 credit per call","operationId":"post-bitiba-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word such as hundefutter, or a Bitiba search link. A product link returns 400. www.bitiba.com returns 400.","schema":{"type":"string","description":"What to look for. A word such as hundefutter, or a Bitiba search link. A product link returns 400. www.bitiba.com returns 400."}},{"name":"region","in":"query","required":false,"description":"Country shop. de is Germany (default), fr is France, uk is the United Kingdom. gb means uk.","schema":{"type":"string","default":"de","description":"Country shop. de is Germany (default), fr is France, uk is the United Kingdom. gb means uk."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 uses p=2.","schema":{"type":"number","minimum":1,"description":"Page number, starting at 1. Page 2 uses p=2."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"brands":{"type":"array","items":{"type":"string"}},"images":{"type":"array","items":{"type":"string"}},"is_new":{"type":"boolean"},"rating":{"type":"number"},"region":{"type":"string"},"summary":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_alt":{"type":"string"},"image_url":{"type":"string"},"is_choice":{"type":"boolean"},"pet_types":{"type":"array","items":{"type":"string"}},"article_id":{"type":"string"},"is_reduced":{"type":"boolean"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"choice_label":{"nullable":true},"is_sponsored":{"type":"boolean"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"discount_label":{"nullable":true},"promotion_text":{"nullable":true},"reference_price":{"type":"number"},"delivery_max_days":{"type":"integer"},"delivery_min_days":{"type":"integer"},"unit_price_display":{"type":"string"},"variant_description":{"type":"string"},"reference_price_label":{"type":"string"},"reference_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"My Friend dog food on bitiba.de":{"value":{"results":[{"sku":"75036.2","url":"https://www.bitiba.de/shop/hunde/hundefutter_trocken/my_friend/75036?activeVariant=75036.2","unit":"kg","brand":"Bosch My Friend","price":23.49,"title":"My Friend Hundefutter","brands":["Bosch My Friend"],"images":["https://media.zooplus.com/bilder/8/400/13912_pla_my_friend_hundefutter_8.jpg"],"is_new":false,"rating":4.6,"region":"de","summary":"Ausgewogene Vollnahrung für ausgewachsene Hunde mit normaler Aktivität, bekömmlich und sehr schmackhaft, moderater Energiegehalt, ohne künstliche Farb- oder Lockstoffe","currency":"EUR","in_stock":true,"image_alt":"My Friend Hundefutter - 20 kg","image_url":"https://media.zooplus.com/bilder/8/400/13912_pla_my_friend_hundefutter_8.jpg","is_choice":false,"pet_types":["DOGS"],"article_id":"343803","is_reduced":true,"product_id":"75036","unit_price":1.17,"variant_id":"2","choice_label":null,"is_sponsored":false,"review_count":65,"price_display":"23,49 €","variant_count":1,"discount_label":null,"promotion_text":null,"reference_price":31.95,"delivery_max_days":4,"delivery_min_days":2,"unit_price_display":"1,17 €","variant_description":"20 kg","reference_price_label":"UVP","reference_price_display":"31,95 €"}],"pagination":{"next":"https://www.bitiba.de/search/results?q=hundefutter&p=2","page":1,"per_page":48,"total_pages":160,"total_results":7652}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/inet/product":{"get":{"summary":"Inet Product","description":"Read one Inet.se product by article number or URL, including SEK price, specs, and warehouse stock.\n\n**Credit cost:** 1 credit per call","operationId":"get-inet-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Article number or product URL. Example: 4306287. A search link returns 400.","schema":{"type":"string","description":"Article number or product URL. Example: 4306287. A search link returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"specs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"is_bargain":{"type":"boolean"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}},"description":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"selling_point":{"type":"string"},"stock_quantity":{"type":"integer"},"purchase_status":{"type":"string"},"reference_price":{"nullable":true},"reference_price_display":{"nullable":true}}},"examples":{"Samsung 990 1TB on Inet":{"value":{"sku":"MZ-V9V1T0BW","url":"https://www.inet.se/produkt/4306287/samsung-990-m-2-nvme-ssd-1tb","brand":"Samsung","price":2590,"specs":[{"name":"Minnestyp","value":"Samsung V-NAND"},{"name":"Kontroller","value":"Samsung in-house Controller"},{"name":"Formfaktor","value":"M.2"},{"name":"Färg","value":"Svart"},{"name":"M.2 storlek","value":"2280"},{"name":"M.2 key","value":"M"},{"name":"Höjd","value":"2,38 mm"},{"name":"Storlek","value":"1 TB"},{"name":"Anslutning","value":"M.2"},{"name":"Gränssnitt","value":"PCIe Gen4 x4 NVMe 2.0"},{"name":"PCIe generation","value":"PCIe 4.0"},{"name":"Läshastighet","value":"7 150 MB/sek"},{"name":"M.2 Värmespridare","value":"Nej"},{"name":"Skrivhastighet","value":"6 450 MB/sek"},{"name":"Förväntad livslängd","value":"400 TBW"},{"name":"Tillverkarens garanti","value":"3 år"},{"name":"Paketbredd","value":"10,1 cm"},{"name":"Pakethöjd","value":"2,5 cm"},{"name":"Paketlängd","value":"14,9 cm"},{"name":"Paketvikt","value":"0,068 kg"},{"name":"Vårt ArtNr","value":"4306287"},{"name":"Tillverkarens ArtNr","value":"MZ-V9V1T0BW"},{"name":"Upplagd","value":"2026-07-15 00:00"}],"title":"Samsung 990 M.2 NVMe SSD 1TB","images":["https://cdn.inet.se/product/1600x900/4306287_1mqir6.png","https://cdn.inet.se/product/1600x900/4306287_fhbdom.png","https://cdn.inet.se/product/86x86/4306287_1mqir6.jpg"],"rating":4,"category":"Datorkomponenter > Hårddisk SSD > M.2 > PCIe Gen 4 > Samsung","currency":"SEK","in_stock":true,"image_url":"https://cdn.inet.se/product/1600x900/4306287_1mqir6.png","highlights":["Formfaktor: M.2","PCIe Gen4 x4 NVMe 2.0","Läshastighet: 7150 MB/sek","Skrivhastighet: 6450 MB/sek","M.2"],"is_bargain":false,"product_id":"4306287","breadcrumbs":[{"url":"https://www.inet.se/kategori/31/datorkomponenter","title":"Datorkomponenter"},{"url":"https://www.inet.se/kategori/591/harddisk-ssd","title":"Hårddisk SSD"},{"url":"https://www.inet.se/kategori/982/m-2","title":"M.2"},{"url":"https://www.inet.se/kategori/1232/pcie-gen-4","title":"PCIe Gen 4"},{"url":"https://www.inet.se/kategori/1232/pcie-gen-4/34/samsung","title":"Samsung"}],"description":"Samsung 990 är en PCIe 4.0 NVMe SSD som kombinerar höga överförings­hastigheter med energieffektiv drift och generös lagringskapacitet. Med sekventiella läshastigheter på upp till 7 250 MB/s och skrivhastigheter på upp till 6 450 MB/s levererar Samsung 990 snabb respons vid spel, innehållsskapande och krävande arbetsflöden, samtidigt som den rymmer hela ditt spel- eller mediebibliotek.","review_count":1,"price_display":"2 590 kr","selling_point":"Hög prestanda med låg energiförbrukning","stock_quantity":52,"purchase_status":"Purchasable","reference_price":null,"reference_price_display":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Inet Product","description":"Read one Inet.se product by article number or URL, including SEK price, specs, and warehouse stock.\n\n**Credit cost:** 1 credit per call","operationId":"post-inet-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Article number or product URL. Example: 4306287. A search link returns 400.","schema":{"type":"string","description":"Article number or product URL. Example: 4306287. A search link returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"specs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"is_bargain":{"type":"boolean"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}},"description":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"selling_point":{"type":"string"},"stock_quantity":{"type":"integer"},"purchase_status":{"type":"string"},"reference_price":{"nullable":true},"reference_price_display":{"nullable":true}}},"examples":{"Samsung 990 1TB on Inet":{"value":{"sku":"MZ-V9V1T0BW","url":"https://www.inet.se/produkt/4306287/samsung-990-m-2-nvme-ssd-1tb","brand":"Samsung","price":2590,"specs":[{"name":"Minnestyp","value":"Samsung V-NAND"},{"name":"Kontroller","value":"Samsung in-house Controller"},{"name":"Formfaktor","value":"M.2"},{"name":"Färg","value":"Svart"},{"name":"M.2 storlek","value":"2280"},{"name":"M.2 key","value":"M"},{"name":"Höjd","value":"2,38 mm"},{"name":"Storlek","value":"1 TB"},{"name":"Anslutning","value":"M.2"},{"name":"Gränssnitt","value":"PCIe Gen4 x4 NVMe 2.0"},{"name":"PCIe generation","value":"PCIe 4.0"},{"name":"Läshastighet","value":"7 150 MB/sek"},{"name":"M.2 Värmespridare","value":"Nej"},{"name":"Skrivhastighet","value":"6 450 MB/sek"},{"name":"Förväntad livslängd","value":"400 TBW"},{"name":"Tillverkarens garanti","value":"3 år"},{"name":"Paketbredd","value":"10,1 cm"},{"name":"Pakethöjd","value":"2,5 cm"},{"name":"Paketlängd","value":"14,9 cm"},{"name":"Paketvikt","value":"0,068 kg"},{"name":"Vårt ArtNr","value":"4306287"},{"name":"Tillverkarens ArtNr","value":"MZ-V9V1T0BW"},{"name":"Upplagd","value":"2026-07-15 00:00"}],"title":"Samsung 990 M.2 NVMe SSD 1TB","images":["https://cdn.inet.se/product/1600x900/4306287_1mqir6.png","https://cdn.inet.se/product/1600x900/4306287_fhbdom.png","https://cdn.inet.se/product/86x86/4306287_1mqir6.jpg"],"rating":4,"category":"Datorkomponenter > Hårddisk SSD > M.2 > PCIe Gen 4 > Samsung","currency":"SEK","in_stock":true,"image_url":"https://cdn.inet.se/product/1600x900/4306287_1mqir6.png","highlights":["Formfaktor: M.2","PCIe Gen4 x4 NVMe 2.0","Läshastighet: 7150 MB/sek","Skrivhastighet: 6450 MB/sek","M.2"],"is_bargain":false,"product_id":"4306287","breadcrumbs":[{"url":"https://www.inet.se/kategori/31/datorkomponenter","title":"Datorkomponenter"},{"url":"https://www.inet.se/kategori/591/harddisk-ssd","title":"Hårddisk SSD"},{"url":"https://www.inet.se/kategori/982/m-2","title":"M.2"},{"url":"https://www.inet.se/kategori/1232/pcie-gen-4","title":"PCIe Gen 4"},{"url":"https://www.inet.se/kategori/1232/pcie-gen-4/34/samsung","title":"Samsung"}],"description":"Samsung 990 är en PCIe 4.0 NVMe SSD som kombinerar höga överförings­hastigheter med energieffektiv drift och generös lagringskapacitet. Med sekventiella läshastigheter på upp till 7 250 MB/s och skrivhastigheter på upp till 6 450 MB/s levererar Samsung 990 snabb respons vid spel, innehållsskapande och krävande arbetsflöden, samtidigt som den rymmer hela ditt spel- eller mediebibliotek.","review_count":1,"price_display":"2 590 kr","selling_point":"Hög prestanda med låg energiförbrukning","stock_quantity":52,"purchase_status":"Purchasable","reference_price":null,"reference_price_display":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/reichelt/search":{"get":{"summary":"Reichelt Search","description":"Search reichelt.de by keyword or category. Euro prices are rebuilt from the number, including whole-euro amounts.\n\n**Credit cost:** 1 credit per call","operationId":"get-reichelt-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word such as 1n4148, or a reichelt.de search or category link. A product link returns 400.","schema":{"type":"string","description":"What to look for. A word such as 1n4148, or a reichelt.de search or category link. A product link returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 is PAGE=1 on the shop.","schema":{"type":"number","minimum":1,"description":"Page number, starting at 1. Page 2 is PAGE=1 on the shop."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"product_id":{"type":"string"},"price_display":{"type":"string"},"article_number":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"1N4148W diode on Reichelt":{"value":{"results":[{"url":"https://www.reichelt.de/de/de/shop/produkt/kleinsignal-schalt-diode_100_v_300_ma_sod-123-332913","brand":"HOTTECH SEMICONDUCTOR","price":0.02,"title":"Kleinsignal-Schalt-Diode, 100 V, 300 mA, SOD-123","currency":"EUR","in_stock":false,"image_url":"https://cdn-reichelt.de/resize/130%2F-/web/artikel_ws/A400%2FSOD-123-HOTTECH.jpg?type=Product&resize=130%252F-&","attributes":[{"name":"Typ","value":"Gleichrichterdiode"},{"name":"Ausführung","value":"Switching"},{"name":"URRM","value":"100 V"},{"name":"Montageart","value":"SMD"},{"name":"Bauform","value":"SOD-123"},{"name":"IF(AV)","value":"0,3 A"},{"name":"IFSM","value":"2 A"},{"name":"Temperaturbereich","value":"-55..+150 °C"}],"product_id":"332913","price_display":"0,02 €","article_number":"1N4148W HOT"}],"pagination":{"next":null,"page":1,"per_page":8,"total_pages":1,"total_results":8}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Reichelt Search","description":"Search reichelt.de by keyword or category. Euro prices are rebuilt from the number, including whole-euro amounts.\n\n**Credit cost:** 1 credit per call","operationId":"post-reichelt-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word such as 1n4148, or a reichelt.de search or category link. A product link returns 400.","schema":{"type":"string","description":"What to look for. A word such as 1n4148, or a reichelt.de search or category link. A product link returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 is PAGE=1 on the shop.","schema":{"type":"number","minimum":1,"description":"Page number, starting at 1. Page 2 is PAGE=1 on the shop."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"product_id":{"type":"string"},"price_display":{"type":"string"},"article_number":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"1N4148W diode on Reichelt":{"value":{"results":[{"url":"https://www.reichelt.de/de/de/shop/produkt/kleinsignal-schalt-diode_100_v_300_ma_sod-123-332913","brand":"HOTTECH SEMICONDUCTOR","price":0.02,"title":"Kleinsignal-Schalt-Diode, 100 V, 300 mA, SOD-123","currency":"EUR","in_stock":false,"image_url":"https://cdn-reichelt.de/resize/130%2F-/web/artikel_ws/A400%2FSOD-123-HOTTECH.jpg?type=Product&resize=130%252F-&","attributes":[{"name":"Typ","value":"Gleichrichterdiode"},{"name":"Ausführung","value":"Switching"},{"name":"URRM","value":"100 V"},{"name":"Montageart","value":"SMD"},{"name":"Bauform","value":"SOD-123"},{"name":"IF(AV)","value":"0,3 A"},{"name":"IFSM","value":"2 A"},{"name":"Temperaturbereich","value":"-55..+150 °C"}],"product_id":"332913","price_display":"0,02 €","article_number":"1N4148W HOT"}],"pagination":{"next":null,"page":1,"per_page":8,"total_pages":1,"total_results":8}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/inet/search":{"get":{"summary":"Inet Search","description":"Search Inet.se by keyword or category. Prices are inc-VAT SEK, with the next page URL when more results exist.\n\n**Credit cost:** 1 credit per call","operationId":"get-inet-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word such as ssd, or an Inet search or category link. A product link returns 400.","schema":{"type":"string","description":"What to look for. A word such as ssd, or an Inet search or category link. A product link returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 uses page=2.","schema":{"type":"number","minimum":1,"description":"Page number, starting at 1. Page 2 uses page=2."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"is_bargain":{"type":"boolean"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"selling_point":{"type":"string"},"stock_quantity":{"type":"integer"},"purchase_status":{"type":"string"},"reference_price":{"nullable":true},"reference_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Crucial X10 on a search for ssd":{"value":{"results":[{"url":"https://www.inet.se/produkt/4306208/crucial-x10-portable-ssd-2tb","brand":"Crucial","price":2999,"title":"Crucial X10 Portable SSD 2TB","rating":4.8,"currency":"SEK","in_stock":true,"image_url":"https://cdn.inet.se/product/86x86/4306208_hirbw9.jpg","highlights":["Storlek: 2 TB","Tillverkarens garanti: 3 år","USB 3.2 Gen 2x2 Type C"],"is_bargain":false,"product_id":"4306208","review_count":4,"price_display":"2 999 kr","selling_point":"Snabb och pålitlig","stock_quantity":59,"purchase_status":"Purchasable","reference_price":null,"reference_price_display":null}],"pagination":{"next":"https://www.inet.se/hitta?q=ssd&page=2","page":1,"per_page":60,"total_pages":7,"total_results":381}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Inet Search","description":"Search Inet.se by keyword or category. Prices are inc-VAT SEK, with the next page URL when more results exist.\n\n**Credit cost:** 1 credit per call","operationId":"post-inet-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word such as ssd, or an Inet search or category link. A product link returns 400.","schema":{"type":"string","description":"What to look for. A word such as ssd, or an Inet search or category link. A product link returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 uses page=2.","schema":{"type":"number","minimum":1,"description":"Page number, starting at 1. Page 2 uses page=2."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"is_bargain":{"type":"boolean"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"selling_point":{"type":"string"},"stock_quantity":{"type":"integer"},"purchase_status":{"type":"string"},"reference_price":{"nullable":true},"reference_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Crucial X10 on a search for ssd":{"value":{"results":[{"url":"https://www.inet.se/produkt/4306208/crucial-x10-portable-ssd-2tb","brand":"Crucial","price":2999,"title":"Crucial X10 Portable SSD 2TB","rating":4.8,"currency":"SEK","in_stock":true,"image_url":"https://cdn.inet.se/product/86x86/4306208_hirbw9.jpg","highlights":["Storlek: 2 TB","Tillverkarens garanti: 3 år","USB 3.2 Gen 2x2 Type C"],"is_bargain":false,"product_id":"4306208","review_count":4,"price_display":"2 999 kr","selling_point":"Snabb och pålitlig","stock_quantity":59,"purchase_status":"Purchasable","reference_price":null,"reference_price_display":null}],"pagination":{"next":"https://www.inet.se/hitta?q=ssd&page=2","page":1,"per_page":60,"total_pages":7,"total_results":381}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/reichelt/product":{"get":{"summary":"Reichelt Product","description":"Read one reichelt.de product URL, including article number, EAN, and the euro price.\n\n**Credit cost:** 1 credit per call","operationId":"get-reichelt-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A reichelt.de or reichelt.com product link. A search link returns 400.","schema":{"type":"string","description":"A reichelt.de or reichelt.com product link. A search link returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"mpn":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"price_display":{"type":"string"},"article_number":{"type":"string"}}},"examples":{"Arduino Uno Rev. 3 on Reichelt":{"value":{"ean":"9783645651394","mpn":"A000073","url":"https://www.reichelt.de/de/de/shop/produkt/arduino_uno_rev_3_smd-variante_atmega328_usb-119045","brand":"ARDUINO","price":19.9,"title":"Arduino Uno Rev. 3, SMD-Variante, ATmega328, USB","images":["https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_01_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_02_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_03_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_04_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_01_NEU.jpg?type=Product&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_02_NEU.jpg?type=Product&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_03_NEU.jpg?type=Product&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_04_NEU.jpg?type=Product&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_01_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_02_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_03_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_04_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/50%2F50/web/artikel_ws/A300%2FARDUINO_UNO_DIP_01_NEU.jpg?type=Product&resize=50%252F50&"],"currency":"EUR","in_stock":true,"image_url":"https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_01_NEU.png?type=ProductXxl&resize=600%252F-&","product_id":"119045","description":"ARDUINO™ UNO - OPEN SOURCE Prototyp Plattform Ein Microcontroller-Board basierend auf dem ATMega328 von Atmel. Dieses Board enthält alle wichtigen Eigenschaften um schnell und unkompliziert mit der Programmierung starten zu können. Dieses Board verfügt über: - 14 digitale I/O - Schnittstellen (6 davon als PWM-Ausgang nutzbar) - 6 analoge Eingänge - 16 MHz - Quarzoszillator - USB-Anschluss - Stromanschluss - ICSP-Header - Reset Technischen Daten: - ATMega 328 - Betriebsspannung: 5 V - Eingangsspannung: 7 .. 12 V - Eingangsspannung ( Limit ): 6 .. 20 V - digitale Ein/Ausgänge: 14 - analoge Eingänge: 6 - I DC 40 mA (I/O) / 50 mA (3,3 V) - Flash Memory: 32 KByte - SRAM : 2 KByte - EEPROM: 1 KByte - Takt: 16 MHz Software finden Sie unter: https://www.arduino.cc/en/Main/Software","price_display":"19,90 €","article_number":"ARDUINO UNO"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Reichelt Product","description":"Read one reichelt.de product URL, including article number, EAN, and the euro price.\n\n**Credit cost:** 1 credit per call","operationId":"post-reichelt-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A reichelt.de or reichelt.com product link. A search link returns 400.","schema":{"type":"string","description":"A reichelt.de or reichelt.com product link. A search link returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"mpn":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"price_display":{"type":"string"},"article_number":{"type":"string"}}},"examples":{"Arduino Uno Rev. 3 on Reichelt":{"value":{"ean":"9783645651394","mpn":"A000073","url":"https://www.reichelt.de/de/de/shop/produkt/arduino_uno_rev_3_smd-variante_atmega328_usb-119045","brand":"ARDUINO","price":19.9,"title":"Arduino Uno Rev. 3, SMD-Variante, ATmega328, USB","images":["https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_01_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_02_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_03_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_04_NEU.png?type=ProductXxl&resize=600%252F-&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_01_NEU.jpg?type=Product&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_02_NEU.jpg?type=Product&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_03_NEU.jpg?type=Product&","https://cdn-reichelt.de/bilder/web/artikel_ws/A300%2FARDUINO_UNO_04_NEU.jpg?type=Product&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_01_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_02_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_03_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/75%2F75/web/artikel_ws/A300%2FARDUINO_UNO_04_NEU.jpg?type=Product&resize=75%252F75&","https://cdn-reichelt.de/resize/50%2F50/web/artikel_ws/A300%2FARDUINO_UNO_DIP_01_NEU.jpg?type=Product&resize=50%252F50&"],"currency":"EUR","in_stock":true,"image_url":"https://cdn-reichelt.de/resize/600%2F-/web/xxl_ws/A300%2FARDUINO_UNO_01_NEU.png?type=ProductXxl&resize=600%252F-&","product_id":"119045","description":"ARDUINO™ UNO - OPEN SOURCE Prototyp Plattform Ein Microcontroller-Board basierend auf dem ATMega328 von Atmel. Dieses Board enthält alle wichtigen Eigenschaften um schnell und unkompliziert mit der Programmierung starten zu können. Dieses Board verfügt über: - 14 digitale I/O - Schnittstellen (6 davon als PWM-Ausgang nutzbar) - 6 analoge Eingänge - 16 MHz - Quarzoszillator - USB-Anschluss - Stromanschluss - ICSP-Header - Reset Technischen Daten: - ATMega 328 - Betriebsspannung: 5 V - Eingangsspannung: 7 .. 12 V - Eingangsspannung ( Limit ): 6 .. 20 V - digitale Ein/Ausgänge: 14 - analoge Eingänge: 6 - I DC 40 mA (I/O) / 50 mA (3,3 V) - Flash Memory: 32 KByte - SRAM : 2 KByte - EEPROM: 1 KByte - Takt: 16 MHz Software finden Sie unter: https://www.arduino.cc/en/Main/Software","price_display":"19,90 €","article_number":"ARDUINO UNO"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/tdlr/search":{"get":{"summary":"TDLR License Search","description":"Search Texas TDLR licenses by name, city, county, or ZIP. license_type such as AIRREF is required for a useful search. 25 rows per page.\n\n**Credit cost:** 1 credit per call","operationId":"get-tdlr-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Optional when city, county, or postal_code is set. Person or business name, example SMITH. A detail URL is rejected.","schema":{"type":"string","description":"Optional when city, county, or postal_code is set. Person or business name, example SMITH. A detail URL is rejected."}},{"name":"license_type","in":"query","required":false,"description":"Optional on the request, required for a useful search. License type code, example AIRREF for air conditioning contractors. ALL or blank searches every type.","schema":{"type":"string","description":"Optional on the request, required for a useful search. License type code, example AIRREF for air conditioning contractors. ALL or blank searches every type."}},{"name":"city","in":"query","required":false,"description":"Optional. Business city. Example: Austin. One of query, city, county, or postal_code is required.","schema":{"type":"string","description":"Optional. Business city. Example: Austin. One of query, city, county, or postal_code is required."}},{"name":"county","in":"query","required":false,"description":"Optional. Business county. Example: TRAVIS.","schema":{"type":"string","description":"Optional. Business county. Example: TRAVIS."}},{"name":"postal_code","in":"query","required":false,"description":"Optional. Business ZIP. Example: 78701.","schema":{"type":"string","description":"Optional. Business ZIP. Example: 78701."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. Each page has 25 rows.","schema":{"type":"number","description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. Each page has 25 rows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"dba":{"nullable":true},"url":{"type":"string"},"city":{"nullable":true},"name":{"type":"string"},"notes":{"type":"array","items":{}},"phone":{"nullable":true},"county":{"type":"string"},"status":{"nullable":true},"subtype":{"nullable":true},"detail_id":{"type":"string"},"postal_code":{"nullable":true},"license_type":{"type":"string"},"business_name":{"type":"string"},"license_number":{"type":"string"},"expiration_date":{"type":"string"},"license_type_code":{"type":"string"},"original_issue_date":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"SMITH air conditioning contractors":{"value":{"results":[{"dba":null,"url":"https://www.tdlr.texas.gov/LicenseSearch/SearchResultDetail.asp?1=AIRREF00000564","city":null,"name":"SMITH, JAMES CHARLES JR","notes":[],"phone":null,"county":"FORT BEND","status":null,"subtype":null,"detail_id":"AIRREF00000564","postal_code":null,"license_type":"Air Conditioning Contractors","business_name":"JIMMY'S AIR CONDITIONING & HEATING","license_number":"TACLA00000564E","expiration_date":"12/24/2026","license_type_code":"AIRREF","original_issue_date":null}],"pagination":{"next":"https://www.tdlr.texas.gov/LicenseSearch/SearchResultsListBrowse.asp?from=search&pht_oth_name=SMITH&tdlr_status=AIRREF&page=2","page":1,"per_page":25,"total_pages":7,"total_results":153}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TDLR License Search","description":"Search Texas TDLR licenses by name, city, county, or ZIP. license_type such as AIRREF is required for a useful search. 25 rows per page.\n\n**Credit cost:** 1 credit per call","operationId":"post-tdlr-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Optional when city, county, or postal_code is set. Person or business name, example SMITH. A detail URL is rejected.","schema":{"type":"string","description":"Optional when city, county, or postal_code is set. Person or business name, example SMITH. A detail URL is rejected."}},{"name":"license_type","in":"query","required":false,"description":"Optional on the request, required for a useful search. License type code, example AIRREF for air conditioning contractors. ALL or blank searches every type.","schema":{"type":"string","description":"Optional on the request, required for a useful search. License type code, example AIRREF for air conditioning contractors. ALL or blank searches every type."}},{"name":"city","in":"query","required":false,"description":"Optional. Business city. Example: Austin. One of query, city, county, or postal_code is required.","schema":{"type":"string","description":"Optional. Business city. Example: Austin. One of query, city, county, or postal_code is required."}},{"name":"county","in":"query","required":false,"description":"Optional. Business county. Example: TRAVIS.","schema":{"type":"string","description":"Optional. Business county. Example: TRAVIS."}},{"name":"postal_code","in":"query","required":false,"description":"Optional. Business ZIP. Example: 78701.","schema":{"type":"string","description":"Optional. Business ZIP. Example: 78701."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. Each page has 25 rows.","schema":{"type":"number","description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. Each page has 25 rows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"dba":{"nullable":true},"url":{"type":"string"},"city":{"nullable":true},"name":{"type":"string"},"notes":{"type":"array","items":{}},"phone":{"nullable":true},"county":{"type":"string"},"status":{"nullable":true},"subtype":{"nullable":true},"detail_id":{"type":"string"},"postal_code":{"nullable":true},"license_type":{"type":"string"},"business_name":{"type":"string"},"license_number":{"type":"string"},"expiration_date":{"type":"string"},"license_type_code":{"type":"string"},"original_issue_date":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"SMITH air conditioning contractors":{"value":{"results":[{"dba":null,"url":"https://www.tdlr.texas.gov/LicenseSearch/SearchResultDetail.asp?1=AIRREF00000564","city":null,"name":"SMITH, JAMES CHARLES JR","notes":[],"phone":null,"county":"FORT BEND","status":null,"subtype":null,"detail_id":"AIRREF00000564","postal_code":null,"license_type":"Air Conditioning Contractors","business_name":"JIMMY'S AIR CONDITIONING & HEATING","license_number":"TACLA00000564E","expiration_date":"12/24/2026","license_type_code":"AIRREF","original_issue_date":null}],"pagination":{"next":"https://www.tdlr.texas.gov/LicenseSearch/SearchResultsListBrowse.asp?from=search&pht_oth_name=SMITH&tdlr_status=AIRREF&page=2","page":1,"per_page":25,"total_pages":7,"total_results":153}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rappi/search":{"get":{"summary":"Rappi Search","description":"Search Rappi Mexico on rappi.com.mx. The city resolves to Mexico City. Each row is one store offer, and next is null.\n\n**Credit cost:** 1 credit per call","operationId":"get-rappi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, example leche, or a rappi.com.mx search URL such as https://www.rappi.com.mx/search?query=leche. A product URL or another country host is rejected.\n\n**Examples:**\n\n    leche\n","schema":{"type":"string","description":"Required. Keyword, example leche, or a rappi.com.mx search URL such as https://www.rappi.com.mx/search?query=leche. A product URL or another country host is rejected.\n\n**Examples:**\n\n    leche\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Only page 1 returns rows. Example: 1. Defaults to 1. Page 2 is rejected because the payload has no next page.","schema":{"type":"number","description":"Optional. Only page 1 returns rows. Example: 1. Defaults to 1. Page 2 is rejected because the payload has no next page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"eta":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"store_id":{"type":"integer"},"store_url":{"type":"string"},"unit_type":{"type":"string"},"product_id":{"type":"string"},"store_name":{"type":"string"},"unit_price":{"type":"string"},"has_discount":{"type":"boolean"},"price_display":{"type":"string"},"shipping_cost":{"type":"integer"},"original_price":{"nullable":true},"store_promotion":{"type":"string"},"has_free_shipping":{"type":"boolean"},"master_product_id":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Leche in Mexico City":{"value":{"results":[{"eta":"9 - 12 min","url":"https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semidescremada-1-l-14069","name":"Santa Clara Leche Deslactosada Semidescremada 1 L","image":"https://images.rappi.com.mx/products/40efda20-78c9-4351-b9e1-a860ab740866.png?e=webp&q=80&d=130x130","price":35.9,"currency":"MXN","in_stock":true,"store_id":1923301762,"store_url":"https://www.rappi.com.mx/tiendas/1923301762","unit_type":"l","product_id":"2109993478","store_name":"Turbo Fresh-Angel Independencia","unit_price":"0.0359/ml","has_discount":false,"price_display":"$35.90","shipping_cost":25,"original_price":null,"store_promotion":"Hasta 42% Off","has_free_shipping":false,"master_product_id":14069}],"pagination":{"next":null,"page":1,"per_page":208,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rappi Search","description":"Search Rappi Mexico on rappi.com.mx. The city resolves to Mexico City. Each row is one store offer, and next is null.\n\n**Credit cost:** 1 credit per call","operationId":"post-rappi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, example leche, or a rappi.com.mx search URL such as https://www.rappi.com.mx/search?query=leche. A product URL or another country host is rejected.\n\n**Examples:**\n\n    leche\n","schema":{"type":"string","description":"Required. Keyword, example leche, or a rappi.com.mx search URL such as https://www.rappi.com.mx/search?query=leche. A product URL or another country host is rejected.\n\n**Examples:**\n\n    leche\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Only page 1 returns rows. Example: 1. Defaults to 1. Page 2 is rejected because the payload has no next page.","schema":{"type":"number","description":"Optional. Only page 1 returns rows. Example: 1. Defaults to 1. Page 2 is rejected because the payload has no next page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"eta":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"store_id":{"type":"integer"},"store_url":{"type":"string"},"unit_type":{"type":"string"},"product_id":{"type":"string"},"store_name":{"type":"string"},"unit_price":{"type":"string"},"has_discount":{"type":"boolean"},"price_display":{"type":"string"},"shipping_cost":{"type":"integer"},"original_price":{"nullable":true},"store_promotion":{"type":"string"},"has_free_shipping":{"type":"boolean"},"master_product_id":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Leche in Mexico City":{"value":{"results":[{"eta":"9 - 12 min","url":"https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semidescremada-1-l-14069","name":"Santa Clara Leche Deslactosada Semidescremada 1 L","image":"https://images.rappi.com.mx/products/40efda20-78c9-4351-b9e1-a860ab740866.png?e=webp&q=80&d=130x130","price":35.9,"currency":"MXN","in_stock":true,"store_id":1923301762,"store_url":"https://www.rappi.com.mx/tiendas/1923301762","unit_type":"l","product_id":"2109993478","store_name":"Turbo Fresh-Angel Independencia","unit_price":"0.0359/ml","has_discount":false,"price_display":"$35.90","shipping_cost":25,"original_price":null,"store_promotion":"Hasta 42% Off","has_free_shipping":false,"master_product_id":14069}],"pagination":{"next":null,"page":1,"per_page":208,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ticketmaster/event":{"get":{"summary":"Ticketmaster Event","description":"Fetch one Ticketmaster event from a slugged event URL. The slug is searched and the matching event id is returned with the venue address.\n\n**Credit cost:** 1 credit per call","operationId":"get-ticketmaster-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Slugged event URL, example https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA. A short /event/{discoveryId} link has no slug and cannot be resolved.","schema":{"type":"string","description":"Required. Slugged event URL, example https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA. A short /event/{discoveryId} link has no slug and cannot be resolved."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"tba":{"type":"boolean"},"url":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"artists":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number"},"presales":{"type":"array","items":{}},"sold_out":{"type":"boolean"},"timezone":{"type":"string"},"cancelled":{"type":"boolean"},"longitude":{"type":"number"},"postponed":{"type":"boolean"},"venue_url":{"type":"string"},"start_date":{"type":"string"},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"onsale_date":{"type":"string"},"postal_code":{"type":"string"},"rescheduled":{"type":"boolean"},"seatmap_url":{"type":"string"},"venue_state":{"type":"string"},"discovery_id":{"type":"string"},"venue_address":{"type":"string"},"venue_country":{"type":"string"},"artist_profiles":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"ticketing_status":{"type":"string"},"span_multiple_days":{"type":"boolean"},"event_change_status":{"type":"string"},"limited_availability":{"type":"boolean"}}},"examples":{"Suns vs Jazz":{"value":{"id":"19006507A7257EEA","tba":false,"url":"https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA","image":"https://s1.ticketm.net/dam/a/c62/0636ff21-e369-4b8c-bee4-214ea0a81c62_1339761_ARTIST_PAGE_3_2.jpg","title":"Suns vs Jazz: Kids Day","artists":["Phoenix Suns","Utah Jazz"],"latitude":33.445899,"presales":[],"sold_out":false,"timezone":"America/Phoenix","cancelled":false,"longitude":-112.071313,"postponed":false,"venue_url":"https://www.ticketmaster.com/mortgage-matchup-center-tickets-phoenix/venue/205079","start_date":"2027-01-24T21:00:00Z","venue_city":"Phoenix","venue_name":"Mortgage Matchup Center","onsale_date":"2026-08-17T15:00:00Z","postal_code":"85004","rescheduled":false,"seatmap_url":"https://mapsapi.tmol.io/maps/geometry/3/event/19006507A7257EEA/staticImage?type=png&systemId=HOST","venue_state":"AZ","discovery_id":"1A_Zkf6GkeEa9Dn","venue_address":"201 East Jefferson Street","venue_country":"US","artist_profiles":[{"url":"https://www.ticketmaster.com/phoenix-suns-tickets/artist/806004","name":"Phoenix Suns"},{"url":"https://www.ticketmaster.com/utah-jazz-tickets/artist/806035","name":"Utah Jazz"}],"ticketing_status":"UNKNOWN","span_multiple_days":false,"event_change_status":"none","limited_availability":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Ticketmaster Event","description":"Fetch one Ticketmaster event from a slugged event URL. The slug is searched and the matching event id is returned with the venue address.\n\n**Credit cost:** 1 credit per call","operationId":"post-ticketmaster-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Slugged event URL, example https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA. A short /event/{discoveryId} link has no slug and cannot be resolved.","schema":{"type":"string","description":"Required. Slugged event URL, example https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA. A short /event/{discoveryId} link has no slug and cannot be resolved."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"tba":{"type":"boolean"},"url":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"artists":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number"},"presales":{"type":"array","items":{}},"sold_out":{"type":"boolean"},"timezone":{"type":"string"},"cancelled":{"type":"boolean"},"longitude":{"type":"number"},"postponed":{"type":"boolean"},"venue_url":{"type":"string"},"start_date":{"type":"string"},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"onsale_date":{"type":"string"},"postal_code":{"type":"string"},"rescheduled":{"type":"boolean"},"seatmap_url":{"type":"string"},"venue_state":{"type":"string"},"discovery_id":{"type":"string"},"venue_address":{"type":"string"},"venue_country":{"type":"string"},"artist_profiles":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"ticketing_status":{"type":"string"},"span_multiple_days":{"type":"boolean"},"event_change_status":{"type":"string"},"limited_availability":{"type":"boolean"}}},"examples":{"Suns vs Jazz":{"value":{"id":"19006507A7257EEA","tba":false,"url":"https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA","image":"https://s1.ticketm.net/dam/a/c62/0636ff21-e369-4b8c-bee4-214ea0a81c62_1339761_ARTIST_PAGE_3_2.jpg","title":"Suns vs Jazz: Kids Day","artists":["Phoenix Suns","Utah Jazz"],"latitude":33.445899,"presales":[],"sold_out":false,"timezone":"America/Phoenix","cancelled":false,"longitude":-112.071313,"postponed":false,"venue_url":"https://www.ticketmaster.com/mortgage-matchup-center-tickets-phoenix/venue/205079","start_date":"2027-01-24T21:00:00Z","venue_city":"Phoenix","venue_name":"Mortgage Matchup Center","onsale_date":"2026-08-17T15:00:00Z","postal_code":"85004","rescheduled":false,"seatmap_url":"https://mapsapi.tmol.io/maps/geometry/3/event/19006507A7257EEA/staticImage?type=png&systemId=HOST","venue_state":"AZ","discovery_id":"1A_Zkf6GkeEa9Dn","venue_address":"201 East Jefferson Street","venue_country":"US","artist_profiles":[{"url":"https://www.ticketmaster.com/phoenix-suns-tickets/artist/806004","name":"Phoenix Suns"},{"url":"https://www.ticketmaster.com/utah-jazz-tickets/artist/806035","name":"Utah Jazz"}],"ticketing_status":"UNKNOWN","span_multiple_days":false,"event_change_status":"none","limited_availability":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ticketmaster/search":{"get":{"summary":"Ticketmaster Search","description":"Search Ticketmaster events by keyword. Returns event cards, including Ticketweb partner rows, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-ticketmaster-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, example jazz, or a ticketmaster.com search URL such as https://www.ticketmaster.com/search?q=jazz. An event URL is rejected.\n\n**Examples:**\n\n    jazz\n","schema":{"type":"string","description":"Required. Keyword, example jazz, or a ticketmaster.com search URL such as https://www.ticketmaster.com/search?q=jazz. An event URL is rejected.\n\n**Examples:**\n\n    jazz\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. On ticketmaster.com the page query is zero-based, so API page 2 is page=1 on the site.","schema":{"type":"number","description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. On ticketmaster.com the page query is zero-based, so API page 2 is page=1 on the site."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"tba":{"type":"boolean"},"url":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"artists":{"type":"array","items":{"type":"string"}},"sold_out":{"type":"boolean"},"timezone":{"type":"string"},"cancelled":{"type":"boolean"},"postponed":{"type":"boolean"},"start_date":{"type":"string"},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"onsale_date":{"type":"string"},"rescheduled":{"type":"boolean"},"venue_state":{"type":"string"},"venue_country":{"type":"string"},"ticketing_status":{"type":"string"},"event_change_status":{"type":"string"},"limited_availability":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Jazz events":{"value":{"results":[{"id":"19006507A7257EEA","tba":false,"url":"https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA","image":"https://s1.ticketm.net/dam/a/c62/0636ff21-e369-4b8c-bee4-214ea0a81c62_1339761_ARTIST_PAGE_3_2.jpg","title":"Suns vs Jazz: Kids Day","artists":["Phoenix Suns","Utah Jazz"],"sold_out":false,"timezone":"America/Phoenix","cancelled":false,"postponed":false,"start_date":"2027-01-24T21:00:00Z","venue_city":"Phoenix","venue_name":"Mortgage Matchup Center","onsale_date":"2026-08-17T15:00:00Z","rescheduled":false,"venue_state":"AZ","venue_country":"US","ticketing_status":"UNKNOWN","event_change_status":"none","limited_availability":false}],"pagination":{"next":"https://www.ticketmaster.com/search?q=jazz&page=1","page":1,"per_page":20,"total_pages":199,"total_results":3970}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Ticketmaster Search","description":"Search Ticketmaster events by keyword. Returns event cards, including Ticketweb partner rows, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-ticketmaster-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, example jazz, or a ticketmaster.com search URL such as https://www.ticketmaster.com/search?q=jazz. An event URL is rejected.\n\n**Examples:**\n\n    jazz\n","schema":{"type":"string","description":"Required. Keyword, example jazz, or a ticketmaster.com search URL such as https://www.ticketmaster.com/search?q=jazz. An event URL is rejected.\n\n**Examples:**\n\n    jazz\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. On ticketmaster.com the page query is zero-based, so API page 2 is page=1 on the site.","schema":{"type":"number","description":"Optional. Page number starting at 1. Example: 2. Defaults to 1. On ticketmaster.com the page query is zero-based, so API page 2 is page=1 on the site."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"tba":{"type":"boolean"},"url":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"artists":{"type":"array","items":{"type":"string"}},"sold_out":{"type":"boolean"},"timezone":{"type":"string"},"cancelled":{"type":"boolean"},"postponed":{"type":"boolean"},"start_date":{"type":"string"},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"onsale_date":{"type":"string"},"rescheduled":{"type":"boolean"},"venue_state":{"type":"string"},"venue_country":{"type":"string"},"ticketing_status":{"type":"string"},"event_change_status":{"type":"string"},"limited_availability":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Jazz events":{"value":{"results":[{"id":"19006507A7257EEA","tba":false,"url":"https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA","image":"https://s1.ticketm.net/dam/a/c62/0636ff21-e369-4b8c-bee4-214ea0a81c62_1339761_ARTIST_PAGE_3_2.jpg","title":"Suns vs Jazz: Kids Day","artists":["Phoenix Suns","Utah Jazz"],"sold_out":false,"timezone":"America/Phoenix","cancelled":false,"postponed":false,"start_date":"2027-01-24T21:00:00Z","venue_city":"Phoenix","venue_name":"Mortgage Matchup Center","onsale_date":"2026-08-17T15:00:00Z","rescheduled":false,"venue_state":"AZ","venue_country":"US","ticketing_status":"UNKNOWN","event_change_status":"none","limited_availability":false}],"pagination":{"next":"https://www.ticketmaster.com/search?q=jazz&page=1","page":1,"per_page":20,"total_pages":199,"total_results":3970}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/npi/search":{"get":{"summary":"NPI Search","description":"Search the NPPES NPI registry by person name, organization, or 10-digit NPI. With NPI-2, a text query is the organization name. total_results is null, and next is set only when the page is full.\n\n**Credit cost:** 1 credit per call","operationId":"get-npi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Optional when another criterion is set. Example: Anthony Fauci. Also a 10-digit NPI such as 1972813608, or an NPPES search URL. With enumeration_type=NPI-2 this text is the organization name, for example Mayo Clinic. A provider-view URL is rejected here.","schema":{"type":"string","description":"Optional when another criterion is set. Example: Anthony Fauci. Also a 10-digit NPI such as 1972813608, or an NPPES search URL. With enumeration_type=NPI-2 this text is the organization name, for example Mayo Clinic. A provider-view URL is rejected here."}},{"name":"first_name","in":"query","required":false,"description":"Optional. Example: Anthony. Used as the given name when you do not want query to be split.","schema":{"type":"string","description":"Optional. Example: Anthony. Used as the given name when you do not want query to be split."}},{"name":"last_name","in":"query","required":false,"description":"Optional. Example: Fauci. A single-word query such as Smith is used as the last name.","schema":{"type":"string","description":"Optional. Example: Fauci. A single-word query such as Smith is used as the last name."}},{"name":"organization_name","in":"query","required":false,"description":"Optional. Example: Mayo Clinic. You can also pass that name in query with enumeration_type=NPI-2.","schema":{"type":"string","description":"Optional. Example: Mayo Clinic. You can also pass that name in query with enumeration_type=NPI-2."}},{"name":"city","in":"query","required":false,"description":"Optional. Practice city. Example: Washington.","schema":{"type":"string","description":"Optional. Practice city. Example: Washington."}},{"name":"state","in":"query","required":false,"description":"Optional. Two-letter state code. Example: DC. Any other value is rejected.","schema":{"type":"string","description":"Optional. Two-letter state code. Example: DC. Any other value is rejected."}},{"name":"postal_code","in":"query","required":false,"description":"Optional. Postal code. Example: 20016.","schema":{"type":"string","description":"Optional. Postal code. Example: 20016."}},{"name":"taxonomy","in":"query","required":false,"description":"Optional. Taxonomy description. Example: Internal Medicine.","schema":{"type":"string","description":"Optional. Taxonomy description. Example: Internal Medicine."}},{"name":"enumeration_type","in":"query","required":false,"description":"Optional. NPI-1 for a person or NPI-2 for an organization. Example: NPI-2. NPI-2 treats a text query as an organization name.","schema":{"type":"string","description":"Optional. NPI-1 for a person or NPI-2 for an organization. Example: NPI-2. NPI-2 treats a text query as an organization name."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number, starting at 1. Example: 2. Defaults to 1.","schema":{"type":"number","description":"Optional. Page number, starting at 1. Example: 2. Defaults to 1."}},{"name":"limit","in":"query","required":false,"description":"Optional. Page size. Example: 10. Defaults to 10 and cannot exceed 200. next is a URL only when the page contains this many rows.","schema":{"type":"number","description":"Optional. Page size. Example: 10. Defaults to 10 and cannot exceed 200. next is a URL only when the page contains this many rows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"npi":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"taxonomy":{"type":"string"},"last_name":{"type":"string"},"credential":{"type":"string"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"postal_code":{"type":"string"},"taxonomy_code":{"type":"string"},"enumeration_date":{"type":"string"},"enumeration_type":{"type":"string"},"organization_name":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Anthony Fauci":{"value":{"results":[{"npi":"1972813608","url":"https://npiregistry.cms.hhs.gov/provider-view/1972813608","city":"WASHINGTON","name":"Dr. ANTHONY STEPHEN FAUCI","phone":"301-496-2263","state":"DC","status":"A","address":"3012 - 43RD STREET, N.W.","taxonomy":"Internal Medicine, Infectious Disease","last_name":"FAUCI","credential":"M.D.","first_name":"ANTHONY","middle_name":"STEPHEN","postal_code":"200163547","taxonomy_code":"207RI0200X","enumeration_date":"2010-10-15","enumeration_type":"NPI-1","organization_name":null}],"pagination":{"next":null,"page":1,"per_page":10,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"NPI Search","description":"Search the NPPES NPI registry by person name, organization, or 10-digit NPI. With NPI-2, a text query is the organization name. total_results is null, and next is set only when the page is full.\n\n**Credit cost:** 1 credit per call","operationId":"post-npi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Optional when another criterion is set. Example: Anthony Fauci. Also a 10-digit NPI such as 1972813608, or an NPPES search URL. With enumeration_type=NPI-2 this text is the organization name, for example Mayo Clinic. A provider-view URL is rejected here.","schema":{"type":"string","description":"Optional when another criterion is set. Example: Anthony Fauci. Also a 10-digit NPI such as 1972813608, or an NPPES search URL. With enumeration_type=NPI-2 this text is the organization name, for example Mayo Clinic. A provider-view URL is rejected here."}},{"name":"first_name","in":"query","required":false,"description":"Optional. Example: Anthony. Used as the given name when you do not want query to be split.","schema":{"type":"string","description":"Optional. Example: Anthony. Used as the given name when you do not want query to be split."}},{"name":"last_name","in":"query","required":false,"description":"Optional. Example: Fauci. A single-word query such as Smith is used as the last name.","schema":{"type":"string","description":"Optional. Example: Fauci. A single-word query such as Smith is used as the last name."}},{"name":"organization_name","in":"query","required":false,"description":"Optional. Example: Mayo Clinic. You can also pass that name in query with enumeration_type=NPI-2.","schema":{"type":"string","description":"Optional. Example: Mayo Clinic. You can also pass that name in query with enumeration_type=NPI-2."}},{"name":"city","in":"query","required":false,"description":"Optional. Practice city. Example: Washington.","schema":{"type":"string","description":"Optional. Practice city. Example: Washington."}},{"name":"state","in":"query","required":false,"description":"Optional. Two-letter state code. Example: DC. Any other value is rejected.","schema":{"type":"string","description":"Optional. Two-letter state code. Example: DC. Any other value is rejected."}},{"name":"postal_code","in":"query","required":false,"description":"Optional. Postal code. Example: 20016.","schema":{"type":"string","description":"Optional. Postal code. Example: 20016."}},{"name":"taxonomy","in":"query","required":false,"description":"Optional. Taxonomy description. Example: Internal Medicine.","schema":{"type":"string","description":"Optional. Taxonomy description. Example: Internal Medicine."}},{"name":"enumeration_type","in":"query","required":false,"description":"Optional. NPI-1 for a person or NPI-2 for an organization. Example: NPI-2. NPI-2 treats a text query as an organization name.","schema":{"type":"string","description":"Optional. NPI-1 for a person or NPI-2 for an organization. Example: NPI-2. NPI-2 treats a text query as an organization name."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number, starting at 1. Example: 2. Defaults to 1.","schema":{"type":"number","description":"Optional. Page number, starting at 1. Example: 2. Defaults to 1."}},{"name":"limit","in":"query","required":false,"description":"Optional. Page size. Example: 10. Defaults to 10 and cannot exceed 200. next is a URL only when the page contains this many rows.","schema":{"type":"number","description":"Optional. Page size. Example: 10. Defaults to 10 and cannot exceed 200. next is a URL only when the page contains this many rows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"npi":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"taxonomy":{"type":"string"},"last_name":{"type":"string"},"credential":{"type":"string"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"postal_code":{"type":"string"},"taxonomy_code":{"type":"string"},"enumeration_date":{"type":"string"},"enumeration_type":{"type":"string"},"organization_name":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Anthony Fauci":{"value":{"results":[{"npi":"1972813608","url":"https://npiregistry.cms.hhs.gov/provider-view/1972813608","city":"WASHINGTON","name":"Dr. ANTHONY STEPHEN FAUCI","phone":"301-496-2263","state":"DC","status":"A","address":"3012 - 43RD STREET, N.W.","taxonomy":"Internal Medicine, Infectious Disease","last_name":"FAUCI","credential":"M.D.","first_name":"ANTHONY","middle_name":"STEPHEN","postal_code":"200163547","taxonomy_code":"207RI0200X","enumeration_date":"2010-10-15","enumeration_type":"NPI-1","organization_name":null}],"pagination":{"next":null,"page":1,"per_page":10,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rappi/product":{"get":{"summary":"Rappi Product","description":"Fetch one Rappi Mexico product, including the primary store price and the other store offers. The primary price can differ from a search card.\n\n**Credit cost:** 1 credit per call","operationId":"get-rappi-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Product URL on rappi.com.mx, example https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semidescremada-1-l-14069, or a numeric master id such as 14069.","schema":{"type":"string","description":"Required. Product URL on rappi.com.mx, example https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semidescremada-1-l-14069, or a numeric master id such as 14069."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"offers":{"type":"array","items":{"type":"object","properties":{"price":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"store_id":{"type":"integer"},"store_url":{"type":"string"},"store_name":{"type":"string"},"has_discount":{"type":"boolean"},"price_display":{"type":"string"},"original_price":{"nullable":true}}}},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"store_id":{"type":"integer"},"store_url":{"type":"string"},"unit_type":{"type":"string"},"product_id":{"type":"string"},"store_name":{"type":"string"},"unit_price":{"type":"string"},"description":{"type":"string"},"has_discount":{"type":"boolean"},"max_quantity":{"type":"integer"},"min_quantity":{"type":"integer"},"presentation":{"type":"string"},"price_display":{"type":"string"},"original_price":{"nullable":true},"master_product_id":{"type":"integer"},"alcoholic_beverage":{"type":"boolean"},"has_age_restriction":{"type":"boolean"},"requires_prescription":{"type":"boolean"}}},"examples":{"Santa Clara leche":{"value":{"url":"https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semi-14069","city":"Ciudad de México","name":"Santa Clara Leche Deslactosada Semidescremada 1 L","image":"https://images.rappi.com.mx/products/40efda20-78c9-4351-b9e1-a860ab740866.png","price":33,"offers":[{"price":33,"currency":"MXN","in_stock":true,"store_id":1930460513,"store_url":"https://www.rappi.com.mx/tiendas/1930460513-city-market","store_name":"City Market","has_discount":false,"price_display":"$33.00","original_price":null},{"price":33,"currency":"MXN","in_stock":true,"store_id":1930301321,"store_url":"https://www.rappi.com.mx/tiendas/1930301321-la-comer","store_name":"La Comer","has_discount":false,"price_display":"$33.00","original_price":null},{"price":34,"currency":"MXN","in_stock":true,"store_id":1930455981,"store_url":"https://www.rappi.com.mx/tiendas/1930455981-chedraui-supercito","store_name":"Chedraui Supercito","has_discount":false,"price_display":"$34.00","original_price":null},{"price":34,"currency":"MXN","in_stock":true,"store_id":1930103161,"store_url":"https://www.rappi.com.mx/tiendas/1930103161-mascotas-chedraui","store_name":"Mascotas Chedraui","has_discount":false,"price_display":"$34.00","original_price":null},{"price":34,"currency":"MXN","in_stock":true,"store_id":1930195015,"store_url":"https://www.rappi.com.mx/tiendas/1930195015-super-che","store_name":"Súper Che","has_discount":false,"price_display":"$34.00","original_price":null},{"price":35,"currency":"MXN","in_stock":true,"store_id":1930211752,"store_url":"https://www.rappi.com.mx/tiendas/1930211752-chedraui-selecto","store_name":"Chedraui Selecto","has_discount":false,"price_display":"$35.00","original_price":null},{"price":35,"currency":"MXN","in_stock":true,"store_id":1930195033,"store_url":"https://www.rappi.com.mx/tiendas/1930195033-super-chedraui-selecto","store_name":"Súper Chedraui Selecto","has_discount":false,"price_display":"$35.00","original_price":null},{"price":35.9,"currency":"MXN","in_stock":true,"store_id":1930392251,"store_url":"https://www.rappi.com.mx/tiendas/1930392251-turbo","store_name":"Turbo","has_discount":false,"price_display":"$35.90","original_price":null},{"price":35.9,"currency":"MXN","in_stock":true,"store_id":1930024623,"store_url":"https://www.rappi.com.mx/tiendas/1930024623-turbo-farma","store_name":"Turbo Farma","has_discount":false,"price_display":"$35.90","original_price":null},{"price":35.9,"currency":"MXN","in_stock":true,"store_id":1923301762,"store_url":"https://www.rappi.com.mx/tiendas/1923301762-turbo-fresh-angel-independencia","store_name":"Turbo Fresh-Angel Independencia","has_discount":false,"price_display":"$35.90","original_price":null},{"price":37,"currency":"MXN","in_stock":true,"store_id":1930446726,"store_url":"https://www.rappi.com.mx/tiendas/1930446726-oxxo","store_name":"OXXO","has_discount":false,"price_display":"$37.00","original_price":null},{"price":38.9,"currency":"MXN","in_stock":true,"store_id":942001337,"store_url":"https://www.rappi.com.mx/tiendas/942001337-soriana-hiper","store_name":"Soriana Híper","has_discount":false,"price_display":"$38.90","original_price":null},{"price":40.5,"currency":"MXN","in_stock":true,"store_id":1930171590,"store_url":"https://www.rappi.com.mx/tiendas/1930171590-soriana-mercado","store_name":"Soriana Mercado","has_discount":false,"price_display":"$40.50","original_price":null},{"price":42.03,"currency":"MXN","in_stock":true,"store_id":1930230975,"store_url":"https://www.rappi.com.mx/tiendas/1930230975-justo","store_name":"Jüsto","has_discount":false,"price_display":"$42.03","original_price":null},{"price":43.13,"currency":"MXN","in_stock":true,"store_id":1930095502,"store_url":"https://www.rappi.com.mx/tiendas/1930095502-7-eleven","store_name":"7 Eleven","has_discount":false,"price_display":"$43.13","original_price":null},{"price":44.4,"currency":"MXN","in_stock":true,"store_id":160195150,"store_url":"https://www.rappi.com.mx/tiendas/160195150-farmacias-guadalajara","store_name":"Farmacias Guadalajara","has_discount":false,"price_display":"$44.40","original_price":null}],"category":"Leche natural","currency":"MXN","in_stock":true,"store_id":1930460513,"store_url":"https://www.rappi.com.mx/tiendas/1930460513-city-market","unit_type":"l","product_id":"975243808","store_name":"City Market","unit_price":"$0.0330/ml","description":"Esta leche te aporta la misma cantidad de calcio, vitaminas y proteínas que la leche normal, pero sin lactosa. Tiene menor porcentaje de grasa, sabe perfecta sola, con cereal, café, fría o caliente.","has_discount":false,"max_quantity":21,"min_quantity":1,"presentation":"1 X 1 L","price_display":"$33.00","original_price":null,"master_product_id":14069,"alcoholic_beverage":false,"has_age_restriction":false,"requires_prescription":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rappi Product","description":"Fetch one Rappi Mexico product, including the primary store price and the other store offers. The primary price can differ from a search card.\n\n**Credit cost:** 1 credit per call","operationId":"post-rappi-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Product URL on rappi.com.mx, example https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semidescremada-1-l-14069, or a numeric master id such as 14069.","schema":{"type":"string","description":"Required. Product URL on rappi.com.mx, example https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semidescremada-1-l-14069, or a numeric master id such as 14069."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"offers":{"type":"array","items":{"type":"object","properties":{"price":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"store_id":{"type":"integer"},"store_url":{"type":"string"},"store_name":{"type":"string"},"has_discount":{"type":"boolean"},"price_display":{"type":"string"},"original_price":{"nullable":true}}}},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"store_id":{"type":"integer"},"store_url":{"type":"string"},"unit_type":{"type":"string"},"product_id":{"type":"string"},"store_name":{"type":"string"},"unit_price":{"type":"string"},"description":{"type":"string"},"has_discount":{"type":"boolean"},"max_quantity":{"type":"integer"},"min_quantity":{"type":"integer"},"presentation":{"type":"string"},"price_display":{"type":"string"},"original_price":{"nullable":true},"master_product_id":{"type":"integer"},"alcoholic_beverage":{"type":"boolean"},"has_age_restriction":{"type":"boolean"},"requires_prescription":{"type":"boolean"}}},"examples":{"Santa Clara leche":{"value":{"url":"https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semi-14069","city":"Ciudad de México","name":"Santa Clara Leche Deslactosada Semidescremada 1 L","image":"https://images.rappi.com.mx/products/40efda20-78c9-4351-b9e1-a860ab740866.png","price":33,"offers":[{"price":33,"currency":"MXN","in_stock":true,"store_id":1930460513,"store_url":"https://www.rappi.com.mx/tiendas/1930460513-city-market","store_name":"City Market","has_discount":false,"price_display":"$33.00","original_price":null},{"price":33,"currency":"MXN","in_stock":true,"store_id":1930301321,"store_url":"https://www.rappi.com.mx/tiendas/1930301321-la-comer","store_name":"La Comer","has_discount":false,"price_display":"$33.00","original_price":null},{"price":34,"currency":"MXN","in_stock":true,"store_id":1930455981,"store_url":"https://www.rappi.com.mx/tiendas/1930455981-chedraui-supercito","store_name":"Chedraui Supercito","has_discount":false,"price_display":"$34.00","original_price":null},{"price":34,"currency":"MXN","in_stock":true,"store_id":1930103161,"store_url":"https://www.rappi.com.mx/tiendas/1930103161-mascotas-chedraui","store_name":"Mascotas Chedraui","has_discount":false,"price_display":"$34.00","original_price":null},{"price":34,"currency":"MXN","in_stock":true,"store_id":1930195015,"store_url":"https://www.rappi.com.mx/tiendas/1930195015-super-che","store_name":"Súper Che","has_discount":false,"price_display":"$34.00","original_price":null},{"price":35,"currency":"MXN","in_stock":true,"store_id":1930211752,"store_url":"https://www.rappi.com.mx/tiendas/1930211752-chedraui-selecto","store_name":"Chedraui Selecto","has_discount":false,"price_display":"$35.00","original_price":null},{"price":35,"currency":"MXN","in_stock":true,"store_id":1930195033,"store_url":"https://www.rappi.com.mx/tiendas/1930195033-super-chedraui-selecto","store_name":"Súper Chedraui Selecto","has_discount":false,"price_display":"$35.00","original_price":null},{"price":35.9,"currency":"MXN","in_stock":true,"store_id":1930392251,"store_url":"https://www.rappi.com.mx/tiendas/1930392251-turbo","store_name":"Turbo","has_discount":false,"price_display":"$35.90","original_price":null},{"price":35.9,"currency":"MXN","in_stock":true,"store_id":1930024623,"store_url":"https://www.rappi.com.mx/tiendas/1930024623-turbo-farma","store_name":"Turbo Farma","has_discount":false,"price_display":"$35.90","original_price":null},{"price":35.9,"currency":"MXN","in_stock":true,"store_id":1923301762,"store_url":"https://www.rappi.com.mx/tiendas/1923301762-turbo-fresh-angel-independencia","store_name":"Turbo Fresh-Angel Independencia","has_discount":false,"price_display":"$35.90","original_price":null},{"price":37,"currency":"MXN","in_stock":true,"store_id":1930446726,"store_url":"https://www.rappi.com.mx/tiendas/1930446726-oxxo","store_name":"OXXO","has_discount":false,"price_display":"$37.00","original_price":null},{"price":38.9,"currency":"MXN","in_stock":true,"store_id":942001337,"store_url":"https://www.rappi.com.mx/tiendas/942001337-soriana-hiper","store_name":"Soriana Híper","has_discount":false,"price_display":"$38.90","original_price":null},{"price":40.5,"currency":"MXN","in_stock":true,"store_id":1930171590,"store_url":"https://www.rappi.com.mx/tiendas/1930171590-soriana-mercado","store_name":"Soriana Mercado","has_discount":false,"price_display":"$40.50","original_price":null},{"price":42.03,"currency":"MXN","in_stock":true,"store_id":1930230975,"store_url":"https://www.rappi.com.mx/tiendas/1930230975-justo","store_name":"Jüsto","has_discount":false,"price_display":"$42.03","original_price":null},{"price":43.13,"currency":"MXN","in_stock":true,"store_id":1930095502,"store_url":"https://www.rappi.com.mx/tiendas/1930095502-7-eleven","store_name":"7 Eleven","has_discount":false,"price_display":"$43.13","original_price":null},{"price":44.4,"currency":"MXN","in_stock":true,"store_id":160195150,"store_url":"https://www.rappi.com.mx/tiendas/160195150-farmacias-guadalajara","store_name":"Farmacias Guadalajara","has_discount":false,"price_display":"$44.40","original_price":null}],"category":"Leche natural","currency":"MXN","in_stock":true,"store_id":1930460513,"store_url":"https://www.rappi.com.mx/tiendas/1930460513-city-market","unit_type":"l","product_id":"975243808","store_name":"City Market","unit_price":"$0.0330/ml","description":"Esta leche te aporta la misma cantidad de calcio, vitaminas y proteínas que la leche normal, pero sin lactosa. Tiene menor porcentaje de grasa, sabe perfecta sola, con cereal, café, fría o caliente.","has_discount":false,"max_quantity":21,"min_quantity":1,"presentation":"1 X 1 L","price_display":"$33.00","original_price":null,"master_product_id":14069,"alcoholic_beverage":false,"has_age_restriction":false,"requires_prescription":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/tdlr/license":{"get":{"summary":"TDLR License","description":"Fetch one TDLR license by detail id or SearchResultDetail URL, including status, subtype, DBA, and notes.\n\n**Credit cost:** 1 credit per call","operationId":"get-tdlr-license","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Detail id, example AIRREF00000564, or the SearchResultDetail URL from search.","schema":{"type":"string","description":"Required. Detail id, example AIRREF00000564, or the SearchResultDetail URL from search."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"dba":{"type":"string"},"url":{"type":"string"},"city":{"nullable":true},"name":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"phone":{"nullable":true},"county":{"type":"string"},"status":{"type":"string"},"subtype":{"type":"string"},"detail_id":{"type":"string"},"postal_code":{"nullable":true},"license_type":{"type":"string"},"business_name":{"type":"string"},"license_number":{"type":"string"},"expiration_date":{"type":"string"},"license_type_code":{"type":"string"},"original_issue_date":{"type":"string"}}},"examples":{"TACLA00000564E":{"value":{"dba":"JIMMY'S AIR CONDITIONING & HEATING","url":"https://www.tdlr.texas.gov/LicenseSearch/SearchResultDetail.asp?1=AIRREF00000564","city":null,"name":"SMITH, JAMES CHARLES JR","notes":["No Public Contracting"],"phone":null,"county":"FORT BEND","status":"Active","subtype":"AE","detail_id":"AIRREF00000564","postal_code":null,"license_type":"Air Conditioning/Refrigeration Contractor","business_name":"JIMMY'S AIR CONDITIONING & HEATING","license_number":"TACLA00000564E","expiration_date":"12/24/2026","license_type_code":"AIRREF","original_issue_date":"08/16/1984"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TDLR License","description":"Fetch one TDLR license by detail id or SearchResultDetail URL, including status, subtype, DBA, and notes.\n\n**Credit cost:** 1 credit per call","operationId":"post-tdlr-license","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Detail id, example AIRREF00000564, or the SearchResultDetail URL from search.","schema":{"type":"string","description":"Required. Detail id, example AIRREF00000564, or the SearchResultDetail URL from search."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"dba":{"type":"string"},"url":{"type":"string"},"city":{"nullable":true},"name":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"phone":{"nullable":true},"county":{"type":"string"},"status":{"type":"string"},"subtype":{"type":"string"},"detail_id":{"type":"string"},"postal_code":{"nullable":true},"license_type":{"type":"string"},"business_name":{"type":"string"},"license_number":{"type":"string"},"expiration_date":{"type":"string"},"license_type_code":{"type":"string"},"original_issue_date":{"type":"string"}}},"examples":{"TACLA00000564E":{"value":{"dba":"JIMMY'S AIR CONDITIONING & HEATING","url":"https://www.tdlr.texas.gov/LicenseSearch/SearchResultDetail.asp?1=AIRREF00000564","city":null,"name":"SMITH, JAMES CHARLES JR","notes":["No Public Contracting"],"phone":null,"county":"FORT BEND","status":"Active","subtype":"AE","detail_id":"AIRREF00000564","postal_code":null,"license_type":"Air Conditioning/Refrigeration Contractor","business_name":"JIMMY'S AIR CONDITIONING & HEATING","license_number":"TACLA00000564E","expiration_date":"12/24/2026","license_type_code":"AIRREF","original_issue_date":"08/16/1984"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/npi/provider":{"get":{"summary":"NPI Provider","description":"Fetch one NPPES provider or organization by 10-digit NPI or provider-view URL, including addresses and taxonomies.\n\n**Credit cost:** 1 credit per call","operationId":"get-npi-provider","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. 10-digit NPI, example 1972813608, or a provider-view URL such as https://npiregistry.cms.hhs.gov/provider-view/1972813608.","schema":{"type":"string","description":"Required. 10-digit NPI, example 1972813608, or a provider-view URL such as https://npiregistry.cms.hhs.gov/provider-view/1972813608."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"npi":{"type":"string"},"sex":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"taxonomy":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"type":{"type":"string"},"line1":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"purpose":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"}}}},"last_name":{"type":"string"},"credential":{"type":"string"},"first_name":{"type":"string"},"taxonomies":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"group":{"nullable":true},"state":{"type":"string"},"license":{"type":"string"},"primary":{"type":"boolean"},"description":{"type":"string"}}}},"identifiers":{"type":"array","items":{}},"middle_name":{"type":"string"},"name_prefix":{"type":"string"},"name_suffix":{"nullable":true},"other_names":{"type":"array","items":{}},"postal_code":{"type":"string"},"last_updated":{"type":"string"},"taxonomy_code":{"type":"string"},"sole_proprietor":{"type":"string"},"enumeration_date":{"type":"string"},"enumeration_type":{"type":"string"},"organization_name":{"nullable":true},"certification_date":{"nullable":true},"organizational_subpart":{"nullable":true},"authorized_official_name":{"nullable":true},"authorized_official_phone":{"nullable":true},"authorized_official_title":{"nullable":true}}},"examples":{"Anthony Fauci":{"value":{"npi":"1972813608","sex":"M","url":"https://npiregistry.cms.hhs.gov/provider-view/1972813608","city":"WASHINGTON","name":"Dr. ANTHONY STEPHEN FAUCI","phone":"301-496-2263","state":"DC","status":"A","address":"3012 - 43RD STREET, N.W.","taxonomy":"Internal Medicine, Infectious Disease","addresses":[{"city":"WASHINGTON","type":"DOM","line1":"3012 - 43RD STREET, N.W.","phone":"301-496-2263","state":"DC","country":"United States","purpose":"MAILING","postal_code":"200163547","country_code":"US"},{"city":"WASHINGTON","type":"DOM","line1":"3012 - 43RD STREET, N.W.","phone":"301-496-2263","state":"DC","country":"United States","purpose":"LOCATION","postal_code":"200163547","country_code":"US"}],"last_name":"FAUCI","credential":"M.D.","first_name":"ANTHONY","taxonomies":[{"code":"207RI0200X","group":null,"state":"MD","license":"D0004034","primary":true,"description":"Internal Medicine, Infectious Disease"}],"identifiers":[],"middle_name":"STEPHEN","name_prefix":"Dr.","name_suffix":null,"other_names":[],"postal_code":"200163547","last_updated":"2010-10-15","taxonomy_code":"207RI0200X","sole_proprietor":"YES","enumeration_date":"2010-10-15","enumeration_type":"NPI-1","organization_name":null,"certification_date":null,"organizational_subpart":null,"authorized_official_name":null,"authorized_official_phone":null,"authorized_official_title":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"NPI Provider","description":"Fetch one NPPES provider or organization by 10-digit NPI or provider-view URL, including addresses and taxonomies.\n\n**Credit cost:** 1 credit per call","operationId":"post-npi-provider","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. 10-digit NPI, example 1972813608, or a provider-view URL such as https://npiregistry.cms.hhs.gov/provider-view/1972813608.","schema":{"type":"string","description":"Required. 10-digit NPI, example 1972813608, or a provider-view URL such as https://npiregistry.cms.hhs.gov/provider-view/1972813608."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"npi":{"type":"string"},"sex":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"taxonomy":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"type":{"type":"string"},"line1":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"purpose":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"}}}},"last_name":{"type":"string"},"credential":{"type":"string"},"first_name":{"type":"string"},"taxonomies":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"group":{"nullable":true},"state":{"type":"string"},"license":{"type":"string"},"primary":{"type":"boolean"},"description":{"type":"string"}}}},"identifiers":{"type":"array","items":{}},"middle_name":{"type":"string"},"name_prefix":{"type":"string"},"name_suffix":{"nullable":true},"other_names":{"type":"array","items":{}},"postal_code":{"type":"string"},"last_updated":{"type":"string"},"taxonomy_code":{"type":"string"},"sole_proprietor":{"type":"string"},"enumeration_date":{"type":"string"},"enumeration_type":{"type":"string"},"organization_name":{"nullable":true},"certification_date":{"nullable":true},"organizational_subpart":{"nullable":true},"authorized_official_name":{"nullable":true},"authorized_official_phone":{"nullable":true},"authorized_official_title":{"nullable":true}}},"examples":{"Anthony Fauci":{"value":{"npi":"1972813608","sex":"M","url":"https://npiregistry.cms.hhs.gov/provider-view/1972813608","city":"WASHINGTON","name":"Dr. ANTHONY STEPHEN FAUCI","phone":"301-496-2263","state":"DC","status":"A","address":"3012 - 43RD STREET, N.W.","taxonomy":"Internal Medicine, Infectious Disease","addresses":[{"city":"WASHINGTON","type":"DOM","line1":"3012 - 43RD STREET, N.W.","phone":"301-496-2263","state":"DC","country":"United States","purpose":"MAILING","postal_code":"200163547","country_code":"US"},{"city":"WASHINGTON","type":"DOM","line1":"3012 - 43RD STREET, N.W.","phone":"301-496-2263","state":"DC","country":"United States","purpose":"LOCATION","postal_code":"200163547","country_code":"US"}],"last_name":"FAUCI","credential":"M.D.","first_name":"ANTHONY","taxonomies":[{"code":"207RI0200X","group":null,"state":"MD","license":"D0004034","primary":true,"description":"Internal Medicine, Infectious Disease"}],"identifiers":[],"middle_name":"STEPHEN","name_prefix":"Dr.","name_suffix":null,"other_names":[],"postal_code":"200163547","last_updated":"2010-10-15","taxonomy_code":"207RI0200X","sole_proprietor":"YES","enumeration_date":"2010-10-15","enumeration_type":"NPI-1","organization_name":null,"certification_date":null,"organizational_subpart":null,"authorized_official_name":null,"authorized_official_phone":null,"authorized_official_title":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/seek/job":{"get":{"summary":"SEEK Job","description":"Read one SEEK Australia job from its URL or numeric id.\n\n**Credit cost:** 2 credits per call","operationId":"get-seek-job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. SEEK job URL or numeric id, for example 95568355 or https://www.seek.com.au/job/95568355. A keyword is rejected.","schema":{"type":"string","description":"Required. SEEK job URL or numeric id, for example 95568355 or https://www.seek.com.au/job/95568355. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"salary":{"type":"integer"},"company":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"listed_at":{"nullable":true},"work_type":{"type":"string"},"salary_max":{"nullable":true},"salary_min":{"nullable":true},"description":{"type":"string"},"salary_period":{"type":"string"},"classification":{"type":"string"},"salary_display":{"type":"string"}}},"examples":{"Telehealth Nurse":{"value":{"id":"95568355","url":"https://www.seek.com.au/job/95568355","title":"Telehealth Nurse (RN or EN)","salary":45,"company":"Reorg Solutions","currency":"AUD","location":"Sydney NSW","listed_at":null,"work_type":"Casual/Vacation","salary_max":null,"salary_min":null,"description":"Telehealth Registered Nurse (RN) - Working With Veterans Casual Position | $45 Per Hour | Work From Home Initially Full-Time Hours | Monday to Friday, 9:00am–5:00pm - Subject to discussion and change to suit you. Veteran Experience Appreciated We are seeking a compassionate Registered Nurse (RN) to join our growing telehealth healthcare team supporting Australian veterans. This is a fully remote, casual position paying $45 per hour, initially offering full-time hours, Monday to Friday, 9:00am–5:00pm, to assist with clearing an existing backlog. Once the backlog has been addressed, ongoing hours will be determined by operational demand and workload requirements. There is potential for the position to transition into permanent part-time or full-time employment in the future, depending on business needs and suitability. About the Role You will provide support to patients via telehealth, working alongside a team of doctors and other healthcare professionals. The role involves patient communication, clinical support, triage, care coordination and following up on patient requests. Full training and ongoing support will be provided. This role would suit a nurse who is confident working independently, highly organised and comfortable working in a busy online healthcare environment. Key Responsibilities Conducting patient consultations via telehealth Taking accurate and detailed clinical notes during consultations Working with GPs and the wider clinical team Managing your own workload and working independently Managing appointment bookings and keeping the consultation schedule running smoothly Communicating professionally and compassionately with patients Managing upset, frustrated or distressed patients calmly and appropriately Identifying matters requiring escalation and referring to the appropriate member of the clinical team Following established clinical processes and procedures Providing a high standard of patient care and maintaining accurate documentation About You Current AHPRA registration as a Registered Nurse (RN) Strong communication and interpersonal skills Excellent organisation and attention to detail Comfortable working independently from home Confident using technology and online clinical systems Calm, professional and compassionate approach Experience working with veterans or within veteran healthcare is highly regarded What We Offer $45 per hour casual rate Initially full-time hours to assist with clearing an existing backlog Monday to Friday, 9:00am–5:00pm during the initial period Ongoing hours based on operational demand Potential to transition into permanent part-time or full-time employment Fully remote work from home Training provided Supportive clinical team Opportunity to work within a specialised veteran healthcare environment Requirements You will need: Current AHPRA registration as a Registered Nurse Your own reliable computer/laptop suitable for telehealth Reliable, high-speed internet A quiet and professional home workspace Availability to initially work Monday to Friday, 9:00am–5:00pm Flexibility regarding ongoing hours as operational needs change If you are a Registered Nurse looking for a casual work-from-home opportunity with the potential for permanent employment, and are passionate about providing quality healthcare to veterans, we would love to hear from you. Apply with your resume and a brief cover letter outlining your nursing experience and interest in the role.","salary_period":"hour","classification":"Nursing - General Medical & Surgical (Healthcare & Medical)","salary_display":"$45 per hour"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SEEK Job","description":"Read one SEEK Australia job from its URL or numeric id.\n\n**Credit cost:** 2 credits per call","operationId":"post-seek-job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. SEEK job URL or numeric id, for example 95568355 or https://www.seek.com.au/job/95568355. A keyword is rejected.","schema":{"type":"string","description":"Required. SEEK job URL or numeric id, for example 95568355 or https://www.seek.com.au/job/95568355. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"salary":{"type":"integer"},"company":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"listed_at":{"nullable":true},"work_type":{"type":"string"},"salary_max":{"nullable":true},"salary_min":{"nullable":true},"description":{"type":"string"},"salary_period":{"type":"string"},"classification":{"type":"string"},"salary_display":{"type":"string"}}},"examples":{"Telehealth Nurse":{"value":{"id":"95568355","url":"https://www.seek.com.au/job/95568355","title":"Telehealth Nurse (RN or EN)","salary":45,"company":"Reorg Solutions","currency":"AUD","location":"Sydney NSW","listed_at":null,"work_type":"Casual/Vacation","salary_max":null,"salary_min":null,"description":"Telehealth Registered Nurse (RN) - Working With Veterans Casual Position | $45 Per Hour | Work From Home Initially Full-Time Hours | Monday to Friday, 9:00am–5:00pm - Subject to discussion and change to suit you. Veteran Experience Appreciated We are seeking a compassionate Registered Nurse (RN) to join our growing telehealth healthcare team supporting Australian veterans. This is a fully remote, casual position paying $45 per hour, initially offering full-time hours, Monday to Friday, 9:00am–5:00pm, to assist with clearing an existing backlog. Once the backlog has been addressed, ongoing hours will be determined by operational demand and workload requirements. There is potential for the position to transition into permanent part-time or full-time employment in the future, depending on business needs and suitability. About the Role You will provide support to patients via telehealth, working alongside a team of doctors and other healthcare professionals. The role involves patient communication, clinical support, triage, care coordination and following up on patient requests. Full training and ongoing support will be provided. This role would suit a nurse who is confident working independently, highly organised and comfortable working in a busy online healthcare environment. Key Responsibilities Conducting patient consultations via telehealth Taking accurate and detailed clinical notes during consultations Working with GPs and the wider clinical team Managing your own workload and working independently Managing appointment bookings and keeping the consultation schedule running smoothly Communicating professionally and compassionately with patients Managing upset, frustrated or distressed patients calmly and appropriately Identifying matters requiring escalation and referring to the appropriate member of the clinical team Following established clinical processes and procedures Providing a high standard of patient care and maintaining accurate documentation About You Current AHPRA registration as a Registered Nurse (RN) Strong communication and interpersonal skills Excellent organisation and attention to detail Comfortable working independently from home Confident using technology and online clinical systems Calm, professional and compassionate approach Experience working with veterans or within veteran healthcare is highly regarded What We Offer $45 per hour casual rate Initially full-time hours to assist with clearing an existing backlog Monday to Friday, 9:00am–5:00pm during the initial period Ongoing hours based on operational demand Potential to transition into permanent part-time or full-time employment Fully remote work from home Training provided Supportive clinical team Opportunity to work within a specialised veteran healthcare environment Requirements You will need: Current AHPRA registration as a Registered Nurse Your own reliable computer/laptop suitable for telehealth Reliable, high-speed internet A quiet and professional home workspace Availability to initially work Monday to Friday, 9:00am–5:00pm Flexibility regarding ongoing hours as operational needs change If you are a Registered Nurse looking for a casual work-from-home opportunity with the potential for permanent employment, and are passionate about providing quality healthcare to veterans, we would love to hear from you. Apply with your resume and a brief cover letter outlining your nursing experience and interest in the role.","salary_period":"hour","classification":"Nursing - General Medical & Surgical (Healthcare & Medical)","salary_display":"$45 per hour"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/stubhub/event":{"get":{"summary":"StubHub Event","description":"Read one StubHub event from its URL or numeric id, including the lowest printed ticket price.\n\n**Credit cost:** 2 credits per call","operationId":"get-stubhub-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. StubHub event URL or numeric id, for example 162387399 or https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/. A keyword is rejected.","schema":{"type":"string","description":"Required. StubHub event URL or numeric id, for example 162387399 or https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"date":{"nullable":true},"name":{"type":"string"},"time":{"nullable":true},"year":{"nullable":true},"image":{"type":"string"},"price":{"type":"integer"},"country":{"type":"string"},"currency":{"type":"string"},"start_at":{"type":"string"},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"day_of_week":{"nullable":true},"description":{"type":"string"},"country_code":{"nullable":true},"price_display":{"type":"string"},"venue_location":{"type":"string"},"is_parking_event":{"nullable":true},"has_active_listings":{"type":"boolean"}}},"examples":{"Harlem Globetrotters Marseille":{"value":{"id":"162387399","url":"https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/","date":null,"name":"Harlem Globetrotters","time":null,"year":null,"image":"https://img.vggcdn.net/img/cat/11035/3/1.jpg","price":68,"country":"France","currency":"EUR","start_at":"2027-03-31T19:00:00","venue_city":"Marseille","venue_name":"Palais des Sports de Marseille","day_of_week":null,"description":"Acheter et vendre Billets Harlem Globetrotters pour mars 31 à Palais des Sports de Marseille à Marseille sur StubHub ! Les billets sont couverts à 100 % par la Garantie FanProtect","country_code":null,"price_display":"68 €","venue_location":"81 rue Raymond Teisseire, 13009, Marseille, France","is_parking_event":null,"has_active_listings":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"StubHub Event","description":"Read one StubHub event from its URL or numeric id, including the lowest printed ticket price.\n\n**Credit cost:** 2 credits per call","operationId":"post-stubhub-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. StubHub event URL or numeric id, for example 162387399 or https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/. A keyword is rejected.","schema":{"type":"string","description":"Required. StubHub event URL or numeric id, for example 162387399 or https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"date":{"nullable":true},"name":{"type":"string"},"time":{"nullable":true},"year":{"nullable":true},"image":{"type":"string"},"price":{"type":"integer"},"country":{"type":"string"},"currency":{"type":"string"},"start_at":{"type":"string"},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"day_of_week":{"nullable":true},"description":{"type":"string"},"country_code":{"nullable":true},"price_display":{"type":"string"},"venue_location":{"type":"string"},"is_parking_event":{"nullable":true},"has_active_listings":{"type":"boolean"}}},"examples":{"Harlem Globetrotters Marseille":{"value":{"id":"162387399","url":"https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/","date":null,"name":"Harlem Globetrotters","time":null,"year":null,"image":"https://img.vggcdn.net/img/cat/11035/3/1.jpg","price":68,"country":"France","currency":"EUR","start_at":"2027-03-31T19:00:00","venue_city":"Marseille","venue_name":"Palais des Sports de Marseille","day_of_week":null,"description":"Acheter et vendre Billets Harlem Globetrotters pour mars 31 à Palais des Sports de Marseille à Marseille sur StubHub ! Les billets sont couverts à 100 % par la Garantie FanProtect","country_code":null,"price_display":"68 €","venue_location":"81 rue Raymond Teisseire, 13009, Marseille, France","is_parking_event":null,"has_active_listings":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/jamesedition/search":{"get":{"summary":"JamesEdition Search","description":"Search JamesEdition luxury homes by keyword or by a results URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-jamesedition-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, for example villa, or a JamesEdition results URL such as https://www.jamesedition.com/real_estate/france. A single listing URL is rejected.\n\n**Examples:**\n\n    villa\n","schema":{"type":"string","description":"Required. Keyword, for example villa, or a JamesEdition results URL such as https://www.jamesedition.com/real_estate/france. A single listing URL is rejected.\n\n**Examples:**\n\n    villa\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"badges":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"area_sqm":{"type":"integer"},"bedrooms":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"promoted":{"type":"boolean"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"price_eur":{"type":"integer"},"price_usd":{"type":"integer"},"office_url":{"type":"string"},"area_display":{"type":"string"},"country_code":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Villa search, Lake Starnberg project":{"value":{"results":[{"id":"17793477","url":"https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477","city":"Munich","image":"https://img.jamesedition.com/listing_images/2026/05/07/09/16/45/419dac60-8b4b-4032-ac51-9765ab7d3418/je/507x312xc.jpg","price":670000,"title":"Alpine Panorama above Lake Starnberg – New-Build Project near Munich","badges":["Directly from developer","Video","Promoted"],"region":"Bavaria","address":"Munich, Bavaria, Germany","country":"Germany","area_sqm":43,"bedrooms":1,"category":"Apartment","currency":"EUR","latitude":48.1351253,"promoted":true,"bathrooms":1,"longitude":11.5819806,"price_eur":670000,"price_usd":750540,"office_url":"https://www.jamesedition.com/offices/real_estate/c7-gruppe-505101","area_display":"43 sqm","country_code":"DE","price_display":"€670,000"}],"pagination":{"next":"https://www.jamesedition.com/real_estate?q=villa&page=2","page":1,"per_page":31,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"JamesEdition Search","description":"Search JamesEdition luxury homes by keyword or by a results URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-jamesedition-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, for example villa, or a JamesEdition results URL such as https://www.jamesedition.com/real_estate/france. A single listing URL is rejected.\n\n**Examples:**\n\n    villa\n","schema":{"type":"string","description":"Required. Keyword, for example villa, or a JamesEdition results URL such as https://www.jamesedition.com/real_estate/france. A single listing URL is rejected.\n\n**Examples:**\n\n    villa\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"badges":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"area_sqm":{"type":"integer"},"bedrooms":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"promoted":{"type":"boolean"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"price_eur":{"type":"integer"},"price_usd":{"type":"integer"},"office_url":{"type":"string"},"area_display":{"type":"string"},"country_code":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Villa search, Lake Starnberg project":{"value":{"results":[{"id":"17793477","url":"https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477","city":"Munich","image":"https://img.jamesedition.com/listing_images/2026/05/07/09/16/45/419dac60-8b4b-4032-ac51-9765ab7d3418/je/507x312xc.jpg","price":670000,"title":"Alpine Panorama above Lake Starnberg – New-Build Project near Munich","badges":["Directly from developer","Video","Promoted"],"region":"Bavaria","address":"Munich, Bavaria, Germany","country":"Germany","area_sqm":43,"bedrooms":1,"category":"Apartment","currency":"EUR","latitude":48.1351253,"promoted":true,"bathrooms":1,"longitude":11.5819806,"price_eur":670000,"price_usd":750540,"office_url":"https://www.jamesedition.com/offices/real_estate/c7-gruppe-505101","area_display":"43 sqm","country_code":"DE","price_display":"€670,000"}],"pagination":{"next":"https://www.jamesedition.com/real_estate?q=villa&page=2","page":1,"per_page":31,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/jamesedition/property":{"get":{"summary":"JamesEdition Property","description":"Read one JamesEdition listing from its URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-jamesedition-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. JamesEdition listing URL, for example https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477. A keyword is rejected.","schema":{"type":"string","description":"Required. JamesEdition listing URL, for example https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"specs":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"lot_sqm":{"nullable":true},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"location":{"type":"string"},"bathrooms":{"type":"integer"},"description":{"type":"string"},"lot_display":{"nullable":true},"interior_sqm":{"type":"integer"},"price_display":{"type":"string"},"interior_display":{"type":"string"}}},"examples":{"Lake Starnberg apartment":{"value":{"id":"17793477","url":"https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477","image":"https://img.jamesedition.com/listing_images/2026/05/07/09/16/45/419dac60-8b4b-4032-ac51-9765ab7d3418/je/1040x620xc.jpg","price":670000,"specs":["1 Beds","1 Baths","44 Sqm"],"title":"Alpine Panorama Above Lake Starnberg – New Build Project Near Munich","lot_sqm":null,"bedrooms":1,"currency":"EUR","location":"Munich, Bavaria, Germany","bathrooms":1,"description":"Munich, Bavaria, Germany | 1 Bed, 1 Bath Apartment For Sale | €670,000 - FELDAFINGER HÖHE – LIVING WHERE OTHERS GO ON VACATION<br/><br/>In Feldafing on the...","lot_display":null,"interior_sqm":44,"price_display":"€670,000","interior_display":"44 Sqm"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"JamesEdition Property","description":"Read one JamesEdition listing from its URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-jamesedition-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. JamesEdition listing URL, for example https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477. A keyword is rejected.","schema":{"type":"string","description":"Required. JamesEdition listing URL, for example https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"specs":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"lot_sqm":{"nullable":true},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"location":{"type":"string"},"bathrooms":{"type":"integer"},"description":{"type":"string"},"lot_display":{"nullable":true},"interior_sqm":{"type":"integer"},"price_display":{"type":"string"},"interior_display":{"type":"string"}}},"examples":{"Lake Starnberg apartment":{"value":{"id":"17793477","url":"https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477","image":"https://img.jamesedition.com/listing_images/2026/05/07/09/16/45/419dac60-8b4b-4032-ac51-9765ab7d3418/je/1040x620xc.jpg","price":670000,"specs":["1 Beds","1 Baths","44 Sqm"],"title":"Alpine Panorama Above Lake Starnberg – New Build Project Near Munich","lot_sqm":null,"bedrooms":1,"currency":"EUR","location":"Munich, Bavaria, Germany","bathrooms":1,"description":"Munich, Bavaria, Germany | 1 Bed, 1 Bath Apartment For Sale | €670,000 - FELDAFINGER HÖHE – LIVING WHERE OTHERS GO ON VACATION<br/><br/>In Feldafing on the...","lot_display":null,"interior_sqm":44,"price_display":"€670,000","interior_display":"44 Sqm"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/prnewswire/article":{"get":{"summary":"PR Newswire Article","description":"Read one PR Newswire press release from its URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-prnewswire-article","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. PR Newswire release URL, for example https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html. A keyword is rejected.","schema":{"type":"string","description":"Required. PR Newswire release URL, for example https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"body":{"type":"string"},"image":{"nullable":true},"title":{"type":"string"},"company":{"type":"string"},"dateline":{"type":"string"},"keywords":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"updated_at_iso":{"type":"string"},"published_at_iso":{"type":"string"}}},"examples":{"Pumpkin pet insurance release":{"value":{"id":"302924942","url":"https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html","body":"NEW YORK , Oct. 30, 2026 /PRNewswire/ -- Pumpkin Pet Insurance is rewarding 11 veterinary clinics with $1,000 to support angel funds that help pets access care their families otherwise can't afford.\n\nThese awarded donations are part of Pumpkin's ongoing effort to help veterinary clinics educate families about the cost-of-care.\n\nMaking care decisions with confidence\n\nClear, early conversations about expected costs, coverage basics, and payment options can build trust and allow pet parents to make confident care decisions. When the subject of cost is part of routine vet visits, pet parents are more likely to be proactive about budgeting, pet insurance, and next steps. In a recent AVMA survey, 81% of veterinarians reported that clients are more sensitive to costs than just a few years ago, leading to fewer visits and more clients who decline recommended care. 1\n\n\"No one should have to choose between the pet they love and the care that can help them,\" said Bob Betz, SVP of Vet Sales at Pumpkin. \"These clinics lean into honest, compassionate talks about cost, so families know what to expect and how a Pumpkin plan can help them afford it.\"\n\nWhere the donations are going\n\nThe following clinics were awarded donations through Pumpkin's cost-of-care education challenge:\n\n\"We're proud and excited to make these donations, so pets can get care when families can't afford it and parents can say yes in the moments that matter,\" said Betz.\n\n\"Cost is part of care. When we explain the impact early, in plain words and with options, families feel ready to move forward,\" said Kym Penland, Practice Manager at Carpenter Animal Hospital & Pet Inn. \"This win is bigger than $1,000, but we're thrilled to bolster our partner's angel fund and take care of pets in need.\"\n\nSee tools, programs like this, and learn more about how Pumpkin partners with vets .\n\n1. Nolen, R. Scott. \" Veterinarians report increasing price sensitivity, decreasing visits .\" American Veterinary Medical Association News, Feb. 2026. 2. Pumpkin was the #1 rated pet insurance on Google among brands with 2,500+ reviews as of March 2026. 3. Based on responses from 447 veterinary staff members who participated in the \"Pumpkin 2025 Survey: Vet Partners Feedback\" between 12/3/25-12/15/25.\n\nAbout Pumpkin\n\nPumpkin Insurance Services Inc. (\"Pumpkin\") is the #1-rated pet insurance brand on Google 2 and one of the fastest-growing pet health companies in the US. Trusted by nine out of ten surveyed veterinarians 3 , Pumpkin has insured over 230,000 pets and counting, and paid more than $176 million in claims since launching in 2020. Pumpkin also offers PumpkinNow, the only urgent pay service that can pay pet parents for eligible claims before they pay vet bills — making it one of the fastest claims experiences in pet insurance. Pumpkin covers up to 90% of eligible care at any licensed veterinary clinic in the US and Canada. Beyond accidents and illnesses, Pumpkin Wellness Club provides preventive care plans that help pay for everything from routine vet visits to grooming. For more information, visit pumpkin.care .\n\nFor terms and conditions, visit: https://www.pumpkin.care/sample-plan/ . Products are underwritten by either Independence American Insurance Company (NAIC #26581), or United States Fire Insurance Company (NAIC #21113), and produced by Pumpkin Insurance Services Inc. (\"Pumpkin\") (NPN #19084749; CA License #6001617). Premiums are based on and may increase or decrease due to the age of your pet, the species or breed of your pet, and your home address.\n\nSOURCE Pumpkin Pet Insurance","image":null,"title":"Pumpkin awarded $11,000 in donations to veterinary clinics for cost-of-care education","company":"Pumpkin Pet Insurance","dateline":"NEW YORK","keywords":"Pumpkin Pet Insurance","company_url":"https://www.prnewswire.com/news/pumpkin-pet-insurance/","description":"/PRNewswire/ -- Pumpkin Pet Insurance is rewarding 11 veterinary clinics with $1,000 to support angel funds that help pets access care their families otherwise...","published_at":"Oct 30, 2026, 09:06 ET","updated_at_iso":"2026-10-30T13:07:53Z","published_at_iso":"2026-10-30T13:06:00Z"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PR Newswire Article","description":"Read one PR Newswire press release from its URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-prnewswire-article","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. PR Newswire release URL, for example https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html. A keyword is rejected.","schema":{"type":"string","description":"Required. PR Newswire release URL, for example https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html. A keyword is rejected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"body":{"type":"string"},"image":{"nullable":true},"title":{"type":"string"},"company":{"type":"string"},"dateline":{"type":"string"},"keywords":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"updated_at_iso":{"type":"string"},"published_at_iso":{"type":"string"}}},"examples":{"Pumpkin pet insurance release":{"value":{"id":"302924942","url":"https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html","body":"NEW YORK , Oct. 30, 2026 /PRNewswire/ -- Pumpkin Pet Insurance is rewarding 11 veterinary clinics with $1,000 to support angel funds that help pets access care their families otherwise can't afford.\n\nThese awarded donations are part of Pumpkin's ongoing effort to help veterinary clinics educate families about the cost-of-care.\n\nMaking care decisions with confidence\n\nClear, early conversations about expected costs, coverage basics, and payment options can build trust and allow pet parents to make confident care decisions. When the subject of cost is part of routine vet visits, pet parents are more likely to be proactive about budgeting, pet insurance, and next steps. In a recent AVMA survey, 81% of veterinarians reported that clients are more sensitive to costs than just a few years ago, leading to fewer visits and more clients who decline recommended care. 1\n\n\"No one should have to choose between the pet they love and the care that can help them,\" said Bob Betz, SVP of Vet Sales at Pumpkin. \"These clinics lean into honest, compassionate talks about cost, so families know what to expect and how a Pumpkin plan can help them afford it.\"\n\nWhere the donations are going\n\nThe following clinics were awarded donations through Pumpkin's cost-of-care education challenge:\n\n\"We're proud and excited to make these donations, so pets can get care when families can't afford it and parents can say yes in the moments that matter,\" said Betz.\n\n\"Cost is part of care. When we explain the impact early, in plain words and with options, families feel ready to move forward,\" said Kym Penland, Practice Manager at Carpenter Animal Hospital & Pet Inn. \"This win is bigger than $1,000, but we're thrilled to bolster our partner's angel fund and take care of pets in need.\"\n\nSee tools, programs like this, and learn more about how Pumpkin partners with vets .\n\n1. Nolen, R. Scott. \" Veterinarians report increasing price sensitivity, decreasing visits .\" American Veterinary Medical Association News, Feb. 2026. 2. Pumpkin was the #1 rated pet insurance on Google among brands with 2,500+ reviews as of March 2026. 3. Based on responses from 447 veterinary staff members who participated in the \"Pumpkin 2025 Survey: Vet Partners Feedback\" between 12/3/25-12/15/25.\n\nAbout Pumpkin\n\nPumpkin Insurance Services Inc. (\"Pumpkin\") is the #1-rated pet insurance brand on Google 2 and one of the fastest-growing pet health companies in the US. Trusted by nine out of ten surveyed veterinarians 3 , Pumpkin has insured over 230,000 pets and counting, and paid more than $176 million in claims since launching in 2020. Pumpkin also offers PumpkinNow, the only urgent pay service that can pay pet parents for eligible claims before they pay vet bills — making it one of the fastest claims experiences in pet insurance. Pumpkin covers up to 90% of eligible care at any licensed veterinary clinic in the US and Canada. Beyond accidents and illnesses, Pumpkin Wellness Club provides preventive care plans that help pay for everything from routine vet visits to grooming. For more information, visit pumpkin.care .\n\nFor terms and conditions, visit: https://www.pumpkin.care/sample-plan/ . Products are underwritten by either Independence American Insurance Company (NAIC #26581), or United States Fire Insurance Company (NAIC #21113), and produced by Pumpkin Insurance Services Inc. (\"Pumpkin\") (NPN #19084749; CA License #6001617). Premiums are based on and may increase or decrease due to the age of your pet, the species or breed of your pet, and your home address.\n\nSOURCE Pumpkin Pet Insurance","image":null,"title":"Pumpkin awarded $11,000 in donations to veterinary clinics for cost-of-care education","company":"Pumpkin Pet Insurance","dateline":"NEW YORK","keywords":"Pumpkin Pet Insurance","company_url":"https://www.prnewswire.com/news/pumpkin-pet-insurance/","description":"/PRNewswire/ -- Pumpkin Pet Insurance is rewarding 11 veterinary clinics with $1,000 to support angel funds that help pets access care their families otherwise...","published_at":"Oct 30, 2026, 09:06 ET","updated_at_iso":"2026-10-30T13:07:53Z","published_at_iso":"2026-10-30T13:06:00Z"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/stubhub/search":{"get":{"summary":"StubHub Search","description":"Search StubHub events by keyword or by a StubHub search URL. The response is the first embedded page.\n\n**Credit cost:** 1 credit per call","operationId":"get-stubhub-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, for example nba, or a StubHub search URL such as https://www.stubhub.com/secure/search/?q=nba. An event URL is rejected.\n\n**Examples:**\n\n    nba\n","schema":{"type":"string","description":"Required. Keyword, for example nba, or a StubHub search URL such as https://www.stubhub.com/secure/search/?q=nba. An event URL is rejected.\n\n**Examples:**\n\n    nba\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Only page 1 returns events. Example: 1. Page 2 and above return 404 because the search document has no further page.","schema":{"type":"number","default":"1","description":"Optional. Only page 1 returns events. Example: 1. Page 2 and above return 404 because the search document has no further page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"time":{"type":"string"},"year":{"type":"string"},"price":{"nullable":true},"country":{"type":"string"},"currency":{"nullable":true},"start_at":{"nullable":true},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"day_of_week":{"type":"string"},"country_code":{"type":"string"},"price_display":{"nullable":true},"venue_location":{"type":"string"},"is_parking_event":{"type":"boolean"},"has_active_listings":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"NBA search, first embedded event":{"value":{"results":[{"id":"162387399","url":"https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/","date":"Mar 31 2027","name":"Harlem Globetrotters","time":"7:00 PM","year":"2027","price":null,"country":"France","currency":null,"start_at":null,"venue_city":"Marseille","venue_name":"Palais des Sports de Marseille","day_of_week":"Wed","country_code":"FR","price_display":null,"venue_location":"Marseille, France","is_parking_event":false,"has_active_listings":true}],"pagination":{"next":null,"page":1,"per_page":20,"total_pages":null,"total_results":2176}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"StubHub Search","description":"Search StubHub events by keyword or by a StubHub search URL. The response is the first embedded page.\n\n**Credit cost:** 1 credit per call","operationId":"post-stubhub-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, for example nba, or a StubHub search URL such as https://www.stubhub.com/secure/search/?q=nba. An event URL is rejected.\n\n**Examples:**\n\n    nba\n","schema":{"type":"string","description":"Required. Keyword, for example nba, or a StubHub search URL such as https://www.stubhub.com/secure/search/?q=nba. An event URL is rejected.\n\n**Examples:**\n\n    nba\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Only page 1 returns events. Example: 1. Page 2 and above return 404 because the search document has no further page.","schema":{"type":"number","default":"1","description":"Optional. Only page 1 returns events. Example: 1. Page 2 and above return 404 because the search document has no further page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"time":{"type":"string"},"year":{"type":"string"},"price":{"nullable":true},"country":{"type":"string"},"currency":{"nullable":true},"start_at":{"nullable":true},"venue_city":{"type":"string"},"venue_name":{"type":"string"},"day_of_week":{"type":"string"},"country_code":{"type":"string"},"price_display":{"nullable":true},"venue_location":{"type":"string"},"is_parking_event":{"type":"boolean"},"has_active_listings":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"NBA search, first embedded event":{"value":{"results":[{"id":"162387399","url":"https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/","date":"Mar 31 2027","name":"Harlem Globetrotters","time":"7:00 PM","year":"2027","price":null,"country":"France","currency":null,"start_at":null,"venue_city":"Marseille","venue_name":"Palais des Sports de Marseille","day_of_week":"Wed","country_code":"FR","price_display":null,"venue_location":"Marseille, France","is_parking_event":false,"has_active_listings":true}],"pagination":{"next":null,"page":1,"per_page":20,"total_pages":null,"total_results":2176}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/prnewswire/search":{"get":{"summary":"PR Newswire Search","description":"Search PR Newswire press releases by keyword or by a news-search URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-prnewswire-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, for example apple, or a PR Newswire news-search URL such as https://www.prnewswire.com/search/news/?keyword=apple. A release URL is rejected.\n\n**Examples:**\n\n    apple\n","schema":{"type":"string","description":"Required. Keyword, for example apple, or a PR Newswire news-search URL such as https://www.prnewswire.com/search/news/?keyword=apple. A release URL is rejected.\n\n**Examples:**\n\n    apple\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"nullable":true},"title":{"type":"string"},"company":{"type":"string"},"summary":{"type":"string"},"company_url":{"type":"string"},"published_at":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apple search, first release":{"value":{"results":[{"id":"302924942","url":"https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html","image":null,"title":"Pumpkin awarded $11,000 in donations to veterinary clinics for cost-of-care education","company":"Pumpkin Pet Insurance","summary":"Small Animal Hospital of PA (PA) – donating to Peaceable KingdomBrilliant Veterinary Care (NY) – donating to Frankie's Feline Fund and Big Apple Cat RescueSchwenksville Veterinary Hospital (PA) – donating to ALITE FundMassapequa Pet Vet (NY) – donating to Long Island Wildlife","company_url":"https://www.prnewswire.com/news/pumpkin-pet-insurance/","published_at":"Oct 30, 2026, 09:06 ET"}],"pagination":{"next":"https://www.prnewswire.com/search/news/?keyword=apple&pagesize=25&page=2","page":1,"per_page":25,"total_pages":60,"total_results":1492}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PR Newswire Search","description":"Search PR Newswire press releases by keyword or by a news-search URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-prnewswire-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, for example apple, or a PR Newswire news-search URL such as https://www.prnewswire.com/search/news/?keyword=apple. A release URL is rejected.\n\n**Examples:**\n\n    apple\n","schema":{"type":"string","description":"Required. Keyword, for example apple, or a PR Newswire news-search URL such as https://www.prnewswire.com/search/news/?keyword=apple. A release URL is rejected.\n\n**Examples:**\n\n    apple\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"nullable":true},"title":{"type":"string"},"company":{"type":"string"},"summary":{"type":"string"},"company_url":{"type":"string"},"published_at":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apple search, first release":{"value":{"results":[{"id":"302924942","url":"https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html","image":null,"title":"Pumpkin awarded $11,000 in donations to veterinary clinics for cost-of-care education","company":"Pumpkin Pet Insurance","summary":"Small Animal Hospital of PA (PA) – donating to Peaceable KingdomBrilliant Veterinary Care (NY) – donating to Frankie's Feline Fund and Big Apple Cat RescueSchwenksville Veterinary Hospital (PA) – donating to ALITE FundMassapequa Pet Vet (NY) – donating to Long Island Wildlife","company_url":"https://www.prnewswire.com/news/pumpkin-pet-insurance/","published_at":"Oct 30, 2026, 09:06 ET"}],"pagination":{"next":"https://www.prnewswire.com/search/news/?keyword=apple&pagesize=25&page=2","page":1,"per_page":25,"total_pages":60,"total_results":1492}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/seek/search":{"get":{"summary":"SEEK Search","description":"Search SEEK Australia jobs by keyword or by a results URL.\n\n**Credit cost:** 2 credits per call","operationId":"get-seek-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Job keyword, for example nurse, or a SEEK results URL such as https://www.seek.com.au/nurse-jobs. A /job/<id> URL is rejected.\n\n**Examples:**\n\n    nurse\n","schema":{"type":"string","description":"Required. Job keyword, for example nurse, or a SEEK results URL such as https://www.seek.com.au/nurse-jobs. A /job/<id> URL is rejected.\n\n**Examples:**\n\n    nurse\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"salary":{"type":"integer"},"company":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"listed_at":{"type":"string"},"work_type":{"type":"string"},"salary_max":{"nullable":true},"salary_min":{"nullable":true},"company_url":{"type":"string"},"salary_period":{"type":"string"},"classification":{"type":"string"},"salary_display":{"type":"string"},"subclassification":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Nurse jobs, first card":{"value":{"results":[{"id":"95568355","url":"https://www.seek.com.au/job/95568355","title":"Telehealth Nurse (RN or EN)","salary":45,"company":"Reorg Solutions","currency":"AUD","location":"Sydney NSW","listed_at":"1d ago","work_type":"This is a Casual/Vacation job","salary_max":null,"salary_min":null,"company_url":"https://www.seek.com.au/Reorg-Solutions-jobs","salary_period":"hour","classification":"Healthcare & Medical","salary_display":"$45 per hour","subclassification":"Nursing - General Medical & Surgical"}],"pagination":{"next":"https://www.seek.com.au/nurse-jobs?page=2","page":1,"per_page":32,"total_pages":null,"total_results":7894}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SEEK Search","description":"Search SEEK Australia jobs by keyword or by a results URL.\n\n**Credit cost:** 2 credits per call","operationId":"post-seek-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Job keyword, for example nurse, or a SEEK results URL such as https://www.seek.com.au/nurse-jobs. A /job/<id> URL is rejected.\n\n**Examples:**\n\n    nurse\n","schema":{"type":"string","description":"Required. Job keyword, for example nurse, or a SEEK results URL such as https://www.seek.com.au/nurse-jobs. A /job/<id> URL is rejected.\n\n**Examples:**\n\n    nurse\n"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1.","schema":{"type":"number","default":"1","description":"Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"salary":{"type":"integer"},"company":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"listed_at":{"type":"string"},"work_type":{"type":"string"},"salary_max":{"nullable":true},"salary_min":{"nullable":true},"company_url":{"type":"string"},"salary_period":{"type":"string"},"classification":{"type":"string"},"salary_display":{"type":"string"},"subclassification":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Nurse jobs, first card":{"value":{"results":[{"id":"95568355","url":"https://www.seek.com.au/job/95568355","title":"Telehealth Nurse (RN or EN)","salary":45,"company":"Reorg Solutions","currency":"AUD","location":"Sydney NSW","listed_at":"1d ago","work_type":"This is a Casual/Vacation job","salary_max":null,"salary_min":null,"company_url":"https://www.seek.com.au/Reorg-Solutions-jobs","salary_period":"hour","classification":"Healthcare & Medical","salary_display":"$45 per hour","subclassification":"Nursing - General Medical & Surgical"}],"pagination":{"next":"https://www.seek.com.au/nurse-jobs?page=2","page":1,"per_page":32,"total_pages":null,"total_results":7894}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/untappd/search":{"get":{"summary":"Untappd Search","description":"Search Untappd beers by keyword. Cards include brewery, ABV, and IBU. next is null when Untappd does not expose a next page.\n\n**Credit cost:** 2 credits per call","operationId":"get-untappd-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A beer keyword, or an Untappd search URL whose path is /search.\n\n**Example:**\n\n```\nipa\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/search?q=ipa\n```","schema":{"type":"string","description":"Required. A beer keyword, or an Untappd search URL whose path is /search.\n\n**Example:**\n\n```\nipa\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/search?q=ipa\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"abv":{"type":"number"},"ibu":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"style":{"type":"string"},"rating":{"type":"number"},"brewery":{"type":"string"},"abv_display":{"type":"string"},"brewery_url":{"type":"string"},"ibu_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Lagunitas IPA":{"value":{"results":[{"id":"4509","abv":6.2,"ibu":51,"url":"https://untappd.com/b/lagunitas-brewing-company-ipa/4509","name":"IPA","image":"https://assets.untappd.com/site/beer_logos/beer-4509_21190_sm.jpeg","style":"IPA - American","rating":3.68,"brewery":"Lagunitas Brewing Company","abv_display":"6.2% ABV","brewery_url":"https://untappd.com/brewery/765","ibu_display":"51 IBU"}],"pagination":{"next":null,"page":1,"per_page":5,"total_pages":null,"total_results":401027}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Untappd Search","description":"Search Untappd beers by keyword. Cards include brewery, ABV, and IBU. next is null when Untappd does not expose a next page.\n\n**Credit cost:** 2 credits per call","operationId":"post-untappd-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A beer keyword, or an Untappd search URL whose path is /search.\n\n**Example:**\n\n```\nipa\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/search?q=ipa\n```","schema":{"type":"string","description":"Required. A beer keyword, or an Untappd search URL whose path is /search.\n\n**Example:**\n\n```\nipa\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/search?q=ipa\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"abv":{"type":"number"},"ibu":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"style":{"type":"string"},"rating":{"type":"number"},"brewery":{"type":"string"},"abv_display":{"type":"string"},"brewery_url":{"type":"string"},"ibu_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Lagunitas IPA":{"value":{"results":[{"id":"4509","abv":6.2,"ibu":51,"url":"https://untappd.com/b/lagunitas-brewing-company-ipa/4509","name":"IPA","image":"https://assets.untappd.com/site/beer_logos/beer-4509_21190_sm.jpeg","style":"IPA - American","rating":3.68,"brewery":"Lagunitas Brewing Company","abv_display":"6.2% ABV","brewery_url":"https://untappd.com/brewery/765","ibu_display":"51 IBU"}],"pagination":{"next":null,"page":1,"per_page":5,"total_pages":null,"total_results":401027}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/untappd/beer":{"get":{"summary":"Untappd Beer","description":"Read one Untappd beer, including ABV, IBU, and brewery.\n\n**Credit cost:** 2 credits per call","operationId":"get-untappd-beer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The numeric Untappd beer id from search, or a beer URL under /b/ or /beer/. A keyword is not accepted.\n\n**Example:**\n\n```\n4509\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/b/lagunitas-brewing-company-ipa/4509\n```","schema":{"type":"string","description":"Required. The numeric Untappd beer id from search, or a beer URL under /b/ or /beer/. A keyword is not accepted.\n\n**Example:**\n\n```\n4509\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/b/lagunitas-brewing-company-ipa/4509\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"abv":{"type":"number"},"ibu":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"style":{"type":"string"},"rating":{"type":"number"},"brewery":{"type":"string"},"abv_display":{"type":"string"},"brewery_url":{"type":"string"},"description":{"type":"string"},"ibu_display":{"type":"string"},"ratings_count":{"type":"integer"},"total_checkins":{"type":"integer"},"unique_checkins":{"type":"integer"},"monthly_checkins":{"type":"integer"},"total_checkins_display":{"type":"string"}}},"examples":{"Lagunitas IPA":{"value":{"id":"4509","abv":6.2,"ibu":51,"url":"https://untappd.com/beer/4509","name":"IPA","image":"https://assets.untappd.com/site/beer_logos/beer-4509_21190_sm.jpeg","style":"IPA - American","rating":3.6845,"brewery":"Lagunitas Brewing Company","abv_display":"6.2% ABV","brewery_url":"https://untappd.com/LagunitasBrewingCo","description":"A well-rounded, Highly drinkable India Pale Ale. A bit of Caramel Malt barley provides the richness that mellows out the twang of the hops, including Cascade, Centennial, Chinook and a splash of honorary “C” hop, Simcoe.","ibu_display":"51 IBU","ratings_count":813594,"total_checkins":1970000,"unique_checkins":893270,"monthly_checkins":3193,"total_checkins_display":"1.97M+"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Untappd Beer","description":"Read one Untappd beer, including ABV, IBU, and brewery.\n\n**Credit cost:** 2 credits per call","operationId":"post-untappd-beer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The numeric Untappd beer id from search, or a beer URL under /b/ or /beer/. A keyword is not accepted.\n\n**Example:**\n\n```\n4509\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/b/lagunitas-brewing-company-ipa/4509\n```","schema":{"type":"string","description":"Required. The numeric Untappd beer id from search, or a beer URL under /b/ or /beer/. A keyword is not accepted.\n\n**Example:**\n\n```\n4509\n```\n\n**URL example:**\n\n```\nhttps://untappd.com/b/lagunitas-brewing-company-ipa/4509\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"abv":{"type":"number"},"ibu":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"style":{"type":"string"},"rating":{"type":"number"},"brewery":{"type":"string"},"abv_display":{"type":"string"},"brewery_url":{"type":"string"},"description":{"type":"string"},"ibu_display":{"type":"string"},"ratings_count":{"type":"integer"},"total_checkins":{"type":"integer"},"unique_checkins":{"type":"integer"},"monthly_checkins":{"type":"integer"},"total_checkins_display":{"type":"string"}}},"examples":{"Lagunitas IPA":{"value":{"id":"4509","abv":6.2,"ibu":51,"url":"https://untappd.com/beer/4509","name":"IPA","image":"https://assets.untappd.com/site/beer_logos/beer-4509_21190_sm.jpeg","style":"IPA - American","rating":3.6845,"brewery":"Lagunitas Brewing Company","abv_display":"6.2% ABV","brewery_url":"https://untappd.com/LagunitasBrewingCo","description":"A well-rounded, Highly drinkable India Pale Ale. A bit of Caramel Malt barley provides the richness that mellows out the twang of the hops, including Cascade, Centennial, Chinook and a splash of honorary “C” hop, Simcoe.","ibu_display":"51 IBU","ratings_count":813594,"total_checkins":1970000,"unique_checkins":893270,"monthly_checkins":3193,"total_checkins_display":"1.97M+"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/goodreads/book":{"get":{"summary":"Goodreads Book","description":"Read one Goodreads book by the numeric id from search, such as 44767458 for Dune.\n\n**Credit cost:** 2 credits per call","operationId":"get-goodreads-book","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The numeric Goodreads book id from search, or a /book/show/ URL. A title is not accepted.\n\n**Example:**\n\n```\n44767458\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/book/show/44767458\n```","schema":{"type":"string","description":"Required. The numeric Goodreads book id from search, or a /book/show/ URL. A title is not accepted.\n\n**Example:**\n\n```\n44767458\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/book/show/44767458\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"isbn":{"type":"string"},"image":{"type":"string"},"pages":{"type":"integer"},"title":{"type":"string"},"awards":{"type":"array","items":{"type":"string"}},"genres":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"series":{"type":"string"},"authors":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"published":{"type":"string"},"book_format":{"type":"string"},"description":{"type":"string"},"ratings_count":{"type":"integer"},"reviews_count":{"type":"integer"}}},"examples":{"Dune":{"value":{"id":"44767458","url":"https://www.goodreads.com/book/show/44767458","isbn":"9780593099322","image":"https://m.media-amazon.com/images/S/compressed.photo.goodreads.com/books/1555447414i/44767458.jpg","pages":658,"title":"Dune","awards":["Hugo Award Best Novel (1966)","Nebula Award Best Novel (1965)","Seiun Award 星雲賞 Best Foreign Novel (1974)"],"genres":["Science Fiction","Fiction","Fantasy","Classics","Audiobook","Science Fiction Fantasy","Space Opera"],"rating":4.29,"series":"Dune #1","authors":["Frank Herbert"],"language":"English","published":"June 1, 1965","book_format":"Hardcover","description":"Set on the desert planet Arrakis, Dune is the story of the boy Paul Atreides, heir to a noble family tasked with ruling an inhospitable world where the only thing of value is the “spice” melange, a drug capable of extending life and enhancing consciousness. Coveted across the known universe, melange is a prize worth killing for... When House Atreides is betrayed, the destruction of Paul’s family will set the boy on a journey toward a destiny greater than he could ever have imagined. And as he evolves into the mysterious man known as Muad’Dib, he will bring to fruition humankind’s most ancient and unattainable dream. Show more","ratings_count":1723657,"reviews_count":90495}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Goodreads Book","description":"Read one Goodreads book by the numeric id from search, such as 44767458 for Dune.\n\n**Credit cost:** 2 credits per call","operationId":"post-goodreads-book","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The numeric Goodreads book id from search, or a /book/show/ URL. A title is not accepted.\n\n**Example:**\n\n```\n44767458\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/book/show/44767458\n```","schema":{"type":"string","description":"Required. The numeric Goodreads book id from search, or a /book/show/ URL. A title is not accepted.\n\n**Example:**\n\n```\n44767458\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/book/show/44767458\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"isbn":{"type":"string"},"image":{"type":"string"},"pages":{"type":"integer"},"title":{"type":"string"},"awards":{"type":"array","items":{"type":"string"}},"genres":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"series":{"type":"string"},"authors":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"published":{"type":"string"},"book_format":{"type":"string"},"description":{"type":"string"},"ratings_count":{"type":"integer"},"reviews_count":{"type":"integer"}}},"examples":{"Dune":{"value":{"id":"44767458","url":"https://www.goodreads.com/book/show/44767458","isbn":"9780593099322","image":"https://m.media-amazon.com/images/S/compressed.photo.goodreads.com/books/1555447414i/44767458.jpg","pages":658,"title":"Dune","awards":["Hugo Award Best Novel (1966)","Nebula Award Best Novel (1965)","Seiun Award 星雲賞 Best Foreign Novel (1974)"],"genres":["Science Fiction","Fiction","Fantasy","Classics","Audiobook","Science Fiction Fantasy","Space Opera"],"rating":4.29,"series":"Dune #1","authors":["Frank Herbert"],"language":"English","published":"June 1, 1965","book_format":"Hardcover","description":"Set on the desert planet Arrakis, Dune is the story of the boy Paul Atreides, heir to a noble family tasked with ruling an inhospitable world where the only thing of value is the “spice” melange, a drug capable of extending life and enhancing consciousness. Coveted across the known universe, melange is a prize worth killing for... When House Atreides is betrayed, the destruction of Paul’s family will set the boy on a journey toward a destiny greater than he could ever have imagined. And as he evolves into the mysterious man known as Muad’Dib, he will bring to fruition humankind’s most ancient and unattainable dream. Show more","ratings_count":1723657,"reviews_count":90495}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ratemyprofessors/professor":{"get":{"summary":"Rate My Professors Professor","description":"Read one Rate My Professors profile, including difficulty and would-take-again when the page shows them.\n\n**Credit cost:** 2 credits per call","operationId":"get-ratemyprofessors-professor","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The numeric professor id from search, or a /professor/{id} URL. A name is not accepted.\n\n**Example:**\n\n```\n1064107\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/professor/1064107\n```","schema":{"type":"string","description":"Required. The numeric professor id from search, or a /professor/{id} URL. A name is not accepted.\n\n**Example:**\n\n```\n1064107\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/professor/1064107\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"rating":{"type":"number"},"school":{"type":"string"},"last_name":{"type":"string"},"department":{"type":"string"},"difficulty":{"type":"number"},"first_name":{"type":"string"},"school_url":{"type":"string"},"ratings_count":{"type":"integer"},"would_take_again_percent":{"type":"integer"}}},"examples":{"Kevin Smith":{"value":{"id":"1064107","url":"https://www.ratemyprofessors.com/professor/1064107","name":"Kevin Smith","rating":4.6,"school":"Rio Hondo College","last_name":"Smith","department":"Psychology","difficulty":3.1,"first_name":"Kevin","school_url":"https://www.ratemyprofessors.com/school/2746","ratings_count":174,"would_take_again_percent":94}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rate My Professors Professor","description":"Read one Rate My Professors profile, including difficulty and would-take-again when the page shows them.\n\n**Credit cost:** 2 credits per call","operationId":"post-ratemyprofessors-professor","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The numeric professor id from search, or a /professor/{id} URL. A name is not accepted.\n\n**Example:**\n\n```\n1064107\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/professor/1064107\n```","schema":{"type":"string","description":"Required. The numeric professor id from search, or a /professor/{id} URL. A name is not accepted.\n\n**Example:**\n\n```\n1064107\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/professor/1064107\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"rating":{"type":"number"},"school":{"type":"string"},"last_name":{"type":"string"},"department":{"type":"string"},"difficulty":{"type":"number"},"first_name":{"type":"string"},"school_url":{"type":"string"},"ratings_count":{"type":"integer"},"would_take_again_percent":{"type":"integer"}}},"examples":{"Kevin Smith":{"value":{"id":"1064107","url":"https://www.ratemyprofessors.com/professor/1064107","name":"Kevin Smith","rating":4.6,"school":"Rio Hondo College","last_name":"Smith","department":"Psychology","difficulty":3.1,"first_name":"Kevin","school_url":"https://www.ratemyprofessors.com/school/2746","ratings_count":174,"would_take_again_percent":94}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ratemyprofessors/search":{"get":{"summary":"Rate My Professors Search","description":"Search Rate My Professors by name. Cards include school, department, difficulty, and would-take-again when the card shows them.\n\n**Credit cost:** 2 credits per call","operationId":"get-ratemyprofessors-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A professor name, or a Rate My Professors search URL whose path contains /search/professors or whose query contains q=.\n\n**Example:**\n\n```\nsmith\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/search/professors?q=smith\n```","schema":{"type":"string","description":"Required. A professor name, or a Rate My Professors search URL whose path contains /search/professors or whose query contains q=.\n\n**Example:**\n\n```\nsmith\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/search/professors?q=smith\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"rating":{"type":"number"},"school":{"type":"string"},"department":{"type":"string"},"difficulty":{"type":"number"},"ratings_count":{"type":"integer"},"would_take_again_percent":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Kevin Smith":{"value":{"results":[{"id":"1064107","url":"https://www.ratemyprofessors.com/professor/1064107","name":"Kevin Smith","rating":4.6,"school":"Rio Hondo College","department":"Psychology","difficulty":3.1,"ratings_count":174,"would_take_again_percent":94}],"pagination":{"next":null,"page":1,"per_page":5,"total_pages":null,"total_results":10000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rate My Professors Search","description":"Search Rate My Professors by name. Cards include school, department, difficulty, and would-take-again when the card shows them.\n\n**Credit cost:** 2 credits per call","operationId":"post-ratemyprofessors-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A professor name, or a Rate My Professors search URL whose path contains /search/professors or whose query contains q=.\n\n**Example:**\n\n```\nsmith\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/search/professors?q=smith\n```","schema":{"type":"string","description":"Required. A professor name, or a Rate My Professors search URL whose path contains /search/professors or whose query contains q=.\n\n**Example:**\n\n```\nsmith\n```\n\n**URL example:**\n\n```\nhttps://www.ratemyprofessors.com/search/professors?q=smith\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"rating":{"type":"number"},"school":{"type":"string"},"department":{"type":"string"},"difficulty":{"type":"number"},"ratings_count":{"type":"integer"},"would_take_again_percent":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Kevin Smith":{"value":{"results":[{"id":"1064107","url":"https://www.ratemyprofessors.com/professor/1064107","name":"Kevin Smith","rating":4.6,"school":"Rio Hondo College","department":"Psychology","difficulty":3.1,"ratings_count":174,"would_take_again_percent":94}],"pagination":{"next":null,"page":1,"per_page":5,"total_pages":null,"total_results":10000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/goodreads/search":{"get":{"summary":"Goodreads Search","description":"Search Goodreads books by keyword. pagination.next is a Goodreads search URL for the following page.\n\n**Credit cost:** 2 credits per call","operationId":"get-goodreads-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A book keyword, or a Goodreads search URL (the path contains /search or the query contains q=).\n\n**Example:**\n\n```\ndune\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/search?q=dune&page=2\n```","schema":{"type":"string","description":"Required. A book keyword, or a Goodreads search URL (the path contains /search or the query contains q=).\n\n**Example:**\n\n```\ndune\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/search?q=dune&page=2\n```"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number, starting at 1. Omitted or blank uses page 1. A value below 1 returns 400. When query is already a Goodreads search URL, this number replaces the page parameter in that URL.\n\n**Example:**\n\n```\n2\n```","schema":{"type":"number","default":"1","description":"Optional. Page number, starting at 1. Omitted or blank uses page 1. A value below 1 returns 400. When query is already a Goodreads search URL, this number replaces the page parameter in that URL.\n\n**Example:**\n\n```\n2\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"series":{"type":"string"},"authors":{"type":"array","items":{"type":"string"}},"ratings_count":{"type":"integer"},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"Dune":{"value":{"results":[{"id":"44767458","url":"https://www.goodreads.com/book/show/44767458","image":"https://m.media-amazon.com/images/S/compressed.photo.goodreads.com/books/1555447414i/44767458.jpg","title":"Dune","rating":4.29,"series":"Dune (Series #1)","authors":["Frank Herbert"],"ratings_count":1700000,"reviews_count":90400}],"pagination":{"next":"https://www.goodreads.com/search?q=dune&page=2","page":1,"per_page":20,"total_pages":100,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Goodreads Search","description":"Search Goodreads books by keyword. pagination.next is a Goodreads search URL for the following page.\n\n**Credit cost:** 2 credits per call","operationId":"post-goodreads-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A book keyword, or a Goodreads search URL (the path contains /search or the query contains q=).\n\n**Example:**\n\n```\ndune\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/search?q=dune&page=2\n```","schema":{"type":"string","description":"Required. A book keyword, or a Goodreads search URL (the path contains /search or the query contains q=).\n\n**Example:**\n\n```\ndune\n```\n\n**URL example:**\n\n```\nhttps://www.goodreads.com/search?q=dune&page=2\n```"}},{"name":"page","in":"query","required":false,"description":"Optional. Page number, starting at 1. Omitted or blank uses page 1. A value below 1 returns 400. When query is already a Goodreads search URL, this number replaces the page parameter in that URL.\n\n**Example:**\n\n```\n2\n```","schema":{"type":"number","default":"1","description":"Optional. Page number, starting at 1. Omitted or blank uses page 1. A value below 1 returns 400. When query is already a Goodreads search URL, this number replaces the page parameter in that URL.\n\n**Example:**\n\n```\n2\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"series":{"type":"string"},"authors":{"type":"array","items":{"type":"string"}},"ratings_count":{"type":"integer"},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"Dune":{"value":{"results":[{"id":"44767458","url":"https://www.goodreads.com/book/show/44767458","image":"https://m.media-amazon.com/images/S/compressed.photo.goodreads.com/books/1555447414i/44767458.jpg","title":"Dune","rating":4.29,"series":"Dune (Series #1)","authors":["Frank Herbert"],"ratings_count":1700000,"reviews_count":90400}],"pagination":{"next":"https://www.goodreads.com/search?q=dune&page=2","page":1,"per_page":20,"total_pages":100,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/franchisedirect/franchise":{"get":{"summary":"Franchise Direct Franchise","description":"Read one Franchise Direct profile: cash requirement, franchise fee, investment range, and training.\n\n**Credit cost:** 1 credit per call","operationId":"get-franchisedirect-franchise","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.\n\n**Example:**\n\n```\nhttps://www.franchisedirect.com/coffee-franchises/coffeenow\n```","schema":{"type":"string","description":"Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.\n\n**Example:**\n\n```\nhttps://www.franchisedirect.com/coffee-franchises/coffeenow\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"industry":{"type":"string"},"description":{"type":"string"},"business_type":{"type":"string"},"franchise_fee":{"type":"integer"},"training_provided":{"type":"boolean"},"available_locations":{"type":"string"},"financing_assistance":{"type":"string"},"total_investment_max":{"type":"integer"},"total_investment_min":{"type":"integer"},"franchise_fee_display":{"type":"string"},"minimum_cash_required":{"type":"integer"},"total_investment_display":{"type":"string"},"minimum_cash_required_display":{"type":"string"}}},"examples":{"CoffeeNow":{"value":{"url":"https://www.franchisedirect.com/coffee-franchises/coffeenow","name":"CoffeeNow","image":"https://static4.franchisedirect.ie/dims4/default/234c6dc/2147483647/strip/true/crop/350x220+0+0/resize/270x170!/quality/95/?url=https%3A%2F%2Ffranchisedirect-40-prod-ops.s3.amazonaws.com%2F6b%2F9b%2F473082ad4c1b8cfef7f36c4f428c%2Fcn-logo.jpeg","industry":"Coffee Franchises","description":"Bring the coffee shop experience directly to local workplaces with a technology-driven mobile franchise that eliminates the need for a traditional storefront. CoffeeNow combines custom-outfitted coffee vans, proprietary ordering technology, and recurring B2B routes to help entrepreneurs build a scalable business around the weekday workday.","business_type":"Franchise","franchise_fee":25000,"training_provided":true,"available_locations":"Single-unit opportunities available throughout the US, EXCLUDING: CA, HI, IL, IN, MD, MI, MN, NY, ND, RI, SD, VA, WA, WI.","financing_assistance":"None","total_investment_max":309000,"total_investment_min":133000,"franchise_fee_display":"$25,000","minimum_cash_required":60000,"total_investment_display":"$133,000 - $309,000","minimum_cash_required_display":"$60,000"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Franchise Direct Franchise","description":"Read one Franchise Direct profile: cash requirement, franchise fee, investment range, and training.\n\n**Credit cost:** 1 credit per call","operationId":"post-franchisedirect-franchise","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.\n\n**Example:**\n\n```\nhttps://www.franchisedirect.com/coffee-franchises/coffeenow\n```","schema":{"type":"string","description":"Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.\n\n**Example:**\n\n```\nhttps://www.franchisedirect.com/coffee-franchises/coffeenow\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"industry":{"type":"string"},"description":{"type":"string"},"business_type":{"type":"string"},"franchise_fee":{"type":"integer"},"training_provided":{"type":"boolean"},"available_locations":{"type":"string"},"financing_assistance":{"type":"string"},"total_investment_max":{"type":"integer"},"total_investment_min":{"type":"integer"},"franchise_fee_display":{"type":"string"},"minimum_cash_required":{"type":"integer"},"total_investment_display":{"type":"string"},"minimum_cash_required_display":{"type":"string"}}},"examples":{"CoffeeNow":{"value":{"url":"https://www.franchisedirect.com/coffee-franchises/coffeenow","name":"CoffeeNow","image":"https://static4.franchisedirect.ie/dims4/default/234c6dc/2147483647/strip/true/crop/350x220+0+0/resize/270x170!/quality/95/?url=https%3A%2F%2Ffranchisedirect-40-prod-ops.s3.amazonaws.com%2F6b%2F9b%2F473082ad4c1b8cfef7f36c4f428c%2Fcn-logo.jpeg","industry":"Coffee Franchises","description":"Bring the coffee shop experience directly to local workplaces with a technology-driven mobile franchise that eliminates the need for a traditional storefront. CoffeeNow combines custom-outfitted coffee vans, proprietary ordering technology, and recurring B2B routes to help entrepreneurs build a scalable business around the weekday workday.","business_type":"Franchise","franchise_fee":25000,"training_provided":true,"available_locations":"Single-unit opportunities available throughout the US, EXCLUDING: CA, HI, IL, IN, MD, MI, MN, NY, ND, RI, SD, VA, WA, WI.","financing_assistance":"None","total_investment_max":309000,"total_investment_min":133000,"franchise_fee_display":"$25,000","minimum_cash_required":60000,"total_investment_display":"$133,000 - $309,000","minimum_cash_required_display":"$60,000"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/huggingface/model":{"get":{"summary":"Hugging Face Model","description":"Read one public Hugging Face model by an id such as google-bert/bert-base-uncased.\n\n**Credit cost:** 1 credit per call","operationId":"get-huggingface-model","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A public model id (owner/name) or a huggingface.co model URL. Reserved site paths such as models, datasets, or spaces return 400.\n\n**Example:**\n\n```\ngoogle-bert/bert-base-uncased\n```\n\n**URL example:**\n\n```\nhttps://huggingface.co/google-bert/bert-base-uncased\n```","schema":{"type":"string","description":"Required. A public model id (owner/name) or a huggingface.co model URL. Reserved site paths such as models, datasets, or spaces return 400.\n\n**Example:**\n\n```\ngoogle-bert/bert-base-uncased\n```\n\n**URL example:**\n\n```\nhttps://huggingface.co/google-bert/bert-base-uncased\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sha":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"gated":{"type":"boolean"},"likes":{"type":"integer"},"author":{"type":"string"},"license":{"type":"string"},"private":{"type":"boolean"},"datasets":{"type":"array","items":{"type":"string"}},"disabled":{"type":"boolean"},"language":{"type":"array","items":{"type":"string"}},"downloads":{"type":"integer"},"created_at":{"type":"string"},"mask_token":{"type":"string"},"library_name":{"type":"string"},"pipeline_tag":{"type":"string"},"last_modified":{"type":"string"},"trending_score":{"nullable":true}}},"examples":{"bert-base-uncased":{"value":{"id":"google-bert/bert-base-uncased","sha":"86b5e0934494bd15c9632b12f734a8a67f723594","url":"https://huggingface.co/google-bert/bert-base-uncased","tags":["transformers","pytorch","tf","jax","rust","coreml","onnx","safetensors","bert","fill-mask","exbert","en","dataset:bookcorpus","dataset:wikipedia","arxiv:1810.04805","license:apache-2.0","endpoints_compatible","deploy:sagemaker","deploy:azure","region:us"],"gated":false,"likes":3060,"author":"google-bert","license":"apache-2.0","private":false,"datasets":["bookcorpus","wikipedia"],"disabled":false,"language":["en"],"downloads":29160167,"created_at":"2022-03-02T23:29:04.000Z","mask_token":"[MASK]","library_name":"transformers","pipeline_tag":"fill-mask","last_modified":"2024-02-19T11:06:12.000Z","trending_score":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Hugging Face Model","description":"Read one public Hugging Face model by an id such as google-bert/bert-base-uncased.\n\n**Credit cost:** 1 credit per call","operationId":"post-huggingface-model","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A public model id (owner/name) or a huggingface.co model URL. Reserved site paths such as models, datasets, or spaces return 400.\n\n**Example:**\n\n```\ngoogle-bert/bert-base-uncased\n```\n\n**URL example:**\n\n```\nhttps://huggingface.co/google-bert/bert-base-uncased\n```","schema":{"type":"string","description":"Required. A public model id (owner/name) or a huggingface.co model URL. Reserved site paths such as models, datasets, or spaces return 400.\n\n**Example:**\n\n```\ngoogle-bert/bert-base-uncased\n```\n\n**URL example:**\n\n```\nhttps://huggingface.co/google-bert/bert-base-uncased\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sha":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"gated":{"type":"boolean"},"likes":{"type":"integer"},"author":{"type":"string"},"license":{"type":"string"},"private":{"type":"boolean"},"datasets":{"type":"array","items":{"type":"string"}},"disabled":{"type":"boolean"},"language":{"type":"array","items":{"type":"string"}},"downloads":{"type":"integer"},"created_at":{"type":"string"},"mask_token":{"type":"string"},"library_name":{"type":"string"},"pipeline_tag":{"type":"string"},"last_modified":{"type":"string"},"trending_score":{"nullable":true}}},"examples":{"bert-base-uncased":{"value":{"id":"google-bert/bert-base-uncased","sha":"86b5e0934494bd15c9632b12f734a8a67f723594","url":"https://huggingface.co/google-bert/bert-base-uncased","tags":["transformers","pytorch","tf","jax","rust","coreml","onnx","safetensors","bert","fill-mask","exbert","en","dataset:bookcorpus","dataset:wikipedia","arxiv:1810.04805","license:apache-2.0","endpoints_compatible","deploy:sagemaker","deploy:azure","region:us"],"gated":false,"likes":3060,"author":"google-bert","license":"apache-2.0","private":false,"datasets":["bookcorpus","wikipedia"],"disabled":false,"language":["en"],"downloads":29160167,"created_at":"2022-03-02T23:29:04.000Z","mask_token":"[MASK]","library_name":"transformers","pipeline_tag":"fill-mask","last_modified":"2024-02-19T11:06:12.000Z","trending_score":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/huggingface/search":{"get":{"summary":"Hugging Face Search","description":"Search the public Hugging Face models API by keyword and follow pagination.next to the next cursor page.\n\n**Credit cost:** 1 credit per call","operationId":"get-huggingface-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A model keyword, a huggingface.co/models URL, or the full pagination.next cursor URL from a previous page.\n\n**Example:**\n\n```\nbert\n```\n\n**Next-page example:** pass the pagination.next value unchanged as query.","schema":{"type":"string","description":"Required. A model keyword, a huggingface.co/models URL, or the full pagination.next cursor URL from a previous page.\n\n**Example:**\n\n```\nbert\n```\n\n**Next-page example:** pass the pagination.next value unchanged as query."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"likes":{"type":"integer"},"private":{"type":"boolean"},"downloads":{"type":"integer"},"created_at":{"type":"string"},"library_name":{"type":"string"},"pipeline_tag":{"type":"string"},"trending_score":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"bert-base-uncased":{"value":{"results":[{"id":"google-bert/bert-base-uncased","url":"https://huggingface.co/google-bert/bert-base-uncased","tags":["transformers","pytorch","tf","jax","rust","coreml","onnx","safetensors","bert","fill-mask","exbert","en","dataset:bookcorpus","dataset:wikipedia","arxiv:1810.04805","license:apache-2.0","endpoints_compatible","deploy:sagemaker","deploy:azure","region:us"],"likes":3060,"private":false,"downloads":29160167,"created_at":"2022-03-02T23:29:04.000Z","library_name":"transformers","pipeline_tag":"fill-mask","trending_score":6}],"pagination":{"next":"https://huggingface.co/api/models?search=bert&limit=20&cursor=eyIkb3IiOlt7InRyZW5kaW5nU2NvcmUiOjEsIl9pZCI6eyIkZ3QiOiI2MjFmZmRjMDM2NDY4ZDcwOWYxNzQ1MDAifX0seyJ0cmVuZGluZ1Njb3JlIjp7IiRsdCI6MX19LHsidHJlbmRpbmdTY29yZSI6bnVsbH1dLCJzZWFyY2hTZXF1ZW5jZVRva2VuIjoiQ05DSy93RWFDU0VBQUFBQUFBRHdQeG9PV2d4aUgvM0FOa2FOY0o4WFJRQWlEbG9NWWgvOXdEWkdqWENmRjBVQSJ9","page":1,"per_page":20,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Hugging Face Search","description":"Search the public Hugging Face models API by keyword and follow pagination.next to the next cursor page.\n\n**Credit cost:** 1 credit per call","operationId":"post-huggingface-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A model keyword, a huggingface.co/models URL, or the full pagination.next cursor URL from a previous page.\n\n**Example:**\n\n```\nbert\n```\n\n**Next-page example:** pass the pagination.next value unchanged as query.","schema":{"type":"string","description":"Required. A model keyword, a huggingface.co/models URL, or the full pagination.next cursor URL from a previous page.\n\n**Example:**\n\n```\nbert\n```\n\n**Next-page example:** pass the pagination.next value unchanged as query."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"likes":{"type":"integer"},"private":{"type":"boolean"},"downloads":{"type":"integer"},"created_at":{"type":"string"},"library_name":{"type":"string"},"pipeline_tag":{"type":"string"},"trending_score":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"bert-base-uncased":{"value":{"results":[{"id":"google-bert/bert-base-uncased","url":"https://huggingface.co/google-bert/bert-base-uncased","tags":["transformers","pytorch","tf","jax","rust","coreml","onnx","safetensors","bert","fill-mask","exbert","en","dataset:bookcorpus","dataset:wikipedia","arxiv:1810.04805","license:apache-2.0","endpoints_compatible","deploy:sagemaker","deploy:azure","region:us"],"likes":3060,"private":false,"downloads":29160167,"created_at":"2022-03-02T23:29:04.000Z","library_name":"transformers","pipeline_tag":"fill-mask","trending_score":6}],"pagination":{"next":"https://huggingface.co/api/models?search=bert&limit=20&cursor=eyIkb3IiOlt7InRyZW5kaW5nU2NvcmUiOjEsIl9pZCI6eyIkZ3QiOiI2MjFmZmRjMDM2NDY4ZDcwOWYxNzQ1MDAifX0seyJ0cmVuZGluZ1Njb3JlIjp7IiRsdCI6MX19LHsidHJlbmRpbmdTY29yZSI6bnVsbH1dLCJzZWFyY2hTZXF1ZW5jZVRva2VuIjoiQ05DSy93RWFDU0VBQUFBQUFBRHdQeG9PV2d4aUgvM0FOa2FOY0o4WFJRQWlEbG9NWWgvOXdEWkdqWENmRjBVQSJ9","page":1,"per_page":20,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/franchisedirect/search":{"get":{"summary":"Franchise Direct Search","description":"Search Franchise Direct listings by keyword or listing URL. Each card includes a USD cash figure and a numeric minimum.\n\n**Credit cost:** 1 credit per call","operationId":"get-franchisedirect-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.\n\n**Example:**\n\n```\ncoffee\n```\n\n**URL example:**\n\n```\nhttps://www.franchisedirect.com/search?q=coffee\n```","schema":{"type":"string","description":"Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.\n\n**Example:**\n\n```\ncoffee\n```\n\n**URL example:**\n\n```\nhttps://www.franchisedirect.com/search?q=coffee\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"minimum_cash_required":{"type":"integer"},"minimum_cash_required_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"CoffeeNow":{"value":{"results":[{"url":"https://www.franchisedirect.com/coffee-franchises/coffeenow","name":"CoffeeNow","image":"https://static4.franchisedirect.ie/dims4/default/5f4574f/2147483647/strip/true/crop/350x220+0+0/resize/255x160!/quality/95/?url=https%3A%2F%2Ffranchisedirect-40-prod-ops.s3.amazonaws.com%2F6b%2F9b%2F473082ad4c1b8cfef7f36c4f428c%2Fcn-logo.jpeg","category":"Coffee Franchises","description":"Bring the coffee shop experience directly to local workplaces with a technology-driven mobile franchise that eliminates the need for a traditional storefront. CoffeeNow combines custom-outfitted coffee vans, proprietary ordering technology, and recurring B2B routes to help entrepreneurs build a scalable business around the weekday workday.","minimum_cash_required":60000,"minimum_cash_required_display":"$60,000"}],"pagination":{"next":null,"page":1,"per_page":6,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Franchise Direct Search","description":"Search Franchise Direct listings by keyword or listing URL. Each card includes a USD cash figure and a numeric minimum.\n\n**Credit cost:** 1 credit per call","operationId":"post-franchisedirect-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.\n\n**Example:**\n\n```\ncoffee\n```\n\n**URL example:**\n\n```\nhttps://www.franchisedirect.com/search?q=coffee\n```","schema":{"type":"string","description":"Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.\n\n**Example:**\n\n```\ncoffee\n```\n\n**URL example:**\n\n```\nhttps://www.franchisedirect.com/search?q=coffee\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"minimum_cash_required":{"type":"integer"},"minimum_cash_required_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"CoffeeNow":{"value":{"results":[{"url":"https://www.franchisedirect.com/coffee-franchises/coffeenow","name":"CoffeeNow","image":"https://static4.franchisedirect.ie/dims4/default/5f4574f/2147483647/strip/true/crop/350x220+0+0/resize/255x160!/quality/95/?url=https%3A%2F%2Ffranchisedirect-40-prod-ops.s3.amazonaws.com%2F6b%2F9b%2F473082ad4c1b8cfef7f36c4f428c%2Fcn-logo.jpeg","category":"Coffee Franchises","description":"Bring the coffee shop experience directly to local workplaces with a technology-driven mobile franchise that eliminates the need for a traditional storefront. CoffeeNow combines custom-outfitted coffee vans, proprietary ordering technology, and recurring B2B routes to help entrepreneurs build a scalable business around the weekday workday.","minimum_cash_required":60000,"minimum_cash_required_display":"$60,000"}],"pagination":{"next":null,"page":1,"per_page":6,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/clearedjobs/job":{"get":{"summary":"ClearedJobs Job","description":"Fetch one cleared job by its URL or by a slug that ends in the numeric id.\n\n**Credit cost:** 1 credit per call","operationId":"get-clearedjobs-job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Job URL or slug ending in the numeric id. Example: analyst-washington-district-of-columbia-1902823.","schema":{"type":"string","description":"Required. Job URL or slug ending in the numeric id. Example: analyst-washington-district-of-columbia-1902823."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"title":{"type":"string"},"region":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"location":{"type":"string"},"company_url":{"type":"string"},"date_posted":{"type":"string"},"description":{"type":"string"},"postal_code":{"type":"string"},"company_logo":{"type":"string"},"valid_through":{"type":"string"},"employment_type":{"type":"string"},"security_clearance":{"type":"string"}}},"examples":{"Analyst in Washington":{"value":{"id":"1902823","url":"https://clearedjobs.net/job/analyst-washington-district-of-columbia-1902823","city":"Washington","title":"Analyst","region":"District of Columbia","company":"Koniag Government Services","country":"United States","location":"Washington, District of Columbia, United States","company_url":"https://clearedjobs.net/company/koniag-government-services-238216","date_posted":"2026-05-17T07:01:19-04:00","description":"Koniag Professional Services, LLC, a Koniag Government Service Company, is seeking a skilled Analyst to support KPS and our government customer in Washington, DC.This position is for a Future New Business Opportunity.We offer competitive compensation and an extraordinary benefits package including health, dental and vision insurance, 401K with company matching, flexible spending accounts, paid holidays, three weeks paid time off, and more.The ideal candidate will combine strong analytical abilities with expertise in data management, research, and content development. This role requires someone who can effectively coordinate across agencies, manage disaster recovery efforts, and transform complex data into actionable insights.","postal_code":"20001","company_logo":"https://wjm.s3.amazonaws.com/cjng/uploads/KoniagInc.jpg","valid_through":"2027-01-13T22:40:21-05:00","employment_type":"OTHER","security_clearance":"Public Trust"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ClearedJobs Job","description":"Fetch one cleared job by its URL or by a slug that ends in the numeric id.\n\n**Credit cost:** 1 credit per call","operationId":"post-clearedjobs-job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Job URL or slug ending in the numeric id. Example: analyst-washington-district-of-columbia-1902823.","schema":{"type":"string","description":"Required. Job URL or slug ending in the numeric id. Example: analyst-washington-district-of-columbia-1902823."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"title":{"type":"string"},"region":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"location":{"type":"string"},"company_url":{"type":"string"},"date_posted":{"type":"string"},"description":{"type":"string"},"postal_code":{"type":"string"},"company_logo":{"type":"string"},"valid_through":{"type":"string"},"employment_type":{"type":"string"},"security_clearance":{"type":"string"}}},"examples":{"Analyst in Washington":{"value":{"id":"1902823","url":"https://clearedjobs.net/job/analyst-washington-district-of-columbia-1902823","city":"Washington","title":"Analyst","region":"District of Columbia","company":"Koniag Government Services","country":"United States","location":"Washington, District of Columbia, United States","company_url":"https://clearedjobs.net/company/koniag-government-services-238216","date_posted":"2026-05-17T07:01:19-04:00","description":"Koniag Professional Services, LLC, a Koniag Government Service Company, is seeking a skilled Analyst to support KPS and our government customer in Washington, DC.This position is for a Future New Business Opportunity.We offer competitive compensation and an extraordinary benefits package including health, dental and vision insurance, 401K with company matching, flexible spending accounts, paid holidays, three weeks paid time off, and more.The ideal candidate will combine strong analytical abilities with expertise in data management, research, and content development. This role requires someone who can effectively coordinate across agencies, manage disaster recovery efforts, and transform complex data into actionable insights.","postal_code":"20001","company_logo":"https://wjm.s3.amazonaws.com/cjng/uploads/KoniagInc.jpg","valid_through":"2027-01-13T22:40:21-05:00","employment_type":"OTHER","security_clearance":"Public Trust"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/clearedjobs/search":{"get":{"summary":"ClearedJobs Search","description":"Search cleared jobs by keyword. Only the first HTML page is available, so pagination.next is null and page 2 returns 404.\n\n**Credit cost:** 1 credit per call","operationId":"get-clearedjobs-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a clearedjobs.net jobs URL. Example: analyst. A job URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a clearedjobs.net jobs URL. Example: analyst. A job URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Optional. Only page 1 is available. Example: 1. page=2 returns 404. pagination.next is always null.","schema":{"type":"number","description":"Optional. Only page 1 is available. Example: 1. page=2 returns 404. pagination.next is always null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"logo":{"type":"string"},"title":{"type":"string"},"posted":{"type":"string"},"company":{"type":"string"},"location":{"type":"string"},"security_clearance":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"analyst":{"value":{"results":[{"id":"1902823","url":"https://clearedjobs.net/job/analyst-washington-district-of-columbia-1902823","logo":"https://assets.webscribble.com/cdn-cgi/image/width=90,fit=scale-down,format=auto/https://wjm.s3.amazonaws.com/cjng/uploads/KoniagInc-100.jpg","title":"Analyst","posted":"October 16, 2026","company":"Koniag Government Services","location":"Washington, District of Columbia","security_clearance":"Public Trust"}],"pagination":{"next":null,"page":1,"per_page":25,"total_pages":null,"total_results":3170}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ClearedJobs Search","description":"Search cleared jobs by keyword. Only the first HTML page is available, so pagination.next is null and page 2 returns 404.\n\n**Credit cost:** 1 credit per call","operationId":"post-clearedjobs-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a clearedjobs.net jobs URL. Example: analyst. A job URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a clearedjobs.net jobs URL. Example: analyst. A job URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Optional. Only page 1 is available. Example: 1. page=2 returns 404. pagination.next is always null.","schema":{"type":"number","description":"Optional. Only page 1 is available. Example: 1. page=2 returns 404. pagination.next is always null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"logo":{"type":"string"},"title":{"type":"string"},"posted":{"type":"string"},"company":{"type":"string"},"location":{"type":"string"},"security_clearance":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"analyst":{"value":{"results":[{"id":"1902823","url":"https://clearedjobs.net/job/analyst-washington-district-of-columbia-1902823","logo":"https://assets.webscribble.com/cdn-cgi/image/width=90,fit=scale-down,format=auto/https://wjm.s3.amazonaws.com/cjng/uploads/KoniagInc-100.jpg","title":"Analyst","posted":"October 16, 2026","company":"Koniag Government Services","location":"Washington, District of Columbia","security_clearance":"Public Trust"}],"pagination":{"next":null,"page":1,"per_page":25,"total_pages":null,"total_results":3170}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zazzle/product":{"get":{"summary":"Zazzle Product","description":"Fetch one Zazzle product by its product URL or by a slug that ends in the numeric product id.\n\n**Credit cost:** 2 credits per call","operationId":"get-zazzle-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Product URL or slug ending in the numeric product id. Example: https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952.","schema":{"type":"string","description":"Required. Product URL or slug ending in the numeric product id. Example: https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"nullable":true},"price_display":{"type":"string"}}},"examples":{"two-tone mug":{"value":{"url":"https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952","brand":"studioZ","image":"https://rlv.zcache.com/svc/view?max_dim=1000&realview=117426885324810002","price":15.81,"title":"Branded Logo Two-Tone Coffee Mug","currency":"USD","product_id":"256528848440338952","description":"Looking for custom mugs? This mug fits the bill. Personalize it with your own logo for a look that's completely yours. Great for everyday use at home, it's ready whenever you are. It's an easy way to make it feel like yours.","availability":null,"price_display":"$15.81"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zazzle Product","description":"Fetch one Zazzle product by its product URL or by a slug that ends in the numeric product id.\n\n**Credit cost:** 2 credits per call","operationId":"post-zazzle-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Product URL or slug ending in the numeric product id. Example: https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952.","schema":{"type":"string","description":"Required. Product URL or slug ending in the numeric product id. Example: https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"nullable":true},"price_display":{"type":"string"}}},"examples":{"two-tone mug":{"value":{"url":"https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952","brand":"studioZ","image":"https://rlv.zcache.com/svc/view?max_dim=1000&realview=117426885324810002","price":15.81,"title":"Branded Logo Two-Tone Coffee Mug","currency":"USD","product_id":"256528848440338952","description":"Looking for custom mugs? This mug fits the bill. Personalize it with your own logo for a look that's completely yours. Great for everyday use at home, it's ready whenever you are. It's an easy way to make it feel like yours.","availability":null,"price_display":"$15.81"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zazzle/search":{"get":{"summary":"Zazzle Search","description":"Search Zazzle products by keyword. page maps to the pg parameter. Prices are a number plus a display string.\n\n**Credit cost:** 1 credit per call","operationId":"get-zazzle-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a zazzle.com/s search URL. Example: coffee mug. A product URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a zazzle.com/s search URL. Example: coffee mug. A product URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Maps to the Zazzle pg parameter. Defaults to 1.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Maps to the Zazzle pg parameter. Defaults to 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"product_id":{"type":"string"},"price_display":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"coffee mug":{"value":{"results":[{"url":"https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952","image":"https://rlv.zcache.com/branded_logo_two_tone_coffee_mug-r_k6fu4x_306.jpg","price":15.81,"title":"Branded Logo Two-Tone Coffee Mug","product_id":"256528848440338952","price_display":"$15.81","original_price":18.6,"original_price_display":"$18.60"}],"pagination":{"next":"https://www.zazzle.com/s/coffee+mug?pg=2","page":1,"per_page":60,"total_pages":44398,"total_results":2663878}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zazzle Search","description":"Search Zazzle products by keyword. page maps to the pg parameter. Prices are a number plus a display string.\n\n**Credit cost:** 1 credit per call","operationId":"post-zazzle-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a zazzle.com/s search URL. Example: coffee mug. A product URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a zazzle.com/s search URL. Example: coffee mug. A product URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Maps to the Zazzle pg parameter. Defaults to 1.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Maps to the Zazzle pg parameter. Defaults to 1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"product_id":{"type":"string"},"price_display":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"coffee mug":{"value":{"results":[{"url":"https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952","image":"https://rlv.zcache.com/branded_logo_two_tone_coffee_mug-r_k6fu4x_306.jpg","price":15.81,"title":"Branded Logo Two-Tone Coffee Mug","product_id":"256528848440338952","price_display":"$15.81","original_price":18.6,"original_price_display":"$18.60"}],"pagination":{"next":"https://www.zazzle.com/s/coffee+mug?pg=2","page":1,"per_page":60,"total_pages":44398,"total_results":2663878}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/greenhouse/job":{"get":{"summary":"Greenhouse Job","description":"Fetch one Greenhouse job by board/id, such as discord/8806482002, or by a job-boards.greenhouse.io job URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-greenhouse-job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. board/id or a job URL. Example: discord/8806482002 or https://job-boards.greenhouse.io/discord/jobs/8806482002.","schema":{"type":"string","description":"Required. board/id or a job URL. Example: discord/8806482002 or https://job-boards.greenhouse.io/discord/jobs/8806482002."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"title":{"type":"string"},"offices":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"location":{"type":"string"},"updated_at":{"type":"string"},"departments":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"company_name":{"type":"string"},"requisition_id":{"type":"string"},"first_published":{"type":"string"},"application_deadline":{"nullable":true}}},"examples":{"Commercial Policy Lead":{"value":{"id":8806482002,"url":"https://job-boards.greenhouse.io/discord/jobs/8806482002","title":"Commercial Policy Lead","offices":["Remote (US)"],"language":"en","location":"San Francisco Bay Area","updated_at":"2026-10-20T20:27:20-04:00","departments":["Policy"],"description":"Discord has a highly engaged community of millions of daily active users who use the platform for many different reasons, but there’s one thing that nearly everyone does: play video games. Discord plays a uniquely important role in the future of gaming, and we are focused on making it easier and more fun for people to hang out before, during, and after playing games. We are seeking a strategic Commercial Policy Lead to shape Discord's approach to monetization and revenue products. As a key member of the Product Policy organization, you will develop and implement advertising and commerce policies that enable Discord's business while maintaining platform safety and user trust. This role requires a deep understanding of digital commerce, creator economies, and advertising ecosystems, with the ability to balance business objectives with responsible platform practices.","company_name":"Discord","requisition_id":"R-107406","first_published":"2026-09-15T12:52:11-04:00","application_deadline":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Greenhouse Job","description":"Fetch one Greenhouse job by board/id, such as discord/8806482002, or by a job-boards.greenhouse.io job URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-greenhouse-job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. board/id or a job URL. Example: discord/8806482002 or https://job-boards.greenhouse.io/discord/jobs/8806482002.","schema":{"type":"string","description":"Required. board/id or a job URL. Example: discord/8806482002 or https://job-boards.greenhouse.io/discord/jobs/8806482002."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"title":{"type":"string"},"offices":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"location":{"type":"string"},"updated_at":{"type":"string"},"departments":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"company_name":{"type":"string"},"requisition_id":{"type":"string"},"first_published":{"type":"string"},"application_deadline":{"nullable":true}}},"examples":{"Commercial Policy Lead":{"value":{"id":8806482002,"url":"https://job-boards.greenhouse.io/discord/jobs/8806482002","title":"Commercial Policy Lead","offices":["Remote (US)"],"language":"en","location":"San Francisco Bay Area","updated_at":"2026-10-20T20:27:20-04:00","departments":["Policy"],"description":"Discord has a highly engaged community of millions of daily active users who use the platform for many different reasons, but there’s one thing that nearly everyone does: play video games. Discord plays a uniquely important role in the future of gaming, and we are focused on making it easier and more fun for people to hang out before, during, and after playing games. We are seeking a strategic Commercial Policy Lead to shape Discord's approach to monetization and revenue products. As a key member of the Product Policy organization, you will develop and implement advertising and commerce policies that enable Discord's business while maintaining platform safety and user trust. This role requires a deep understanding of digital commerce, creator economies, and advertising ecosystems, with the ability to balance business objectives with responsible platform practices.","company_name":"Discord","requisition_id":"R-107406","first_published":"2026-09-15T12:52:11-04:00","application_deadline":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/greenhouse/search":{"get":{"summary":"Greenhouse Search","description":"List jobs on a Greenhouse board. query is the board token, such as discord. keyword filters title and location.\n\n**Credit cost:** 1 credit per call","operationId":"get-greenhouse-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Board token or a job-boards.greenhouse.io board URL. Example: discord. A job URL returns 400.","schema":{"type":"string","description":"Required. Board token or a job-boards.greenhouse.io board URL. Example: discord. A job URL returns 400."}},{"name":"keyword","in":"query","required":false,"description":"Optional. Case-insensitive filter on title and location. Example: policy. Omit it to list the whole board.","schema":{"type":"string","description":"Optional. Case-insensitive filter on title and location. Example: policy. Omit it to list the whole board."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Page size is 20.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Page size is 20."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"location":{"type":"string"},"updated_at":{"type":"string"},"company_name":{"type":"string"},"requisition_id":{"type":"string"},"first_published":{"type":"string"},"application_deadline":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"discord":{"value":{"results":[{"id":8806482002,"url":"https://job-boards.greenhouse.io/discord/jobs/8806482002","title":"Commercial Policy Lead","language":"en","location":"San Francisco Bay Area","updated_at":"2026-10-20T20:27:20-04:00","company_name":"Discord","requisition_id":"R-107406","first_published":"2026-09-15T12:52:11-04:00","application_deadline":null}],"pagination":{"next":"https://job-boards.greenhouse.io/discord?page=2","page":1,"per_page":20,"total_pages":3,"total_results":43}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Greenhouse Search","description":"List jobs on a Greenhouse board. query is the board token, such as discord. keyword filters title and location.\n\n**Credit cost:** 1 credit per call","operationId":"post-greenhouse-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Board token or a job-boards.greenhouse.io board URL. Example: discord. A job URL returns 400.","schema":{"type":"string","description":"Required. Board token or a job-boards.greenhouse.io board URL. Example: discord. A job URL returns 400."}},{"name":"keyword","in":"query","required":false,"description":"Optional. Case-insensitive filter on title and location. Example: policy. Omit it to list the whole board.","schema":{"type":"string","description":"Optional. Case-insensitive filter on title and location. Example: policy. Omit it to list the whole board."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Page size is 20.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Page size is 20."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"location":{"type":"string"},"updated_at":{"type":"string"},"company_name":{"type":"string"},"requisition_id":{"type":"string"},"first_published":{"type":"string"},"application_deadline":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"discord":{"value":{"results":[{"id":8806482002,"url":"https://job-boards.greenhouse.io/discord/jobs/8806482002","title":"Commercial Policy Lead","language":"en","location":"San Francisco Bay Area","updated_at":"2026-10-20T20:27:20-04:00","company_name":"Discord","requisition_id":"R-107406","first_published":"2026-09-15T12:52:11-04:00","application_deadline":null}],"pagination":{"next":"https://job-boards.greenhouse.io/discord?page=2","page":1,"per_page":20,"total_pages":3,"total_results":43}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/usaspending/award":{"get":{"summary":"USAspending Award","description":"Fetch one US federal award by its generated id or by a usaspending.gov award URL. Amounts are a number plus a display string.\n\n**Credit cost:** 1 credit per call","operationId":"get-usaspending-award","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Generated award id or a usaspending.gov/award URL. Example: CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-.","schema":{"type":"string","description":"Required. Generated award id or a usaspending.gov/award URL. Example: CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"award_id":{"type":"string"},"category":{"type":"string"},"end_date":{"type":"string"},"psc_code":{"type":"string"},"type_code":{"type":"string"},"award_type":{"type":"string"},"naics_code":{"type":"string"},"start_date":{"type":"string"},"date_signed":{"type":"string"},"description":{"type":"string"},"award_amount":{"type":"integer"},"recipient_uei":{"type":"string"},"amount_display":{"type":"string"},"funding_agency":{"type":"string"},"recipient_name":{"type":"string"},"subaward_count":{"type":"integer"},"awarding_agency":{"type":"string"},"psc_description":{"type":"string"},"naics_description":{"type":"string"},"awarding_sub_agency":{"type":"string"},"generated_internal_id":{"type":"string"}}},"examples":{"NASA contract":{"value":{"url":"https://www.usaspending.gov/award/CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-/","city":"BALTIMORE","state":"MD","country":"UNITED STATES","award_id":"GSFC0198106DNAS526555","category":"contract","end_date":"2026-10-31","psc_code":"AR21","type_code":"D","award_type":"DEFINITIVE CONTRACT","naics_code":"333314","start_date":"1987-09-15","date_signed":"1987-09-15","description":"THE PRIMARY ACTIVITIES COVERED BY THIS EFFORT INCLUDE THE FINAL SERVICING MISSION AND SUBSEQUENT OPERATIONS THROUGH END-OF-MISSION. THESE ACTIVITIES INCLUDE: A. SCIENCE PROGRAM IMPLEMENTATION INCLUDING: MISSION PLANNING SUPPORT, SCIENCE PROGRAM DEFINITION SUPPORT, MANAGEMENT OF THE PROPOSAL SELECTION, TIME ALLOCATION, AND GRANT AWARD COMMITTEE PROCESSES, AND SCIENCE COMMUNITY OUTREACH. B. ROUTINE SCIENCE OPERATIONS INCLUDING: PROPOSAL GENERATION AND RECEIPT, OBSERVATION PLANNING AND SCHEDULING, UPDATING INSTRUMENT HANDBOOKS, OBSERVING AND USER SUPPORT, DATA PROCESSING AND PRODUCT GENERATION, ARCHIVAL AND DATA DISTRIBUTION SERVICES, CALIBRATION ASSISTANCE AND DATA ANALYSIS, ANOMALY INVESTIGATION SUPPORT, USER GRANT ADMINISTRATION, OBSERVER ASSISTANCE AND ENGINEERING OPERATIONS SUPPORT. C.","award_amount":2533788480,"recipient_uei":"W1NBN156CYF9","amount_display":"$2,533,788,480.00","funding_agency":"National Aeronautics and Space Administration","recipient_name":"ASSOCIATION OF UNIVERSITIES FOR RESEARCH IN ASTRONOMY, INC.","subaward_count":9,"awarding_agency":"National Aeronautics and Space Administration","psc_description":"R&D- SPACE: SCIENCE/APPLICATIONS (BASIC RESEARCH)","naics_description":"Optical Instrument and Lens Manufacturing","awarding_sub_agency":"National Aeronautics and Space Administration","generated_internal_id":"CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"USAspending Award","description":"Fetch one US federal award by its generated id or by a usaspending.gov award URL. Amounts are a number plus a display string.\n\n**Credit cost:** 1 credit per call","operationId":"post-usaspending-award","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Generated award id or a usaspending.gov/award URL. Example: CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-.","schema":{"type":"string","description":"Required. Generated award id or a usaspending.gov/award URL. Example: CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"award_id":{"type":"string"},"category":{"type":"string"},"end_date":{"type":"string"},"psc_code":{"type":"string"},"type_code":{"type":"string"},"award_type":{"type":"string"},"naics_code":{"type":"string"},"start_date":{"type":"string"},"date_signed":{"type":"string"},"description":{"type":"string"},"award_amount":{"type":"integer"},"recipient_uei":{"type":"string"},"amount_display":{"type":"string"},"funding_agency":{"type":"string"},"recipient_name":{"type":"string"},"subaward_count":{"type":"integer"},"awarding_agency":{"type":"string"},"psc_description":{"type":"string"},"naics_description":{"type":"string"},"awarding_sub_agency":{"type":"string"},"generated_internal_id":{"type":"string"}}},"examples":{"NASA contract":{"value":{"url":"https://www.usaspending.gov/award/CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-/","city":"BALTIMORE","state":"MD","country":"UNITED STATES","award_id":"GSFC0198106DNAS526555","category":"contract","end_date":"2026-10-31","psc_code":"AR21","type_code":"D","award_type":"DEFINITIVE CONTRACT","naics_code":"333314","start_date":"1987-09-15","date_signed":"1987-09-15","description":"THE PRIMARY ACTIVITIES COVERED BY THIS EFFORT INCLUDE THE FINAL SERVICING MISSION AND SUBSEQUENT OPERATIONS THROUGH END-OF-MISSION. THESE ACTIVITIES INCLUDE: A. SCIENCE PROGRAM IMPLEMENTATION INCLUDING: MISSION PLANNING SUPPORT, SCIENCE PROGRAM DEFINITION SUPPORT, MANAGEMENT OF THE PROPOSAL SELECTION, TIME ALLOCATION, AND GRANT AWARD COMMITTEE PROCESSES, AND SCIENCE COMMUNITY OUTREACH. B. ROUTINE SCIENCE OPERATIONS INCLUDING: PROPOSAL GENERATION AND RECEIPT, OBSERVATION PLANNING AND SCHEDULING, UPDATING INSTRUMENT HANDBOOKS, OBSERVING AND USER SUPPORT, DATA PROCESSING AND PRODUCT GENERATION, ARCHIVAL AND DATA DISTRIBUTION SERVICES, CALIBRATION ASSISTANCE AND DATA ANALYSIS, ANOMALY INVESTIGATION SUPPORT, USER GRANT ADMINISTRATION, OBSERVER ASSISTANCE AND ENGINEERING OPERATIONS SUPPORT. C.","award_amount":2533788480,"recipient_uei":"W1NBN156CYF9","amount_display":"$2,533,788,480.00","funding_agency":"National Aeronautics and Space Administration","recipient_name":"ASSOCIATION OF UNIVERSITIES FOR RESEARCH IN ASTRONOMY, INC.","subaward_count":9,"awarding_agency":"National Aeronautics and Space Administration","psc_description":"R&D- SPACE: SCIENCE/APPLICATIONS (BASIC RESEARCH)","naics_description":"Optical Instrument and Lens Manufacturing","awarding_sub_agency":"National Aeronautics and Space Administration","generated_internal_id":"CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/usaspending/search":{"get":{"summary":"USAspending Search","description":"Search US federal awards by keyword. award_type selects one group: contract (default), grant, idv, or loan. Amounts are a number plus a display string.\n\n**Credit cost:** 1 credit per call","operationId":"get-usaspending-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a usaspending.gov search URL. Example: software. An award URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a usaspending.gov search URL. Example: software. An award URL returns 400."}},{"name":"award_type","in":"query","required":false,"description":"Optional. One group: contract (default when omitted), grant, idv, or loan. Example: grant.","schema":{"type":"string","description":"Optional. One group: contract (default when omitted), grant, idv, or loan. Example: grant."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 awards. total_results stays null.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 awards. total_results stays null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"nullable":true},"state":{"nullable":true},"award_id":{"type":"string"},"end_date":{"type":"string"},"psc_code":{"nullable":true},"award_type":{"nullable":true},"naics_code":{"nullable":true},"start_date":{"type":"string"},"description":{"type":"string"},"award_amount":{"type":"integer"},"amount_display":{"type":"string"},"funding_agency":{"type":"string"},"recipient_name":{"type":"string"},"awarding_agency":{"type":"string"},"awarding_sub_agency":{"type":"string"},"generated_internal_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"software contracts":{"value":{"results":[{"url":"https://www.usaspending.gov/award/CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-/","city":null,"state":null,"award_id":"GSFC0198106DNAS526555","end_date":"2026-10-31","psc_code":null,"award_type":null,"naics_code":null,"start_date":"1987-09-15","description":"THE PRIMARY ACTIVITIES COVERED BY THIS EFFORT INCLUDE THE FINAL SERVICING MISSION AND SUBSEQUENT OPERATIONS THROUGH END-OF-MISSION. THESE ACTIVITIES INCLUDE: A. SCIENCE PROGRAM IMPLEMENTATION INCLUDING: MISSION PLANNING SUPPORT, SCIENCE PROGRAM DEFINITION SUPPORT, MANAGEMENT OF THE PROPOSAL SELECTION, TIME ALLOCATION, AND GRANT AWARD COMMITTEE PROCESSES, AND SCIENCE COMMUNITY OUTREACH. B. ROUTINE SCIENCE OPERATIONS INCLUDING: PROPOSAL GENERATION AND RECEIPT, OBSERVATION PLANNING AND SCHEDULING, UPDATING INSTRUMENT HANDBOOKS, OBSERVING AND USER SUPPORT, DATA PROCESSING AND PRODUCT GENERATION, ARCHIVAL AND DATA DISTRIBUTION SERVICES, CALIBRATION ASSISTANCE AND DATA ANALYSIS, ANOMALY INVESTIGATION SUPPORT, USER GRANT ADMINISTRATION, OBSERVER ASSISTANCE AND ENGINEERING OPERATIONS SUPPORT. C.","award_amount":2533788480,"amount_display":"$2,533,788,480.00","funding_agency":"National Aeronautics and Space Administration","recipient_name":"ASSOCIATION OF UNIVERSITIES FOR RESEARCH IN ASTRONOMY, INC.","awarding_agency":"National Aeronautics and Space Administration","awarding_sub_agency":"National Aeronautics and Space Administration","generated_internal_id":"CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-"}],"pagination":{"next":"https://www.usaspending.gov/search/?keywords=software&page=2","page":1,"per_page":10,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"USAspending Search","description":"Search US federal awards by keyword. award_type selects one group: contract (default), grant, idv, or loan. Amounts are a number plus a display string.\n\n**Credit cost:** 1 credit per call","operationId":"post-usaspending-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a usaspending.gov search URL. Example: software. An award URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a usaspending.gov search URL. Example: software. An award URL returns 400."}},{"name":"award_type","in":"query","required":false,"description":"Optional. One group: contract (default when omitted), grant, idv, or loan. Example: grant.","schema":{"type":"string","description":"Optional. One group: contract (default when omitted), grant, idv, or loan. Example: grant."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 awards. total_results stays null.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 awards. total_results stays null."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"nullable":true},"state":{"nullable":true},"award_id":{"type":"string"},"end_date":{"type":"string"},"psc_code":{"nullable":true},"award_type":{"nullable":true},"naics_code":{"nullable":true},"start_date":{"type":"string"},"description":{"type":"string"},"award_amount":{"type":"integer"},"amount_display":{"type":"string"},"funding_agency":{"type":"string"},"recipient_name":{"type":"string"},"awarding_agency":{"type":"string"},"awarding_sub_agency":{"type":"string"},"generated_internal_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"software contracts":{"value":{"results":[{"url":"https://www.usaspending.gov/award/CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-/","city":null,"state":null,"award_id":"GSFC0198106DNAS526555","end_date":"2026-10-31","psc_code":null,"award_type":null,"naics_code":null,"start_date":"1987-09-15","description":"THE PRIMARY ACTIVITIES COVERED BY THIS EFFORT INCLUDE THE FINAL SERVICING MISSION AND SUBSEQUENT OPERATIONS THROUGH END-OF-MISSION. THESE ACTIVITIES INCLUDE: A. SCIENCE PROGRAM IMPLEMENTATION INCLUDING: MISSION PLANNING SUPPORT, SCIENCE PROGRAM DEFINITION SUPPORT, MANAGEMENT OF THE PROPOSAL SELECTION, TIME ALLOCATION, AND GRANT AWARD COMMITTEE PROCESSES, AND SCIENCE COMMUNITY OUTREACH. B. ROUTINE SCIENCE OPERATIONS INCLUDING: PROPOSAL GENERATION AND RECEIPT, OBSERVATION PLANNING AND SCHEDULING, UPDATING INSTRUMENT HANDBOOKS, OBSERVING AND USER SUPPORT, DATA PROCESSING AND PRODUCT GENERATION, ARCHIVAL AND DATA DISTRIBUTION SERVICES, CALIBRATION ASSISTANCE AND DATA ANALYSIS, ANOMALY INVESTIGATION SUPPORT, USER GRANT ADMINISTRATION, OBSERVER ASSISTANCE AND ENGINEERING OPERATIONS SUPPORT. C.","award_amount":2533788480,"amount_display":"$2,533,788,480.00","funding_agency":"National Aeronautics and Space Administration","recipient_name":"ASSOCIATION OF UNIVERSITIES FOR RESEARCH IN ASTRONOMY, INC.","awarding_agency":"National Aeronautics and Space Administration","awarding_sub_agency":"National Aeronautics and Space Administration","generated_internal_id":"CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-"}],"pagination":{"next":"https://www.usaspending.gov/search/?keywords=software&page=2","page":1,"per_page":10,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/doaj/journal":{"get":{"summary":"DOAJ Journal","description":"Fetch one DOAJ journal by ISSN, journal id, or a doaj.org toc URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-doaj-journal","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Journal ISSN, journal id, or a doaj.org/toc URL. Example: 2747-173X.","schema":{"type":"string","description":"Required. Journal ISSN, journal id, or a doaj.org/toc URL. Example: 2747-173X."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"eissn":{"type":"string"},"pissn":{"nullable":true},"title":{"type":"string"},"has_apc":{"type":"boolean"},"license":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"oa_start":{"type":"string"},"subjects":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"}},"publisher":{"type":"string"},"license_url":{"type":"string"},"alternative_title":{"type":"string"},"publisher_country":{"type":"string"}}},"examples":{"CERiMRE":{"value":{"id":"00087d1be705481c92efc11a6dc42b80","url":"https://doaj.org/toc/2747-173X","eissn":"2747-173X","pissn":null,"title":"Computational and Experimental Research in Materials and Renewable Energy","has_apc":false,"license":"CC BY-SA","keywords":["renewable energy","nuclear materials","thermoelectric materials","ptoelectronics materials"],"oa_start":"2018","subjects":["Renewable energy sources"],"languages":["EN"],"publisher":"Physics Department, Faculty of Mathematics and Natural Sciences University of Jember","license_url":"https://creativecommons.org/licenses/by-sa/4.0/","alternative_title":"CERiMRE","publisher_country":"ID"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"DOAJ Journal","description":"Fetch one DOAJ journal by ISSN, journal id, or a doaj.org toc URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-doaj-journal","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Journal ISSN, journal id, or a doaj.org/toc URL. Example: 2747-173X.","schema":{"type":"string","description":"Required. Journal ISSN, journal id, or a doaj.org/toc URL. Example: 2747-173X."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"eissn":{"type":"string"},"pissn":{"nullable":true},"title":{"type":"string"},"has_apc":{"type":"boolean"},"license":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"oa_start":{"type":"string"},"subjects":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"}},"publisher":{"type":"string"},"license_url":{"type":"string"},"alternative_title":{"type":"string"},"publisher_country":{"type":"string"}}},"examples":{"CERiMRE":{"value":{"id":"00087d1be705481c92efc11a6dc42b80","url":"https://doaj.org/toc/2747-173X","eissn":"2747-173X","pissn":null,"title":"Computational and Experimental Research in Materials and Renewable Energy","has_apc":false,"license":"CC BY-SA","keywords":["renewable energy","nuclear materials","thermoelectric materials","ptoelectronics materials"],"oa_start":"2018","subjects":["Renewable energy sources"],"languages":["EN"],"publisher":"Physics Department, Faculty of Mathematics and Natural Sciences University of Jember","license_url":"https://creativecommons.org/licenses/by-sa/4.0/","alternative_title":"CERiMRE","publisher_country":"ID"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/doaj/search":{"get":{"summary":"DOAJ Search","description":"Search DOAJ articles or journals. kind is article (default) or journal. Article ids and journal ISSNs are the detail keys.\n\n**Credit cost:** 1 credit per call","operationId":"get-doaj-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a doaj.org search URL. Example: climate. An article or journal URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a doaj.org search URL. Example: climate. An article or journal URL returns 400."}},{"name":"kind","in":"query","required":false,"description":"Optional. article or journal. Example: journal. Defaults to article.","schema":{"type":"string","default":"article","description":"Optional. article or journal. Example: journal. Defaults to article."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 records.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 records."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"doi":{"type":"string"},"url":{"type":"string"},"year":{"type":"string"},"issue":{"type":"string"},"month":{"type":"string"},"title":{"type":"string"},"volume":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"type":"string"}}}},"abstract":{"type":"string"},"end_page":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"subjects":{"type":"array","items":{"type":"string"}},"start_page":{"type":"string"},"fulltext_url":{"type":"string"},"journal_issn":{"type":"string"},"journal_title":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"climate articles":{"value":{"results":[{"id":"000004687a3a411cb466625281f2ceb0","doi":"10.1002/ece3.8411","url":"https://doaj.org/article/000004687a3a411cb466625281f2ceb0","year":"2021","issue":"24","month":"12","title":"Fishing, predation, and temperature drive herring decline in a large marine ecosystem","volume":"11","authors":[{"name":"Daniel G. Boyce","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Brian Petrie","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Kenneth T. Frank","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"}],"abstract":"Abstract Since 1960, landings of Atlantic herring have been the greatest of any marine species in Canada, surpassing Atlantic cod and accounting for 24% of the total seafood harvested in Atlantic Canada. The Scotian Shelf‐Bay of Fundy herring fisheries (NAFO Division 4VWX) is among Canada's oldest and drives this productivity, accounting for up to 75% of the total herring catch in some years. The stocks’ productivity and overall health have declined since 1965. Despite management measures to promote recovery implemented since 2003, biomass remains low and is declining. The factors that drive the productivity of 4VWX herring are primarily unresolved, likely impeding the effectiveness of management actions on this stock.","end_page":"18150","keywords":["Atlantic herring","climate change","ecosystem","ecosystem‐based","egg predation","exploitation"],"subjects":["Ecology"],"start_page":"18136","fulltext_url":"https://doi.org/10.1002/ece3.8411","journal_issn":"2045-7758","journal_title":"Ecology and Evolution"}],"pagination":{"next":"https://doaj.org/search/articles/climate?page=2","page":1,"per_page":10,"total_pages":27197,"total_results":271961}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"DOAJ Search","description":"Search DOAJ articles or journals. kind is article (default) or journal. Article ids and journal ISSNs are the detail keys.\n\n**Credit cost:** 1 credit per call","operationId":"post-doaj-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword or a doaj.org search URL. Example: climate. An article or journal URL returns 400.","schema":{"type":"string","description":"Required. Keyword or a doaj.org search URL. Example: climate. An article or journal URL returns 400."}},{"name":"kind","in":"query","required":false,"description":"Optional. article or journal. Example: journal. Defaults to article.","schema":{"type":"string","default":"article","description":"Optional. article or journal. Example: journal. Defaults to article."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 records.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 records."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"doi":{"type":"string"},"url":{"type":"string"},"year":{"type":"string"},"issue":{"type":"string"},"month":{"type":"string"},"title":{"type":"string"},"volume":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"type":"string"}}}},"abstract":{"type":"string"},"end_page":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"subjects":{"type":"array","items":{"type":"string"}},"start_page":{"type":"string"},"fulltext_url":{"type":"string"},"journal_issn":{"type":"string"},"journal_title":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"climate articles":{"value":{"results":[{"id":"000004687a3a411cb466625281f2ceb0","doi":"10.1002/ece3.8411","url":"https://doaj.org/article/000004687a3a411cb466625281f2ceb0","year":"2021","issue":"24","month":"12","title":"Fishing, predation, and temperature drive herring decline in a large marine ecosystem","volume":"11","authors":[{"name":"Daniel G. Boyce","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Brian Petrie","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Kenneth T. Frank","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"}],"abstract":"Abstract Since 1960, landings of Atlantic herring have been the greatest of any marine species in Canada, surpassing Atlantic cod and accounting for 24% of the total seafood harvested in Atlantic Canada. The Scotian Shelf‐Bay of Fundy herring fisheries (NAFO Division 4VWX) is among Canada's oldest and drives this productivity, accounting for up to 75% of the total herring catch in some years. The stocks’ productivity and overall health have declined since 1965. Despite management measures to promote recovery implemented since 2003, biomass remains low and is declining. The factors that drive the productivity of 4VWX herring are primarily unresolved, likely impeding the effectiveness of management actions on this stock.","end_page":"18150","keywords":["Atlantic herring","climate change","ecosystem","ecosystem‐based","egg predation","exploitation"],"subjects":["Ecology"],"start_page":"18136","fulltext_url":"https://doi.org/10.1002/ece3.8411","journal_issn":"2045-7758","journal_title":"Ecology and Evolution"}],"pagination":{"next":"https://doaj.org/search/articles/climate?page=2","page":1,"per_page":10,"total_pages":27197,"total_results":271961}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/doaj/article":{"get":{"summary":"DOAJ Article","description":"Fetch one DOAJ article by its id or by a doaj.org article URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-doaj-article","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Article id or a doaj.org/article URL. Example: 000004687a3a411cb466625281f2ceb0.","schema":{"type":"string","description":"Required. Article id or a doaj.org/article URL. Example: 000004687a3a411cb466625281f2ceb0."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"doi":{"type":"string"},"url":{"type":"string"},"year":{"type":"string"},"issue":{"type":"string"},"month":{"type":"string"},"title":{"type":"string"},"volume":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"type":"string"}}}},"abstract":{"type":"string"},"end_page":{"nullable":true},"keywords":{"type":"array","items":{"type":"string"}},"subjects":{"type":"array","items":{"type":"string"}},"start_page":{"nullable":true},"fulltext_url":{"type":"string"},"journal_issn":{"nullable":true},"journal_title":{"type":"string"}}},"examples":{"herring article":{"value":{"id":"000004687a3a411cb466625281f2ceb0","doi":"10.1002/ece3.8411","url":"https://doaj.org/article/000004687a3a411cb466625281f2ceb0","year":"2021","issue":"24","month":"12","title":"Fishing, predation, and temperature drive herring decline in a large marine ecosystem","volume":"11","authors":[{"name":"Daniel G. Boyce","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Brian Petrie","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Kenneth T. Frank","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"}],"abstract":"Abstract Since 1960, landings of Atlantic herring have been the greatest of any marine species in Canada, surpassing Atlantic cod and accounting for 24% of the total seafood harvested in Atlantic Canada. The Scotian Shelf‐Bay of Fundy herring fisheries (NAFO Division 4VWX) is among Canada's oldest and drives this productivity, accounting for up to 75% of the total herring catch in some years. The stocks’ productivity and overall health have declined since 1965. Despite management measures to promote recovery implemented since 2003, biomass remains low and is declining. The factors that drive the productivity of 4VWX herring are primarily unresolved, likely impeding the effectiveness of management actions on this stock.","end_page":null,"keywords":["Atlantic herring","climate change","ecosystem","ecosystem‐based","egg predation","exploitation"],"subjects":["Ecology"],"start_page":null,"fulltext_url":"https://doi.org/10.1002/ece3.8411","journal_issn":null,"journal_title":"Ecology and Evolution"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"DOAJ Article","description":"Fetch one DOAJ article by its id or by a doaj.org article URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-doaj-article","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Article id or a doaj.org/article URL. Example: 000004687a3a411cb466625281f2ceb0.","schema":{"type":"string","description":"Required. Article id or a doaj.org/article URL. Example: 000004687a3a411cb466625281f2ceb0."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"doi":{"type":"string"},"url":{"type":"string"},"year":{"type":"string"},"issue":{"type":"string"},"month":{"type":"string"},"title":{"type":"string"},"volume":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"type":"string"}}}},"abstract":{"type":"string"},"end_page":{"nullable":true},"keywords":{"type":"array","items":{"type":"string"}},"subjects":{"type":"array","items":{"type":"string"}},"start_page":{"nullable":true},"fulltext_url":{"type":"string"},"journal_issn":{"nullable":true},"journal_title":{"type":"string"}}},"examples":{"herring article":{"value":{"id":"000004687a3a411cb466625281f2ceb0","doi":"10.1002/ece3.8411","url":"https://doaj.org/article/000004687a3a411cb466625281f2ceb0","year":"2021","issue":"24","month":"12","title":"Fishing, predation, and temperature drive herring decline in a large marine ecosystem","volume":"11","authors":[{"name":"Daniel G. Boyce","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Brian Petrie","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"},{"name":"Kenneth T. Frank","affiliation":"Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"}],"abstract":"Abstract Since 1960, landings of Atlantic herring have been the greatest of any marine species in Canada, surpassing Atlantic cod and accounting for 24% of the total seafood harvested in Atlantic Canada. The Scotian Shelf‐Bay of Fundy herring fisheries (NAFO Division 4VWX) is among Canada's oldest and drives this productivity, accounting for up to 75% of the total herring catch in some years. The stocks’ productivity and overall health have declined since 1965. Despite management measures to promote recovery implemented since 2003, biomass remains low and is declining. The factors that drive the productivity of 4VWX herring are primarily unresolved, likely impeding the effectiveness of management actions on this stock.","end_page":null,"keywords":["Atlantic herring","climate change","ecosystem","ecosystem‐based","egg predation","exploitation"],"subjects":["Ecology"],"start_page":null,"fulltext_url":"https://doi.org/10.1002/ece3.8411","journal_issn":null,"journal_title":"Ecology and Evolution"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/arxiv/search":{"get":{"summary":"arXiv Search","description":"Search arXiv papers by keyword, author query such as au:einstein, or arXiv id. A paper URL returns 400. Page through results when the match count is large.\n\n**Credit cost:** 1 credit per call","operationId":"get-arxiv-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, fielded query such as au:einstein, arXiv id, or an arxiv.org search URL. Example: electron. A paper URL such as https://arxiv.org/abs/2201.00978 returns 400.","schema":{"type":"string","description":"Required. Keyword, fielded query such as au:einstein, arXiv id, or an arxiv.org search URL. Example: electron. A paper URL such as https://arxiv.org/abs/2201.00978 returns 400."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 papers.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 papers."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"doi":{"nullable":true},"url":{"type":"string"},"title":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"nullable":true}}}},"comment":{"type":"string"},"pdf_url":{"type":"string"},"updated":{"type":"string"},"version":{"type":"integer"},"abstract":{"type":"string"},"arxiv_id":{"type":"string"},"published":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"journal_ref":{"type":"string"},"primary_category":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"electron":{"value":{"results":[{"doi":null,"url":"https://arxiv.org/abs/cond-mat/0011267v1","title":"The electronic structure of cuprates from high energy spectroscopy","authors":[{"name":"Mark S. Golden","affiliation":null},{"name":"Christian Duerr","affiliation":null},{"name":"Andreas Koitzsch","affiliation":null},{"name":"Sibylle Legner","affiliation":null},{"name":"Zhiwei Hu","affiliation":null},{"name":"Sergey Borisenko","affiliation":null},{"name":"Martin Knupfer","affiliation":null},{"name":"Joerg Fink","affiliation":null}],"comment":"J. Electron Spec. Relat. Phenom.: special issue on electron correlation, in press","pdf_url":"https://arxiv.org/pdf/cond-mat/0011267v1","updated":"2000-11-15T16:19:15Z","version":1,"abstract":"We report studies of the electronic structure and elementary excitations of doped and undoped cuprate chains, ladders and planes. Using high energy spectroscopies such as x-ray absorption, core level photoemission and angle resolved photoemission spectroscopy, important information regarding the charge distribution and hole dynamics can be obtained. The comparison of the experimental data with suitable theoretical models sets constraints on the parameters entering into the model calculations, and offers insight into the important physical quantities governing the electronic structure of these materials. Recurring themes include the importance of the dimensionality of the Cu-O network (1D->2D) and the crucial role played by the spin-background in determining the dynamics of low-lying excitations in these strongly correlated systems.","arxiv_id":"cond-mat/0011267","published":"2000-11-15T16:19:15Z","categories":["cond-mat.supr-con","cond-mat.str-el"],"journal_ref":"J. Electron Spectr. Relat. Phenom. 117-118, 203 (2001)","primary_category":"cond-mat.supr-con"}],"pagination":{"next":"https://arxiv.org/search/?searchtype=all&query=electron&start=10","page":1,"per_page":10,"total_pages":18823,"total_results":188230}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"arXiv Search","description":"Search arXiv papers by keyword, author query such as au:einstein, or arXiv id. A paper URL returns 400. Page through results when the match count is large.\n\n**Credit cost:** 1 credit per call","operationId":"post-arxiv-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. Keyword, fielded query such as au:einstein, arXiv id, or an arxiv.org search URL. Example: electron. A paper URL such as https://arxiv.org/abs/2201.00978 returns 400.","schema":{"type":"string","description":"Required. Keyword, fielded query such as au:einstein, arXiv id, or an arxiv.org search URL. Example: electron. A paper URL such as https://arxiv.org/abs/2201.00978 returns 400."}},{"name":"page","in":"query","required":false,"description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 papers.","schema":{"type":"number","description":"Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 papers."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"doi":{"nullable":true},"url":{"type":"string"},"title":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"nullable":true}}}},"comment":{"type":"string"},"pdf_url":{"type":"string"},"updated":{"type":"string"},"version":{"type":"integer"},"abstract":{"type":"string"},"arxiv_id":{"type":"string"},"published":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"journal_ref":{"type":"string"},"primary_category":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"electron":{"value":{"results":[{"doi":null,"url":"https://arxiv.org/abs/cond-mat/0011267v1","title":"The electronic structure of cuprates from high energy spectroscopy","authors":[{"name":"Mark S. Golden","affiliation":null},{"name":"Christian Duerr","affiliation":null},{"name":"Andreas Koitzsch","affiliation":null},{"name":"Sibylle Legner","affiliation":null},{"name":"Zhiwei Hu","affiliation":null},{"name":"Sergey Borisenko","affiliation":null},{"name":"Martin Knupfer","affiliation":null},{"name":"Joerg Fink","affiliation":null}],"comment":"J. Electron Spec. Relat. Phenom.: special issue on electron correlation, in press","pdf_url":"https://arxiv.org/pdf/cond-mat/0011267v1","updated":"2000-11-15T16:19:15Z","version":1,"abstract":"We report studies of the electronic structure and elementary excitations of doped and undoped cuprate chains, ladders and planes. Using high energy spectroscopies such as x-ray absorption, core level photoemission and angle resolved photoemission spectroscopy, important information regarding the charge distribution and hole dynamics can be obtained. The comparison of the experimental data with suitable theoretical models sets constraints on the parameters entering into the model calculations, and offers insight into the important physical quantities governing the electronic structure of these materials. Recurring themes include the importance of the dimensionality of the Cu-O network (1D->2D) and the crucial role played by the spin-background in determining the dynamics of low-lying excitations in these strongly correlated systems.","arxiv_id":"cond-mat/0011267","published":"2000-11-15T16:19:15Z","categories":["cond-mat.supr-con","cond-mat.str-el"],"journal_ref":"J. Electron Spectr. Relat. Phenom. 117-118, 203 (2001)","primary_category":"cond-mat.supr-con"}],"pagination":{"next":"https://arxiv.org/search/?searchtype=all&query=electron&start=10","page":1,"per_page":10,"total_pages":18823,"total_results":188230}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/arxiv/paper":{"get":{"summary":"arXiv Paper","description":"Fetch one arXiv paper by id or by an abs, pdf, or html URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-arxiv-paper","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. arXiv id or an abs, pdf, or html URL. Example: 2201.00978 or https://arxiv.org/abs/cond-mat/0011267v1.","schema":{"type":"string","description":"Required. arXiv id or an abs, pdf, or html URL. Example: 2201.00978 or https://arxiv.org/abs/cond-mat/0011267v1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"doi":{"nullable":true},"url":{"type":"string"},"title":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"nullable":true}}}},"comment":{"type":"string"},"pdf_url":{"type":"string"},"updated":{"type":"string"},"version":{"type":"integer"},"abstract":{"type":"string"},"arxiv_id":{"type":"string"},"published":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"journal_ref":{"type":"string"},"primary_category":{"type":"string"}}},"examples":{"cond-mat/0011267":{"value":{"doi":null,"url":"https://arxiv.org/abs/cond-mat/0011267v1","title":"The electronic structure of cuprates from high energy spectroscopy","authors":[{"name":"Mark S. Golden","affiliation":null},{"name":"Christian Duerr","affiliation":null},{"name":"Andreas Koitzsch","affiliation":null},{"name":"Sibylle Legner","affiliation":null},{"name":"Zhiwei Hu","affiliation":null},{"name":"Sergey Borisenko","affiliation":null},{"name":"Martin Knupfer","affiliation":null},{"name":"Joerg Fink","affiliation":null}],"comment":"J. Electron Spec. Relat. Phenom.: special issue on electron correlation, in press","pdf_url":"https://arxiv.org/pdf/cond-mat/0011267v1","updated":"2000-11-15T16:19:15Z","version":1,"abstract":"We report studies of the electronic structure and elementary excitations of doped and undoped cuprate chains, ladders and planes. Using high energy spectroscopies such as x-ray absorption, core level photoemission and angle resolved photoemission spectroscopy, important information regarding the charge distribution and hole dynamics can be obtained. The comparison of the experimental data with suitable theoretical models sets constraints on the parameters entering into the model calculations, and offers insight into the important physical quantities governing the electronic structure of these materials. Recurring themes include the importance of the dimensionality of the Cu-O network (1D->2D) and the crucial role played by the spin-background in determining the dynamics of low-lying excitations in these strongly correlated systems.","arxiv_id":"cond-mat/0011267","published":"2000-11-15T16:19:15Z","categories":["cond-mat.supr-con","cond-mat.str-el"],"journal_ref":"J. Electron Spectr. Relat. Phenom. 117-118, 203 (2001)","primary_category":"cond-mat.supr-con"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"arXiv Paper","description":"Fetch one arXiv paper by id or by an abs, pdf, or html URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-arxiv-paper","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. arXiv id or an abs, pdf, or html URL. Example: 2201.00978 or https://arxiv.org/abs/cond-mat/0011267v1.","schema":{"type":"string","description":"Required. arXiv id or an abs, pdf, or html URL. Example: 2201.00978 or https://arxiv.org/abs/cond-mat/0011267v1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"doi":{"nullable":true},"url":{"type":"string"},"title":{"type":"string"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"affiliation":{"nullable":true}}}},"comment":{"type":"string"},"pdf_url":{"type":"string"},"updated":{"type":"string"},"version":{"type":"integer"},"abstract":{"type":"string"},"arxiv_id":{"type":"string"},"published":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"journal_ref":{"type":"string"},"primary_category":{"type":"string"}}},"examples":{"cond-mat/0011267":{"value":{"doi":null,"url":"https://arxiv.org/abs/cond-mat/0011267v1","title":"The electronic structure of cuprates from high energy spectroscopy","authors":[{"name":"Mark S. Golden","affiliation":null},{"name":"Christian Duerr","affiliation":null},{"name":"Andreas Koitzsch","affiliation":null},{"name":"Sibylle Legner","affiliation":null},{"name":"Zhiwei Hu","affiliation":null},{"name":"Sergey Borisenko","affiliation":null},{"name":"Martin Knupfer","affiliation":null},{"name":"Joerg Fink","affiliation":null}],"comment":"J. Electron Spec. Relat. Phenom.: special issue on electron correlation, in press","pdf_url":"https://arxiv.org/pdf/cond-mat/0011267v1","updated":"2000-11-15T16:19:15Z","version":1,"abstract":"We report studies of the electronic structure and elementary excitations of doped and undoped cuprate chains, ladders and planes. Using high energy spectroscopies such as x-ray absorption, core level photoemission and angle resolved photoemission spectroscopy, important information regarding the charge distribution and hole dynamics can be obtained. The comparison of the experimental data with suitable theoretical models sets constraints on the parameters entering into the model calculations, and offers insight into the important physical quantities governing the electronic structure of these materials. Recurring themes include the importance of the dimensionality of the Cu-O network (1D->2D) and the crucial role played by the spin-background in determining the dynamics of low-lying excitations in these strongly correlated systems.","arxiv_id":"cond-mat/0011267","published":"2000-11-15T16:19:15Z","categories":["cond-mat.supr-con","cond-mat.str-el"],"journal_ref":"J. Electron Spectr. Relat. Phenom. 117-118, 203 (2001)","primary_category":"cond-mat.supr-con"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/gsaelibrary/contract":{"get":{"summary":"GSA eLibrary Contract","description":"Read one GSA eLibrary contractor record from the contract URL returned by search.\n\n**Credit cost:** 1 credit per call","operationId":"get-gsaelibrary-contract","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The contractorInfo.do URL from a search contract row. A contract number is also accepted, but GS-07F-0239T alone currently returns 404 because GSA needs the contractor name that search includes in the URL.\n\n**Example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES\n```","schema":{"type":"string","description":"Required. The contractorInfo.do URL from a search contract row. A contract number is also accepted, but GS-07F-0239T alone currently returns 404 because GSA needs the contractor name that search includes in the URL.\n\n**Example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"epls":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"},"sam_uei":{"type":"string"},"website":{"type":"string"},"terms_url":{"nullable":true},"categories":{"type":"array","items":{"type":"object","properties":{"sin":{"type":"string"},"name":{"type":"string"}}}},"schedule_name":{"type":"string"},"socio_economic":{"type":"string"},"contract_number":{"type":"string"},"contractor_name":{"type":"string"},"schedule_number":{"type":"string"},"government_poc_name":{"type":"string"},"government_poc_email":{"type":"string"},"government_poc_phone":{"type":"string"},"current_option_period_end_date":{"type":"string"}}},"examples":{"US RADAR INC":{"value":{"url":"https://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES","epls":"Contractor not found on the Excluded Parties List System","email":"ron@usradar.com","phone":"732-566-2035","address":"173 AMBOY RD, MORGANVILLE, NJ 07751-1003","sam_uei":"TL26M1812HG4","website":"http://usradar.com","terms_url":null,"categories":[{"sin":"334515","name":"Diagnostic, Measuring and Testing Equipment"}],"schedule_name":"Multiple Award Schedule","socio_economic":"Small Business","contract_number":"GS-07F-0239T","contractor_name":"US RADAR INC","schedule_number":"MAS","government_poc_name":"Brian Buffett","government_poc_email":"brian.buffett@gsa.gov","government_poc_phone":"470-496-9410","current_option_period_end_date":"Feb 14, 2027"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"GSA eLibrary Contract","description":"Read one GSA eLibrary contractor record from the contract URL returned by search.\n\n**Credit cost:** 1 credit per call","operationId":"post-gsaelibrary-contract","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. The contractorInfo.do URL from a search contract row. A contract number is also accepted, but GS-07F-0239T alone currently returns 404 because GSA needs the contractor name that search includes in the URL.\n\n**Example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES\n```","schema":{"type":"string","description":"Required. The contractorInfo.do URL from a search contract row. A contract number is also accepted, but GS-07F-0239T alone currently returns 404 because GSA needs the contractor name that search includes in the URL.\n\n**Example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"epls":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"},"sam_uei":{"type":"string"},"website":{"type":"string"},"terms_url":{"nullable":true},"categories":{"type":"array","items":{"type":"object","properties":{"sin":{"type":"string"},"name":{"type":"string"}}}},"schedule_name":{"type":"string"},"socio_economic":{"type":"string"},"contract_number":{"type":"string"},"contractor_name":{"type":"string"},"schedule_number":{"type":"string"},"government_poc_name":{"type":"string"},"government_poc_email":{"type":"string"},"government_poc_phone":{"type":"string"},"current_option_period_end_date":{"type":"string"}}},"examples":{"US RADAR INC":{"value":{"url":"https://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES","epls":"Contractor not found on the Excluded Parties List System","email":"ron@usradar.com","phone":"732-566-2035","address":"173 AMBOY RD, MORGANVILLE, NJ 07751-1003","sam_uei":"TL26M1812HG4","website":"http://usradar.com","terms_url":null,"categories":[{"sin":"334515","name":"Diagnostic, Measuring and Testing Equipment"}],"schedule_name":"Multiple Award Schedule","socio_economic":"Small Business","contract_number":"GS-07F-0239T","contractor_name":"US RADAR INC","schedule_number":"MAS","government_poc_name":"Brian Buffett","government_poc_email":"brian.buffett@gsa.gov","government_poc_phone":"470-496-9410","current_option_period_end_date":"Feb 14, 2027"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/gsaelibrary/search":{"get":{"summary":"GSA eLibrary Search","description":"Search GSA eLibrary for schedule, SIN, and contract rows by keyword or by a full search URL.\n\n**Credit cost:** 1 credit per call","operationId":"get-gsaelibrary-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A keyword, or a full search URL on gsaelibrary.gsa.gov. The URL must contain searchResults.do or searchText=.\n\n**Example:**\n\n```\nradar\n```\n\n**URL example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/searchResults.do?searchText=radar&searchType=allWords\n```","schema":{"type":"string","description":"Required. A keyword, or a full search URL on gsaelibrary.gsa.gov. The URL must contain searchResults.do or searchText=.\n\n**Example:**\n\n```\nradar\n```\n\n**URL example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/searchResults.do?searchText=radar&searchType=allWords\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sin":{"nullable":true},"url":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"description":{"nullable":true},"result_type":{"type":"string"},"schedule_name":{"type":"string"},"contract_number":{"type":"string"},"schedule_number":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"US RADAR INC":{"value":{"results":[{"sin":null,"url":"https://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES","name":"US RADAR INC","category":"Contractors","description":null,"result_type":"contract","schedule_name":"Multiple Award Schedule","contract_number":"GS-07F-0239T","schedule_number":"MAS"}],"pagination":{"next":null,"page":1,"per_page":63,"total_pages":1,"total_results":63}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"GSA eLibrary Search","description":"Search GSA eLibrary for schedule, SIN, and contract rows by keyword or by a full search URL.\n\n**Credit cost:** 1 credit per call","operationId":"post-gsaelibrary-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Required. A keyword, or a full search URL on gsaelibrary.gsa.gov. The URL must contain searchResults.do or searchText=.\n\n**Example:**\n\n```\nradar\n```\n\n**URL example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/searchResults.do?searchText=radar&searchType=allWords\n```","schema":{"type":"string","description":"Required. A keyword, or a full search URL on gsaelibrary.gsa.gov. The URL must contain searchResults.do or searchText=.\n\n**Example:**\n\n```\nradar\n```\n\n**URL example:**\n\n```\nhttps://www.gsaelibrary.gsa.gov/ElibMain/searchResults.do?searchText=radar&searchType=allWords\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sin":{"nullable":true},"url":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"description":{"nullable":true},"result_type":{"type":"string"},"schedule_name":{"type":"string"},"contract_number":{"type":"string"},"schedule_number":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"US RADAR INC":{"value":{"results":[{"sin":null,"url":"https://www.gsaelibrary.gsa.gov/ElibMain/contractorInfo.do?contractNumber=GS-07F-0239T&contractorName=US+RADAR+INC&executeQuery=YES","name":"US RADAR INC","category":"Contractors","description":null,"result_type":"contract","schedule_name":"Multiple Award Schedule","contract_number":"GS-07F-0239T","schedule_number":"MAS"}],"pagination":{"next":null,"page":1,"per_page":63,"total_pages":1,"total_results":63}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/thalia/product":{"get":{"summary":"Thalia Product","description":"Read one Thalia product from its URL. You get price, author or brand, and the product details.\n\n**Credit cost:** 2 credits per call","operationId":"get-thalia-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or Thalia article id.\n\n**Examples:**\n\n```\nA1074644377\n```\n\n```\nhttps://www.thalia.de/shop/home/artikeldetails/A1074644377\n```\n\nA free-text keyword returns 400.","schema":{"type":"string","description":"Product URL or Thalia article id.\n\n**Examples:**\n\n```\nA1074644377\n```\n\n```\nhttps://www.thalia.de/shop/home/artikeldetails/A1074644377\n```\n\nA free-text keyword returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false.","schema":{"type":"boolean","description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"isbn":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"author":{"type":"string"},"format":{"type":"string"},"rating":{"type":"number"},"series":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"subtitle":{"type":"string"},"publisher":{"type":"string"},"page_count":{"type":"integer"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"publication_date":{"type":"string"}}},"examples":{"Harry Potter und die Kammer des Schreckens":{"value":{"id":"A1074644377","url":"https://www.thalia.de/shop/home/artikeldetails/A1074644377","isbn":"978-3-551-55923-4","image":"https://images.thalia.media/07/-/3aeeae4a5ce44ac39ca88cc122da4164/harry-potter-und-die-kammer-des-schreckens-harry-potter-2-gebundene-ausgabe-j-k-rowling.jpeg","price":18,"title":"Harry Potter und die Kammer des Schreckens (Harry Potter 2)","author":"J. K. Rowling","format":"Hardcover","rating":4.9,"series":"Harry Potter","currency":"EUR","language":"Deutsch","subtitle":"Neuausgabe des Kinderbuch-Klassikers ab 10 Jahren über den bekanntesten Zauberer der Welt","publisher":"Carlsen","page_count":352,"description":"Detailreiche und prachtvoll veredelte Neugestaltung aller sieben Bände Endlich wieder Schule! Einen solchen Seufzer kann nur der ausstoßen, dessen Ferien scheußlich waren: Harry Potter. Doch wie im vergangenen Schuljahr stehen nicht nur Zaubertrankunterricht und Verwandlung auf dem Programm. Ein grauenhaftes Etwas treibt sein Unwesen in der Schule. Wird Harry mit Hilfe seiner Freunde Ron und Hermine das Rätsel lösen und Hogwarts von den dunklen Mächten befreien können? Ein generationenübergreifender Fantasy-Klassiker Millionen von Leser*innen in mehreren Generationen sind mit den Geschichten von Harry Potter aufgewachsen. J.K. Rowling hat mit Hogwarts ein Universum geschaffen, das einzigartig ist und eine große kulturelle Bedeutung erlangt hat. Neben der magischen Welt und spannenden Abenteuern spielen auch moralische Werte wie Freundschaft, Toleranz, Loyalität und der Einsatz für das Gute in ihren Büchern eine wichtige Rolle. Diese vom griechischen Illustrator George Caltsoudas neu gestaltete Ausgabe des zweiten Bandes der Harry-Potter-Serie wird Leser*innen jeden Alters verzaubern.","availability":"Sofort lieferbar","review_count":97,"price_display":"18,00 €","publication_date":"2025-09-01"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Thalia Product","description":"Read one Thalia product from its URL. You get price, author or brand, and the product details.\n\n**Credit cost:** 2 credits per call","operationId":"post-thalia-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or Thalia article id.\n\n**Examples:**\n\n```\nA1074644377\n```\n\n```\nhttps://www.thalia.de/shop/home/artikeldetails/A1074644377\n```\n\nA free-text keyword returns 400.","schema":{"type":"string","description":"Product URL or Thalia article id.\n\n**Examples:**\n\n```\nA1074644377\n```\n\n```\nhttps://www.thalia.de/shop/home/artikeldetails/A1074644377\n```\n\nA free-text keyword returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false.","schema":{"type":"boolean","description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"isbn":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"author":{"type":"string"},"format":{"type":"string"},"rating":{"type":"number"},"series":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"subtitle":{"type":"string"},"publisher":{"type":"string"},"page_count":{"type":"integer"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"publication_date":{"type":"string"}}},"examples":{"Harry Potter und die Kammer des Schreckens":{"value":{"id":"A1074644377","url":"https://www.thalia.de/shop/home/artikeldetails/A1074644377","isbn":"978-3-551-55923-4","image":"https://images.thalia.media/07/-/3aeeae4a5ce44ac39ca88cc122da4164/harry-potter-und-die-kammer-des-schreckens-harry-potter-2-gebundene-ausgabe-j-k-rowling.jpeg","price":18,"title":"Harry Potter und die Kammer des Schreckens (Harry Potter 2)","author":"J. K. Rowling","format":"Hardcover","rating":4.9,"series":"Harry Potter","currency":"EUR","language":"Deutsch","subtitle":"Neuausgabe des Kinderbuch-Klassikers ab 10 Jahren über den bekanntesten Zauberer der Welt","publisher":"Carlsen","page_count":352,"description":"Detailreiche und prachtvoll veredelte Neugestaltung aller sieben Bände Endlich wieder Schule! Einen solchen Seufzer kann nur der ausstoßen, dessen Ferien scheußlich waren: Harry Potter. Doch wie im vergangenen Schuljahr stehen nicht nur Zaubertrankunterricht und Verwandlung auf dem Programm. Ein grauenhaftes Etwas treibt sein Unwesen in der Schule. Wird Harry mit Hilfe seiner Freunde Ron und Hermine das Rätsel lösen und Hogwarts von den dunklen Mächten befreien können? Ein generationenübergreifender Fantasy-Klassiker Millionen von Leser*innen in mehreren Generationen sind mit den Geschichten von Harry Potter aufgewachsen. J.K. Rowling hat mit Hogwarts ein Universum geschaffen, das einzigartig ist und eine große kulturelle Bedeutung erlangt hat. Neben der magischen Welt und spannenden Abenteuern spielen auch moralische Werte wie Freundschaft, Toleranz, Loyalität und der Einsatz für das Gute in ihren Büchern eine wichtige Rolle. Diese vom griechischen Illustrator George Caltsoudas neu gestaltete Ausgabe des zweiten Bandes der Harry-Potter-Serie wird Leser*innen jeden Alters verzaubern.","availability":"Sofort lieferbar","review_count":97,"price_display":"18,00 €","publication_date":"2025-09-01"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/thalia/search":{"get":{"summary":"Thalia Search","description":"Search Thalia by keyword and page books, media, and gifts. Cards include title, price, and the product link.\n\n**Credit cost:** 2 credits per call","operationId":"get-thalia-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a thalia.de search URL (/suche or a category URL). A product URL returns 400.\n\n**Example:** `Harry Potter`","schema":{"type":"string","description":"Keyword or a thalia.de search URL (/suche or a category URL). A product URL returns 400.\n\n**Example:** `Harry Potter`"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1. Sent to Thalia as the query parameter p. Default 1.","schema":{"type":"number","description":"Page number, from 1. Sent to Thalia as the query parameter p. Default 1."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false.","schema":{"type":"boolean","description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"author":{"type":"string"},"format":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"Harry Potter, first card":{"value":{"results":[{"id":"A1074644377","url":"https://www.thalia.de/shop/home/artikeldetails/A1074644377","image":"https://images.thalia.media/03/-/3aeeae4a5ce44ac39ca88cc122da4164/harry-potter-und-die-kammer-des-schreckens-harry-potter-2-gebundene-ausgabe-j-k-rowling.jpeg","price":18,"title":"Harry Potter und die Kammer des Schreckens (Harry Potter 2)","author":"J. K. Rowling","format":"Buch (Gebundene Ausgabe)","rating":5,"currency":"EUR","review_count":97,"price_display":"18,00 €"}],"pagination":{"next":"https://www.thalia.de/suche?sq=Harry%20potter&p=2","page":1,"per_page":24,"total_pages":258,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Thalia Search","description":"Search Thalia by keyword and page books, media, and gifts. Cards include title, price, and the product link.\n\n**Credit cost:** 2 credits per call","operationId":"post-thalia-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a thalia.de search URL (/suche or a category URL). A product URL returns 400.\n\n**Example:** `Harry Potter`","schema":{"type":"string","description":"Keyword or a thalia.de search URL (/suche or a category URL). A product URL returns 400.\n\n**Example:** `Harry Potter`"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1. Sent to Thalia as the query parameter p. Default 1.","schema":{"type":"number","description":"Page number, from 1. Sent to Thalia as the query parameter p. Default 1."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false.","schema":{"type":"boolean","description":"When true, returns {\"result\": \"<html>...\"} instead of the parsed JSON. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"author":{"type":"string"},"format":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"Harry Potter, first card":{"value":{"results":[{"id":"A1074644377","url":"https://www.thalia.de/shop/home/artikeldetails/A1074644377","image":"https://images.thalia.media/03/-/3aeeae4a5ce44ac39ca88cc122da4164/harry-potter-und-die-kammer-des-schreckens-harry-potter-2-gebundene-ausgabe-j-k-rowling.jpeg","price":18,"title":"Harry Potter und die Kammer des Schreckens (Harry Potter 2)","author":"J. K. Rowling","format":"Buch (Gebundene Ausgabe)","rating":5,"currency":"EUR","review_count":97,"price_display":"18,00 €"}],"pagination":{"next":"https://www.thalia.de/suche?sq=Harry%20potter&p=2","page":1,"per_page":24,"total_pages":258,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aboutyou/product":{"get":{"summary":"About You Product","description":"Read one About You product from a product URL or a keyword. A keyword opens the first search hit. Set region when the query does not already name the shop.\n\n**Credit cost:** 2 credits per call","operationId":"get-aboutyou-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or keyword. A keyword opens the first search result.","schema":{"type":"string","description":"Product URL or keyword. A keyword opens the first search result."}},{"name":"region","in":"query","required":false,"description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme.","schema":{"type":"string","description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"price_display":{"type":"string"},"article_number":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}},"examples":{"PUMA Suede Bloom, France":{"value":{"id":32191359,"url":"https://www.aboutyou.fr/p/puma/baskets-basses-suede-bloom-32191359","name":"Baskets basses 'Suede Bloom'","brand":"PUMA","color":"rose","image":"https://cdn.aboutstatic.com/file/images/f69d3161a57ca8a8aff626a5acc399bf.jpg?brightness=0.96&quality=75&trim=1","price":69.9,"region":"fr","currency":"EUR","in_stock":true,"price_display":"69,90 €","article_number":"PUMliff008000002","original_price":89.9,"original_price_display":"89,90 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"About You Product","description":"Read one About You product from a product URL or a keyword. A keyword opens the first search hit. Set region when the query does not already name the shop.\n\n**Credit cost:** 2 credits per call","operationId":"post-aboutyou-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or keyword. A keyword opens the first search result.","schema":{"type":"string","description":"Product URL or keyword. A keyword opens the first search result."}},{"name":"region","in":"query","required":false,"description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme.","schema":{"type":"string","description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"price_display":{"type":"string"},"article_number":{"type":"string"},"original_price":{"type":"number"},"original_price_display":{"type":"string"}}},"examples":{"PUMA Suede Bloom, France":{"value":{"id":32191359,"url":"https://www.aboutyou.fr/p/puma/baskets-basses-suede-bloom-32191359","name":"Baskets basses 'Suede Bloom'","brand":"PUMA","color":"rose","image":"https://cdn.aboutstatic.com/file/images/f69d3161a57ca8a8aff626a5acc399bf.jpg?brightness=0.96&quality=75&trim=1","price":69.9,"region":"fr","currency":"EUR","in_stock":true,"price_display":"69,90 €","article_number":"PUMliff008000002","original_price":89.9,"original_price_display":"89,90 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aboutyou/search":{"get":{"summary":"About You Search","description":"Search an About You shop with a keyword or a search URL. Pick the country with region, or let a full link choose the shop. Cards include brand, price, and the product link.\n\n**Credit cost:** 2 credits per call","operationId":"get-aboutyou-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or About You search, category, or brand URL.","schema":{"type":"string","description":"Keyword or About You search, category, or brand URL."}},{"name":"region","in":"query","required":false,"description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme.","schema":{"type":"string","description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme."}},{"name":"page","in":"query","required":false,"description":"Only page 1 is available.","schema":{"type":"number","description":"Only page 1 is available."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Suede bloom, France":{"value":{"results":[{"id":24283626,"url":"https://www.aboutyou.fr/p/puma/baskets-basses-suede-xl-24283626","name":"Baskets basses 'Suede XL'","brand":"PUMA","image":"https://cdn.aboutstatic.com/file/images/970952623a9504597b852a2f439e7c35.png?bg=F4F4F5&quality=75&trim=1","price":99.95,"region":"fr","currency":"EUR","price_display":"99,95 €"}],"pagination":{"next":null,"page":1,"per_page":31,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"About You Search","description":"Search an About You shop with a keyword or a search URL. Pick the country with region, or let a full link choose the shop. Cards include brand, price, and the product link.\n\n**Credit cost:** 2 credits per call","operationId":"post-aboutyou-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or About You search, category, or brand URL.","schema":{"type":"string","description":"Keyword or About You search, category, or brand URL."}},{"name":"region","in":"query","required":false,"description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme.","schema":{"type":"string","description":"Shop code. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nde\n```\n\n```\nch-fr\n```\n\nThe full list is the Shops table in the readme."}},{"name":"page","in":"query","required":false,"description":"Only page 1 is available.","schema":{"type":"number","description":"Only page 1 is available."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Suede bloom, France":{"value":{"results":[{"id":24283626,"url":"https://www.aboutyou.fr/p/puma/baskets-basses-suede-xl-24283626","name":"Baskets basses 'Suede XL'","brand":"PUMA","image":"https://cdn.aboutstatic.com/file/images/970952623a9504597b852a2f439e7c35.png?bg=F4F4F5&quality=75&trim=1","price":99.95,"region":"fr","currency":"EUR","price_display":"99,95 €"}],"pagination":{"next":null,"page":1,"per_page":31,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/intersport/product":{"get":{"summary":"Intersport Product","description":"Read one Intersport product from its URL. You get price, brand, and the product details.\n\n**Credit cost:** 2 credits per call","operationId":"get-intersport-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL on intersport.fr, or a root-relative path ending in -p-{id}.\n\n**Example:**\n\n```\nhttps://www.intersport.fr/blancetvert-chaussures_de_running_homme_pegasus_plus2-nike-p-IM2541~VZE/\n```","schema":{"type":"string","description":"Product URL on intersport.fr, or a root-relative path ending in -p-{id}.\n\n**Example:**\n\n```\nhttps://www.intersport.fr/blancetvert-chaussures_de_running_homme_pegasus_plus2-nike-p-IM2541~VZE/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"sizes":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"size":{"type":"string"},"price":{"nullable":true},"in_stock":{"type":"boolean"},"price_display":{"nullable":true}}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Pegasus Plus 2":{"value":{"url":"https://www.intersport.fr/blancetvert-chaussures_de_running_homme_pegasus_plus2-nike-p-IM2541~VZE/","brand":"NIKE","image":"https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_Q1?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","price":169.99,"sizes":[{"ean":"0198966699953","size":"38,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966742147","size":"39","price":null,"in_stock":false,"price_display":null},{"ean":"0198966703834","size":"40","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966708488","size":"40,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966725751","size":"41","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966718708","size":"42","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966732186","size":"42,5","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966679375","size":"43","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966733435","size":"44","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966715271","size":"44,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966733497","size":"45","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966744608","size":"45,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966687868","size":"46","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966733640","size":"47","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966739987","size":"47,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966718463","size":"48,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966719033","size":"49,5","price":null,"in_stock":false,"price_display":null}],"title":"Chaussures de running homme Pegasus Plus 2 blanc et vert","images":["https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_Q1?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_PR?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_DE?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_SE?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_AR?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_D1?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_D2?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_D3?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp"],"category":"Running > Chaussures > Chaussures homme","currency":"EUR","product_id":"IM2541 VZE","description":"La Pegasus Plus 2 fait passer l'amorti réactif au niveau supérieur. Nike a ajouté une unité Air Zoom incurvée à l'avant-pied pour fournir un retour d'énergie encore plus élevé que le modèle précédent. La mousse ZoomX ultra-légère dynamise les runs quotidiens tandis qu'un ajustement confortable et une empeigne légère et respirante permettent d'enchaîner les kilomètres dans le confort.","availability":"in_stock","price_display":"169,99 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Intersport Product","description":"Read one Intersport product from its URL. You get price, brand, and the product details.\n\n**Credit cost:** 2 credits per call","operationId":"post-intersport-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL on intersport.fr, or a root-relative path ending in -p-{id}.\n\n**Example:**\n\n```\nhttps://www.intersport.fr/blancetvert-chaussures_de_running_homme_pegasus_plus2-nike-p-IM2541~VZE/\n```","schema":{"type":"string","description":"Product URL on intersport.fr, or a root-relative path ending in -p-{id}.\n\n**Example:**\n\n```\nhttps://www.intersport.fr/blancetvert-chaussures_de_running_homme_pegasus_plus2-nike-p-IM2541~VZE/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"sizes":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"size":{"type":"string"},"price":{"nullable":true},"in_stock":{"type":"boolean"},"price_display":{"nullable":true}}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Pegasus Plus 2":{"value":{"url":"https://www.intersport.fr/blancetvert-chaussures_de_running_homme_pegasus_plus2-nike-p-IM2541~VZE/","brand":"NIKE","image":"https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_Q1?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","price":169.99,"sizes":[{"ean":"0198966699953","size":"38,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966742147","size":"39","price":null,"in_stock":false,"price_display":null},{"ean":"0198966703834","size":"40","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966708488","size":"40,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966725751","size":"41","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966718708","size":"42","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966732186","size":"42,5","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966679375","size":"43","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966733435","size":"44","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966715271","size":"44,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966733497","size":"45","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966744608","size":"45,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966687868","size":"46","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966733640","size":"47","price":169.99,"in_stock":true,"price_display":"169,99 €"},{"ean":"0198966739987","size":"47,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966718463","size":"48,5","price":null,"in_stock":false,"price_display":null},{"ean":"0198966719033","size":"49,5","price":null,"in_stock":false,"price_display":null}],"title":"Chaussures de running homme Pegasus Plus 2 blanc et vert","images":["https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_Q1?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_PR?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_DE?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_SE?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_AR?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_D1?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_D2?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp","https://media.intersport.fr/is/image/intersportfr/IM2541_VZE_D3?$product_grey$&layer=comp&fit=constrain,0&$produit_xl$&fmt=webp"],"category":"Running > Chaussures > Chaussures homme","currency":"EUR","product_id":"IM2541 VZE","description":"La Pegasus Plus 2 fait passer l'amorti réactif au niveau supérieur. Nike a ajouté une unité Air Zoom incurvée à l'avant-pied pour fournir un retour d'énergie encore plus élevé que le modèle précédent. La mousse ZoomX ultra-légère dynamise les runs quotidiens tandis qu'un ajustement confortable et une empeigne légère et respirante permettent d'enchaîner les kilomètres dans le confort.","availability":"in_stock","price_display":"169,99 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/intersport/search":{"get":{"summary":"Intersport Search","description":"Search Intersport by keyword and page the sports grid. Cards include title, price, and product link.\n\n**Credit cost:** 2 credits per call","operationId":"get-intersport-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or an intersport.fr listing URL. A product URL returns 400.\n\n**Examples:**\n\n```\nnike\n```\n\n```\nhttps://www.intersport.fr/nike-produits/\n```","schema":{"type":"string","description":"Keyword or an intersport.fr listing URL. A product URL returns 400.\n\n**Examples:**\n\n```\nnike\n```\n\n```\nhttps://www.intersport.fr/nike-produits/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1. Default is 1. Intersport's page query is zero-based, so page 2 is sent as page=1.\n\n**Example:** `2`","schema":{"type":"number","description":"Page number, from 1. Default is 1. Intersport's page query is zero-based, so page 2 is sent as page=1.\n\n**Example:** `2`"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"color_count":{"type":"integer"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Nike search, first card":{"value":{"results":[{"url":"https://www.intersport.fr/bleu_marine-maillot_de_football_enfant_equipe_de_francestadium_domicile_26-nike-p-IB5129~6Y9/","brand":"NIKE","image":"https://media.intersport.fr/is/image/intersportfr/IB5129_6Y9_Q1?$produit_m$&$product_grey$","price":84.99,"title":"Maillot de football enfant Équipe de France Stadium Domicile 26 bleu marine","rating":4,"currency":"EUR","position":1,"product_id":"IB5129 6Y9","color_count":1,"review_count":30,"price_display":"84,99 €"}],"pagination":{"next":"https://www.intersport.fr/search/?text=nike&page=1","page":1,"per_page":40,"total_pages":25,"total_results":7701}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Intersport Search","description":"Search Intersport by keyword and page the sports grid. Cards include title, price, and product link.\n\n**Credit cost:** 2 credits per call","operationId":"post-intersport-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or an intersport.fr listing URL. A product URL returns 400.\n\n**Examples:**\n\n```\nnike\n```\n\n```\nhttps://www.intersport.fr/nike-produits/\n```","schema":{"type":"string","description":"Keyword or an intersport.fr listing URL. A product URL returns 400.\n\n**Examples:**\n\n```\nnike\n```\n\n```\nhttps://www.intersport.fr/nike-produits/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1. Default is 1. Intersport's page query is zero-based, so page 2 is sent as page=1.\n\n**Example:** `2`","schema":{"type":"number","description":"Page number, from 1. Default is 1. Intersport's page query is zero-based, so page 2 is sent as page=1.\n\n**Example:** `2`"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"color_count":{"type":"integer"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Nike search, first card":{"value":{"results":[{"url":"https://www.intersport.fr/bleu_marine-maillot_de_football_enfant_equipe_de_francestadium_domicile_26-nike-p-IB5129~6Y9/","brand":"NIKE","image":"https://media.intersport.fr/is/image/intersportfr/IB5129_6Y9_Q1?$produit_m$&$product_grey$","price":84.99,"title":"Maillot de football enfant Équipe de France Stadium Domicile 26 bleu marine","rating":4,"currency":"EUR","position":1,"product_id":"IB5129 6Y9","color_count":1,"review_count":30,"price_display":"84,99 €"}],"pagination":{"next":"https://www.intersport.fr/search/?text=nike&page=1","page":1,"per_page":40,"total_pages":25,"total_results":7701}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/decathlon/product":{"get":{"summary":"Decathlon Product","description":"Read one Decathlon product from a product URL, a product path, or a keyword. A keyword uses the first search hit. Set region when the query does not already name the shop.\n\n**Credit cost:** 1 credit per call","operationId":"get-decathlon-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product link, a `/p/...` or `/products/...` path, or a keyword. A keyword opens the first search hit. A search link returns 400.\n\n**Examples:**\n\n```\nhttps://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536\n```\n\n```\ngourde\n```\n\n```\nhttps://www.decathlon.com/products/van-rysel-rcr-105-di2-357620\n```","schema":{"type":"string","description":"Product link, a `/p/...` or `/products/...` path, or a keyword. A keyword opens the first search hit. A search link returns 400.\n\n**Examples:**\n\n```\nhttps://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536\n```\n\n```\ngourde\n```\n\n```\nhttps://www.decathlon.com/products/van-rysel-rcr-105-di2-357620\n```"}},{"name":"region","in":"query","required":false,"description":"Country shop when `query` is a keyword or a path. Default is `fr`. A full product link picks the shop.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nus\n```\n\n`us` reads the Shopify product JSON on decathlon.com.","schema":{"type":"string","default":"fr","description":"Country shop when `query` is a keyword or a path. Default is `fr`. A full product link picks the shop.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nus\n```\n\n`us` reads the Shopify product JSON on decathlon.com."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw page body in result.","schema":{"type":"boolean","description":"Set to true to get the raw page body in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"price_display":{"type":"string"}}}},"image_url":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}},"examples":{"Quechua bottle in France":{"value":{"sku":"c98m8612536","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, bleu","brand":"QUECHUA","color":"bleu canard","price":9.99,"images":["https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg","https://contents.mediadecathlon.com/p2851411/k$c612714aa771cbc61caf653fce5a5761/picture.jpg"],"rating":4.58,"region":"fr","currency":"EUR","in_stock":true,"variants":[{"sku":"c98m8612536","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-d-alu-recycle-bleu/330041/c98m8612536","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, bleu","color":"bleu canard","price":9.99,"currency":"EUR","in_stock":true,"image_url":"https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg","product_id":"330041","price_display":"9,99 €"},{"sku":"c261m8914342","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-d-alu-recycle-vert/330041/c261m8914342","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, vert","color":"vert eucalyptus","price":9.99,"currency":"EUR","in_stock":true,"image_url":"https://contents.mediadecathlon.com/p2851411/k$c612714aa771cbc61caf653fce5a5761/picture.jpg","product_id":"330041","price_display":"9,99 €"}],"image_url":"https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg","product_id":"330041","breadcrumbs":[{"url":"https://www.decathlon.fr/","name":"Home"},{"url":"https://www.decathlon.fr/tous-les-sports","name":"Tous les sports"},{"url":"https://www.decathlon.fr/tous-les-sports/randonnee-trek","name":"Randonnée - Trek"}],"description":"Résistante, en aluminium, cette gourde avec son bouchon verrouillable à ouverture rapide vous accompagnera dans vos randonnées et vos déplacements quotidiens (1L).","review_count":4700,"price_display":"9,99 €"}},"Van Rysel RCR 105 DI2 in the US":{"value":{"sku":"5320706","url":"https://www.decathlon.com/products/van-rysel-rcr-105-di2-357620?variant=42064466313278","name":"Van Rysel RCR 105 DI2","brand":"Van Rysel","price":4999,"handle":"van-rysel-rcr-105-di2-357620","images":["https://cdn.shopify.com/s/files/1/1330/6287/files/RCR_105_DI2_BLACK_-_8883076_-_001_---_Expires_on_12-11-2033_011e783c-f957-4ba1-b298-b51525620f56.jpg?v=1760088595","https://cdn.shopify.com/s/files/1/1330/6287/files/RCR105DI2BLACK-8883076-001---Expireson12-11-2033.jpg?v=1760088543"],"region":"us","currency":"USD","in_stock":true,"variants":[{"sku":"5320706","name":"Smoked Black / XL","price":4999,"option1":"Smoked Black","option2":"XL","currency":"USD","available":true,"variant_id":"42064466313278","price_display":"$4,999.00"}],"image_url":"https://cdn.shopify.com/s/files/1/1330/6287/files/RCR_105_DI2_BLACK_-_8883076_-_001_---_Expires_on_12-11-2033_011e783c-f957-4ba1-b298-b51525620f56.jpg?v=1760088595","product_id":"7884172296254","variant_id":"42064466313278","description":"This bike is for racers obsessed with achieving the perfect balance of aerodynamics, weight and rigidity. RCR stands for \"racer\", because that's who it's for.","product_type":"Road bike","price_display":"$4,999.00"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Decathlon Product","description":"Read one Decathlon product from a product URL, a product path, or a keyword. A keyword uses the first search hit. Set region when the query does not already name the shop.\n\n**Credit cost:** 1 credit per call","operationId":"post-decathlon-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product link, a `/p/...` or `/products/...` path, or a keyword. A keyword opens the first search hit. A search link returns 400.\n\n**Examples:**\n\n```\nhttps://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536\n```\n\n```\ngourde\n```\n\n```\nhttps://www.decathlon.com/products/van-rysel-rcr-105-di2-357620\n```","schema":{"type":"string","description":"Product link, a `/p/...` or `/products/...` path, or a keyword. A keyword opens the first search hit. A search link returns 400.\n\n**Examples:**\n\n```\nhttps://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536\n```\n\n```\ngourde\n```\n\n```\nhttps://www.decathlon.com/products/van-rysel-rcr-105-di2-357620\n```"}},{"name":"region","in":"query","required":false,"description":"Country shop when `query` is a keyword or a path. Default is `fr`. A full product link picks the shop.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nus\n```\n\n`us` reads the Shopify product JSON on decathlon.com.","schema":{"type":"string","default":"fr","description":"Country shop when `query` is a keyword or a path. Default is `fr`. A full product link picks the shop.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nus\n```\n\n`us` reads the Shopify product JSON on decathlon.com."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw page body in result.","schema":{"type":"boolean","description":"Set to true to get the raw page body in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"price_display":{"type":"string"}}}},"image_url":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}},"examples":{"Quechua bottle in France":{"value":{"sku":"c98m8612536","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, bleu","brand":"QUECHUA","color":"bleu canard","price":9.99,"images":["https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg","https://contents.mediadecathlon.com/p2851411/k$c612714aa771cbc61caf653fce5a5761/picture.jpg"],"rating":4.58,"region":"fr","currency":"EUR","in_stock":true,"variants":[{"sku":"c98m8612536","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-d-alu-recycle-bleu/330041/c98m8612536","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, bleu","color":"bleu canard","price":9.99,"currency":"EUR","in_stock":true,"image_url":"https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg","product_id":"330041","price_display":"9,99 €"},{"sku":"c261m8914342","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-d-alu-recycle-vert/330041/c261m8914342","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, vert","color":"vert eucalyptus","price":9.99,"currency":"EUR","in_stock":true,"image_url":"https://contents.mediadecathlon.com/p2851411/k$c612714aa771cbc61caf653fce5a5761/picture.jpg","product_id":"330041","price_display":"9,99 €"}],"image_url":"https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg","product_id":"330041","breadcrumbs":[{"url":"https://www.decathlon.fr/","name":"Home"},{"url":"https://www.decathlon.fr/tous-les-sports","name":"Tous les sports"},{"url":"https://www.decathlon.fr/tous-les-sports/randonnee-trek","name":"Randonnée - Trek"}],"description":"Résistante, en aluminium, cette gourde avec son bouchon verrouillable à ouverture rapide vous accompagnera dans vos randonnées et vos déplacements quotidiens (1L).","review_count":4700,"price_display":"9,99 €"}},"Van Rysel RCR 105 DI2 in the US":{"value":{"sku":"5320706","url":"https://www.decathlon.com/products/van-rysel-rcr-105-di2-357620?variant=42064466313278","name":"Van Rysel RCR 105 DI2","brand":"Van Rysel","price":4999,"handle":"van-rysel-rcr-105-di2-357620","images":["https://cdn.shopify.com/s/files/1/1330/6287/files/RCR_105_DI2_BLACK_-_8883076_-_001_---_Expires_on_12-11-2033_011e783c-f957-4ba1-b298-b51525620f56.jpg?v=1760088595","https://cdn.shopify.com/s/files/1/1330/6287/files/RCR105DI2BLACK-8883076-001---Expireson12-11-2033.jpg?v=1760088543"],"region":"us","currency":"USD","in_stock":true,"variants":[{"sku":"5320706","name":"Smoked Black / XL","price":4999,"option1":"Smoked Black","option2":"XL","currency":"USD","available":true,"variant_id":"42064466313278","price_display":"$4,999.00"}],"image_url":"https://cdn.shopify.com/s/files/1/1330/6287/files/RCR_105_DI2_BLACK_-_8883076_-_001_---_Expires_on_12-11-2033_011e783c-f957-4ba1-b298-b51525620f56.jpg?v=1760088595","product_id":"7884172296254","variant_id":"42064466313278","description":"This bike is for racers obsessed with achieving the perfect balance of aerodynamics, weight and rigidity. RCR stands for \"racer\", because that's who it's for.","product_type":"Road bike","price_display":"$4,999.00"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/decathlon/search":{"get":{"summary":"Decathlon Search","description":"Search a Decathlon shop with a keyword or a search URL. Choose the country with region, or let a full link pick the shop, then page through titles, prices, and product links.\n\n**Credit cost:** 1 credit per call","operationId":"get-decathlon-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Decathlon search link.\n\n**Examples:**\n\n```\ngourde\n```\n\n```\nvelo\n```\n\n```\nhttps://www.decathlon.fr/search?Ntt=gourde\n```\n\n```\nhttps://www.decathlon.co.uk/search?Ntt=tent\n```\n\nA product page link belongs on Product and returns 400 here.","schema":{"type":"string","description":"Keyword, or a Decathlon search link.\n\n**Examples:**\n\n```\ngourde\n```\n\n```\nvelo\n```\n\n```\nhttps://www.decathlon.fr/search?Ntt=gourde\n```\n\n```\nhttps://www.decathlon.co.uk/search?Ntt=tent\n```\n\nA product page link belongs on Product and returns 400 here."}},{"name":"region","in":"query","required":false,"description":"Country shop. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nbe-nl\n```\n\n```\nus\n```\n\n`gb` is the same as `uk`. `us` is the Shopify shop at decathlon.com.","schema":{"type":"string","default":"fr","description":"Country shop. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nbe-nl\n```\n\n```\nus\n```\n\n`gb` is the same as `uk`. `us` is the Shopify shop at decathlon.com."}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1.\n\n**Example:**\n\n```\n2\n```\n\n```\nGET https://api.piloterr.com/v2/decathlon/search?query=gourde&page=2\n```\n\nEuropean shops step by 40. The US shop steps by 24.","schema":{"type":"number","minimum":1,"description":"Page number starting at 1.\n\n**Example:**\n\n```\n2\n```\n\n```\nGET https://api.piloterr.com/v2/decathlon/search?query=gourde&page=2\n```\n\nEuropean shops step by 40. The US shop steps by 24."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"color_count":{"type":"integer"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Quechua bottle on decathlon.fr":{"value":{"results":[{"sku":"c98m8612536","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, bleu","price":9.99,"rating":4.6,"region":"fr","currency":"EUR","image_url":"https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg?format=auto&f=3000x0","product_id":"330041","color_count":3,"review_count":4700,"price_display":"9,99 €"}],"pagination":{"next":"https://www.decathlon.fr/search?Ntt=gourde&from=40&size=40","page":1,"per_page":40,"total_pages":25,"total_results":5274}}},"Van Rysel bike on decathlon.com":{"value":{"results":[{"url":"https://www.decathlon.com/products/van-rysel-xcr-triathlon-ultegra-di2?variant=42685025550398&_pos=1&_sid=f66afe510&_ss=r","name":"Van Rysel XCR TRIATHLON ULTEGRA DI2","price":8499,"region":"us","currency":"USD","image_url":"https://www.decathlon.com/cdn/shop/files/default_2b2f6fb1-86fa-4f0b-b3ab-57a43be1de4c.jpg?v=1775491210&width=3840","product_id":"8058089242686","variant_id":"42685025550398","price_display":"$8,499.00"}],"pagination":{"next":"https://www.decathlon.com/search?q=bike&page=2","page":1,"per_page":24,"total_pages":8,"total_results":177}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Decathlon Search","description":"Search a Decathlon shop with a keyword or a search URL. Choose the country with region, or let a full link pick the shop, then page through titles, prices, and product links.\n\n**Credit cost:** 1 credit per call","operationId":"post-decathlon-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Decathlon search link.\n\n**Examples:**\n\n```\ngourde\n```\n\n```\nvelo\n```\n\n```\nhttps://www.decathlon.fr/search?Ntt=gourde\n```\n\n```\nhttps://www.decathlon.co.uk/search?Ntt=tent\n```\n\nA product page link belongs on Product and returns 400 here.","schema":{"type":"string","description":"Keyword, or a Decathlon search link.\n\n**Examples:**\n\n```\ngourde\n```\n\n```\nvelo\n```\n\n```\nhttps://www.decathlon.fr/search?Ntt=gourde\n```\n\n```\nhttps://www.decathlon.co.uk/search?Ntt=tent\n```\n\nA product page link belongs on Product and returns 400 here."}},{"name":"region","in":"query","required":false,"description":"Country shop. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nbe-nl\n```\n\n```\nus\n```\n\n`gb` is the same as `uk`. `us` is the Shopify shop at decathlon.com.","schema":{"type":"string","default":"fr","description":"Country shop. Default is `fr`. A full link in `query` picks the shop, and a conflicting `region` returns 400.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nuk\n```\n\n```\nbe-nl\n```\n\n```\nus\n```\n\n`gb` is the same as `uk`. `us` is the Shopify shop at decathlon.com."}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1.\n\n**Example:**\n\n```\n2\n```\n\n```\nGET https://api.piloterr.com/v2/decathlon/search?query=gourde&page=2\n```\n\nEuropean shops step by 40. The US shop steps by 24.","schema":{"type":"number","minimum":1,"description":"Page number starting at 1.\n\n**Example:**\n\n```\n2\n```\n\n```\nGET https://api.piloterr.com/v2/decathlon/search?query=gourde&page=2\n```\n\nEuropean shops step by 40. The US shop steps by 24."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"color_count":{"type":"integer"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Quechua bottle on decathlon.fr":{"value":{"results":[{"sku":"c98m8612536","url":"https://www.decathlon.fr/p/gourde-alu-1l-avec-bouchon-instantane-composee-a-100percent-dalu-recycle-bleu/330041/c98m8612536","name":"Gourde alu 1L avec bouchon instantané, composée à 100% d’alu recyclé, bleu","price":9.99,"rating":4.6,"region":"fr","currency":"EUR","image_url":"https://contents.mediadecathlon.com/p2579584/k$6ca4ddf66bdc61cefd58225cb14ae926/picture.jpg?format=auto&f=3000x0","product_id":"330041","color_count":3,"review_count":4700,"price_display":"9,99 €"}],"pagination":{"next":"https://www.decathlon.fr/search?Ntt=gourde&from=40&size=40","page":1,"per_page":40,"total_pages":25,"total_results":5274}}},"Van Rysel bike on decathlon.com":{"value":{"results":[{"url":"https://www.decathlon.com/products/van-rysel-xcr-triathlon-ultegra-di2?variant=42685025550398&_pos=1&_sid=f66afe510&_ss=r","name":"Van Rysel XCR TRIATHLON ULTEGRA DI2","price":8499,"region":"us","currency":"USD","image_url":"https://www.decathlon.com/cdn/shop/files/default_2b2f6fb1-86fa-4f0b-b3ab-57a43be1de4c.jpg?v=1775491210&width=3840","product_id":"8058089242686","variant_id":"42685025550398","price_display":"$8,499.00"}],"pagination":{"next":"https://www.decathlon.com/search?q=bike&page=2","page":1,"per_page":24,"total_pages":8,"total_results":177}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/sephora/product":{"get":{"summary":"Sephora Product","description":"Read one European Sephora product by id or product URL. Set region when you are not on the French shop.\n\n**Credit cost:** 2 credits per call","operationId":"get-sephora-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Sephora product URL. A product id such as 831955 also works.\n```\nhttps://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html\n```","schema":{"type":"string","description":"A Sephora product URL. A product id such as 831955 also works.\n```\nhttps://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html\n```"}},{"name":"region","in":"query","required":false,"description":"Shop when query is only an id. Use fr for France or de for Germany. Leave empty for France.","schema":{"type":"string","description":"Shop when query is only an id. Use fr for France or de for Germany. Leave empty for France."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"selected":{"type":"boolean"},"price_display":{"type":"string"}}}},"brand_url":{"type":"string"},"master_id":{"type":"string"},"unit_price":{"type":"number"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}},"examples":{"Midnight Espresso, France":{"value":{"id":"831955","sku":"831955","url":"https://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html","name":"Midnight Espresso - Eau de Parfum","size":"75 ml","badge":"Nouveauté","brand":"KILIAN PARIS","price":145,"images":["https://media.sephora.eu/content/dam/gdam/europe/digital/pim/published/K/KILIAN_PARIS/831955/410806-media_swatch-0.jpg?scaleWidth=750&scaleHeight=750&scaleMode=fit"],"rating":4.6,"region":"fr","currency":"EUR","in_stock":true,"variants":[{"sku":"831955","url":"https://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html","name":"Midnight Espresso - Eau de Parfum - 75 ml","size":"75 ml","price":145,"currency":"EUR","in_stock":true,"selected":true,"price_display":"145,00 €"}],"brand_url":"https://www.sephora.fr/marques/de-a-a-z/kilian-paris-kilia/","master_id":"P1000215059","unit_price":193.33,"review_count":237,"price_display":"145,00 €","unit_price_display":"193,33 € / 100ml"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Sephora Product","description":"Read one European Sephora product by id or product URL. Set region when you are not on the French shop.\n\n**Credit cost:** 2 credits per call","operationId":"post-sephora-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Sephora product URL. A product id such as 831955 also works.\n```\nhttps://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html\n```","schema":{"type":"string","description":"A Sephora product URL. A product id such as 831955 also works.\n```\nhttps://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html\n```"}},{"name":"region","in":"query","required":false,"description":"Shop when query is only an id. Use fr for France or de for Germany. Leave empty for France.","schema":{"type":"string","description":"Shop when query is only an id. Use fr for France or de for Germany. Leave empty for France."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"selected":{"type":"boolean"},"price_display":{"type":"string"}}}},"brand_url":{"type":"string"},"master_id":{"type":"string"},"unit_price":{"type":"number"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}},"examples":{"Midnight Espresso, France":{"value":{"id":"831955","sku":"831955","url":"https://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html","name":"Midnight Espresso - Eau de Parfum","size":"75 ml","badge":"Nouveauté","brand":"KILIAN PARIS","price":145,"images":["https://media.sephora.eu/content/dam/gdam/europe/digital/pim/published/K/KILIAN_PARIS/831955/410806-media_swatch-0.jpg?scaleWidth=750&scaleHeight=750&scaleMode=fit"],"rating":4.6,"region":"fr","currency":"EUR","in_stock":true,"variants":[{"sku":"831955","url":"https://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html","name":"Midnight Espresso - Eau de Parfum - 75 ml","size":"75 ml","price":145,"currency":"EUR","in_stock":true,"selected":true,"price_display":"145,00 €"}],"brand_url":"https://www.sephora.fr/marques/de-a-a-z/kilian-paris-kilia/","master_id":"P1000215059","unit_price":193.33,"review_count":237,"price_display":"145,00 €","unit_price_display":"193,33 € / 100ml"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/sephora/search":{"get":{"summary":"Sephora Search","description":"Search a European Sephora shop by keyword. Region defaults to France. Page through makeup and skincare cards. The US site is a different page and is not included.\n\n**Credit cost:** 2 credits per call","operationId":"get-sephora-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A product word, for example mascara. Or paste a full Sephora search URL.","schema":{"type":"string","description":"A product word, for example mascara. Or paste a full Sephora search URL."}},{"name":"region","in":"query","required":false,"description":"Shop code. Use fr for France or de for Germany. Leave empty for France. A full URL picks the shop.","schema":{"type":"string","description":"Shop code. Use fr for France or de for Germany. Leave empty for France. A full URL picks the shop."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Use 2 for the next page of products.","schema":{"type":"number","description":"Page number, starting at 1. Use 2 for the next page of products."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"subtitle":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"call_to_action":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Mascara, France, page 1":{"value":{"results":[{"id":"836334","url":"https://www.sephora.fr/p/vertigo---coffret-vertigo-mascara-836334.html","name":"Vertigo","size":"10 ml + 3.9 ml + 3.9 ml","badge":"Nouveauté","brand":"ARMANI","image":"https://media.sephora.eu/content/dam/gdam/europe/digital/pim/published/A/ARMANI/836334/414410-media_swatch-0.jpg?scaleWidth=3840&scaleMode=fit","price":95,"rating":4.7,"region":"fr","currency":"EUR","subtitle":"Coffret Vertigo mascara","review_count":454,"price_display":"95,00 €","call_to_action":"Ajouter au panier"}],"pagination":{"next":"https://www.sephora.fr/recherche/?q=mascara&page=2","page":1,"per_page":24,"total_pages":9,"total_results":215}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Sephora Search","description":"Search a European Sephora shop by keyword. Region defaults to France. Page through makeup and skincare cards. The US site is a different page and is not included.\n\n**Credit cost:** 2 credits per call","operationId":"post-sephora-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A product word, for example mascara. Or paste a full Sephora search URL.","schema":{"type":"string","description":"A product word, for example mascara. Or paste a full Sephora search URL."}},{"name":"region","in":"query","required":false,"description":"Shop code. Use fr for France or de for Germany. Leave empty for France. A full URL picks the shop.","schema":{"type":"string","description":"Shop code. Use fr for France or de for Germany. Leave empty for France. A full URL picks the shop."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Use 2 for the next page of products.","schema":{"type":"number","description":"Page number, starting at 1. Use 2 for the next page of products."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of JSON.","schema":{"type":"boolean","description":"Return the rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"subtitle":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"call_to_action":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Mascara, France, page 1":{"value":{"results":[{"id":"836334","url":"https://www.sephora.fr/p/vertigo---coffret-vertigo-mascara-836334.html","name":"Vertigo","size":"10 ml + 3.9 ml + 3.9 ml","badge":"Nouveauté","brand":"ARMANI","image":"https://media.sephora.eu/content/dam/gdam/europe/digital/pim/published/A/ARMANI/836334/414410-media_swatch-0.jpg?scaleWidth=3840&scaleMode=fit","price":95,"rating":4.7,"region":"fr","currency":"EUR","subtitle":"Coffret Vertigo mascara","review_count":454,"price_display":"95,00 €","call_to_action":"Ajouter au panier"}],"pagination":{"next":"https://www.sephora.fr/recherche/?q=mascara&page=2","page":1,"per_page":24,"total_pages":9,"total_results":215}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bricodepot/search":{"get":{"summary":"Brico Dépôt Search","description":"Search Brico Dépôt with a /produits/ listing URL, not a keyword box. Page 2 is the same path with /2 at the end.\n\n**Credit cost:** 1 credit per call","operationId":"get-bricodepot-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Brico Dépôt listing URL under /produits/.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/produits/outillage/outillage-electroportatif-a-main-et-accessoire/perceuse-visseuse-et-outillage-de-percage/perceuse-visseuse-et-perceuse-a-percussion-sans-fil\n```\n\nA product URL or a bare keyword returns 400. `page` starts at 1. Page 2 uses the /2 path suffix.","schema":{"type":"string","description":"Brico Dépôt listing URL under /produits/.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/produits/outillage/outillage-electroportatif-a-main-et-accessoire/perceuse-visseuse-et-outillage-de-percage/perceuse-visseuse-et-perceuse-a-percussion-sans-fil\n```\n\nA product URL or a bare keyword returns 400. `page` starts at 1. Page 2 uses the /2 path suffix."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Page 2 is the /2 path suffix.","schema":{"type":"number","description":"Page from 1. Page 2 is the /2 path suffix."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"price_unit":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Perceuse visseuse, first card":{"value":{"results":[{"sku":"5063022810069","url":"https://www.bricodepot.fr/p/5063022810069/perceuse-visseuse-sans-fil-18-v-50-nm-2-vitesses","name":"Perceuse visseuse sans fil 18 V 50 Nm 2 vitesses","badge":"Nouveau","image":"https://media.bricodepot.fr/is/image/KingfisherDigital/5063022810069_01i?wid=300&hei=300","price":17.9,"currency":"EUR","price_unit":"TTC/pièce","price_display":"17,90 €"}],"pagination":{"next":"https://www.bricodepot.fr/produits/outillage/outillage-electroportatif-a-main-et-accessoire/perceuse-visseuse-et-outillage-de-percage/perceuse-visseuse-et-perceuse-a-percussion-sans-fil/2","page":1,"per_page":36,"total_pages":2,"total_results":63}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Brico Dépôt Search","description":"Search Brico Dépôt with a /produits/ listing URL, not a keyword box. Page 2 is the same path with /2 at the end.\n\n**Credit cost:** 1 credit per call","operationId":"post-bricodepot-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Brico Dépôt listing URL under /produits/.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/produits/outillage/outillage-electroportatif-a-main-et-accessoire/perceuse-visseuse-et-outillage-de-percage/perceuse-visseuse-et-perceuse-a-percussion-sans-fil\n```\n\nA product URL or a bare keyword returns 400. `page` starts at 1. Page 2 uses the /2 path suffix.","schema":{"type":"string","description":"Brico Dépôt listing URL under /produits/.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/produits/outillage/outillage-electroportatif-a-main-et-accessoire/perceuse-visseuse-et-outillage-de-percage/perceuse-visseuse-et-perceuse-a-percussion-sans-fil\n```\n\nA product URL or a bare keyword returns 400. `page` starts at 1. Page 2 uses the /2 path suffix."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Page 2 is the /2 path suffix.","schema":{"type":"number","description":"Page from 1. Page 2 is the /2 path suffix."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"price_unit":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Perceuse visseuse, first card":{"value":{"results":[{"sku":"5063022810069","url":"https://www.bricodepot.fr/p/5063022810069/perceuse-visseuse-sans-fil-18-v-50-nm-2-vitesses","name":"Perceuse visseuse sans fil 18 V 50 Nm 2 vitesses","badge":"Nouveau","image":"https://media.bricodepot.fr/is/image/KingfisherDigital/5063022810069_01i?wid=300&hei=300","price":17.9,"currency":"EUR","price_unit":"TTC/pièce","price_display":"17,90 €"}],"pagination":{"next":"https://www.bricodepot.fr/produits/outillage/outillage-electroportatif-a-main-et-accessoire/perceuse-visseuse-et-outillage-de-percage/perceuse-visseuse-et-perceuse-a-percussion-sans-fil/2","page":1,"per_page":36,"total_pages":2,"total_results":63}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bricodepot/product":{"get":{"summary":"Brico Dépôt Product","description":"Read one Brico Dépôt product from its product URL. You get price, brand, SKU, and availability.\n\n**Credit cost:** 1 credit per call","operationId":"get-bricodepot-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL `/p/{ean}/{slug}`.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/p/3373270014082/compresseur-coaxial-50l-vertical-10-bars-accessoires-1\n```\n\nA listing URL returns 400.","schema":{"type":"string","description":"Product URL `/p/{ean}/{slug}`.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/p/3373270014082/compresseur-coaxial-50l-vertical-10-bars-accessoires-1\n```\n\nA listing URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"breadcrumb":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"type":"string"}},"price_unit":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"product_code":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Compresseur coaxial 50L":{"value":{"sku":"3373270014082","url":"https://www.bricodepot.fr/p/3373270014082/compresseur-coaxial-50l-vertical-10-bars-accessoires","gtin":"3373270014082","name":"Compresseur coaxial 50L vertical 10 bars + accessoires","brand":"Prodif","image":"https://media.bricodepot.fr/is/image/KingfisherDigital/3373270014082_07c","price":109,"images":["https://media.bricodepot.fr/is/image/KingfisherDigital/3373270014082_07c"],"category":"Compresseur et accessoire","currency":"EUR","breadcrumb":["Produits","Matériau et gros œuvre","Gros œuvre et évacuation des eaux","Matériel de chantier","Compresseur et accessoire"],"highlights":["Compresseur puissant 10 bars avec accessoires complets","Livré avec un kit complet d’accessoires pratiques.","Pression maximale de 10 bars pour une puissance fiable."],"price_unit":"TTC/La pièce","description":"Compresseur robuste et performant, idéal pour tous vos travaux de bricolage. Sa pression maximale de 10 bar garantit une puissance adaptée à diverses applicatio","availability":"in_stock","product_code":"101507253","price_display":"109,00 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Brico Dépôt Product","description":"Read one Brico Dépôt product from its product URL. You get price, brand, SKU, and availability.\n\n**Credit cost:** 1 credit per call","operationId":"post-bricodepot-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL `/p/{ean}/{slug}`.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/p/3373270014082/compresseur-coaxial-50l-vertical-10-bars-accessoires-1\n```\n\nA listing URL returns 400.","schema":{"type":"string","description":"Product URL `/p/{ean}/{slug}`.\n\n**Example:**\n\n```\nhttps://www.bricodepot.fr/p/3373270014082/compresseur-coaxial-50l-vertical-10-bars-accessoires-1\n```\n\nA listing URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"breadcrumb":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"type":"string"}},"price_unit":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"product_code":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Compresseur coaxial 50L":{"value":{"sku":"3373270014082","url":"https://www.bricodepot.fr/p/3373270014082/compresseur-coaxial-50l-vertical-10-bars-accessoires","gtin":"3373270014082","name":"Compresseur coaxial 50L vertical 10 bars + accessoires","brand":"Prodif","image":"https://media.bricodepot.fr/is/image/KingfisherDigital/3373270014082_07c","price":109,"images":["https://media.bricodepot.fr/is/image/KingfisherDigital/3373270014082_07c"],"category":"Compresseur et accessoire","currency":"EUR","breadcrumb":["Produits","Matériau et gros œuvre","Gros œuvre et évacuation des eaux","Matériel de chantier","Compresseur et accessoire"],"highlights":["Compresseur puissant 10 bars avec accessoires complets","Livré avec un kit complet d’accessoires pratiques.","Pression maximale de 10 bars pour une puissance fiable."],"price_unit":"TTC/La pièce","description":"Compresseur robuste et performant, idéal pour tous vos travaux de bricolage. Sa pression maximale de 10 bar garantit une puissance adaptée à diverses applicatio","availability":"in_stock","product_code":"101507253","price_display":"109,00 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/kijiji/ad":{"get":{"summary":"Kijiji Ad","description":"Read one Kijiji ad from its id or URL. You get the asking price, the title, and the city.\n\n**Credit cost:** 1 credit per call","operationId":"get-kijiji-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Kijiji listing URL or the numeric listing id.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/v-cell-phone-accessories/city-of-toronto/nateroso-iphone-16-case-cute-bear-honey-design/1745477275\n```\n\n```\n1745477275\n```","schema":{"type":"string","description":"Full Kijiji listing URL or the numeric listing id.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/v-cell-phone-accessories/city-of-toronto/nateroso-iphone-16-case-cute-bear-honey-design/1745477275\n```\n\n```\n1745477275\n```"}},{"name":"language","in":"query","required":false,"description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA and prints `$20`. `fr` sets fr-CA and prints `20 $` on the same ad.","schema":{"type":"string","default":"en","description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA and prints `$20`. `fr` sets fr-CA and prints `20 $` on the same ad."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"views":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"location":{"type":"string"},"condition":{"type":"string"},"longitude":{"type":"number"},"posted_at":{"type":"string"},"seller_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"description":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"NATEROSO iPhone 16 case, City of Toronto":{"value":{"id":"1745477275","url":"https://www.kijiji.ca/v-cell-phone-accessories/city-of-toronto/nateroso-iphone-16-case-cute-bear-&-honey-design/1745477275","price":20,"title":"NATEROSO iPhone 16 Case – Cute Bear & Honey Design","views":12,"images":["https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/3f/3f481470-f0df-4464-838b-da8b2a1f026e?rule=kijijica-640-webp","https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/15/15193d1f-e4d7-43da-8c1a-a2b94a37e06b?rule=kijijica-640-webp","https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/34/3441b5c1-af0a-4bcb-b557-172a285a5676?rule=kijijica-640-webp","https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/34/34c07cf0-e9b8-4ccd-9683-f089f8ea2801?rule=kijijica-640-webp"],"address":"Canadian Rd, Scarborough, ON M1R 4Z5","currency":"CAD","latitude":43.76,"location":"City of Toronto","condition":"New","longitude":-79.29,"posted_at":"2026-10-29T17:09:09.000Z","seller_id":"1019125131","attributes":[{"name":"Cashless payment","value":"Yes"},{"name":"For Sale By","value":"Owner"},{"name":"Curbside pick up","value":"No"},{"name":"Shipping","value":"No"},{"name":"Fulfillment","value":"Drop off / Delivery"},{"name":"Drop off / Delivery","value":"Yes"},{"name":"Cash accepted","value":"Yes"},{"name":"Payment","value":"Cashless payment, Cash accepted"},{"name":"Condition","value":"New"}],"description":"✨ Condition: Brand New\nFits standard iPhone 16 (6.1″)\nCute bear and honey design with textured details\nSoft, flexible TPU case with a comfortable grip\nRaised edges around the screen and camera\nPerfect for anyone who loves cute phone accessories!\n⚠️ For iPhone 16 only — not compatible with Plus, Pro or Pro Max.\n️ Check out my page for more great deals!","price_display":"$20"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Kijiji Ad","description":"Read one Kijiji ad from its id or URL. You get the asking price, the title, and the city.\n\n**Credit cost:** 1 credit per call","operationId":"post-kijiji-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Kijiji listing URL or the numeric listing id.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/v-cell-phone-accessories/city-of-toronto/nateroso-iphone-16-case-cute-bear-honey-design/1745477275\n```\n\n```\n1745477275\n```","schema":{"type":"string","description":"Full Kijiji listing URL or the numeric listing id.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/v-cell-phone-accessories/city-of-toronto/nateroso-iphone-16-case-cute-bear-honey-design/1745477275\n```\n\n```\n1745477275\n```"}},{"name":"language","in":"query","required":false,"description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA and prints `$20`. `fr` sets fr-CA and prints `20 $` on the same ad.","schema":{"type":"string","default":"en","description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA and prints `$20`. `fr` sets fr-CA and prints `20 $` on the same ad."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"views":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"location":{"type":"string"},"condition":{"type":"string"},"longitude":{"type":"number"},"posted_at":{"type":"string"},"seller_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"description":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"NATEROSO iPhone 16 case, City of Toronto":{"value":{"id":"1745477275","url":"https://www.kijiji.ca/v-cell-phone-accessories/city-of-toronto/nateroso-iphone-16-case-cute-bear-&-honey-design/1745477275","price":20,"title":"NATEROSO iPhone 16 Case – Cute Bear & Honey Design","views":12,"images":["https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/3f/3f481470-f0df-4464-838b-da8b2a1f026e?rule=kijijica-640-webp","https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/15/15193d1f-e4d7-43da-8c1a-a2b94a37e06b?rule=kijijica-640-webp","https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/34/3441b5c1-af0a-4bcb-b557-172a285a5676?rule=kijijica-640-webp","https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/34/34c07cf0-e9b8-4ccd-9683-f089f8ea2801?rule=kijijica-640-webp"],"address":"Canadian Rd, Scarborough, ON M1R 4Z5","currency":"CAD","latitude":43.76,"location":"City of Toronto","condition":"New","longitude":-79.29,"posted_at":"2026-10-29T17:09:09.000Z","seller_id":"1019125131","attributes":[{"name":"Cashless payment","value":"Yes"},{"name":"For Sale By","value":"Owner"},{"name":"Curbside pick up","value":"No"},{"name":"Shipping","value":"No"},{"name":"Fulfillment","value":"Drop off / Delivery"},{"name":"Drop off / Delivery","value":"Yes"},{"name":"Cash accepted","value":"Yes"},{"name":"Payment","value":"Cashless payment, Cash accepted"},{"name":"Condition","value":"New"}],"description":"✨ Condition: Brand New\nFits standard iPhone 16 (6.1″)\nCute bear and honey design with textured details\nSoft, flexible TPU case with a comfortable grip\nRaised edges around the screen and camera\nPerfect for anyone who loves cute phone accessories!\n⚠️ For iPhone 16 only — not compatible with Plus, Pro or Pro Max.\n️ Check out my page for more great deals!","price_display":"$20"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/vivareal/search":{"get":{"summary":"Viva Real Search","description":"Search Viva Real by city and operation, sale or rent. Page with pagina. Development cards and 'from' prices are left out.\n\n**Credit cost:** 1 credit per call","operationId":"get-vivareal-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City, City plus UF, or a Viva Real search URL.\n\n**Examples:**\n\n```\nSão Paulo\n```\n\n```\nRio de Janeiro, RJ\n```\n\n```\nhttps://www.vivareal.com.br/venda/sp/sao-paulo/\n```\n\nA listing URL returns 400.","schema":{"type":"string","description":"City, City plus UF, or a Viva Real search URL.\n\n**Examples:**\n\n```\nSão Paulo\n```\n\n```\nRio de Janeiro, RJ\n```\n\n```\nhttps://www.vivareal.com.br/venda/sp/sao-paulo/\n```\n\nA listing URL returns 400."}},{"name":"operation","in":"query","required":false,"description":"Sale or rent when query is a city.\n\n**Examples:**\n\n```\nsale\n```\n\n```\nrent\n```\n\nAliases: venda, aluguel, buy. Default sale. A search URL keeps its own path.","schema":{"type":"string","default":"sale","description":"Sale or rent when query is a city.\n\n**Examples:**\n\n```\nsale\n```\n\n```\nrent\n```\n\nAliases: venda, aluguel, buy. Default sale. A search URL keeps its own path."}},{"name":"property_type","in":"query","required":false,"description":"Optional type when query is a city.\n\n**Examples:**\n\n```\napartment\n```\n\n```\nhouse\n```\n\n```\nland\n```\n\nEmpty means every type.","schema":{"type":"string","description":"Optional type when query is a city.\n\n**Examples:**\n\n```\napartment\n```\n\n```\nhouse\n```\n\n```\nland\n```\n\nEmpty means every type."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Placeholder 2. Viva Real receives this as pagina=2. Page 1 and page 2 return different listings. A few featured ids can repeat. Most ids on page 2 are new.","schema":{"type":"number","description":"Page from 1. Placeholder 2. Viva Real receives this as pagina=2. Page 1 and page 2 return different listings. A few featured ids can repeat. Most ids on page 2 are new."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"iptu":{"type":"integer"},"price":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"bathrooms":{"type":"integer"},"image_url":{"type":"string"},"operation":{"type":"string"},"state_code":{"type":"string"},"condominium":{"type":"integer"},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"parking_spaces":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"São Paulo sale, Tatuapé apartment 2910482320":{"value":{"results":[{"id":"2910482320","url":"https://www.vivareal.com.br/imovel/apartamento-4-quartos-tatuape-zona-leste-sao-paulo-com-garagem-225m2-venda-RS4250000-id-2910482320/","area":225,"city":"São Paulo","iptu":1293,"price":4250000,"title":"Apartamento para comprar com 225 m², 4 quartos, 5 banheiros, 4 vagas em Chácara Califórnia, São Paulo","address":"Rua Antônio de Lucena, Chácara Califórnia, São Paulo - SP","bedrooms":4,"currency":"BRL","bathrooms":5,"image_url":"https://resizedimgs.vivareal.com/img/vr-listing/f343296aa94fef7c6d452a62715150c6/apartamento-com-4-quartos-a-venda-225m-no-chacara-california-sao-paulo.webp?action=fit-in&dimension=614x297","operation":"sale","state_code":"SP","condominium":3072,"neighborhood":"Chácara Califórnia","price_display":"R$ 4.250.000","property_type":"apartment","parking_spaces":4}],"pagination":{"next":"https://www.vivareal.com.br/venda/sp/sao-paulo/?onde=%2CS%C3%A3o+Paulo%2CS%C3%A3o+Paulo%2C%2C%2C%2C%2Ccity%2CBR%3ESao+Paulo%3ENULL%3ESao+Paulo%2C-23.555771%2C-46.639557%2C&pagina=2","page":1,"per_page":30,"total_pages":27853,"total_results":835576}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Viva Real Search","description":"Search Viva Real by city and operation, sale or rent. Page with pagina. Development cards and 'from' prices are left out.\n\n**Credit cost:** 1 credit per call","operationId":"post-vivareal-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City, City plus UF, or a Viva Real search URL.\n\n**Examples:**\n\n```\nSão Paulo\n```\n\n```\nRio de Janeiro, RJ\n```\n\n```\nhttps://www.vivareal.com.br/venda/sp/sao-paulo/\n```\n\nA listing URL returns 400.","schema":{"type":"string","description":"City, City plus UF, or a Viva Real search URL.\n\n**Examples:**\n\n```\nSão Paulo\n```\n\n```\nRio de Janeiro, RJ\n```\n\n```\nhttps://www.vivareal.com.br/venda/sp/sao-paulo/\n```\n\nA listing URL returns 400."}},{"name":"operation","in":"query","required":false,"description":"Sale or rent when query is a city.\n\n**Examples:**\n\n```\nsale\n```\n\n```\nrent\n```\n\nAliases: venda, aluguel, buy. Default sale. A search URL keeps its own path.","schema":{"type":"string","default":"sale","description":"Sale or rent when query is a city.\n\n**Examples:**\n\n```\nsale\n```\n\n```\nrent\n```\n\nAliases: venda, aluguel, buy. Default sale. A search URL keeps its own path."}},{"name":"property_type","in":"query","required":false,"description":"Optional type when query is a city.\n\n**Examples:**\n\n```\napartment\n```\n\n```\nhouse\n```\n\n```\nland\n```\n\nEmpty means every type.","schema":{"type":"string","description":"Optional type when query is a city.\n\n**Examples:**\n\n```\napartment\n```\n\n```\nhouse\n```\n\n```\nland\n```\n\nEmpty means every type."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Placeholder 2. Viva Real receives this as pagina=2. Page 1 and page 2 return different listings. A few featured ids can repeat. Most ids on page 2 are new.","schema":{"type":"number","description":"Page from 1. Placeholder 2. Viva Real receives this as pagina=2. Page 1 and page 2 return different listings. A few featured ids can repeat. Most ids on page 2 are new."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"iptu":{"type":"integer"},"price":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"bathrooms":{"type":"integer"},"image_url":{"type":"string"},"operation":{"type":"string"},"state_code":{"type":"string"},"condominium":{"type":"integer"},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"parking_spaces":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"São Paulo sale, Tatuapé apartment 2910482320":{"value":{"results":[{"id":"2910482320","url":"https://www.vivareal.com.br/imovel/apartamento-4-quartos-tatuape-zona-leste-sao-paulo-com-garagem-225m2-venda-RS4250000-id-2910482320/","area":225,"city":"São Paulo","iptu":1293,"price":4250000,"title":"Apartamento para comprar com 225 m², 4 quartos, 5 banheiros, 4 vagas em Chácara Califórnia, São Paulo","address":"Rua Antônio de Lucena, Chácara Califórnia, São Paulo - SP","bedrooms":4,"currency":"BRL","bathrooms":5,"image_url":"https://resizedimgs.vivareal.com/img/vr-listing/f343296aa94fef7c6d452a62715150c6/apartamento-com-4-quartos-a-venda-225m-no-chacara-california-sao-paulo.webp?action=fit-in&dimension=614x297","operation":"sale","state_code":"SP","condominium":3072,"neighborhood":"Chácara Califórnia","price_display":"R$ 4.250.000","property_type":"apartment","parking_spaces":4}],"pagination":{"next":"https://www.vivareal.com.br/venda/sp/sao-paulo/?onde=%2CS%C3%A3o+Paulo%2CS%C3%A3o+Paulo%2C%2C%2C%2C%2Ccity%2CBR%3ESao+Paulo%3ENULL%3ESao+Paulo%2C-23.555771%2C-46.639557%2C&pagina=2","page":1,"per_page":30,"total_pages":27853,"total_results":835576}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/vivareal/property":{"get":{"summary":"Viva Real Property","description":"Read one Viva Real property from its URL. The price follows the operation of that URL, so a sale link stays a sale price.\n\n**Credit cost:** 1 credit per call","operationId":"get-vivareal-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Viva Real listing URL under /imovel/ with an id- number.\n\n**Example:**\n\n```\nhttps://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/\n```\n\nA search URL returns 400. On a sale URL, price stays the sale price when the page also shows rent.","schema":{"type":"string","description":"Viva Real listing URL under /imovel/ with an id- number.\n\n**Example:**\n\n```\nhttps://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/\n```\n\nA search URL returns 400. On a sale URL, price stays the sale price when the page also shows rent."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"iptu":{"type":"integer"},"floor":{"nullable":true},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"suites":{"type":"integer"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"integer"},"image_url":{"type":"string"},"operation":{"type":"string"},"reference":{"type":"string"},"state_code":{"type":"string"},"condominium":{"type":"integer"},"description":{"type":"string"},"iptu_display":{"type":"string"},"neighborhood":{"type":"string"},"published_at":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"parking_spaces":{"type":"integer"},"publisher_name":{"type":"string"},"publisher_license":{"type":"string"},"condominium_display":{"type":"string"}}},"examples":{"Brooklin sale 2776423622, rent also shown on the page":{"value":{"id":"2776423622","url":"https://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/","area":186,"city":"São Paulo","iptu":917,"floor":null,"price":3710000,"title":"Apartamento com 3 Quartos à venda, 186m² - Brooklin","images":["https://resizedimgs.vivareal.com/img/vr-listing/c16fea316fbef741a3dacf22121412b1/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297","https://resizedimgs.vivareal.com/img/vr-listing/3b1700b6695469ff6130dfa4dd7bd29a/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/772a845f1483ec587b420c75499aa818/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/06b6bbfa2c04d465eb4a54cdbcfee39c/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/e506f5b4a8978baace21c4bb4f23dc68/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/e24557ae970e7c88d63c02b8b93bb285/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/63b359900c7910916c576ed5f4be5db5/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/6c0a7e3a7a3379307b2ea8fb4b6097aa/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/744030c65a06d4a9388c84533e965add/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/c32fdef988ec9e7d0ed932587c27926f/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/2bd6ca3a8550827912e07bda6ae41173/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/7d20899930ba3d5328037e10548f45df/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/86f08323d734c678a620939684eb2f40/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/b97f0b7f824e07809dc72d42aba01f0a/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/ee74d88e5f474ef6e5feed81a1ba3f57/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/4ac4e946324633e889cd85de017ef491/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/331c07bf790f8ce37a0f16b5b58a7fa6/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/f225ff8f910eb7d2b5867719134ae405/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false"],"suites":2,"address":"Rua Nova York, 161 - Brooklin, São Paulo - SP","bedrooms":3,"currency":"BRL","amenities":["Mobiliado","Aceita animais","Cozinha","Freezer","Escritório","Armário embutido"],"bathrooms":3,"image_url":"https://resizedimgs.vivareal.com/img/vr-listing/c16fea316fbef741a3dacf22121412b1/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297","operation":"sale","reference":"LR4127","state_code":"SP","condominium":2500,"description":"Apartamento alto padrão de 3 dormitórios sendo 1 suíte master com closet, home theater integrado, sala com living para 2 ambientes, cozinha totalmente planejada, sacada com vista livre e lazer completo no condominio. A permanência de animais de estimação no imóvel dependerá de avaliação e autorização expressa do proprietário. Conheça o Condomínio Nova York Penthouses, uma morada que reflete o espírito vibrante de São Paulo. Localizado na Rua Nova York, disponibiliza vários recursos para trazer comodidade e aconchego ao dia a dia dos moradores. Contando com portaria 24 horas, academia, piscina, quadra esportiva, salão de festas, gás encanado, playground, sauna, salão de jogos, brinquedoteca e espaço gourmet na área comum, o Condomínio Nova York Penthouses é preparado para atender às necessidades dos moradores que buscam lazer e conforto em um só lugar. A proximidade com DeRose Method Brooklin, Estação Campo Belo, Diko Pataca, Escola M. Dias, Beatíssima Virgem Maria e Escolinha das Acácias acrescenta praticidade e comodidade na rotina dos que residem no local. Atenção: Unidade sujeita a confirmação de valores e disponibilidade, sem aviso prévio.","iptu_display":"R$ 917","neighborhood":"Brooklin","published_at":"2025-02-03","price_display":"R$ 3.710.000","property_type":"apartment","parking_spaces":3,"publisher_name":"Lr Flats Imobiliária","publisher_license":"46905-J","condominium_display":"R$ 2.500/mês"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Viva Real Property","description":"Read one Viva Real property from its URL. The price follows the operation of that URL, so a sale link stays a sale price.\n\n**Credit cost:** 1 credit per call","operationId":"post-vivareal-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Viva Real listing URL under /imovel/ with an id- number.\n\n**Example:**\n\n```\nhttps://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/\n```\n\nA search URL returns 400. On a sale URL, price stays the sale price when the page also shows rent.","schema":{"type":"string","description":"Viva Real listing URL under /imovel/ with an id- number.\n\n**Example:**\n\n```\nhttps://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/\n```\n\nA search URL returns 400. On a sale URL, price stays the sale price when the page also shows rent."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"iptu":{"type":"integer"},"floor":{"nullable":true},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"suites":{"type":"integer"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"integer"},"image_url":{"type":"string"},"operation":{"type":"string"},"reference":{"type":"string"},"state_code":{"type":"string"},"condominium":{"type":"integer"},"description":{"type":"string"},"iptu_display":{"type":"string"},"neighborhood":{"type":"string"},"published_at":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"parking_spaces":{"type":"integer"},"publisher_name":{"type":"string"},"publisher_license":{"type":"string"},"condominium_display":{"type":"string"}}},"examples":{"Brooklin sale 2776423622, rent also shown on the page":{"value":{"id":"2776423622","url":"https://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/","area":186,"city":"São Paulo","iptu":917,"floor":null,"price":3710000,"title":"Apartamento com 3 Quartos à venda, 186m² - Brooklin","images":["https://resizedimgs.vivareal.com/img/vr-listing/c16fea316fbef741a3dacf22121412b1/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297","https://resizedimgs.vivareal.com/img/vr-listing/3b1700b6695469ff6130dfa4dd7bd29a/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/772a845f1483ec587b420c75499aa818/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/06b6bbfa2c04d465eb4a54cdbcfee39c/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/e506f5b4a8978baace21c4bb4f23dc68/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/e24557ae970e7c88d63c02b8b93bb285/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/63b359900c7910916c576ed5f4be5db5/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/6c0a7e3a7a3379307b2ea8fb4b6097aa/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/744030c65a06d4a9388c84533e965add/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/c32fdef988ec9e7d0ed932587c27926f/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/2bd6ca3a8550827912e07bda6ae41173/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/7d20899930ba3d5328037e10548f45df/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/86f08323d734c678a620939684eb2f40/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/b97f0b7f824e07809dc72d42aba01f0a/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/ee74d88e5f474ef6e5feed81a1ba3f57/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/4ac4e946324633e889cd85de017ef491/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/331c07bf790f8ce37a0f16b5b58a7fa6/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.vivareal.com/img/vr-listing/f225ff8f910eb7d2b5867719134ae405/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false"],"suites":2,"address":"Rua Nova York, 161 - Brooklin, São Paulo - SP","bedrooms":3,"currency":"BRL","amenities":["Mobiliado","Aceita animais","Cozinha","Freezer","Escritório","Armário embutido"],"bathrooms":3,"image_url":"https://resizedimgs.vivareal.com/img/vr-listing/c16fea316fbef741a3dacf22121412b1/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297","operation":"sale","reference":"LR4127","state_code":"SP","condominium":2500,"description":"Apartamento alto padrão de 3 dormitórios sendo 1 suíte master com closet, home theater integrado, sala com living para 2 ambientes, cozinha totalmente planejada, sacada com vista livre e lazer completo no condominio. A permanência de animais de estimação no imóvel dependerá de avaliação e autorização expressa do proprietário. Conheça o Condomínio Nova York Penthouses, uma morada que reflete o espírito vibrante de São Paulo. Localizado na Rua Nova York, disponibiliza vários recursos para trazer comodidade e aconchego ao dia a dia dos moradores. Contando com portaria 24 horas, academia, piscina, quadra esportiva, salão de festas, gás encanado, playground, sauna, salão de jogos, brinquedoteca e espaço gourmet na área comum, o Condomínio Nova York Penthouses é preparado para atender às necessidades dos moradores que buscam lazer e conforto em um só lugar. A proximidade com DeRose Method Brooklin, Estação Campo Belo, Diko Pataca, Escola M. Dias, Beatíssima Virgem Maria e Escolinha das Acácias acrescenta praticidade e comodidade na rotina dos que residem no local. Atenção: Unidade sujeita a confirmação de valores e disponibilidade, sem aviso prévio.","iptu_display":"R$ 917","neighborhood":"Brooklin","published_at":"2025-02-03","price_display":"R$ 3.710.000","property_type":"apartment","parking_spaces":3,"publisher_name":"Lr Flats Imobiliária","publisher_license":"46905-J","condominium_display":"R$ 2.500/mês"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/argenprop/property":{"get":{"summary":"Argenprop Property","description":"Read one Argenprop listing from its URL or id. You get price, address, rooms, expenses, and the agent when the page shows them.\n\n**Credit cost:** 1 credit per call","operationId":"get-argenprop-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The full listing page on argenprop.com. Copy it from results[].url on [Argenprop Search](https://www.piloterr.com/library/argenprop-search). The listing id is the number after the double dash.\n\nThe placeholder is listing 20724993, the apartment at Jerónimo Salguero 2700, Palermo Chico, asking USD 2.400.000, with 275 m² and 5 rooms.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993\n```\n\nListing 19017618, at Mansilla 4000, Palermo, asks USD 87.000 and prints building fees of $150.000.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-2-ambientes--19017618\n```\n\nSend the full listing URL. A bare id such as 20724993 is rejected. A results page such as /departamentos/venta/palermo belongs on search.\n","schema":{"type":"string","description":"The full listing page on argenprop.com. Copy it from results[].url on [Argenprop Search](https://www.piloterr.com/library/argenprop-search). The listing id is the number after the double dash.\n\nThe placeholder is listing 20724993, the apartment at Jerónimo Salguero 2700, Palermo Chico, asking USD 2.400.000, with 275 m² and 5 rooms.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993\n```\n\nListing 19017618, at Mansilla 4000, Palermo, asks USD 87.000 and prints building fees of $150.000.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-2-ambientes--19017618\n```\n\nSend the full listing URL. A bare id such as 20724993 is rejected. A results page such as /departamentos/venta/palermo belongs on search.\n"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"}}},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"garages":{"type":"integer"},"toilets":{"type":"integer"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"expenses":{"nullable":true},"latitude":{"type":"number"},"location":{"type":"string"},"services":{"type":"array","items":{"type":"string"}},"age_label":{"type":"string"},"age_years":{"type":"integer"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"integer"},"condition":{"type":"string"},"longitude":{"type":"number"},"operation":{"type":"string"},"video_url":{"type":"string"},"description":{"type":"string"},"disposition":{"type":"string"},"orientation":{"type":"string"},"photo_count":{"type":"integer"},"listing_code":{"type":"string"},"neighborhood":{"type":"string"},"pets_allowed":{"type":"boolean"},"price_display":{"type":"string"},"property_type":{"type":"string"},"total_area_m2":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"covered_area_m2":{"type":"integer"},"credit_eligible":{"type":"boolean"},"expenses_display":{"nullable":true},"general_features":{"type":"array","items":{"type":"string"}},"virtual_tour_url":{"type":"string"},"expenses_currency":{"nullable":true},"semi_covered_area_m2":{"nullable":true}}},"examples":{"Apartment at Jerónimo Salguero 2700":{"value":{"id":"20724993","url":"https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993","city":"Palermo","agent":{"url":"https://www.argenprop.com/inmobiliarias/lopez-castromil-propiedades","name":"Alex Martin","image":"https://www.argenprop.com/placeholder/example-user.jpg"},"price":2400000,"rooms":5,"title":"Torre bellini! piso alto! balcón c/espec vista panorámica! t/a nuevo! full amenities! 2 coch! único!","images":["https://www.argenprop.com/static-content/39942702/4792c440-1cec-4120-a78c-953e933e9303.jpg","https://www.argenprop.com/static-content/39942702/2fd7f06d-795b-4a7e-89da-8e774c1dfd1a_u_medium.jpg","https://www.argenprop.com/static-content/39942702/ebd2a079-0a5e-4504-8ae0-1ecd4e306330_u_medium.jpg","https://www.argenprop.com/static-content/39942702/30e833f3-5712-4d1b-ad92-67ae4a218396_u_medium.jpg","https://www.argenprop.com/static-content/39942702/e8924825-1f98-4086-bddd-1bc952a5e01e_u_medium.jpg"],"address":"Jerónimo Salguero 2700","garages":2,"toilets":1,"bedrooms":3,"currency":"USD","expenses":null,"latitude":-34.58001,"location":"Jerónimo Salguero 2700, Palermo, CABA, Capital Federal","services":["Agua corriente","Calefacción","Electricidad","Gas natural","Seguridad","Vigilancia"],"age_label":"17 años","age_years":17,"amenities":["Agua corriente","Aire acondicionado individual","Ascensor","Ascensores de servicio","Ascensores principales","Calefacción","Electricidad","Gas natural","Muebles de cocina"],"bathrooms":4,"condition":"Excelente","longitude":-58.40805,"operation":"venta","video_url":"https://www.youtube.com/embed/dKv144vnbbg?controls=0&rel=0","description":"TORRE BELLINI\nDE REVISTA!\nIMPECABLE PISO MUY ALTO!\nBALCóN CON ESPECTACULAR VISTA PANORáMICA A LA CIUDAD Y AL RíO!\nMuy luminoso!\nTodo luz y sol!\nExcelente distribución!\nTodo externo!\nDoble circulación!\nTODO A NUEVO!\nPalier privado!\nHall de entrada!\nGran living y comedor!\nToilette de recepción!\nSala de estar o playroom con habitación de guardado!\n1 Master suite con 2 vestidores!\n1 Dormitorio en suite!\n1 Dormitorio!\nBaño completo!\nMuchos placares!\nCocina completa!\nLavadero independiente!\nBaño de servicio!\nEntrada de servicio!\nFull Amenities: Piscina climatizada y solárium, jacuzzi y solárium en piso 37, gimnasio con vestuarios, sauna, sala de relax, SUM, parrilla, juegos para niños, espacio verde, microcine, jaulas de golf y laundry!\nCalefacción y aire acondicionado central con regulación individual!\nAberturas de aluminio con DVH!\n2 Cocheras fijas y cubiertas!\n2 Bauleras!\nGrupo electrógeno!\n3 Ascensores!\nEstacionamiento de cortesía!\nEl edificio cuenta con encargado y 2 ayudantes!\nVigilancia 24hs!\nAPTO CRéDITO!\nExcelente ubicación!\nLa mejor zona de Palermo!\nA metros de Av. Libertador y Plaza Alemania!\núNICO!\nOPORTUNIDAD!\n* Esta propiedad posee rampa de acceso para personas con movilidad reducida\n*Las descripciones, medidas, superficies y proporciones consignadas en esta ficha son aproximadas, sólo se muestran a modo orientativo. Los montos de expensas, tasas e impuestos deben ser confirmados ya que dependen de la fecha en la que se obtuvo la información.\n*Matrícula CUCICBA 2204","disposition":"Frente","orientation":"NE","photo_count":46,"listing_code":"PRO-68988-627452","neighborhood":"Palermo Chico","pets_allowed":true,"price_display":"USD 2.400.000","property_type":"departamento","total_area_m2":275,"characteristics":[{"name":"Cant. Ambientes","value":"5"},{"name":"Cant. Dormitorios","value":"3"},{"name":"Cant. Toilettes","value":"1"},{"name":"Cant. Baños","value":"4"},{"name":"Cant. Cocheras","value":"2"},{"name":"Estado","value":"Excelente"},{"name":"Antiguedad","value":"17"},{"name":"Disposición","value":"Frente"},{"name":"Orientación","value":"NE"},{"name":"Tipo de Unidad","value":"Departamento"},{"name":"Tipo de operación","value":"Venta"},{"name":"Precio","value":"USD 2.400.000"},{"name":"Sup. Cubierta","value":"275 m2"},{"name":"Sup. Total","value":"275 m2"}],"covered_area_m2":275,"credit_eligible":true,"expenses_display":null,"general_features":["Permite Mascotas"],"virtual_tour_url":"https://kuula.co/share/collection/7HVCw?logo=1&info=0&fs=1&vr=1&sd=1&initload=0&thumbs=1&inst=es","expenses_currency":null,"semi_covered_area_m2":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Argenprop Property","description":"Read one Argenprop listing from its URL or id. You get price, address, rooms, expenses, and the agent when the page shows them.\n\n**Credit cost:** 1 credit per call","operationId":"post-argenprop-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The full listing page on argenprop.com. Copy it from results[].url on [Argenprop Search](https://www.piloterr.com/library/argenprop-search). The listing id is the number after the double dash.\n\nThe placeholder is listing 20724993, the apartment at Jerónimo Salguero 2700, Palermo Chico, asking USD 2.400.000, with 275 m² and 5 rooms.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993\n```\n\nListing 19017618, at Mansilla 4000, Palermo, asks USD 87.000 and prints building fees of $150.000.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-2-ambientes--19017618\n```\n\nSend the full listing URL. A bare id such as 20724993 is rejected. A results page such as /departamentos/venta/palermo belongs on search.\n","schema":{"type":"string","description":"The full listing page on argenprop.com. Copy it from results[].url on [Argenprop Search](https://www.piloterr.com/library/argenprop-search). The listing id is the number after the double dash.\n\nThe placeholder is listing 20724993, the apartment at Jerónimo Salguero 2700, Palermo Chico, asking USD 2.400.000, with 275 m² and 5 rooms.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993\n```\n\nListing 19017618, at Mansilla 4000, Palermo, asks USD 87.000 and prints building fees of $150.000.\n\n```\nGET https://api.piloterr.com/v2/argenprop/property?query=https://www.argenprop.com/departamento-en-venta-en-palermo-2-ambientes--19017618\n```\n\nSend the full listing URL. A bare id such as 20724993 is rejected. A results page such as /departamentos/venta/palermo belongs on search.\n"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"}}},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"garages":{"type":"integer"},"toilets":{"type":"integer"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"expenses":{"nullable":true},"latitude":{"type":"number"},"location":{"type":"string"},"services":{"type":"array","items":{"type":"string"}},"age_label":{"type":"string"},"age_years":{"type":"integer"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"integer"},"condition":{"type":"string"},"longitude":{"type":"number"},"operation":{"type":"string"},"video_url":{"type":"string"},"description":{"type":"string"},"disposition":{"type":"string"},"orientation":{"type":"string"},"photo_count":{"type":"integer"},"listing_code":{"type":"string"},"neighborhood":{"type":"string"},"pets_allowed":{"type":"boolean"},"price_display":{"type":"string"},"property_type":{"type":"string"},"total_area_m2":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"covered_area_m2":{"type":"integer"},"credit_eligible":{"type":"boolean"},"expenses_display":{"nullable":true},"general_features":{"type":"array","items":{"type":"string"}},"virtual_tour_url":{"type":"string"},"expenses_currency":{"nullable":true},"semi_covered_area_m2":{"nullable":true}}},"examples":{"Apartment at Jerónimo Salguero 2700":{"value":{"id":"20724993","url":"https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993","city":"Palermo","agent":{"url":"https://www.argenprop.com/inmobiliarias/lopez-castromil-propiedades","name":"Alex Martin","image":"https://www.argenprop.com/placeholder/example-user.jpg"},"price":2400000,"rooms":5,"title":"Torre bellini! piso alto! balcón c/espec vista panorámica! t/a nuevo! full amenities! 2 coch! único!","images":["https://www.argenprop.com/static-content/39942702/4792c440-1cec-4120-a78c-953e933e9303.jpg","https://www.argenprop.com/static-content/39942702/2fd7f06d-795b-4a7e-89da-8e774c1dfd1a_u_medium.jpg","https://www.argenprop.com/static-content/39942702/ebd2a079-0a5e-4504-8ae0-1ecd4e306330_u_medium.jpg","https://www.argenprop.com/static-content/39942702/30e833f3-5712-4d1b-ad92-67ae4a218396_u_medium.jpg","https://www.argenprop.com/static-content/39942702/e8924825-1f98-4086-bddd-1bc952a5e01e_u_medium.jpg"],"address":"Jerónimo Salguero 2700","garages":2,"toilets":1,"bedrooms":3,"currency":"USD","expenses":null,"latitude":-34.58001,"location":"Jerónimo Salguero 2700, Palermo, CABA, Capital Federal","services":["Agua corriente","Calefacción","Electricidad","Gas natural","Seguridad","Vigilancia"],"age_label":"17 años","age_years":17,"amenities":["Agua corriente","Aire acondicionado individual","Ascensor","Ascensores de servicio","Ascensores principales","Calefacción","Electricidad","Gas natural","Muebles de cocina"],"bathrooms":4,"condition":"Excelente","longitude":-58.40805,"operation":"venta","video_url":"https://www.youtube.com/embed/dKv144vnbbg?controls=0&rel=0","description":"TORRE BELLINI\nDE REVISTA!\nIMPECABLE PISO MUY ALTO!\nBALCóN CON ESPECTACULAR VISTA PANORáMICA A LA CIUDAD Y AL RíO!\nMuy luminoso!\nTodo luz y sol!\nExcelente distribución!\nTodo externo!\nDoble circulación!\nTODO A NUEVO!\nPalier privado!\nHall de entrada!\nGran living y comedor!\nToilette de recepción!\nSala de estar o playroom con habitación de guardado!\n1 Master suite con 2 vestidores!\n1 Dormitorio en suite!\n1 Dormitorio!\nBaño completo!\nMuchos placares!\nCocina completa!\nLavadero independiente!\nBaño de servicio!\nEntrada de servicio!\nFull Amenities: Piscina climatizada y solárium, jacuzzi y solárium en piso 37, gimnasio con vestuarios, sauna, sala de relax, SUM, parrilla, juegos para niños, espacio verde, microcine, jaulas de golf y laundry!\nCalefacción y aire acondicionado central con regulación individual!\nAberturas de aluminio con DVH!\n2 Cocheras fijas y cubiertas!\n2 Bauleras!\nGrupo electrógeno!\n3 Ascensores!\nEstacionamiento de cortesía!\nEl edificio cuenta con encargado y 2 ayudantes!\nVigilancia 24hs!\nAPTO CRéDITO!\nExcelente ubicación!\nLa mejor zona de Palermo!\nA metros de Av. Libertador y Plaza Alemania!\núNICO!\nOPORTUNIDAD!\n* Esta propiedad posee rampa de acceso para personas con movilidad reducida\n*Las descripciones, medidas, superficies y proporciones consignadas en esta ficha son aproximadas, sólo se muestran a modo orientativo. Los montos de expensas, tasas e impuestos deben ser confirmados ya que dependen de la fecha en la que se obtuvo la información.\n*Matrícula CUCICBA 2204","disposition":"Frente","orientation":"NE","photo_count":46,"listing_code":"PRO-68988-627452","neighborhood":"Palermo Chico","pets_allowed":true,"price_display":"USD 2.400.000","property_type":"departamento","total_area_m2":275,"characteristics":[{"name":"Cant. Ambientes","value":"5"},{"name":"Cant. Dormitorios","value":"3"},{"name":"Cant. Toilettes","value":"1"},{"name":"Cant. Baños","value":"4"},{"name":"Cant. Cocheras","value":"2"},{"name":"Estado","value":"Excelente"},{"name":"Antiguedad","value":"17"},{"name":"Disposición","value":"Frente"},{"name":"Orientación","value":"NE"},{"name":"Tipo de Unidad","value":"Departamento"},{"name":"Tipo de operación","value":"Venta"},{"name":"Precio","value":"USD 2.400.000"},{"name":"Sup. Cubierta","value":"275 m2"},{"name":"Sup. Total","value":"275 m2"}],"covered_area_m2":275,"credit_eligible":true,"expenses_display":null,"general_features":["Permite Mascotas"],"virtual_tour_url":"https://kuula.co/share/collection/7HVCw?logo=1&info=0&fs=1&vr=1&sd=1&initload=0&thumbs=1&inst=es","expenses_currency":null,"semi_covered_area_m2":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zonaprop/property":{"get":{"summary":"ZonaProp Property","description":"Read one ZonaProp listing from its URL. You get the asking price in USD or ARS, the address, and the publisher.\n\n**Credit cost:** 2 credits per call","operationId":"get-zonaprop-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"ZonaProp listing URL under /propiedades/clasificado/.\n\n**Example:**\n\n```\nhttps://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html\n```\n\nA search URL or an emprendimiento URL returns 400.","schema":{"type":"string","description":"ZonaProp listing URL under /propiedades/clasificado/.\n\n**Example:**\n\n```\nhttps://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html\n```\n\nA search URL or an emprendimiento URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number"},"antiquity":{"type":"string"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"operation":{"type":"string"},"description":{"type":"string"},"area_display":{"type":"string"},"covered_area":{"type":"integer"},"neighborhood":{"type":"string"},"published_at":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"publisher_url":{"type":"string"},"publisher_name":{"type":"string"},"covered_area_display":{"type":"string"}}},"examples":{"Villa Crespo, Av. Estado de Israel 4620":{"value":{"id":"59096735","url":"https://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html","area":53,"city":"Capital Federal","image":"https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496641.jpg?isFirstImage=true","price":149773,"rooms":2,"title":"Venta Departamento 2 Ambientes Villa Crespo - Financiación","images":["https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496641.jpg?isFirstImage=true","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496645.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179751.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179759.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179761.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179756.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179753.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179750.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179754.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179757.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179762.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179764.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496631.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496602.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496597.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496617.jpg"],"address":"Av. Estado de Israel 4620","bedrooms":1,"currency":"USD","features":["Parrilla","Ascensor","Balcón","Living comedor"],"latitude":-34.6,"antiquity":"2","bathrooms":1,"longitude":-58.43,"operation":"venta","description":"VENTA DEPARTAMENTO 2 AMBIENTES EN VILLA CRESPO\nACEPTA CRIPTOMONEDAS\nACEPTA PERMUTA\nFINANCIACIÓN DISPONIBLE.\nEDIFICIO EN CONSTRUCCIÓN EN ETAPA DE TERMINACIONES. IDEAL INVERSIÓN, EXCELENTE CONECTIVIDAD. ENTREGA ESTIMADA PARA EL SEGUNDO SEMESTRE DE 2027.\nCONSULTANOS POR MÁS UNIDADES Y TIPOLOGÍAS DISPONIBLES DE DIFERENTES METRAJES Y VALORES.\nUBICACIÓN\n- A 200 mts de Av. Corrientes\n- A 350 mts de Av. Córdoba\n- A 400 mts de Av. Raúl Scalabrini Ortiz\n- A 600 mts de Av. Medrano\nEn cercanía de múltiples líneas de transporte\nMETRAJE\n- 48,70 m² Cubiertos\n- 53,55 m² Totales\nDEPARTAMENTO\n- 2 ambientes\n- Balcón\n- 1 dormitorio\n- 1 baño completo\n- Cocina integrada\nCARACTERÍSTICAS\n- Instalación preparada para aire acondicionado.\n- Agua caliente central.\n- Cocina amoblada con frente e interior en melamina y mesada de granito.\n- Anafe y horno eléctricos.\n- Grifería FV o similar.\n- Artefactos sanitarios Ferrum o similar.\n- Pisos de porcelanato en unidades y espacios comunes.\n- Carpintería de aluminio color negro con doble vidrio hermético (DVH).\n- Puertas interiores de madera.\n- Frentes e interiores de placard completos.\nAMENITIES\n- Parrilla con terraza\n- Laundry\n- Bicicletero\nPROYECTO\n- Edificio de 13 pisos.\n- 20 unidades con balcón.\n- Unidades de 1, 2 y 3 ambientes.\nTodas las propiedades que figuran en esta publicación se encuentran a cargo del profesional matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496 por lo tanto la intermediación y la conclusión de las operaciones serán llevadas exclusivamente por él. En cumplimiento de la Ley 10.973 de la Provincia de Buenos Aires, Ley Nacional 25.028, Ley Nacional 20.266, Ley 22.802 de Lealtad Comercial, Ley 24.240 de Defensa al Consumidor, las normas del Código Civil y Comercial de la Nación y Constitucionales, los asesores o agentes NO ejercen el corretaje inmobiliario. Todas las operaciones inmobiliarias son objeto de intermediación y conclusión por parte del martillero y corredor colegiado, cuyos datos se exhiben en el nombre de la inmobiliaria. Ley 5115: EXCEPTO que en la descripción de la propiedad se indique lo contrario, el edificio puede no contar con rampa para personas con movilidad reducida, y no ser Accesible para personas con discapacidades físicas. Las medidas son aproximadas, las reales surgen del título o plano de mensura. Las reservas se toman exclusivamente en la inmobiliaria con el matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496.\nJLY\n------------------------------------------------------------\nTodas las propiedades que figuran en esta publicación se encuentran a cargo del profesional matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496 por lo tanto la intermediación y la conclusión de las operaciones serán llevadas exclusivamente por él. En cumplimiento de la Ley 10.973 de la Provincia de Buenos Aires, Ley Nacional 25.028, Ley Nacional 20.266, Ley 22.802 de Lealtad Comercial, Ley 24.240 de Defensa al Consumidor, las normas del Código Civil y Comercial de la Nación y Constitucionales, los asesores o agentes NO ejercen el corretaje inmobiliario. Todas las operaciones inmobiliarias son objeto de intermediación y conclusión por parte del martillero y corredor colegiado, cuyos datos se exhiben en el nombre de la inmobiliaria. Ley 5115: EXCEPTO que en la descripción de la propiedad se indique lo contrario, el edificio puede no contar con rampa para personas con movilidad reducida, y no ser Accesible para personas con discapacidades físicas. Las medidas son aproximadas, las reales surgen del título o plano de mensura. Las reservas se toman exclusivamente en la inmobiliaria con el matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496\nBrian Levi y Martin Alvarez Matrícula CUCICBA 7924 l CPMAL 496 Todas las propiedades que figuran en esta publicación se encuentran a cargo del profesional matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMAL 496 por lo tanto la intermediación y la conclusión de las operaciones serán llevadas exclusivamente por él. En cumplimiento de la Ley 10.973 de la Provincia de Buenos Aires, Ley Nacional 25.028, Ley Nacional 20.266, Ley 22.802 de Lealtad Comercial, Ley 24.240 de Defensa al Consumidor, las normas del Código Civil y Comercial de la Nación y Constitucionales, los asesores o agentes NO ejercen el corretaje inmobiliario. Todas las operaciones inmobiliarias son objeto de intermediación y conclusión por parte del martillero y corredor colegiado, cuyos datos se exhiben en el nombre de la inmobiliaria. Ley 5115: EXCEPTO que en la descripción de la propiedad se indique lo contrario, el edificio puede no contar con rampa para personas con movilidad reducida, y no ser Accesible para personas con discapacidades físicas. Venta sujeta a la obtención del COTI por parte del propietario. Las medidas son aproximadas, las reales surgen del título o plano de mensura. Las reservas se toman exclusivamente en la inmobiliaria con el matriculado CUCICBA 7924 l CPMAL 496","area_display":"53 m² tot.","covered_area":48,"neighborhood":"Villa Crespo","published_at":"2026-05-12T22:30:30Z","price_display":"USD 149.773","property_type":"Apartamento","publisher_url":"https://www.zonaprop.com.ar/inmobiliarias/century-21-billion_30409994-inmuebles.html","publisher_name":"Century 21 Billion","covered_area_display":"48 m² cub."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ZonaProp Property","description":"Read one ZonaProp listing from its URL. You get the asking price in USD or ARS, the address, and the publisher.\n\n**Credit cost:** 2 credits per call","operationId":"post-zonaprop-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"ZonaProp listing URL under /propiedades/clasificado/.\n\n**Example:**\n\n```\nhttps://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html\n```\n\nA search URL or an emprendimiento URL returns 400.","schema":{"type":"string","description":"ZonaProp listing URL under /propiedades/clasificado/.\n\n**Example:**\n\n```\nhttps://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html\n```\n\nA search URL or an emprendimiento URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number"},"antiquity":{"type":"string"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"operation":{"type":"string"},"description":{"type":"string"},"area_display":{"type":"string"},"covered_area":{"type":"integer"},"neighborhood":{"type":"string"},"published_at":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"publisher_url":{"type":"string"},"publisher_name":{"type":"string"},"covered_area_display":{"type":"string"}}},"examples":{"Villa Crespo, Av. Estado de Israel 4620":{"value":{"id":"59096735","url":"https://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html","area":53,"city":"Capital Federal","image":"https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496641.jpg?isFirstImage=true","price":149773,"rooms":2,"title":"Venta Departamento 2 Ambientes Villa Crespo - Financiación","images":["https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496641.jpg?isFirstImage=true","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496645.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179751.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179759.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179761.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179756.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179753.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179750.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179754.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179757.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179762.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2070179764.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496631.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496602.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496597.jpg","https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/720x532/2052496617.jpg"],"address":"Av. Estado de Israel 4620","bedrooms":1,"currency":"USD","features":["Parrilla","Ascensor","Balcón","Living comedor"],"latitude":-34.6,"antiquity":"2","bathrooms":1,"longitude":-58.43,"operation":"venta","description":"VENTA DEPARTAMENTO 2 AMBIENTES EN VILLA CRESPO\nACEPTA CRIPTOMONEDAS\nACEPTA PERMUTA\nFINANCIACIÓN DISPONIBLE.\nEDIFICIO EN CONSTRUCCIÓN EN ETAPA DE TERMINACIONES. IDEAL INVERSIÓN, EXCELENTE CONECTIVIDAD. ENTREGA ESTIMADA PARA EL SEGUNDO SEMESTRE DE 2027.\nCONSULTANOS POR MÁS UNIDADES Y TIPOLOGÍAS DISPONIBLES DE DIFERENTES METRAJES Y VALORES.\nUBICACIÓN\n- A 200 mts de Av. Corrientes\n- A 350 mts de Av. Córdoba\n- A 400 mts de Av. Raúl Scalabrini Ortiz\n- A 600 mts de Av. Medrano\nEn cercanía de múltiples líneas de transporte\nMETRAJE\n- 48,70 m² Cubiertos\n- 53,55 m² Totales\nDEPARTAMENTO\n- 2 ambientes\n- Balcón\n- 1 dormitorio\n- 1 baño completo\n- Cocina integrada\nCARACTERÍSTICAS\n- Instalación preparada para aire acondicionado.\n- Agua caliente central.\n- Cocina amoblada con frente e interior en melamina y mesada de granito.\n- Anafe y horno eléctricos.\n- Grifería FV o similar.\n- Artefactos sanitarios Ferrum o similar.\n- Pisos de porcelanato en unidades y espacios comunes.\n- Carpintería de aluminio color negro con doble vidrio hermético (DVH).\n- Puertas interiores de madera.\n- Frentes e interiores de placard completos.\nAMENITIES\n- Parrilla con terraza\n- Laundry\n- Bicicletero\nPROYECTO\n- Edificio de 13 pisos.\n- 20 unidades con balcón.\n- Unidades de 1, 2 y 3 ambientes.\nTodas las propiedades que figuran en esta publicación se encuentran a cargo del profesional matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496 por lo tanto la intermediación y la conclusión de las operaciones serán llevadas exclusivamente por él. En cumplimiento de la Ley 10.973 de la Provincia de Buenos Aires, Ley Nacional 25.028, Ley Nacional 20.266, Ley 22.802 de Lealtad Comercial, Ley 24.240 de Defensa al Consumidor, las normas del Código Civil y Comercial de la Nación y Constitucionales, los asesores o agentes NO ejercen el corretaje inmobiliario. Todas las operaciones inmobiliarias son objeto de intermediación y conclusión por parte del martillero y corredor colegiado, cuyos datos se exhiben en el nombre de la inmobiliaria. Ley 5115: EXCEPTO que en la descripción de la propiedad se indique lo contrario, el edificio puede no contar con rampa para personas con movilidad reducida, y no ser Accesible para personas con discapacidades físicas. Las medidas son aproximadas, las reales surgen del título o plano de mensura. Las reservas se toman exclusivamente en la inmobiliaria con el matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496.\nJLY\n------------------------------------------------------------\nTodas las propiedades que figuran en esta publicación se encuentran a cargo del profesional matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496 por lo tanto la intermediación y la conclusión de las operaciones serán llevadas exclusivamente por él. En cumplimiento de la Ley 10.973 de la Provincia de Buenos Aires, Ley Nacional 25.028, Ley Nacional 20.266, Ley 22.802 de Lealtad Comercial, Ley 24.240 de Defensa al Consumidor, las normas del Código Civil y Comercial de la Nación y Constitucionales, los asesores o agentes NO ejercen el corretaje inmobiliario. Todas las operaciones inmobiliarias son objeto de intermediación y conclusión por parte del martillero y corredor colegiado, cuyos datos se exhiben en el nombre de la inmobiliaria. Ley 5115: EXCEPTO que en la descripción de la propiedad se indique lo contrario, el edificio puede no contar con rampa para personas con movilidad reducida, y no ser Accesible para personas con discapacidades físicas. Las medidas son aproximadas, las reales surgen del título o plano de mensura. Las reservas se toman exclusivamente en la inmobiliaria con el matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMCAL 496\nBrian Levi y Martin Alvarez Matrícula CUCICBA 7924 l CPMAL 496 Todas las propiedades que figuran en esta publicación se encuentran a cargo del profesional matriculado Brian Levi y Martin Alvarez, Matrícula CUCICBA 7924 l CPMAL 496 por lo tanto la intermediación y la conclusión de las operaciones serán llevadas exclusivamente por él. En cumplimiento de la Ley 10.973 de la Provincia de Buenos Aires, Ley Nacional 25.028, Ley Nacional 20.266, Ley 22.802 de Lealtad Comercial, Ley 24.240 de Defensa al Consumidor, las normas del Código Civil y Comercial de la Nación y Constitucionales, los asesores o agentes NO ejercen el corretaje inmobiliario. Todas las operaciones inmobiliarias son objeto de intermediación y conclusión por parte del martillero y corredor colegiado, cuyos datos se exhiben en el nombre de la inmobiliaria. Ley 5115: EXCEPTO que en la descripción de la propiedad se indique lo contrario, el edificio puede no contar con rampa para personas con movilidad reducida, y no ser Accesible para personas con discapacidades físicas. Venta sujeta a la obtención del COTI por parte del propietario. Las medidas son aproximadas, las reales surgen del título o plano de mensura. Las reservas se toman exclusivamente en la inmobiliaria con el matriculado CUCICBA 7924 l CPMAL 496","area_display":"53 m² tot.","covered_area":48,"neighborhood":"Villa Crespo","published_at":"2026-05-12T22:30:30Z","price_display":"USD 149.773","property_type":"Apartamento","publisher_url":"https://www.zonaprop.com.ar/inmobiliarias/century-21-billion_30409994-inmuebles.html","publisher_name":"Century 21 Billion","covered_area_display":"48 m² cub."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/olx/ad":{"get":{"summary":"OLX Ad","description":"Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name.\n\n**Credit cost:** 1 credit per call","operationId":"get-olx-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"OLX listing URL.\n\n**Example:**\n\n    https://www.olx.pl/d/oferta/apple-iphone-17-pro-256-gb-nowy-szczecin-zaplombowany-karta-sim-ul-baluki-4-szczecin-CID99-ID18Acsd.html","schema":{"type":"string","description":"OLX listing URL.\n\n**Example:**\n\n    https://www.olx.pl/d/oferta/apple-iphone-17-pro-256-gb-nowy-szczecin-zaplombowany-karta-sim-ul-baluki-4-szczecin-CID99-ID18Acsd.html"}},{"name":"region","in":"query","required":false,"description":"Ignored when query is a full URL. The host selects the country.\n\n**Example:**\n\n    pl","schema":{"type":"string","description":"Ignored when query is a full URL. The host selects the country.\n\n**Example:**\n\n    pl"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"location":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"district":{"type":"string"}}},"condition":{"type":"string"},"longitude":{"type":"number"},"seller_id":{"type":"integer"},"created_at":{"type":"string"},"negotiable":{"type":"boolean"},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"is_business":{"type":"boolean"},"is_promoted":{"type":"boolean"},"seller_name":{"type":"string"},"refreshed_at":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"iPhone 17 Pro on olx.pl":{"value":{"id":1042971205,"url":"https://www.olx.pl/d/oferta/apple-iphone-17-pro-256-gb-nowy-szczecin-zaplombowany-karta-sim-ul-baluki-4-szczecin-CID99-ID18Acsd.html","image":"https://ireland.apollo.olxcdn.com:443/v1/files/u7efs2w88qtt-PL/image;s=3024x4032","price":4999,"title":"Apple iPhone 17 Pro 256 Gb NOWY Szczecin Zaplombowany Karta sim | ul. Bałuki 4 Szczecin","images":["https://ireland.apollo.olxcdn.com:443/v1/files/u7efs2w88qtt-PL/image;s=3024x4032","https://ireland.apollo.olxcdn.com:443/v1/files/dcr4lxvv6iy5-PL/image;s=1254x1254","https://ireland.apollo.olxcdn.com:443/v1/files/35p9glqk148p3-PL/image;s=1086x1448"],"region":"pl","status":"active","currency":"PLN","latitude":53.43138,"location":{"city":"Szczecin","region":"Zachodniopomorskie","district":"Centrum"},"condition":"Nowe","longitude":14.54948,"seller_id":25081589,"created_at":"2025-12-06T18:02:46+01:00","negotiable":false,"parameters":[{"name":"Stan","value":"Nowe"},{"name":"Model telefonu","value":"iPhone 17 Pro"},{"name":"Wbudowana pamięć","value":"256GB"},{"name":"Opcje SIM","value":"Dual SIM (SIM + eSIM)"},{"name":"Funkcje","value":"Always on display, Rozpoznawanie twarzy, Szybkie ładowanie, Hot-Spot, Płatność NFC, Ładowanie indukcyjne"}],"breadcrumbs":[{"url":"https://www.olx.pl/","name":"Strona główna"},{"url":"https://www.olx.pl/elektronika/","name":"Elektronika"},{"url":"https://www.olx.pl/elektronika/telefony/","name":"Telefony"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/","name":"Smartfony i telefony komórkowe"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/","name":"iPhone"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/zachodniopomorskie/","name":"iPhone - Zachodniopomorskie"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/szczecin/","name":"iPhone - Szczecin"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/szczecin/?search%5Bdistrict_id%5D=731","name":"iPhone - Centrum"}],"description":"Apple iPhone 17 Pro 256 GB – , oryginalny produkt Apple Prezentowany telefon to w 100% oryginalny produkt firmy Apple. Urządzenie jest nowe – nieużywane, nieodnawiane, nienaprawiane i nieprzepakowywane. Wersja z dystrybucji europejskiej ze standardowym wejściem na KARTE SIM. Nie Obciążony ratami Najważniejsze informacje: Model: Apple iPhone 17 Pro Pojemność: 256 GB Kolor: zapytaj o dostępność Stan: nowy Gwarancja producenta 12 miesięcy Fabrycznie bez simlocka – działa z każdą siecią Polskie menu Brak blokad ratalnych i innych ograniczeń Szkło hartowane GRATIS Możliwość zabezpieczenia telefonu folią ochronną lub szkłem hartowanym na miejscu Zapłać mniej i zostaw swój stary telefon w rozliczeniu. Na telefony używane oferujemy 3 miesiące gwarancji. Na nowe iPhone – 12 miesięcy gwarancji, a na nowe urządzenia innych marek – aż 24 miesiące gwarancji. Zestaw zawiera: iPhone 17 Pro 256 GB Oryginalny kabel do ładowania Fabryczne pudełko (zgodne z numerem IMEI urządzenia) Dodatkowe informacje: Urządzenie nie było naprawiane ani aktywowane Pochodzi z oficjalnej dystrybucji Apple Możliwość odbioru osobistego w Szczecinie Przy zakupie wystawiamy potwierdzenie sprzedaży Dane kontaktowe i odbiór: GALAXY GSM PREMIUM ul. Edmunda Bałuki 4 70-464 Szczecin Godziny otwarcia: Poniedziałek – Piątek: 9:00 – 19:00 Sobota: 10:00 – 16:00","is_business":true,"is_promoted":true,"seller_name":"Alex Martin","refreshed_at":"2026-10-14T22:54:22+02:00","price_display":"4 999 zł"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"OLX Ad","description":"Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name.\n\n**Credit cost:** 1 credit per call","operationId":"post-olx-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"OLX listing URL.\n\n**Example:**\n\n    https://www.olx.pl/d/oferta/apple-iphone-17-pro-256-gb-nowy-szczecin-zaplombowany-karta-sim-ul-baluki-4-szczecin-CID99-ID18Acsd.html","schema":{"type":"string","description":"OLX listing URL.\n\n**Example:**\n\n    https://www.olx.pl/d/oferta/apple-iphone-17-pro-256-gb-nowy-szczecin-zaplombowany-karta-sim-ul-baluki-4-szczecin-CID99-ID18Acsd.html"}},{"name":"region","in":"query","required":false,"description":"Ignored when query is a full URL. The host selects the country.\n\n**Example:**\n\n    pl","schema":{"type":"string","description":"Ignored when query is a full URL. The host selects the country.\n\n**Example:**\n\n    pl"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"location":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"district":{"type":"string"}}},"condition":{"type":"string"},"longitude":{"type":"number"},"seller_id":{"type":"integer"},"created_at":{"type":"string"},"negotiable":{"type":"boolean"},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"is_business":{"type":"boolean"},"is_promoted":{"type":"boolean"},"seller_name":{"type":"string"},"refreshed_at":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"iPhone 17 Pro on olx.pl":{"value":{"id":1042971205,"url":"https://www.olx.pl/d/oferta/apple-iphone-17-pro-256-gb-nowy-szczecin-zaplombowany-karta-sim-ul-baluki-4-szczecin-CID99-ID18Acsd.html","image":"https://ireland.apollo.olxcdn.com:443/v1/files/u7efs2w88qtt-PL/image;s=3024x4032","price":4999,"title":"Apple iPhone 17 Pro 256 Gb NOWY Szczecin Zaplombowany Karta sim | ul. Bałuki 4 Szczecin","images":["https://ireland.apollo.olxcdn.com:443/v1/files/u7efs2w88qtt-PL/image;s=3024x4032","https://ireland.apollo.olxcdn.com:443/v1/files/dcr4lxvv6iy5-PL/image;s=1254x1254","https://ireland.apollo.olxcdn.com:443/v1/files/35p9glqk148p3-PL/image;s=1086x1448"],"region":"pl","status":"active","currency":"PLN","latitude":53.43138,"location":{"city":"Szczecin","region":"Zachodniopomorskie","district":"Centrum"},"condition":"Nowe","longitude":14.54948,"seller_id":25081589,"created_at":"2025-12-06T18:02:46+01:00","negotiable":false,"parameters":[{"name":"Stan","value":"Nowe"},{"name":"Model telefonu","value":"iPhone 17 Pro"},{"name":"Wbudowana pamięć","value":"256GB"},{"name":"Opcje SIM","value":"Dual SIM (SIM + eSIM)"},{"name":"Funkcje","value":"Always on display, Rozpoznawanie twarzy, Szybkie ładowanie, Hot-Spot, Płatność NFC, Ładowanie indukcyjne"}],"breadcrumbs":[{"url":"https://www.olx.pl/","name":"Strona główna"},{"url":"https://www.olx.pl/elektronika/","name":"Elektronika"},{"url":"https://www.olx.pl/elektronika/telefony/","name":"Telefony"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/","name":"Smartfony i telefony komórkowe"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/","name":"iPhone"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/zachodniopomorskie/","name":"iPhone - Zachodniopomorskie"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/szczecin/","name":"iPhone - Szczecin"},{"url":"https://www.olx.pl/elektronika/telefony/smartfony-telefony-komorkowe/iphone/szczecin/?search%5Bdistrict_id%5D=731","name":"iPhone - Centrum"}],"description":"Apple iPhone 17 Pro 256 GB – , oryginalny produkt Apple Prezentowany telefon to w 100% oryginalny produkt firmy Apple. Urządzenie jest nowe – nieużywane, nieodnawiane, nienaprawiane i nieprzepakowywane. Wersja z dystrybucji europejskiej ze standardowym wejściem na KARTE SIM. Nie Obciążony ratami Najważniejsze informacje: Model: Apple iPhone 17 Pro Pojemność: 256 GB Kolor: zapytaj o dostępność Stan: nowy Gwarancja producenta 12 miesięcy Fabrycznie bez simlocka – działa z każdą siecią Polskie menu Brak blokad ratalnych i innych ograniczeń Szkło hartowane GRATIS Możliwość zabezpieczenia telefonu folią ochronną lub szkłem hartowanym na miejscu Zapłać mniej i zostaw swój stary telefon w rozliczeniu. Na telefony używane oferujemy 3 miesiące gwarancji. Na nowe iPhone – 12 miesięcy gwarancji, a na nowe urządzenia innych marek – aż 24 miesiące gwarancji. Zestaw zawiera: iPhone 17 Pro 256 GB Oryginalny kabel do ładowania Fabryczne pudełko (zgodne z numerem IMEI urządzenia) Dodatkowe informacje: Urządzenie nie było naprawiane ani aktywowane Pochodzi z oficjalnej dystrybucji Apple Możliwość odbioru osobistego w Szczecinie Przy zakupie wystawiamy potwierdzenie sprzedaży Dane kontaktowe i odbiór: GALAXY GSM PREMIUM ul. Edmunda Bałuki 4 70-464 Szczecin Godziny otwarcia: Poniedziałek – Piątek: 9:00 – 19:00 Sobota: 10:00 – 16:00","is_business":true,"is_promoted":true,"seller_name":"Alex Martin","refreshed_at":"2026-10-14T22:54:22+02:00","price_display":"4 999 zł"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/olx/search":{"get":{"summary":"OLX Search","description":"Search OLX Brazil classifieds by keyword and get title, price, location, seller type, and condition as structured JSON in real time.\n\n**Credit cost:** 1 credit per call","operationId":"get-olx-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or phrase, as you would type it in the OLX search bar. Supports Portuguese terms for Brazilian inventory.\n\n**Example 1:**\n\n    iphone 14\n\n**Example 2:**\n\n    honda civic 2020\n\n**Example 3:**\n\n    apartamento centro são paulo","schema":{"type":"string","description":"Search keyword or phrase, as you would type it in the OLX search bar. Supports Portuguese terms for Brazilian inventory.\n\n**Example 1:**\n\n    iphone 14\n\n**Example 2:**\n\n    honda civic 2020\n\n**Example 3:**\n\n    apartamento centro são paulo"}},{"name":"category","in":"query","required":false,"description":"OLX category slug to restrict results to a specific vertical. Common values:\n\n- `eletronicos-e-celulares`: Electronics and phones\n- `autos-e-pecas`: Cars and auto parts\n- `imoveis`: Real estate\n- `eletrodomesticos`: Home appliances\n- `esportes-e-lazer`: Sports and leisure\n\n**Example:**\n\n    autos-e-pecas","schema":{"type":"string","description":"OLX category slug to restrict results to a specific vertical. Common values:\n\n- `eletronicos-e-celulares`: Electronics and phones\n- `autos-e-pecas`: Cars and auto parts\n- `imoveis`: Real estate\n- `eletrodomesticos`: Home appliances\n- `esportes-e-lazer`: Sports and leisure\n\n**Example:**\n\n    autos-e-pecas"}},{"name":"state","in":"query","required":false,"description":"Brazilian state abbreviation to filter results geographically.\n\n**Example:**\n\n    SP","schema":{"type":"string","description":"Brazilian state abbreviation to filter results geographically.\n\n**Example:**\n\n    SP"}},{"name":"city","in":"query","required":false,"description":"City slug to narrow results to a specific municipality. Use lowercase with hyphens.\n\n**Example:**\n\n    sao-paulo","schema":{"type":"string","description":"City slug to narrow results to a specific municipality. Use lowercase with hyphens.\n\n**Example:**\n\n    sao-paulo"}},{"name":"min_price","in":"query","required":false,"description":"Minimum listing price in BRL.\n\n**Example:**\n\n    500","schema":{"type":"number","description":"Minimum listing price in BRL.\n\n**Example:**\n\n    500"}},{"name":"max_price","in":"query","required":false,"description":"Maximum listing price in BRL.\n\n**Example:**\n\n    5000","schema":{"type":"number","description":"Maximum listing price in BRL.\n\n**Example:**\n\n    5000"}},{"name":"seller_type","in":"query","required":false,"description":"Filter by seller type.\n\n- `particular`: Private individual sellers\n- `profissional`: Professional/business sellers\n\nLeave empty to return both.","schema":{"type":"string","description":"Filter by seller type.\n\n- `particular`: Private individual sellers\n- `profissional`: Professional/business sellers\n\nLeave empty to return both."}},{"name":"sort","in":"query","required":false,"description":"Sort order for results.\n\n- `relevance`: Most relevant first (default)\n- `date`: Most recent listings first\n- `price_asc`: Lowest price first\n- `price_desc`: Highest price first","schema":{"type":"string","default":"relevance","description":"Sort order for results.\n\n- `relevance`: Most relevant first (default)\n- `date`: Most recent listings first\n- `price_asc`: Lowest price first\n- `price_desc`: Highest price first"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated results. **Default: 1.**\n\n**Example:**\n\n    2","schema":{"type":"number","default":"1","description":"Page number for paginated results. **Default: 1.**\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"featured":{"type":"boolean"},"location":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"}}},"condition":{"type":"string"},"thumbnail":{"type":"string"},"category_id":{"type":"string"},"seller_type":{"type":"string"},"installments":{"type":"object","properties":{"amount":{"type":"number"},"quantity":{"type":"integer"}}},"published_at":{"type":"string"},"free_shipping":{"type":"boolean"},"original_price":{"type":"integer"}}}},"total_results":{"type":"integer"},"results_per_page":{"type":"integer"}}},"examples":{"Search for 'iphone 14'":{"value":{"page":1,"results":[{"id":"902901124","url":"https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html","price":3200,"title":"iPhone 14 128GB Como Novo","images":["https://img.olx.com.br/images/902901124_1.jpg","https://img.olx.com.br/images/902901124_2.jpg"],"category":"Celulares e Smartphones","featured":false,"location":{"city":"São Paulo","state":"SP"},"condition":"usado","thumbnail":"https://img.olx.com.br/images/902901124_1_thumb.jpg","category_id":"3486","seller_type":"particular","installments":{"amount":1066.67,"quantity":3},"published_at":"2026-04-29T14:35:00.000Z","free_shipping":false,"original_price":3800},{"id":"893412874","url":"https://www.olx.com.br/iphone-14-pro-256gb-roxo-lacrado-IDJ2kPr.html","price":4900,"title":"iPhone 14 Pro 256GB Roxo Lacrado","images":["https://img.olx.com.br/images/893412874_1.jpg","https://img.olx.com.br/images/893412874_2.jpg"],"category":"Celulares e Smartphones","featured":true,"location":{"city":"Rio de Janeiro","state":"RJ"},"condition":"novo","thumbnail":"https://img.olx.com.br/images/893412874_1_thumb.jpg","category_id":"3486","seller_type":"profissional","installments":{"amount":490,"quantity":10},"published_at":"2026-04-29T10:12:00.000Z","free_shipping":true,"original_price":null}],"total_results":8432,"results_per_page":25}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"OLX Search","description":"Search OLX Brazil classifieds by keyword and get title, price, location, seller type, and condition as structured JSON in real time.\n\n**Credit cost:** 1 credit per call","operationId":"post-olx-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or phrase, as you would type it in the OLX search bar. Supports Portuguese terms for Brazilian inventory.\n\n**Example 1:**\n\n    iphone 14\n\n**Example 2:**\n\n    honda civic 2020\n\n**Example 3:**\n\n    apartamento centro são paulo","schema":{"type":"string","description":"Search keyword or phrase, as you would type it in the OLX search bar. Supports Portuguese terms for Brazilian inventory.\n\n**Example 1:**\n\n    iphone 14\n\n**Example 2:**\n\n    honda civic 2020\n\n**Example 3:**\n\n    apartamento centro são paulo"}},{"name":"category","in":"query","required":false,"description":"OLX category slug to restrict results to a specific vertical. Common values:\n\n- `eletronicos-e-celulares`: Electronics and phones\n- `autos-e-pecas`: Cars and auto parts\n- `imoveis`: Real estate\n- `eletrodomesticos`: Home appliances\n- `esportes-e-lazer`: Sports and leisure\n\n**Example:**\n\n    autos-e-pecas","schema":{"type":"string","description":"OLX category slug to restrict results to a specific vertical. Common values:\n\n- `eletronicos-e-celulares`: Electronics and phones\n- `autos-e-pecas`: Cars and auto parts\n- `imoveis`: Real estate\n- `eletrodomesticos`: Home appliances\n- `esportes-e-lazer`: Sports and leisure\n\n**Example:**\n\n    autos-e-pecas"}},{"name":"state","in":"query","required":false,"description":"Brazilian state abbreviation to filter results geographically.\n\n**Example:**\n\n    SP","schema":{"type":"string","description":"Brazilian state abbreviation to filter results geographically.\n\n**Example:**\n\n    SP"}},{"name":"city","in":"query","required":false,"description":"City slug to narrow results to a specific municipality. Use lowercase with hyphens.\n\n**Example:**\n\n    sao-paulo","schema":{"type":"string","description":"City slug to narrow results to a specific municipality. Use lowercase with hyphens.\n\n**Example:**\n\n    sao-paulo"}},{"name":"min_price","in":"query","required":false,"description":"Minimum listing price in BRL.\n\n**Example:**\n\n    500","schema":{"type":"number","description":"Minimum listing price in BRL.\n\n**Example:**\n\n    500"}},{"name":"max_price","in":"query","required":false,"description":"Maximum listing price in BRL.\n\n**Example:**\n\n    5000","schema":{"type":"number","description":"Maximum listing price in BRL.\n\n**Example:**\n\n    5000"}},{"name":"seller_type","in":"query","required":false,"description":"Filter by seller type.\n\n- `particular`: Private individual sellers\n- `profissional`: Professional/business sellers\n\nLeave empty to return both.","schema":{"type":"string","description":"Filter by seller type.\n\n- `particular`: Private individual sellers\n- `profissional`: Professional/business sellers\n\nLeave empty to return both."}},{"name":"sort","in":"query","required":false,"description":"Sort order for results.\n\n- `relevance`: Most relevant first (default)\n- `date`: Most recent listings first\n- `price_asc`: Lowest price first\n- `price_desc`: Highest price first","schema":{"type":"string","default":"relevance","description":"Sort order for results.\n\n- `relevance`: Most relevant first (default)\n- `date`: Most recent listings first\n- `price_asc`: Lowest price first\n- `price_desc`: Highest price first"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated results. **Default: 1.**\n\n**Example:**\n\n    2","schema":{"type":"number","default":"1","description":"Page number for paginated results. **Default: 1.**\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"featured":{"type":"boolean"},"location":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"}}},"condition":{"type":"string"},"thumbnail":{"type":"string"},"category_id":{"type":"string"},"seller_type":{"type":"string"},"installments":{"type":"object","properties":{"amount":{"type":"number"},"quantity":{"type":"integer"}}},"published_at":{"type":"string"},"free_shipping":{"type":"boolean"},"original_price":{"type":"integer"}}}},"total_results":{"type":"integer"},"results_per_page":{"type":"integer"}}},"examples":{"Search for 'iphone 14'":{"value":{"page":1,"results":[{"id":"902901124","url":"https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html","price":3200,"title":"iPhone 14 128GB Como Novo","images":["https://img.olx.com.br/images/902901124_1.jpg","https://img.olx.com.br/images/902901124_2.jpg"],"category":"Celulares e Smartphones","featured":false,"location":{"city":"São Paulo","state":"SP"},"condition":"usado","thumbnail":"https://img.olx.com.br/images/902901124_1_thumb.jpg","category_id":"3486","seller_type":"particular","installments":{"amount":1066.67,"quantity":3},"published_at":"2026-04-29T14:35:00.000Z","free_shipping":false,"original_price":3800},{"id":"893412874","url":"https://www.olx.com.br/iphone-14-pro-256gb-roxo-lacrado-IDJ2kPr.html","price":4900,"title":"iPhone 14 Pro 256GB Roxo Lacrado","images":["https://img.olx.com.br/images/893412874_1.jpg","https://img.olx.com.br/images/893412874_2.jpg"],"category":"Celulares e Smartphones","featured":true,"location":{"city":"Rio de Janeiro","state":"RJ"},"condition":"novo","thumbnail":"https://img.olx.com.br/images/893412874_1_thumb.jpg","category_id":"3486","seller_type":"profissional","installments":{"amount":490,"quantity":10},"published_at":"2026-04-29T10:12:00.000Z","free_shipping":true,"original_price":null}],"total_results":8432,"results_per_page":25}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/argos/product":{"get":{"summary":"Argos Product","description":"Argos Product API: one UK product by id or URL. Browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-argos-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Argos product id or product URL.","schema":{"type":"string","description":"Argos product id or product URL."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"rating":{"type":"number"},"seller":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"shipping_price":{"type":"number"}}},"examples":{"Lenovo IdeaPad Slim3 9637285":{"value":{"id":"9637285","url":"https://www.argos.co.uk/product/9637285","brand":"Lenovo","price":369,"title":"Lenovo IdeaPad Slim3 15in 4GB 128GB Laptop","rating":4.67,"seller":"Argos","currency":"GBP","condition":"new","review_count":3,"price_display":"£369.00","shipping_price":4.95}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Argos Product","description":"Argos Product API: one UK product by id or URL. Browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-argos-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Argos product id or product URL.","schema":{"type":"string","description":"Argos product id or product URL."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"rating":{"type":"number"},"seller":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"shipping_price":{"type":"number"}}},"examples":{"Lenovo IdeaPad Slim3 9637285":{"value":{"id":"9637285","url":"https://www.argos.co.uk/product/9637285","brand":"Lenovo","price":369,"title":"Lenovo IdeaPad Slim3 15in 4GB 128GB Laptop","rating":4.67,"seller":"Argos","currency":"GBP","condition":"new","review_count":3,"price_display":"£369.00","shipping_price":4.95}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/argos/search":{"get":{"summary":"Argos Search","description":"Search the Argos UK catalogue by keyword and page the results. Prices are in pounds. A one-word query that Argos turns into a brand page with no product cards returns no results.\n\n**Credit cost:** 2 credits per call","operationId":"get-argos-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or Argos UK search URL.","schema":{"type":"string","description":"Keyword or Argos UK search URL."}},{"name":"page","in":"query","required":false,"description":"Page number from 1.","schema":{"type":"number","minimum":1,"description":"Page number from 1."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"delivery":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"special_offer":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Laptop search on argos.co.uk":{"value":{"results":[{"id":"9637285","url":"https://www.argos.co.uk/product/9637285","image":"https://media.4rgos.it/s/Argos/9637285_R_SET/1?w=540&h=540&qlt=75&fmt=webp","price":369,"title":"Lenovo IdeaPad Slim3 15in 4GB 128GB Laptop","rating":4.67,"currency":"GBP","delivery":"Free collection or standard delivery","review_count":3,"price_display":"£369.00","special_offer":null}],"pagination":{"next":"https://www.argos.co.uk/search/laptop/opt/page:2/","page":1,"per_page":60,"total_pages":8,"total_results":449}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Argos Search","description":"Search the Argos UK catalogue by keyword and page the results. Prices are in pounds. A one-word query that Argos turns into a brand page with no product cards returns no results.\n\n**Credit cost:** 2 credits per call","operationId":"post-argos-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or Argos UK search URL.","schema":{"type":"string","description":"Keyword or Argos UK search URL."}},{"name":"page","in":"query","required":false,"description":"Page number from 1.","schema":{"type":"number","minimum":1,"description":"Page number from 1."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"delivery":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"special_offer":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Laptop search on argos.co.uk":{"value":{"results":[{"id":"9637285","url":"https://www.argos.co.uk/product/9637285","image":"https://media.4rgos.it/s/Argos/9637285_R_SET/1?w=540&h=540&qlt=75&fmt=webp","price":369,"title":"Lenovo IdeaPad Slim3 15in 4GB 128GB Laptop","rating":4.67,"currency":"GBP","delivery":"Free collection or standard delivery","review_count":3,"price_display":"£369.00","special_offer":null}],"pagination":{"next":"https://www.argos.co.uk/search/laptop/opt/page:2/","page":1,"per_page":60,"total_pages":8,"total_results":449}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/mediamarkt/search":{"get":{"summary":"MediaMarkt Search","description":"Search a MediaMarkt shop by keyword. Set region for Switzerland, Germany, Austria, and the other MediaMarktSaturn countries, then page the results.\n\n**Credit cost:** 2 credits per call","operationId":"get-mediamarkt-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or MediaMarkt URL. Example: iphone","schema":{"type":"string","description":"Keyword or MediaMarkt URL. Example: iphone"}},{"name":"region","in":"query","required":false,"description":"Shop code. Example: ch-fr or de. Default ch-fr. Ignored when query is a full URL.","schema":{"type":"string","description":"Shop code. Example: ch-fr or de. Default ch-fr. Ignored when query is a full URL."}},{"name":"page","in":"query","required":false,"description":"Page number from 1. Example: 1","schema":{"type":"number","minimum":1,"description":"Page number from 1. Example: 1"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"locale":{"type":"string"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"availability":{"type":"string"},"energy_class":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"shipping_cost":{"type":"integer"},"is_marketplace":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"iPhone search on mediamarkt.ch/fr":{"value":{"results":[{"id":"2203371","ean":"0195949036064","url":"https://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html","name":"APPLE iPhone 15 128 GB Black Dual SIM","brand":"APPLE","image":"https://assets.mmsrg.com/isr/166325/c1/-/ASSET_MMS_118271101","price":629,"locale":"fr-CH","rating":4.69,"region":"ch-fr","currency":"CHF","availability":"available","energy_class":"B","review_count":391,"price_display":"CHF 629.00","shipping_cost":0,"is_marketplace":false}],"pagination":{"next":"https://www.mediamarkt.ch/fr/category/apple-iphones-789083.html?page=2","page":1,"per_page":12,"total_pages":43,"total_results":511}}},"HDMI search on mediamarkt.de":{"value":{"results":[{"id":"2784029","ean":"4049011177437","url":"https://www.mediamarkt.de/de/product/_isy-ihd-3400-hdmi-kabel-3-m-2784029.html","name":"ISY IHD-3400, High Speed HDMI-Kabel, 3 m","brand":"ISY","image":"https://assets.mmsrg.com/isr/166325/c1/-/ASSET_MMS_92199048","price":12.99,"locale":"de-DE","rating":4.86,"region":"de","currency":"EUR","availability":"available","review_count":28,"price_display":"12,99 €","shipping_cost":2.99,"is_marketplace":false,"specifications":[{"name":"Produkttyp","value":"High Speed HDMI-Kabel"},{"name":"Anschluss A","value":"HDMI"}]}],"pagination":{"next":"https://www.mediamarkt.de/de/search.html?query=hdmi&page=2","page":1,"per_page":12,"total_pages":4190,"total_results":50273}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"MediaMarkt Search","description":"Search a MediaMarkt shop by keyword. Set region for Switzerland, Germany, Austria, and the other MediaMarktSaturn countries, then page the results.\n\n**Credit cost:** 2 credits per call","operationId":"post-mediamarkt-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or MediaMarkt URL. Example: iphone","schema":{"type":"string","description":"Keyword or MediaMarkt URL. Example: iphone"}},{"name":"region","in":"query","required":false,"description":"Shop code. Example: ch-fr or de. Default ch-fr. Ignored when query is a full URL.","schema":{"type":"string","description":"Shop code. Example: ch-fr or de. Default ch-fr. Ignored when query is a full URL."}},{"name":"page","in":"query","required":false,"description":"Page number from 1. Example: 1","schema":{"type":"number","minimum":1,"description":"Page number from 1. Example: 1"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"locale":{"type":"string"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"availability":{"type":"string"},"energy_class":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"shipping_cost":{"type":"integer"},"is_marketplace":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"iPhone search on mediamarkt.ch/fr":{"value":{"results":[{"id":"2203371","ean":"0195949036064","url":"https://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html","name":"APPLE iPhone 15 128 GB Black Dual SIM","brand":"APPLE","image":"https://assets.mmsrg.com/isr/166325/c1/-/ASSET_MMS_118271101","price":629,"locale":"fr-CH","rating":4.69,"region":"ch-fr","currency":"CHF","availability":"available","energy_class":"B","review_count":391,"price_display":"CHF 629.00","shipping_cost":0,"is_marketplace":false}],"pagination":{"next":"https://www.mediamarkt.ch/fr/category/apple-iphones-789083.html?page=2","page":1,"per_page":12,"total_pages":43,"total_results":511}}},"HDMI search on mediamarkt.de":{"value":{"results":[{"id":"2784029","ean":"4049011177437","url":"https://www.mediamarkt.de/de/product/_isy-ihd-3400-hdmi-kabel-3-m-2784029.html","name":"ISY IHD-3400, High Speed HDMI-Kabel, 3 m","brand":"ISY","image":"https://assets.mmsrg.com/isr/166325/c1/-/ASSET_MMS_92199048","price":12.99,"locale":"de-DE","rating":4.86,"region":"de","currency":"EUR","availability":"available","review_count":28,"price_display":"12,99 €","shipping_cost":2.99,"is_marketplace":false,"specifications":[{"name":"Produkttyp","value":"High Speed HDMI-Kabel"},{"name":"Anschluss A","value":"HDMI"}]}],"pagination":{"next":"https://www.mediamarkt.de/de/search.html?query=hdmi&page=2","page":1,"per_page":12,"total_pages":4190,"total_results":50273}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/mediamarkt/product":{"get":{"summary":"MediaMarkt Product","description":"Read one MediaMarkt product by id or product URL, in the region you choose. You get price, currency, EAN, and availability.\n\n**Credit cost:** 2 credits per call","operationId":"get-mediamarkt-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or article id.\n```\nhttps://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html\n```","schema":{"type":"string","description":"Product URL or article id.\n```\nhttps://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html\n```"}},{"name":"region","in":"query","required":false,"description":"Shop code when query is an article id. Example: ch-fr. Default ch-fr.","schema":{"type":"string","description":"Shop code when query is an article id. Example: ch-fr. Default ch-fr."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"locale":{"type":"string"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"vat_rate":{"type":"number"},"condition":{"type":"string"},"price_note":{"type":"string"},"availability":{"type":"string"},"energy_class":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"shipping_cost":{"type":"integer"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"APPLE iPhone 15 on mediamarkt.ch/fr":{"value":{"id":"2203371","ean":"0195949036064","sku":"2203371","url":"https://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html","name":"APPLE iPhone 15 128 GB Black Dual SIM","brand":"APPLE","image":"https://assets.mmsrg.com/isr/166325/c1/-/ASSET_MMS_118271101","price":629,"locale":"fr-CH","rating":4.69,"region":"ch-fr","currency":"CHF","vat_rate":0.08,"condition":"new","price_note":"TVA incluse sans frais d'envoi","availability":"available","energy_class":"B","review_count":391,"price_display":"CHF 629.00","shipping_cost":0,"specifications":[{"name":"Type de produit","group":"Caractéristiques techniques","value":"Smartphone"},{"name":"Système d'exploitation","group":"Caractéristiques techniques","value":"iOS"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"MediaMarkt Product","description":"Read one MediaMarkt product by id or product URL, in the region you choose. You get price, currency, EAN, and availability.\n\n**Credit cost:** 2 credits per call","operationId":"post-mediamarkt-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or article id.\n```\nhttps://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html\n```","schema":{"type":"string","description":"Product URL or article id.\n```\nhttps://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html\n```"}},{"name":"region","in":"query","required":false,"description":"Shop code when query is an article id. Example: ch-fr. Default ch-fr.","schema":{"type":"string","description":"Shop code when query is an article id. Example: ch-fr. Default ch-fr."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"locale":{"type":"string"},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"vat_rate":{"type":"number"},"condition":{"type":"string"},"price_note":{"type":"string"},"availability":{"type":"string"},"energy_class":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"shipping_cost":{"type":"integer"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"APPLE iPhone 15 on mediamarkt.ch/fr":{"value":{"id":"2203371","ean":"0195949036064","sku":"2203371","url":"https://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html","name":"APPLE iPhone 15 128 GB Black Dual SIM","brand":"APPLE","image":"https://assets.mmsrg.com/isr/166325/c1/-/ASSET_MMS_118271101","price":629,"locale":"fr-CH","rating":4.69,"region":"ch-fr","currency":"CHF","vat_rate":0.08,"condition":"new","price_note":"TVA incluse sans frais d'envoi","availability":"available","energy_class":"B","review_count":391,"price_display":"CHF 629.00","shipping_cost":0,"specifications":[{"name":"Type de produit","group":"Caractéristiques techniques","value":"Smartphone"},{"name":"Système d'exploitation","group":"Caractéristiques techniques","value":"iOS"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/coolblue/product":{"get":{"summary":"Coolblue Product","description":"Read one Coolblue product by article id or product URL, in the region of that shop.\n\n**Credit cost:** 1 credit per call","operationId":"get-coolblue-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product link, or the article number.\n\n**Link:**\n\n```\nhttps://www.coolblue.be/nl/product/905648/sony-wh-1000xm5-zwart.html\n```\n\n**Article number:**\n\n```\n905648\n```\n\nUse region nl, de, or be-fr to open that number on another shop. A search link is rejected.","schema":{"type":"string","description":"Product link, or the article number.\n\n**Link:**\n\n```\nhttps://www.coolblue.be/nl/product/905648/sony-wh-1000xm5-zwart.html\n```\n\n**Article number:**\n\n```\n905648\n```\n\nUse region nl, de, or be-fr to open that number on another shop. A search link is rejected."}},{"name":"region","in":"query","required":false,"description":"Shop for a bare article number.\n\n- be: Belgium, Dutch (default). Example: 905648\n- nl: Netherlands\n- de: Germany\n- be-fr: Belgium, French\n\nbe-en, nl-en, and de-en open the English pages. A full product link picks the shop from the address.","schema":{"type":"string","description":"Shop for a bare article number.\n\n- be: Belgium, Dutch (default). Example: 905648\n- nl: Netherlands\n- de: Germany\n- be-fr: Belgium, French\n\nbe-en, nl-en, and de-en open the English pages. A full product link picks the shop from the address."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"cons":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"title":{"nullable":true}}}},"name":{"type":"string"},"pros":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"title":{"nullable":true}}}},"brand":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"in_the_box":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"included_note":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}},"manufacturer_code":{"type":"string"},"availability_label":{"type":"string"}}},"examples":{"Sony WH-1000XM5 Zwart, Belgium":{"value":{"sku":"905648","url":"https://www.coolblue.be/nl/product/905648/sony-wh-1000xm5-zwart.html","cons":[{"text":"Je vouwt de koptelefoon niet compact op.","title":null}],"name":"Sony WH-1000XM5 Zwart","pros":[{"text":"Dankzij de topklasse noise cancelling wordt omgevingsgeluid sterk gedempt.","title":null},{"text":"Met de Sony Headphones Connect app personaliseer je het geluid via een equalizer.","title":null},{"text":"Dankzij de snellaadfunctie gebruik je na 3 minuten opladen de koptelefoon voor 3 uur.","title":null}],"brand":"Sony","price":249,"images":["https://image.coolblue.nl/500x500/products/1755757","https://image.coolblue.nl/480x360/products/1755757","https://image.coolblue.nl/512x288/products/1755757"],"rating":8.8,"region":"be","currency":"EUR","language":"nl","condition":"new","image_url":"https://image.coolblue.nl/500x500/products/1755757","in_the_box":["Handleiding ( 3.02 MB)","Opberghoes (hardcase)","Usb C naar usb A oplaadkabel (exclusief oplader)","Audiokabel"],"product_id":"905648","breadcrumbs":["Portable audio","Koptelefoons","Sony koptelefoons","Sony WH koptelefoons"],"description":"De Sony WH-1000XM5 Zwart is een draadloze koptelefoon met topklasse noise cancelling. Dankzij de 2 noise cancelling processors dempt de koptelefoon omgevingsgeluid zeer precies. Zo heb je minder last van je omgeving en zet je het volume van de muziek niet onnodig hard. In de Sony Headphones Connect app personaliseer je de geluidsweergave via een equalizer. Hierdoor voeg je een accent toe aan de lage tonen en luister je naar het geluid dat jij mooi vindt. Op een volle lading gaat de koptelefoon 30 uur mee. Is de batterij leeg? Na 3 minuten opladen gebruik je de koptelefoon voor 3 uur.","availability":"in_stock","review_count":404,"included_note":"Geen oplader meegeleverd","price_display":"249,00 €","specifications":[{"name":"Artikelnummer","group":"Product","value":"905648"},{"name":"Fabrikantcode","group":"Product","value":"WH1000XM5B.CE7"},{"name":"Merk","group":"Product","value":"Sony"},{"name":"Garantie","group":"Product","value":"2 jaar"},{"name":"Noise cancelling","group":"Geluid","value":"Ja"},{"name":"Kwaliteit noise cancelling","group":"Geluid","value":"Topklasse"},{"name":"Bluetooth-versie","group":"Verbinding","value":"5.2"},{"name":"Type oorkussen","group":"Behuizing","value":"Over ear"}],"manufacturer_code":"WH1000XM5B.CE7","availability_label":"Morgen geleverd"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Coolblue Product","description":"Read one Coolblue product by article id or product URL, in the region of that shop.\n\n**Credit cost:** 1 credit per call","operationId":"post-coolblue-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product link, or the article number.\n\n**Link:**\n\n```\nhttps://www.coolblue.be/nl/product/905648/sony-wh-1000xm5-zwart.html\n```\n\n**Article number:**\n\n```\n905648\n```\n\nUse region nl, de, or be-fr to open that number on another shop. A search link is rejected.","schema":{"type":"string","description":"Product link, or the article number.\n\n**Link:**\n\n```\nhttps://www.coolblue.be/nl/product/905648/sony-wh-1000xm5-zwart.html\n```\n\n**Article number:**\n\n```\n905648\n```\n\nUse region nl, de, or be-fr to open that number on another shop. A search link is rejected."}},{"name":"region","in":"query","required":false,"description":"Shop for a bare article number.\n\n- be: Belgium, Dutch (default). Example: 905648\n- nl: Netherlands\n- de: Germany\n- be-fr: Belgium, French\n\nbe-en, nl-en, and de-en open the English pages. A full product link picks the shop from the address.","schema":{"type":"string","description":"Shop for a bare article number.\n\n- be: Belgium, Dutch (default). Example: 905648\n- nl: Netherlands\n- de: Germany\n- be-fr: Belgium, French\n\nbe-en, nl-en, and de-en open the English pages. A full product link picks the shop from the address."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"cons":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"title":{"nullable":true}}}},"name":{"type":"string"},"pros":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"title":{"nullable":true}}}},"brand":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"in_the_box":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"included_note":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}},"manufacturer_code":{"type":"string"},"availability_label":{"type":"string"}}},"examples":{"Sony WH-1000XM5 Zwart, Belgium":{"value":{"sku":"905648","url":"https://www.coolblue.be/nl/product/905648/sony-wh-1000xm5-zwart.html","cons":[{"text":"Je vouwt de koptelefoon niet compact op.","title":null}],"name":"Sony WH-1000XM5 Zwart","pros":[{"text":"Dankzij de topklasse noise cancelling wordt omgevingsgeluid sterk gedempt.","title":null},{"text":"Met de Sony Headphones Connect app personaliseer je het geluid via een equalizer.","title":null},{"text":"Dankzij de snellaadfunctie gebruik je na 3 minuten opladen de koptelefoon voor 3 uur.","title":null}],"brand":"Sony","price":249,"images":["https://image.coolblue.nl/500x500/products/1755757","https://image.coolblue.nl/480x360/products/1755757","https://image.coolblue.nl/512x288/products/1755757"],"rating":8.8,"region":"be","currency":"EUR","language":"nl","condition":"new","image_url":"https://image.coolblue.nl/500x500/products/1755757","in_the_box":["Handleiding ( 3.02 MB)","Opberghoes (hardcase)","Usb C naar usb A oplaadkabel (exclusief oplader)","Audiokabel"],"product_id":"905648","breadcrumbs":["Portable audio","Koptelefoons","Sony koptelefoons","Sony WH koptelefoons"],"description":"De Sony WH-1000XM5 Zwart is een draadloze koptelefoon met topklasse noise cancelling. Dankzij de 2 noise cancelling processors dempt de koptelefoon omgevingsgeluid zeer precies. Zo heb je minder last van je omgeving en zet je het volume van de muziek niet onnodig hard. In de Sony Headphones Connect app personaliseer je de geluidsweergave via een equalizer. Hierdoor voeg je een accent toe aan de lage tonen en luister je naar het geluid dat jij mooi vindt. Op een volle lading gaat de koptelefoon 30 uur mee. Is de batterij leeg? Na 3 minuten opladen gebruik je de koptelefoon voor 3 uur.","availability":"in_stock","review_count":404,"included_note":"Geen oplader meegeleverd","price_display":"249,00 €","specifications":[{"name":"Artikelnummer","group":"Product","value":"905648"},{"name":"Fabrikantcode","group":"Product","value":"WH1000XM5B.CE7"},{"name":"Merk","group":"Product","value":"Sony"},{"name":"Garantie","group":"Product","value":"2 jaar"},{"name":"Noise cancelling","group":"Geluid","value":"Ja"},{"name":"Kwaliteit noise cancelling","group":"Geluid","value":"Topklasse"},{"name":"Bluetooth-versie","group":"Verbinding","value":"5.2"},{"name":"Type oorkussen","group":"Behuizing","value":"Over ear"}],"manufacturer_code":"WH1000XM5B.CE7","availability_label":"Morgen geleverd"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/coolblue/search":{"get":{"summary":"Coolblue Search","description":"Search Coolblue with a product keyword. Region defaults to Belgium. Also use nl or de. Page through product cards.\n\n**Credit cost:** 1 credit per call","operationId":"get-coolblue-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search words, or a Coolblue listing link.\n\n**Words:**\n\n```\nsony wh-1000xm5\n```\n\n**Listing link:**\n\n```\nhttps://www.coolblue.be/nl/zoeken?query=sony%20wh-1000xm5\n```\n\nA product link is rejected.","schema":{"type":"string","description":"Search words, or a Coolblue listing link.\n\n**Words:**\n\n```\nsony wh-1000xm5\n```\n\n**Listing link:**\n\n```\nhttps://www.coolblue.be/nl/zoeken?query=sony%20wh-1000xm5\n```\n\nA product link is rejected."}},{"name":"page","in":"query","required":false,"description":"Page number, from 1.\n\nBelgium and the Netherlands send pagina. Germany sends Seite. Belgium in French sends page.\n\n**Examples:**\n\n```\n1\n2\n```","schema":{"type":"number","description":"Page number, from 1.\n\nBelgium and the Netherlands send pagina. Germany sends Seite. Belgium in French sends page.\n\n**Examples:**\n\n```\n1\n2\n```"}},{"name":"region","in":"query","required":false,"description":"Shop, when query is words rather than a full link.\n\n- be: Belgium, Dutch (default). Example: koptelefoon\n- nl: Netherlands. Example: koptelefoon\n- de: Germany. Example: kopfhorer\n- be-fr: Belgium, French. Example: casque\n\nbe-en, nl-en, and de-en open the English pages. A full Coolblue link picks the shop from the address.","schema":{"type":"string","description":"Shop, when query is words rather than a full link.\n\n- be: Belgium, Dutch (default). Example: koptelefoon\n- nl: Netherlands. Example: koptelefoon\n- de: Germany. Example: kopfhorer\n- be-fr: Belgium, French. Example: casque\n\nbe-en, nl-en, and de-en open the English pages. A full Coolblue link picks the shop from the address."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"availability":{"type":"string"},"pickup_label":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"usb-c kabel, Belgium, first card":{"value":{"results":[{"sku":"898247","url":"https://www.coolblue.be/nl/product/898247/bluebuilt-usb-c-naar-usb-c-kabel-1-5m-kevlar-zwart.html","name":"BlueBuilt Usb C naar Usb C kabel 1,5m Kevlar Zwart","price":29.99,"images":["https://image.coolblue.be/transparent/max/320xauto/products/2057932","https://image.coolblue.be/500x500/products/2057932","https://image.coolblue.be/480x360/products/2057932","https://image.coolblue.be/512x288/products/2057932"],"rating":8.7,"region":"be","currency":"EUR","language":"nl","image_url":"https://image.coolblue.be/transparent/max/320xauto/products/2057932","highlights":["Onze keuze voor een extra stevige kabel voor je smartphone","Kabellengte 1,5 m","Kevlar","100 W vermogen"],"product_id":"898247","availability":"in_stock","pickup_label":"Nog sneller op te halen in 11 Coolblue-winkels","review_count":25,"price_display":"29,99 €"}],"pagination":{"next":"https://www.coolblue.be/nl/kabels/oplaadkabels/usb-c-kabels/usb-c-naar-usb-c-kabels?pagina=2","page":1,"per_page":22,"total_pages":2,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Coolblue Search","description":"Search Coolblue with a product keyword. Region defaults to Belgium. Also use nl or de. Page through product cards.\n\n**Credit cost:** 1 credit per call","operationId":"post-coolblue-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search words, or a Coolblue listing link.\n\n**Words:**\n\n```\nsony wh-1000xm5\n```\n\n**Listing link:**\n\n```\nhttps://www.coolblue.be/nl/zoeken?query=sony%20wh-1000xm5\n```\n\nA product link is rejected.","schema":{"type":"string","description":"Search words, or a Coolblue listing link.\n\n**Words:**\n\n```\nsony wh-1000xm5\n```\n\n**Listing link:**\n\n```\nhttps://www.coolblue.be/nl/zoeken?query=sony%20wh-1000xm5\n```\n\nA product link is rejected."}},{"name":"page","in":"query","required":false,"description":"Page number, from 1.\n\nBelgium and the Netherlands send pagina. Germany sends Seite. Belgium in French sends page.\n\n**Examples:**\n\n```\n1\n2\n```","schema":{"type":"number","description":"Page number, from 1.\n\nBelgium and the Netherlands send pagina. Germany sends Seite. Belgium in French sends page.\n\n**Examples:**\n\n```\n1\n2\n```"}},{"name":"region","in":"query","required":false,"description":"Shop, when query is words rather than a full link.\n\n- be: Belgium, Dutch (default). Example: koptelefoon\n- nl: Netherlands. Example: koptelefoon\n- de: Germany. Example: kopfhorer\n- be-fr: Belgium, French. Example: casque\n\nbe-en, nl-en, and de-en open the English pages. A full Coolblue link picks the shop from the address.","schema":{"type":"string","description":"Shop, when query is words rather than a full link.\n\n- be: Belgium, Dutch (default). Example: koptelefoon\n- nl: Netherlands. Example: koptelefoon\n- de: Germany. Example: kopfhorer\n- be-fr: Belgium, French. Example: casque\n\nbe-en, nl-en, and de-en open the English pages. A full Coolblue link picks the shop from the address."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"availability":{"type":"string"},"pickup_label":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"nullable":true}}}}},"examples":{"usb-c kabel, Belgium, first card":{"value":{"results":[{"sku":"898247","url":"https://www.coolblue.be/nl/product/898247/bluebuilt-usb-c-naar-usb-c-kabel-1-5m-kevlar-zwart.html","name":"BlueBuilt Usb C naar Usb C kabel 1,5m Kevlar Zwart","price":29.99,"images":["https://image.coolblue.be/transparent/max/320xauto/products/2057932","https://image.coolblue.be/500x500/products/2057932","https://image.coolblue.be/480x360/products/2057932","https://image.coolblue.be/512x288/products/2057932"],"rating":8.7,"region":"be","currency":"EUR","language":"nl","image_url":"https://image.coolblue.be/transparent/max/320xauto/products/2057932","highlights":["Onze keuze voor een extra stevige kabel voor je smartphone","Kabellengte 1,5 m","Kevlar","100 W vermogen"],"product_id":"898247","availability":"in_stock","pickup_label":"Nog sneller op te halen in 11 Coolblue-winkels","review_count":25,"price_display":"29,99 €"}],"pagination":{"next":"https://www.coolblue.be/nl/kabels/oplaadkabels/usb-c-kabels/usb-c-naar-usb-c-kabels?pagina=2","page":1,"per_page":22,"total_pages":2,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bol/search":{"get":{"summary":"Bol Search","description":"Search bol.com by keyword. Region is nl, be-nl, or be-fr. Page the product cards. Sponsored ads can repeat across pages.\n\n**Credit cost:** 2 credits per call","operationId":"get-bol-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full bol.com search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlego\n```\n\n```\nhttps://www.bol.com/nl/nl/s/?searchtext=lego\n```","schema":{"type":"string","description":"Keyword or full bol.com search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlego\n```\n\n```\nhttps://www.bol.com/nl/nl/s/?searchtext=lego\n```"}},{"name":"region","in":"query","required":false,"description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from /nl/nl/, /be/nl/, or /be/fr/.","schema":{"type":"string","description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from /nl/nl/, /be/nl/, or /be/fr/."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 asks bol for the next screen of the same search.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number, starting at 1. Page 2 asks bol for the next screen of the same search."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"locale":{"type":"string"},"rating":{"type":"number"},"region":{"type":"string"},"seller":{"type":"string"},"brand_id":{"type":"string"},"currency":{"type":"string"},"delivery":{"type":"string"},"offer_id":{"type":"string"},"brand_url":{"type":"string"},"image_alt":{"type":"string"},"image_url":{"type":"string"},"sponsored":{"type":"boolean"},"bol_select":{"type":"boolean"},"highlights":{"type":"array","items":{"type":"string"}},"list_price":{"type":"number"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"rating_display":{"type":"string"},"list_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Search lego on bol.com Netherlands":{"value":{"results":[{"url":"https://www.bol.com/nl/nl/p/lego-icons-rozenboeket-10328/9300000157956429/","brand":"LEGO","price":47.99,"title":"LEGO Botanicals Rozenboeket Decoratief Bloemen Bouwpakket uit de Botanical Collection 10328","locale":"nl-NL","rating":4.8,"region":"nl","seller":"bol","brand_id":"4648554","currency":"EUR","delivery":"Voor 23:59 uur besteld, morgen in huis","offer_id":"6cc9ba23-4459-4455-b1f0-dbb512814ec3","brand_url":"https://www.bol.com/nl/nl/pb/lego/4648554/","image_alt":"LEGO Botanical Collection Rozenboeket verpakking, met afbeelding van twaalf rode rozen.","image_url":"https://media.s-bol.com/8Q2W6R9wqArl/BNlmq0Q/550x839.jpg","sponsored":false,"bol_select":true,"highlights":["822 onderdelen","Geen minifiguren","2024"],"list_price":59.99,"product_id":"9300000157956429","description":"LEGO Botanicals Rozenboeket. Type product: Bouwpakket, Aanbevolen leeftijd (min): 18 jaar, Materiaal:...","availability":"in_stock","review_count":154,"price_display":"47,99 €","rating_display":"4,8/5","list_price_display":"59,99 €"}],"pagination":{"next":"https://www.bol.com/nl/nl/s/?searchtext=lego&page=2","page":1,"per_page":29,"total_pages":null,"total_results":11622}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Bol Search","description":"Search bol.com by keyword. Region is nl, be-nl, or be-fr. Page the product cards. Sponsored ads can repeat across pages.\n\n**Credit cost:** 2 credits per call","operationId":"post-bol-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full bol.com search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlego\n```\n\n```\nhttps://www.bol.com/nl/nl/s/?searchtext=lego\n```","schema":{"type":"string","description":"Keyword or full bol.com search URL. A product URL is rejected.\n\n**Examples:**\n\n```\nlego\n```\n\n```\nhttps://www.bol.com/nl/nl/s/?searchtext=lego\n```"}},{"name":"region","in":"query","required":false,"description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from /nl/nl/, /be/nl/, or /be/fr/.","schema":{"type":"string","description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from /nl/nl/, /be/nl/, or /be/fr/."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Page 2 asks bol for the next screen of the same search.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number, starting at 1. Page 2 asks bol for the next screen of the same search."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"locale":{"type":"string"},"rating":{"type":"number"},"region":{"type":"string"},"seller":{"type":"string"},"brand_id":{"type":"string"},"currency":{"type":"string"},"delivery":{"type":"string"},"offer_id":{"type":"string"},"brand_url":{"type":"string"},"image_alt":{"type":"string"},"image_url":{"type":"string"},"sponsored":{"type":"boolean"},"bol_select":{"type":"boolean"},"highlights":{"type":"array","items":{"type":"string"}},"list_price":{"type":"number"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"rating_display":{"type":"string"},"list_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Search lego on bol.com Netherlands":{"value":{"results":[{"url":"https://www.bol.com/nl/nl/p/lego-icons-rozenboeket-10328/9300000157956429/","brand":"LEGO","price":47.99,"title":"LEGO Botanicals Rozenboeket Decoratief Bloemen Bouwpakket uit de Botanical Collection 10328","locale":"nl-NL","rating":4.8,"region":"nl","seller":"bol","brand_id":"4648554","currency":"EUR","delivery":"Voor 23:59 uur besteld, morgen in huis","offer_id":"6cc9ba23-4459-4455-b1f0-dbb512814ec3","brand_url":"https://www.bol.com/nl/nl/pb/lego/4648554/","image_alt":"LEGO Botanical Collection Rozenboeket verpakking, met afbeelding van twaalf rode rozen.","image_url":"https://media.s-bol.com/8Q2W6R9wqArl/BNlmq0Q/550x839.jpg","sponsored":false,"bol_select":true,"highlights":["822 onderdelen","Geen minifiguren","2024"],"list_price":59.99,"product_id":"9300000157956429","description":"LEGO Botanicals Rozenboeket. Type product: Bouwpakket, Aanbevolen leeftijd (min): 18 jaar, Materiaal:...","availability":"in_stock","review_count":154,"price_display":"47,99 €","rating_display":"4,8/5","list_price_display":"59,99 €"}],"pagination":{"next":"https://www.bol.com/nl/nl/s/?searchtext=lego&page=2","page":1,"per_page":29,"total_pages":null,"total_results":11622}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bol/product":{"get":{"summary":"Bol Product","description":"Read one bol.com product by URL or product id, in nl, be-nl, or be-fr. You get the selling price, the list price, and the seller.\n\n**Credit cost:** 2 credits per call","operationId":"get-bol-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or numeric product id.\n\n**Examples:**\n\n```\n9300000240171676\n```\n\n```\nhttps://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/\n```","schema":{"type":"string","description":"Product URL or numeric product id.\n\n**Examples:**\n\n```\n9300000240171676\n```\n\n```\nhttps://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/\n```"}},{"name":"region","in":"query","required":false,"description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from the path.","schema":{"type":"string","description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from the path."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"color":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"rating":{"type":"integer"},"region":{"type":"string"},"seller":{"type":"string"},"series":{"type":"string"},"reviews":{"type":"array","items":{"type":"object","properties":{"body":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"rating":{"type":"integer"},"published_at":{"type":"string"}}}},"currency":{"type":"string"},"delivery":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"color":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"seller":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"availability":{"type":"string"},"price_display":{"type":"string"}}}},"brand_url":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"list_price":{"type":"integer"},"product_id":{"type":"string"},"series_url":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"return_days":{"type":"integer"},"availability":{"type":"string"},"review_count":{"type":"integer"},"weight_grams":{"type":"integer"},"price_display":{"type":"string"},"rating_counts":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}},"seller_rating":{"type":"number"},"shipping_cost":{"type":"integer"},"rating_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}},"product_group_id":{"type":"string"},"list_price_display":{"type":"string"},"seller_rating_scale":{"type":"integer"},"shipping_cost_display":{"type":"string"}}},"examples":{"iPhone Air on bol.com Netherlands":{"value":{"mpn":"iPhone Air - 256GB - Space Black","url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/","gtin":"0195950622669","brand":"Apple","color":"Zwart","price":895,"title":"Apple iPhone Air - 256GB - Space Black","images":["https://media.s-bol.com/B3MRz4rqxr6N/nRJm0wp/1208x1500.jpg","https://media.s-bol.com/NJ6qQlVK3Wy6/DRjxogK/550x309.jpg","https://media.s-bol.com/1yy95wgwEW20/W76j4Eo/550x353.jpg","https://media.s-bol.com/q3OG4KVRQg0p/jqZPlJl/550x832.jpg","https://media.s-bol.com/QzYlpj63G7B5/wjwWnYJ/550x805.jpg","https://media.s-bol.com/7481oXqRgllj/pQJOxvp/408x840.jpg","https://media.s-bol.com/J3n7L58BJqZD/nRJm0wp/550x472.jpg","https://media.s-bol.com/yL4JRYwj0wXP/nRJm0wp/550x832.jpg","https://media.s-bol.com/K3o5M48D0ZOr/nRJm0wp/413x840.jpg","https://media.s-bol.com/G3kQG4R0D56y/nRJm0wp/131x840.jpg","https://media.s-bol.com/V6XmxJBRPjAB/nxvNg1E/548x840.jpg","https://media.s-bol.com/1RXjlV8LrnxZ/nxvNg1E/124x840.jpg","https://media.s-bol.com/Yg16AVG8vnoA/nxvNg1E/410x840.jpg","https://media.s-bol.com/R9Qgq8xNoJOz/nxvNg1E/550x467.jpg","https://media.s-bol.com/oLGYrA5g1xlz/nxvNg1E/550x682.jpg","https://media.s-bol.com/mv7y321ED290/oZVz43A/550x558.jpg","https://media.s-bol.com/WGG82656pq6g/W76j4Eo/550x520.jpg","https://media.s-bol.com/goAOj82Vzoqr/wjwWnYJ/550x683.jpg","https://media.s-bol.com/KqPNjzLWyYNz/wjwWnYJ/482x840.jpg"],"locale":"nl-NL","rating":5,"region":"nl","seller":"Clevertronic","series":"Apple iPhone 17","reviews":[{"body":"Licht handzaam mooi krachtig gewoon top","title":"Super toestel. Ondanks wat er gezegd wordt een goede batterij","author":"Alex Martin","rating":5,"published_at":"2025-12-17"},{"body":"ik gebruik de iphone air nu een paar maanden als opvolger van mijn iphone 15 pro. De air bevalt me beter. Hij is lichter en handzamer en zeker zo snel. Ik ervaar hem als stabieler en minder nerveus. De zogenaamd eenvoudiger camera is een non-issue; hij functioneert perfect.","title":"state of the art","author":"Jordan Lee","rating":5,"published_at":"2026-06-10"}],"currency":"EUR","delivery":"Voor 23:59 uur besteld, dinsdag in huis","variants":[{"url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-cloud-white/9300000240171668/","gtin":"0195950622867","color":"Wit","price":899,"title":"Apple iPhone Air - 256GB - Cloud White","seller":"Clevertronic","currency":"EUR","condition":"new","image_url":"https://media.s-bol.com/4MB65kz2NG42/Y7R28M0/1205x1500.jpg","product_id":"9300000240171668","availability":"in_stock","price_display":"899,00 €"},{"url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/","gtin":"0195950622669","color":"Zwart","price":895,"title":"Apple iPhone Air - 256GB - Space Black","seller":"Clevertronic","currency":"EUR","condition":"new","image_url":"https://media.s-bol.com/B3MRz4rqxr6N/nRJm0wp/1208x1500.jpg","product_id":"9300000240171676","availability":"in_stock","price_display":"895,00 €"}],"brand_url":"https://www.bol.com/nl/nl/pb/apple/5070005/","condition":"new","image_url":"https://media.s-bol.com/B3MRz4rqxr6N/nRJm0wp/1208x1500.jpg","highlights":["Apple","2025","Schermformaat:  6.5 in","256 GB opslag","Camera:  48 Megapixel","5G","Werkgeheugen:  12 GB","iOS 26"],"list_price":1199,"product_id":"9300000240171676","series_url":"https://www.bol.com/nl/nl/serie/apple-iphone-17/9700000000011697/","breadcrumbs":[{"url":"https://www.bol.com/nl/nl/l/elektronica/3136/","name":"Elektronica"},{"url":"https://www.bol.com/nl/nl/l/telefonie-accessoires/3137/","name":"Telefonie & Accessoires"},{"url":"https://www.bol.com/nl/nl/l/smartphones/4010/","name":"Smartphones"},{"url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/","name":"Apple iPhone Air - 256GB - Space Black"}],"description":"De dunste iPhone ooit! Met zijn maar 5,6 mm en 165 gram is de iPhone Air uniek in zijn soort! En toch heeft iPhone Air een 6,5‑inch display en de kracht van de A19 Pro-chip, dezelfde chip als de iPhone 17 Pro (Max) Nieuw camera systeem: 18MP Center Stage-camer a aan de voorkant. Die je altijd in de voorgrond zet van jouw selfie en zelf switcht tussen verticaal en horizontaal beeld. 48-MP Fusion Hoofdcamera , die functioneert als 2 camera's en 4 lenzen in een. Daarnaast heeft hij 2x een Telelens voor de perfecte zoom. Verder heeft de Air Dolby Vision in 4K met 60 bps Pro Chip: Dankzij de kracht van de nieuwste generatie Apple silicon en de efficiëntie van de A19 Pro-chip draaien geavanceerde features als Apple Intelligence en intensieve games beter dan ooit. A19 Pro bevat de snelste CPU in welke smart­phone dan ook en heeft onze meest geavanceerde GPU tot nu toe. De CPU alleen al is tot 40 procent sneller dan de chip in iPhone 14 Pro. En dankzij C1X, de nieuwe versie van de door Apple ontworpen modem, is iPhone Air de meest energie­zuinige iPhone ooit gemaakt. Batterij & eSim: De Air is ontworpen voor een zo groot mogelijk batterij, daarom is het simkaart slot eruit gehaald en werkt de Air alleen op eSim. Daardoor kan hij tot 27 uur video afspelen . Ook geeft de nieuwe iPhone 17 een snellere en veiligere verbinding, via wifi 7, Bluetooth 6 en 5G. En maakt de Air gebruik van de nieuwste versie van IOS, IOS 26! Met de nieuwste functies en verbeteringen.","return_days":30,"availability":"in_stock","review_count":15,"weight_grams":307,"price_display":"895,00 €","rating_counts":{"1":0,"2":0,"3":0,"4":0,"5":15},"seller_rating":8.7,"shipping_cost":0,"rating_display":"5,0","specifications":[{"name":"Merk","group":"Productinformatie","value":"Apple"},{"name":"Model","group":"Productinformatie","value":"Apple iPhone Air"},{"name":"MPN (Manufacturer Part Number)","group":"Productinformatie","value":"iPhone Air - 256GB - Space Black"},{"name":"EAN","group":"Productinformatie","value":"0195950622669"},{"name":"Kleur","group":"Kenmerken","value":"Zwart"},{"name":"Verpakkingsgewicht","group":"Kenmerken","value":"307 g"}],"product_group_id":"9300000219087270","list_price_display":"1.199,00 €","seller_rating_scale":10,"shipping_cost_display":"0,00 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Bol Product","description":"Read one bol.com product by URL or product id, in nl, be-nl, or be-fr. You get the selling price, the list price, and the seller.\n\n**Credit cost:** 2 credits per call","operationId":"post-bol-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or numeric product id.\n\n**Examples:**\n\n```\n9300000240171676\n```\n\n```\nhttps://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/\n```","schema":{"type":"string","description":"Product URL or numeric product id.\n\n**Examples:**\n\n```\n9300000240171676\n```\n\n```\nhttps://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/\n```"}},{"name":"region","in":"query","required":false,"description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from the path.","schema":{"type":"string","description":"Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from the path."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML as {\"result\": \"...\"}.","schema":{"type":"boolean","description":"When true, return the raw HTML as {\"result\": \"...\"}."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"color":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"rating":{"type":"integer"},"region":{"type":"string"},"seller":{"type":"string"},"series":{"type":"string"},"reviews":{"type":"array","items":{"type":"object","properties":{"body":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"rating":{"type":"integer"},"published_at":{"type":"string"}}}},"currency":{"type":"string"},"delivery":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"color":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"seller":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"availability":{"type":"string"},"price_display":{"type":"string"}}}},"brand_url":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"highlights":{"type":"array","items":{"type":"string"}},"list_price":{"type":"integer"},"product_id":{"type":"string"},"series_url":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"return_days":{"type":"integer"},"availability":{"type":"string"},"review_count":{"type":"integer"},"weight_grams":{"type":"integer"},"price_display":{"type":"string"},"rating_counts":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}},"seller_rating":{"type":"number"},"shipping_cost":{"type":"integer"},"rating_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}},"product_group_id":{"type":"string"},"list_price_display":{"type":"string"},"seller_rating_scale":{"type":"integer"},"shipping_cost_display":{"type":"string"}}},"examples":{"iPhone Air on bol.com Netherlands":{"value":{"mpn":"iPhone Air - 256GB - Space Black","url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/","gtin":"0195950622669","brand":"Apple","color":"Zwart","price":895,"title":"Apple iPhone Air - 256GB - Space Black","images":["https://media.s-bol.com/B3MRz4rqxr6N/nRJm0wp/1208x1500.jpg","https://media.s-bol.com/NJ6qQlVK3Wy6/DRjxogK/550x309.jpg","https://media.s-bol.com/1yy95wgwEW20/W76j4Eo/550x353.jpg","https://media.s-bol.com/q3OG4KVRQg0p/jqZPlJl/550x832.jpg","https://media.s-bol.com/QzYlpj63G7B5/wjwWnYJ/550x805.jpg","https://media.s-bol.com/7481oXqRgllj/pQJOxvp/408x840.jpg","https://media.s-bol.com/J3n7L58BJqZD/nRJm0wp/550x472.jpg","https://media.s-bol.com/yL4JRYwj0wXP/nRJm0wp/550x832.jpg","https://media.s-bol.com/K3o5M48D0ZOr/nRJm0wp/413x840.jpg","https://media.s-bol.com/G3kQG4R0D56y/nRJm0wp/131x840.jpg","https://media.s-bol.com/V6XmxJBRPjAB/nxvNg1E/548x840.jpg","https://media.s-bol.com/1RXjlV8LrnxZ/nxvNg1E/124x840.jpg","https://media.s-bol.com/Yg16AVG8vnoA/nxvNg1E/410x840.jpg","https://media.s-bol.com/R9Qgq8xNoJOz/nxvNg1E/550x467.jpg","https://media.s-bol.com/oLGYrA5g1xlz/nxvNg1E/550x682.jpg","https://media.s-bol.com/mv7y321ED290/oZVz43A/550x558.jpg","https://media.s-bol.com/WGG82656pq6g/W76j4Eo/550x520.jpg","https://media.s-bol.com/goAOj82Vzoqr/wjwWnYJ/550x683.jpg","https://media.s-bol.com/KqPNjzLWyYNz/wjwWnYJ/482x840.jpg"],"locale":"nl-NL","rating":5,"region":"nl","seller":"Clevertronic","series":"Apple iPhone 17","reviews":[{"body":"Licht handzaam mooi krachtig gewoon top","title":"Super toestel. Ondanks wat er gezegd wordt een goede batterij","author":"Alex Martin","rating":5,"published_at":"2025-12-17"},{"body":"ik gebruik de iphone air nu een paar maanden als opvolger van mijn iphone 15 pro. De air bevalt me beter. Hij is lichter en handzamer en zeker zo snel. Ik ervaar hem als stabieler en minder nerveus. De zogenaamd eenvoudiger camera is een non-issue; hij functioneert perfect.","title":"state of the art","author":"Jordan Lee","rating":5,"published_at":"2026-06-10"}],"currency":"EUR","delivery":"Voor 23:59 uur besteld, dinsdag in huis","variants":[{"url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-cloud-white/9300000240171668/","gtin":"0195950622867","color":"Wit","price":899,"title":"Apple iPhone Air - 256GB - Cloud White","seller":"Clevertronic","currency":"EUR","condition":"new","image_url":"https://media.s-bol.com/4MB65kz2NG42/Y7R28M0/1205x1500.jpg","product_id":"9300000240171668","availability":"in_stock","price_display":"899,00 €"},{"url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/","gtin":"0195950622669","color":"Zwart","price":895,"title":"Apple iPhone Air - 256GB - Space Black","seller":"Clevertronic","currency":"EUR","condition":"new","image_url":"https://media.s-bol.com/B3MRz4rqxr6N/nRJm0wp/1208x1500.jpg","product_id":"9300000240171676","availability":"in_stock","price_display":"895,00 €"}],"brand_url":"https://www.bol.com/nl/nl/pb/apple/5070005/","condition":"new","image_url":"https://media.s-bol.com/B3MRz4rqxr6N/nRJm0wp/1208x1500.jpg","highlights":["Apple","2025","Schermformaat:  6.5 in","256 GB opslag","Camera:  48 Megapixel","5G","Werkgeheugen:  12 GB","iOS 26"],"list_price":1199,"product_id":"9300000240171676","series_url":"https://www.bol.com/nl/nl/serie/apple-iphone-17/9700000000011697/","breadcrumbs":[{"url":"https://www.bol.com/nl/nl/l/elektronica/3136/","name":"Elektronica"},{"url":"https://www.bol.com/nl/nl/l/telefonie-accessoires/3137/","name":"Telefonie & Accessoires"},{"url":"https://www.bol.com/nl/nl/l/smartphones/4010/","name":"Smartphones"},{"url":"https://www.bol.com/nl/nl/p/apple-iphone-air-256gb-space-black/9300000240171676/","name":"Apple iPhone Air - 256GB - Space Black"}],"description":"De dunste iPhone ooit! Met zijn maar 5,6 mm en 165 gram is de iPhone Air uniek in zijn soort! En toch heeft iPhone Air een 6,5‑inch display en de kracht van de A19 Pro-chip, dezelfde chip als de iPhone 17 Pro (Max) Nieuw camera systeem: 18MP Center Stage-camer a aan de voorkant. Die je altijd in de voorgrond zet van jouw selfie en zelf switcht tussen verticaal en horizontaal beeld. 48-MP Fusion Hoofdcamera , die functioneert als 2 camera's en 4 lenzen in een. Daarnaast heeft hij 2x een Telelens voor de perfecte zoom. Verder heeft de Air Dolby Vision in 4K met 60 bps Pro Chip: Dankzij de kracht van de nieuwste generatie Apple silicon en de efficiëntie van de A19 Pro-chip draaien geavanceerde features als Apple Intelligence en intensieve games beter dan ooit. A19 Pro bevat de snelste CPU in welke smart­phone dan ook en heeft onze meest geavanceerde GPU tot nu toe. De CPU alleen al is tot 40 procent sneller dan de chip in iPhone 14 Pro. En dankzij C1X, de nieuwe versie van de door Apple ontworpen modem, is iPhone Air de meest energie­zuinige iPhone ooit gemaakt. Batterij & eSim: De Air is ontworpen voor een zo groot mogelijk batterij, daarom is het simkaart slot eruit gehaald en werkt de Air alleen op eSim. Daardoor kan hij tot 27 uur video afspelen . Ook geeft de nieuwe iPhone 17 een snellere en veiligere verbinding, via wifi 7, Bluetooth 6 en 5G. En maakt de Air gebruik van de nieuwste versie van IOS, IOS 26! Met de nieuwste functies en verbeteringen.","return_days":30,"availability":"in_stock","review_count":15,"weight_grams":307,"price_display":"895,00 €","rating_counts":{"1":0,"2":0,"3":0,"4":0,"5":15},"seller_rating":8.7,"shipping_cost":0,"rating_display":"5,0","specifications":[{"name":"Merk","group":"Productinformatie","value":"Apple"},{"name":"Model","group":"Productinformatie","value":"Apple iPhone Air"},{"name":"MPN (Manufacturer Part Number)","group":"Productinformatie","value":"iPhone Air - 256GB - Space Black"},{"name":"EAN","group":"Productinformatie","value":"0195950622669"},{"name":"Kleur","group":"Kenmerken","value":"Zwart"},{"name":"Verpakkingsgewicht","group":"Kenmerken","value":"307 g"}],"product_group_id":"9300000219087270","list_price_display":"1.199,00 €","seller_rating_scale":10,"shipping_cost_display":"0,00 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/boulanger/product":{"get":{"summary":"Boulanger Product","description":"Read one Boulanger product from its URL or product id. You get price, brand, rating, seller, and specifications.\n\n**Credit cost:** 2 credits per call","operationId":"get-boulanger-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL /ref/{id}, or the numeric product id.\n\n**Examples:**\n\n```\nhttps://www.boulanger.com/ref/1193303\n```\n\n```\n1193303\n```\n\nA keyword or a search URL returns 400.","schema":{"type":"string","description":"Product URL /ref/{id}, or the numeric product id.\n\n**Examples:**\n\n```\nhttps://www.boulanger.com/ref/1193303\n```\n\n```\n1193303\n```\n\nA keyword or a search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"nullable":true},"image":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"seller":{"type":"string"},"eco_tax":{"type":"number"},"reviews":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"text":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"rating":{"type":"integer"}}}},"currency":{"type":"string"},"warranty":{"type":"string"},"condition":{"type":"string"},"highlight":{"type":"string"},"was_price":{"type":"integer"},"categories":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"description":{"type":"string"},"return_days":{"type":"integer"},"return_fees":{"type":"string"},"seller_note":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"return_method":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"eco_tax_display":{"type":"string"},"delivery_options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"detail":{"type":"string"}}}},"discount_display":{"type":"string"},"installment_cost":{"nullable":true},"transit_days_max":{"type":"integer"},"transit_days_min":{"type":"integer"},"handling_days_max":{"type":"integer"},"handling_days_min":{"type":"integer"},"installment_count":{"type":"integer"},"installment_price":{"type":"number"},"shipping_price_max":{"type":"integer"},"shipping_price_min":{"type":"integer"},"reference_price_label":{"type":"string"},"installment_cost_display":{"nullable":true},"installment_price_display":{"type":"string"}}},"examples":{"Aspirateur balai DYSON V15 Detect Absolute":{"value":{"sku":"790955ea-031f-4c6a-a06d-a9bdeedec70c","url":"https://www.boulanger.com/ref/1193303","gtin":"5025155081754","name":"Aspirateur balai DYSON V15 Detect Absolute","brand":"DYSON","color":null,"image":"https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_0","price":709.29,"images":["https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_1","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_2","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_3","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_4","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_5","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_6","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_7","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_8","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_r_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_r_l_1","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_b_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_b_l_1","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_z_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_z_l_1"],"rating":4.7,"seller":"electro network","eco_tax":1.2,"reviews":[{"date":"2026-10-19","text":"Tres bon produit, puissant et silencieux, avec une très bonne autonomie de presque 1 heure !! la 2eme brosse avec le laser ... pas vraiment utile, c'est plus un gadget qu'autre chose. Un bon aspirateur, a conseiller :-)","title":"DYSON V15","author":"Alex Martin","rating":5},{"date":"2026-10-05","text":"Très puissant.\\nVraiment top\\nC'est mon quatrième dyson et celui-ci dépasse tous les autres","title":"Aspirateur Dyson","author":"Jordan Lee","rating":5},{"date":"2026-10-05","text":"Je n'ai rien a dire hormis qu'il marche très bien depuis que je l'ai, il est très facile a nettoyer, le filtre et tout le reste s'enlève facilement. Je recommande a 100%","title":"Au top","author":"Sam Rivera","rating":5},{"date":"2026-10-01","text":"contente du produit l'éclairage sur la brosse","title":"utilisation","author":"Casey Nguyen","rating":5},{"date":"2026-09-27","text":"Une aspiration forte idéale pour les pouls de chien \\nLa brosse pour les canapés en tissus pour enlever les pouls de chiens au top la plus efficace de tous les aspirateurs des autres marques type lg ou dreame qui n a ont jamais cette efficacité","title":"Excellent","author":"Morgan Blake","rating":5},{"date":"2026-09-25","text":"Aspire très bien et la lumière sur la brosse permet de voir toutes les petites saletés petit inconvénient un peu lourd;","title":"Top","author":"Riley Chen","rating":5},{"date":"2026-09-25","text":"Très satisfait de cet aspirateur balai Dyson ! Il est puissant, léger et très maniable, ce qui rend le ménage beaucoup plus rapide et agréable. J’apprécie particulièrement son efficacité sur les poussières, les cheveux et les poils d’animaux. La liberté du sans-fil est également un vrai plus au quotidien.\\n\\nUn appareil de qualité, pratique et performant. Je le recommande sans hésiter !","title":"Aspirateur balai DYSON V15","author":"Taylor Brooks","rating":5},{"date":"2026-09-24","text":"Très bon produit. Aspire très bien","title":"Top produit","author":"Quinn Parker","rating":5},{"date":"2026-09-24","text":"Mais il est un peu lourd à utiliser","title":"Il marche très bien","author":"Avery Kim","rating":5},{"date":"2026-09-18","text":"Depuis que je l'ai acheté ma femme me délaisse...","title":"Trop bien","author":"Drew Patel","rating":5}],"currency":"EUR","warranty":"Garantie légale : 2 ans","condition":"neuf","highlight":"Sa lumière révèle les particules invisibles à l'oeil nu ! Fourni avec 4 accessoires","was_price":799,"categories":["Maison - Entretien - Jardin","Aspirateur","Aspirateur balai"],"product_id":"1193303","description":"Toute l'innovation Dyson se retrouve dans l'aspirateur-balai V15 Detect Absolute : performance, hygiène et puissance sont les mots-clés de la conception du V15 Detect Absolute. Une technologie de pointe Offrez à votre intérieur un nettoyage impeccable et un air pur grâce à l'aspiration ultra-puissante du moteur numérique Hyperdymium du V15 Detect Absolute. L'aspiration du V15 Detect Absolute et son filtre à particules retiennent et éliminent 99,97% des poussières, pollens et micro-particules. Le balai aspirateur sans fil V15 Detect Absolute est l'appareil idéal pour une maison saine. Doté d'innovations signées Dyson, l'aspirateur-balai V15 Detect Absolute est équipé d'un moteur Hyperdymium qui délivre une puissance d'aspiration allant jusqu'à 125,000 tours par minute. Ce moteur innovant et ultra-performant vous garantit un nettoyage rapide et efficace sur tout type de sol, des parquets les plus fragiles aux moquettes les plus épaisses. Une conception à votre service L'aspirateur-balai V15 Detect Absolute est équipé d'une brosse motorisée intuitive et performante sur toutes les surfaces. Les poils rigides en nylon gainés sont conçus spécialement pour décoller les saletés des moquettes et tapis, tandis qu'une lumière sur la tête éclaire toutes les poussières pour une aspiration et un rendu impeccables. Pensé pour s'intégrer parfaitement à votre quotidien, l'aspirateur-balai V15 Detect Absolute est doté d'une batterie rechargeable longue durée vous permettant une utilisation optimale jusqu'à 60 minutes. Son écran LCD, quant à lui, vous donne une vision en direct de l'autonomie de votre V15 Detect Absolute et vous laisse naviguer parmi les modes Eco, Auto et Boost. Grâce à sa station de chargement 2-en-1, le V15 Detect Absolute se pose partout, se fixe sur un mur ou s'utilise indépendamment. L'exigence Dyson reconnue par le label LONGTIME Cette technologie bénéficie du label LONGTIME®, qui atteste sa conception pour durer bien au-delà des standards classiques. Testé pour résister à plus de 600 cycles de charge, à des milliers de sollicitations sur ses composants clés et à des chutes répétées, il est fabriqué avec des matériaux ultra-résistants et dispose de protections contre la surchauffe, l'humidité et les chocs. Le label LONGTIME® garantit la durabilité, la réparabilité et la disponibilité des pièces détachées, pour un appareil qui vous accompagne efficacement année après année.","return_days":15,"return_fees":"free","seller_note":"Les délais de livraisons peuvent être allongés en période de soldes et de fin d'année.","availability":"in_stock","review_count":421,"price_display":"709,29 €","return_method":"in_store","specifications":[{"name":"Type de sols","value":"Carrelages, parquets, tapis, moquettes"},{"name":"Pour quelles surfaces ?","value":"Meubles, textiles, hauteurs"},{"name":"Brosse ou Accessoire spécial","value":"Brosse motorisée Optic Fluffy dont la lumière permet de mieux voir et sur une plus grande surface la poussière"},{"name":"Et en plus","value":"Suceur long pour aspirer des endroits difficiles d'accès (voiture, radiateur,...)"},{"name":"Spécial animaux (brosse motorisée)","value":"oui"},{"name":"Brosse principale","value":"Brosse Optic Fluffy"},{"name":"Fonction anti-emmêlement","value":"oui"},{"name":"Puissance d'aspiration maximale","value":"240 airwatts"},{"name":"Qu'est-ce que les Airwatts ?","value":"C'est une unité qui mesure l'efficacité des aspirateurs en se réfèrant au débit d'air (m3/s) et à la puissance (watts) qu'un aspirateur produit et utilise."},{"name":"Détail sur la puissance d'aspiration","value":"Elle peut varier en fonction du type de sols (parquet, carrelage, tapis, moquette) que vous aspirez et du mode utilisé (standard, éco, boost)"},{"name":"Puissance de la batterie","value":"25,2 V"},{"name":"Nombre de batterie","value":"1"},{"name":"Aspiration en marche arrière","value":"Oui"},{"name":"Autonomie","value":"1 h"},{"name":"Temps de charge","value":"4 h 30"},{"name":"Niveau sonore jusqu'à","value":"0 dB"},{"name":"Poids","value":"3,1 kg"},{"name":"Nombre de modes de nettoyage","value":"2"},{"name":"Position parking","value":"Non"},{"name":"Bouton marche / arrêt","value":"Pression continue à maintenir pendant le nettoyage"},{"name":"Station de recharge","value":"support de charge à fixer au mur"},{"name":"Capacité du réservoir","value":"0,76 L"},{"name":"Type de réservoir à poussière","value":"Bac à retirer pour vider la poussière"},{"name":"Aspirateur à main","value":"Nécessite d'enlever le tube et d'utiliser les différents accessoires et brosses fournis pour une utilisation d'appoint (ex: table, voiture, fauteuil)"},{"name":"Tube télescopique","value":"Non concerné"},{"name":"Tube pliable","value":"Non concerné"},{"name":"Système de filtration","value":"2 étapes de filtration, les aspirateurs à plusieurs étapes de filtration permetttent d'aspirer jusqu'à 99,99% des particules et allergènes"},{"name":"Entretien du filtre du réservoir","value":"Lavable sous l'eau"},{"name":"Suceur long ou extensible","value":"Pour aspirer les zones difficiles d'accès : derrière les radiateurs, derrière les meubles, entre les sièges de voiture, ..."},{"name":"Brosse Digital Motorbar","value":"Elle s'adapte automatiquement aux différents types de sols pour optimiser le nettoyage et l'autonomie. Sa technologie auto-démêlante enlève automatiquement les cheveux et poils d'animaux du rouleau de la brosse"},{"name":"Support murale de charge","value":"Pour recharger et ranger l'appareil et ses accessoires"},{"name":"Brosse Optic Fluffy","value":"Brosse faite avec du nylon souple et de la fibre de carbone antistatique pour éliminer plus facilement la poussière des sols durs et espaces étroits. Sa lumière permet de mieux voir et plus loin la poussière dans les zones plus sombres"},{"name":"Dimensions l x h x p","value":"26.6 x 126 x 25 cm"},{"name":"Garantie","value":"2 ans"},{"name":"Fabriqué en","value":"Malaisie"},{"name":"Disponibilité des pièces détachées (données fournisseur)","value":"Pendant 13 ans, à compter de la date d'achat"}],"eco_tax_display":"1,20 €","delivery_options":[{"label":"Retrait en magasin","detail":"indisponible"},{"label":"Livraison à domicile","detail":"dès jeudi 05 novembre"}],"discount_display":"-11%","installment_cost":null,"transit_days_max":10,"transit_days_min":1,"handling_days_max":3,"handling_days_min":1,"installment_count":20,"installment_price":41.59,"shipping_price_max":49,"shipping_price_min":0,"reference_price_label":"Prix de référence","installment_cost_display":null,"installment_price_display":"41,59 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Boulanger Product","description":"Read one Boulanger product from its URL or product id. You get price, brand, rating, seller, and specifications.\n\n**Credit cost:** 2 credits per call","operationId":"post-boulanger-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL /ref/{id}, or the numeric product id.\n\n**Examples:**\n\n```\nhttps://www.boulanger.com/ref/1193303\n```\n\n```\n1193303\n```\n\nA keyword or a search URL returns 400.","schema":{"type":"string","description":"Product URL /ref/{id}, or the numeric product id.\n\n**Examples:**\n\n```\nhttps://www.boulanger.com/ref/1193303\n```\n\n```\n1193303\n```\n\nA keyword or a search URL returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"gtin":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"nullable":true},"image":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"seller":{"type":"string"},"eco_tax":{"type":"number"},"reviews":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"text":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"rating":{"type":"integer"}}}},"currency":{"type":"string"},"warranty":{"type":"string"},"condition":{"type":"string"},"highlight":{"type":"string"},"was_price":{"type":"integer"},"categories":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"description":{"type":"string"},"return_days":{"type":"integer"},"return_fees":{"type":"string"},"seller_note":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"return_method":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"eco_tax_display":{"type":"string"},"delivery_options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"detail":{"type":"string"}}}},"discount_display":{"type":"string"},"installment_cost":{"nullable":true},"transit_days_max":{"type":"integer"},"transit_days_min":{"type":"integer"},"handling_days_max":{"type":"integer"},"handling_days_min":{"type":"integer"},"installment_count":{"type":"integer"},"installment_price":{"type":"number"},"shipping_price_max":{"type":"integer"},"shipping_price_min":{"type":"integer"},"reference_price_label":{"type":"string"},"installment_cost_display":{"nullable":true},"installment_price_display":{"type":"string"}}},"examples":{"Aspirateur balai DYSON V15 Detect Absolute":{"value":{"sku":"790955ea-031f-4c6a-a06d-a9bdeedec70c","url":"https://www.boulanger.com/ref/1193303","gtin":"5025155081754","name":"Aspirateur balai DYSON V15 Detect Absolute","brand":"DYSON","color":null,"image":"https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_0","price":709.29,"images":["https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_1","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_2","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_3","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_4","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_5","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_6","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_7","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_f_l_8","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_r_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_r_l_1","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_b_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_b_l_1","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_z_l_0","https://boulanger.scene7.com/is/image/Boulanger/5025155081754_h_z_l_1"],"rating":4.7,"seller":"electro network","eco_tax":1.2,"reviews":[{"date":"2026-10-19","text":"Tres bon produit, puissant et silencieux, avec une très bonne autonomie de presque 1 heure !! la 2eme brosse avec le laser ... pas vraiment utile, c'est plus un gadget qu'autre chose. Un bon aspirateur, a conseiller :-)","title":"DYSON V15","author":"Alex Martin","rating":5},{"date":"2026-10-05","text":"Très puissant.\\nVraiment top\\nC'est mon quatrième dyson et celui-ci dépasse tous les autres","title":"Aspirateur Dyson","author":"Jordan Lee","rating":5},{"date":"2026-10-05","text":"Je n'ai rien a dire hormis qu'il marche très bien depuis que je l'ai, il est très facile a nettoyer, le filtre et tout le reste s'enlève facilement. Je recommande a 100%","title":"Au top","author":"Sam Rivera","rating":5},{"date":"2026-10-01","text":"contente du produit l'éclairage sur la brosse","title":"utilisation","author":"Casey Nguyen","rating":5},{"date":"2026-09-27","text":"Une aspiration forte idéale pour les pouls de chien \\nLa brosse pour les canapés en tissus pour enlever les pouls de chiens au top la plus efficace de tous les aspirateurs des autres marques type lg ou dreame qui n a ont jamais cette efficacité","title":"Excellent","author":"Morgan Blake","rating":5},{"date":"2026-09-25","text":"Aspire très bien et la lumière sur la brosse permet de voir toutes les petites saletés petit inconvénient un peu lourd;","title":"Top","author":"Riley Chen","rating":5},{"date":"2026-09-25","text":"Très satisfait de cet aspirateur balai Dyson ! Il est puissant, léger et très maniable, ce qui rend le ménage beaucoup plus rapide et agréable. J’apprécie particulièrement son efficacité sur les poussières, les cheveux et les poils d’animaux. La liberté du sans-fil est également un vrai plus au quotidien.\\n\\nUn appareil de qualité, pratique et performant. Je le recommande sans hésiter !","title":"Aspirateur balai DYSON V15","author":"Taylor Brooks","rating":5},{"date":"2026-09-24","text":"Très bon produit. Aspire très bien","title":"Top produit","author":"Quinn Parker","rating":5},{"date":"2026-09-24","text":"Mais il est un peu lourd à utiliser","title":"Il marche très bien","author":"Avery Kim","rating":5},{"date":"2026-09-18","text":"Depuis que je l'ai acheté ma femme me délaisse...","title":"Trop bien","author":"Drew Patel","rating":5}],"currency":"EUR","warranty":"Garantie légale : 2 ans","condition":"neuf","highlight":"Sa lumière révèle les particules invisibles à l'oeil nu ! Fourni avec 4 accessoires","was_price":799,"categories":["Maison - Entretien - Jardin","Aspirateur","Aspirateur balai"],"product_id":"1193303","description":"Toute l'innovation Dyson se retrouve dans l'aspirateur-balai V15 Detect Absolute : performance, hygiène et puissance sont les mots-clés de la conception du V15 Detect Absolute. Une technologie de pointe Offrez à votre intérieur un nettoyage impeccable et un air pur grâce à l'aspiration ultra-puissante du moteur numérique Hyperdymium du V15 Detect Absolute. L'aspiration du V15 Detect Absolute et son filtre à particules retiennent et éliminent 99,97% des poussières, pollens et micro-particules. Le balai aspirateur sans fil V15 Detect Absolute est l'appareil idéal pour une maison saine. Doté d'innovations signées Dyson, l'aspirateur-balai V15 Detect Absolute est équipé d'un moteur Hyperdymium qui délivre une puissance d'aspiration allant jusqu'à 125,000 tours par minute. Ce moteur innovant et ultra-performant vous garantit un nettoyage rapide et efficace sur tout type de sol, des parquets les plus fragiles aux moquettes les plus épaisses. Une conception à votre service L'aspirateur-balai V15 Detect Absolute est équipé d'une brosse motorisée intuitive et performante sur toutes les surfaces. Les poils rigides en nylon gainés sont conçus spécialement pour décoller les saletés des moquettes et tapis, tandis qu'une lumière sur la tête éclaire toutes les poussières pour une aspiration et un rendu impeccables. Pensé pour s'intégrer parfaitement à votre quotidien, l'aspirateur-balai V15 Detect Absolute est doté d'une batterie rechargeable longue durée vous permettant une utilisation optimale jusqu'à 60 minutes. Son écran LCD, quant à lui, vous donne une vision en direct de l'autonomie de votre V15 Detect Absolute et vous laisse naviguer parmi les modes Eco, Auto et Boost. Grâce à sa station de chargement 2-en-1, le V15 Detect Absolute se pose partout, se fixe sur un mur ou s'utilise indépendamment. L'exigence Dyson reconnue par le label LONGTIME Cette technologie bénéficie du label LONGTIME®, qui atteste sa conception pour durer bien au-delà des standards classiques. Testé pour résister à plus de 600 cycles de charge, à des milliers de sollicitations sur ses composants clés et à des chutes répétées, il est fabriqué avec des matériaux ultra-résistants et dispose de protections contre la surchauffe, l'humidité et les chocs. Le label LONGTIME® garantit la durabilité, la réparabilité et la disponibilité des pièces détachées, pour un appareil qui vous accompagne efficacement année après année.","return_days":15,"return_fees":"free","seller_note":"Les délais de livraisons peuvent être allongés en période de soldes et de fin d'année.","availability":"in_stock","review_count":421,"price_display":"709,29 €","return_method":"in_store","specifications":[{"name":"Type de sols","value":"Carrelages, parquets, tapis, moquettes"},{"name":"Pour quelles surfaces ?","value":"Meubles, textiles, hauteurs"},{"name":"Brosse ou Accessoire spécial","value":"Brosse motorisée Optic Fluffy dont la lumière permet de mieux voir et sur une plus grande surface la poussière"},{"name":"Et en plus","value":"Suceur long pour aspirer des endroits difficiles d'accès (voiture, radiateur,...)"},{"name":"Spécial animaux (brosse motorisée)","value":"oui"},{"name":"Brosse principale","value":"Brosse Optic Fluffy"},{"name":"Fonction anti-emmêlement","value":"oui"},{"name":"Puissance d'aspiration maximale","value":"240 airwatts"},{"name":"Qu'est-ce que les Airwatts ?","value":"C'est une unité qui mesure l'efficacité des aspirateurs en se réfèrant au débit d'air (m3/s) et à la puissance (watts) qu'un aspirateur produit et utilise."},{"name":"Détail sur la puissance d'aspiration","value":"Elle peut varier en fonction du type de sols (parquet, carrelage, tapis, moquette) que vous aspirez et du mode utilisé (standard, éco, boost)"},{"name":"Puissance de la batterie","value":"25,2 V"},{"name":"Nombre de batterie","value":"1"},{"name":"Aspiration en marche arrière","value":"Oui"},{"name":"Autonomie","value":"1 h"},{"name":"Temps de charge","value":"4 h 30"},{"name":"Niveau sonore jusqu'à","value":"0 dB"},{"name":"Poids","value":"3,1 kg"},{"name":"Nombre de modes de nettoyage","value":"2"},{"name":"Position parking","value":"Non"},{"name":"Bouton marche / arrêt","value":"Pression continue à maintenir pendant le nettoyage"},{"name":"Station de recharge","value":"support de charge à fixer au mur"},{"name":"Capacité du réservoir","value":"0,76 L"},{"name":"Type de réservoir à poussière","value":"Bac à retirer pour vider la poussière"},{"name":"Aspirateur à main","value":"Nécessite d'enlever le tube et d'utiliser les différents accessoires et brosses fournis pour une utilisation d'appoint (ex: table, voiture, fauteuil)"},{"name":"Tube télescopique","value":"Non concerné"},{"name":"Tube pliable","value":"Non concerné"},{"name":"Système de filtration","value":"2 étapes de filtration, les aspirateurs à plusieurs étapes de filtration permetttent d'aspirer jusqu'à 99,99% des particules et allergènes"},{"name":"Entretien du filtre du réservoir","value":"Lavable sous l'eau"},{"name":"Suceur long ou extensible","value":"Pour aspirer les zones difficiles d'accès : derrière les radiateurs, derrière les meubles, entre les sièges de voiture, ..."},{"name":"Brosse Digital Motorbar","value":"Elle s'adapte automatiquement aux différents types de sols pour optimiser le nettoyage et l'autonomie. Sa technologie auto-démêlante enlève automatiquement les cheveux et poils d'animaux du rouleau de la brosse"},{"name":"Support murale de charge","value":"Pour recharger et ranger l'appareil et ses accessoires"},{"name":"Brosse Optic Fluffy","value":"Brosse faite avec du nylon souple et de la fibre de carbone antistatique pour éliminer plus facilement la poussière des sols durs et espaces étroits. Sa lumière permet de mieux voir et plus loin la poussière dans les zones plus sombres"},{"name":"Dimensions l x h x p","value":"26.6 x 126 x 25 cm"},{"name":"Garantie","value":"2 ans"},{"name":"Fabriqué en","value":"Malaisie"},{"name":"Disponibilité des pièces détachées (données fournisseur)","value":"Pendant 13 ans, à compter de la date d'achat"}],"eco_tax_display":"1,20 €","delivery_options":[{"label":"Retrait en magasin","detail":"indisponible"},{"label":"Livraison à domicile","detail":"dès jeudi 05 novembre"}],"discount_display":"-11%","installment_cost":null,"transit_days_max":10,"transit_days_min":1,"handling_days_max":3,"handling_days_min":1,"installment_count":20,"installment_price":41.59,"shipping_price_max":49,"shipping_price_min":0,"reference_price_label":"Prix de référence","installment_cost_display":null,"installment_price_display":"41,59 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/boulanger/search":{"get":{"summary":"Boulanger Search","description":"Search Boulanger by keyword and page the product grid. Cards include price, brand, seller, and the product URL.\n\n**Credit cost:** 2 credits per call","operationId":"get-boulanger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, a Boulanger /resultats URL, or a /c/ category URL.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.boulanger.com/resultats?tr=aspirateur\n```\n\n```\nhttps://www.boulanger.com/c/aspirateur\n```\n\nA /ref/ product URL returns 400.","schema":{"type":"string","description":"Keyword, a Boulanger /resultats URL, or a /c/ category URL.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.boulanger.com/resultats?tr=aspirateur\n```\n\n```\nhttps://www.boulanger.com/c/aspirateur\n```\n\nA /ref/ product URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, from 1. Default is 1. Page 2 is sent as numPage=2 and returns different product ids.\n\n**Example:** `2`","schema":{"type":"number","description":"Page number, from 1. Default is 1. Page 2 is sent as numPage=2 and returns different product ids.\n\n**Example:** `2`"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"nullable":true},"image":{"type":"string"},"price":{"type":"number"},"rating":{"nullable":true},"seller":{"type":"string"},"eco_tax":{"nullable":true},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"offer_id":{"type":"string"},"position":{"type":"integer"},"condition":{"type":"string"},"highlight":{"type":"string"},"was_price":{"type":"number"},"key_points":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"review_count":{"nullable":true},"price_display":{"type":"string"},"eco_tax_display":{"nullable":true},"discount_display":{"type":"string"},"installment_cost":{"nullable":true},"installment_count":{"nullable":true},"installment_price":{"nullable":true},"installment_cost_display":{"nullable":true},"installment_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Aspirateur, first card":{"value":{"results":[{"url":"https://www.boulanger.com/ref/9000978984","name":"Aspirateur balai VACTIDY V10 PRO","brand":"VACTIDY","color":null,"image":"https://boulanger.scene7.com/is/image/Boulanger/6924843236393_h_f_l_0","price":66.99,"rating":null,"seller":"Vactidy France","eco_tax":null,"currency":"EUR","in_stock":true,"offer_id":"86dc761c-d394-4c82-bb0d-345b89258dd7","position":1,"condition":"neuf","highlight":"Le design moderne rose et le format sans fil léger apportent une touche de plaisir au quotidien, pour un nettoyage simple et fluide.","was_price":89.99,"key_points":["Temps de charge : 4 h, Autonomie : 45 mn, Poids : 2,2 kg","Tube pliable : Non concerné","Note de l'indice de réparabilité (sur 10) : 9.5, Station de recharge intégrée au support mural","On adore : Le design moderne rose et le format sans fil léger apportent une touche de plaisir au quotidien, pour un nettoyage simple et fluide."],"product_id":"9000978984","review_count":null,"price_display":"66,99 €","eco_tax_display":null,"discount_display":"-25%","installment_cost":null,"installment_count":null,"installment_price":null,"installment_cost_display":null,"installment_price_display":null}],"pagination":{"next":"https://www.boulanger.com/resultats?tr=aspirateur&numPage=2","page":1,"per_page":40,"total_pages":23,"total_results":916}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Boulanger Search","description":"Search Boulanger by keyword and page the product grid. Cards include price, brand, seller, and the product URL.\n\n**Credit cost:** 2 credits per call","operationId":"post-boulanger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, a Boulanger /resultats URL, or a /c/ category URL.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.boulanger.com/resultats?tr=aspirateur\n```\n\n```\nhttps://www.boulanger.com/c/aspirateur\n```\n\nA /ref/ product URL returns 400.","schema":{"type":"string","description":"Keyword, a Boulanger /resultats URL, or a /c/ category URL.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.boulanger.com/resultats?tr=aspirateur\n```\n\n```\nhttps://www.boulanger.com/c/aspirateur\n```\n\nA /ref/ product URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, from 1. Default is 1. Page 2 is sent as numPage=2 and returns different product ids.\n\n**Example:** `2`","schema":{"type":"number","description":"Page number, from 1. Default is 1. Page 2 is sent as numPage=2 and returns different product ids.\n\n**Example:** `2`"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false.","schema":{"type":"boolean","description":"When true, returns the raw HTML instead of the parsed JSON. The response shape is {\"result\": \"<html>...\"}. Default false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"color":{"nullable":true},"image":{"type":"string"},"price":{"type":"number"},"rating":{"nullable":true},"seller":{"type":"string"},"eco_tax":{"nullable":true},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"offer_id":{"type":"string"},"position":{"type":"integer"},"condition":{"type":"string"},"highlight":{"type":"string"},"was_price":{"type":"number"},"key_points":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"review_count":{"nullable":true},"price_display":{"type":"string"},"eco_tax_display":{"nullable":true},"discount_display":{"type":"string"},"installment_cost":{"nullable":true},"installment_count":{"nullable":true},"installment_price":{"nullable":true},"installment_cost_display":{"nullable":true},"installment_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Aspirateur, first card":{"value":{"results":[{"url":"https://www.boulanger.com/ref/9000978984","name":"Aspirateur balai VACTIDY V10 PRO","brand":"VACTIDY","color":null,"image":"https://boulanger.scene7.com/is/image/Boulanger/6924843236393_h_f_l_0","price":66.99,"rating":null,"seller":"Vactidy France","eco_tax":null,"currency":"EUR","in_stock":true,"offer_id":"86dc761c-d394-4c82-bb0d-345b89258dd7","position":1,"condition":"neuf","highlight":"Le design moderne rose et le format sans fil léger apportent une touche de plaisir au quotidien, pour un nettoyage simple et fluide.","was_price":89.99,"key_points":["Temps de charge : 4 h, Autonomie : 45 mn, Poids : 2,2 kg","Tube pliable : Non concerné","Note de l'indice de réparabilité (sur 10) : 9.5, Station de recharge intégrée au support mural","On adore : Le design moderne rose et le format sans fil léger apportent une touche de plaisir au quotidien, pour un nettoyage simple et fluide."],"product_id":"9000978984","review_count":null,"price_display":"66,99 €","eco_tax_display":null,"discount_display":"-25%","installment_cost":null,"installment_count":null,"installment_price":null,"installment_cost_display":null,"installment_price_display":null}],"pagination":{"next":"https://www.boulanger.com/resultats?tr=aspirateur&numPage=2","page":1,"per_page":40,"total_pages":23,"total_results":916}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/funda/search":{"get":{"summary":"Funda Search","description":"Search Funda by place. Set offering to koop for sale or huur for rent, then page the listings.\n\n**Credit cost:** 2 credits per call","operationId":"get-funda-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City, area, or a Funda search URL.\n\n**Examples:**\n\n```\namsterdam\n```\n\n```\nhttps://www.funda.nl/zoeken/koop/?selected_area=amsterdam\n```\n\nFor rent, set offering to huur. A listing URL returns 400.","schema":{"type":"string","description":"City, area, or a Funda search URL.\n\n**Examples:**\n\n```\namsterdam\n```\n\n```\nhttps://www.funda.nl/zoeken/koop/?selected_area=amsterdam\n```\n\nFor rent, set offering to huur. A listing URL returns 400."}},{"name":"offering","in":"query","required":false,"description":"Sale or rent when query is a place.\n\n**Examples:**\n\n```\nkoop\n```\n\n```\nhuur\n```\n\nAliases: buy, sale, rent. Default koop. A search URL keeps its own path.","schema":{"type":"string","description":"Sale or rent when query is a place.\n\n**Examples:**\n\n```\nkoop\n```\n\n```\nhuur\n```\n\nAliases: buy, sale, rent. Default koop. A search URL keeps its own path."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Example: 2. Funda receives this as search_result=2. Page 1 and page 2 return different listings.","schema":{"type":"number","description":"Page from 1. Example: 2. Funda receives this as search_result=2. Page 1 and page 2 return different listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"city":{"type":"string"},"agent":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"association":{"type":"string"},"contact_name":{"nullable":true},"contact_image":{"nullable":true}}},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"street":{"type":"string"},"zoning":{"type":"string"},"country":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"district":{"type":"string"},"province":{"type":"string"},"global_id":{"type":"integer"},"plot_area":{"nullable":true},"floor_area":{"type":"integer"},"price_type":{"type":"string"},"promo_text":{"type":"string"},"media_types":{"type":"array","items":{"type":"string"}},"object_type":{"type":"string"},"postal_code":{"type":"string"},"energy_label":{"type":"string"},"house_number":{"type":"string"},"listing_type":{"type":"string"},"municipality":{"type":"string"},"publish_date":{"type":"string"},"neighbourhood":{"type":"string"},"offering_type":{"type":"string"},"price_display":{"type":"string"},"price_condition":{"type":"string"},"construction_type":{"type":"string"},"house_number_suffix":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Amsterdam koop, Hillegomstraat 57-1":{"value":{"results":[{"id":44654106,"url":"https://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/","city":"Amsterdam","agent":{"id":24575,"url":"https://www.funda.nl/makelaar/24575-aw-sabel-makelaardij-og/","logo":"https://cloud.funda.nl/valentina_media/141/983/997.jpg","name":"A.W. Sabel Makelaardij o.g.","association":"NVM","contact_name":null,"contact_image":null},"image":"https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/fccdebc5-cc6a-477e-97e2-32651664f739?options=width=720","price":565000,"rooms":3,"title":"Hillegomstraat 57-1","images":["https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/fccdebc5-cc6a-477e-97e2-32651664f739?options=width=720","https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/fdb09cc2-b7a5-48d9-9243-455de8545155?options=width=720","https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/88438efd-80b7-4838-b423-9cf7b52c5ec5?options=width=720"],"street":"Hillegomstraat","zoning":"residential","country":"NL","bedrooms":2,"currency":"EUR","district":"Hoofddorppleinbuurt","province":"Noord-Holland","global_id":8209743,"plot_area":null,"floor_area":60,"price_type":"regular","promo_text":"Sfeervol appartement met verdiept balkon in de Hoofdorppleinbuurt!","media_types":["floor_plan","photo_360","video"],"object_type":"apartment","postal_code":"1058 LR","energy_label":"D","house_number":"57","listing_type":"single","municipality":"Amsterdam","publish_date":"2026-10-29T15:19:55.3584664+01:00","neighbourhood":"Westlandgrachtbuurt","offering_type":"koop","price_display":"€ 565.000 k.k.","price_condition":"kosten_koper","construction_type":"resale","house_number_suffix":"1"}],"pagination":{"next":"https://www.funda.nl/zoeken/koop/?selected_area=amsterdam&search_result=2","page":1,"per_page":15,"total_pages":467,"total_results":7003}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Funda Search","description":"Search Funda by place. Set offering to koop for sale or huur for rent, then page the listings.\n\n**Credit cost:** 2 credits per call","operationId":"post-funda-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City, area, or a Funda search URL.\n\n**Examples:**\n\n```\namsterdam\n```\n\n```\nhttps://www.funda.nl/zoeken/koop/?selected_area=amsterdam\n```\n\nFor rent, set offering to huur. A listing URL returns 400.","schema":{"type":"string","description":"City, area, or a Funda search URL.\n\n**Examples:**\n\n```\namsterdam\n```\n\n```\nhttps://www.funda.nl/zoeken/koop/?selected_area=amsterdam\n```\n\nFor rent, set offering to huur. A listing URL returns 400."}},{"name":"offering","in":"query","required":false,"description":"Sale or rent when query is a place.\n\n**Examples:**\n\n```\nkoop\n```\n\n```\nhuur\n```\n\nAliases: buy, sale, rent. Default koop. A search URL keeps its own path.","schema":{"type":"string","description":"Sale or rent when query is a place.\n\n**Examples:**\n\n```\nkoop\n```\n\n```\nhuur\n```\n\nAliases: buy, sale, rent. Default koop. A search URL keeps its own path."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Example: 2. Funda receives this as search_result=2. Page 1 and page 2 return different listings.","schema":{"type":"number","description":"Page from 1. Example: 2. Funda receives this as search_result=2. Page 1 and page 2 return different listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"city":{"type":"string"},"agent":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"association":{"type":"string"},"contact_name":{"nullable":true},"contact_image":{"nullable":true}}},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"street":{"type":"string"},"zoning":{"type":"string"},"country":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"district":{"type":"string"},"province":{"type":"string"},"global_id":{"type":"integer"},"plot_area":{"nullable":true},"floor_area":{"type":"integer"},"price_type":{"type":"string"},"promo_text":{"type":"string"},"media_types":{"type":"array","items":{"type":"string"}},"object_type":{"type":"string"},"postal_code":{"type":"string"},"energy_label":{"type":"string"},"house_number":{"type":"string"},"listing_type":{"type":"string"},"municipality":{"type":"string"},"publish_date":{"type":"string"},"neighbourhood":{"type":"string"},"offering_type":{"type":"string"},"price_display":{"type":"string"},"price_condition":{"type":"string"},"construction_type":{"type":"string"},"house_number_suffix":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Amsterdam koop, Hillegomstraat 57-1":{"value":{"results":[{"id":44654106,"url":"https://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/","city":"Amsterdam","agent":{"id":24575,"url":"https://www.funda.nl/makelaar/24575-aw-sabel-makelaardij-og/","logo":"https://cloud.funda.nl/valentina_media/141/983/997.jpg","name":"A.W. Sabel Makelaardij o.g.","association":"NVM","contact_name":null,"contact_image":null},"image":"https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/fccdebc5-cc6a-477e-97e2-32651664f739?options=width=720","price":565000,"rooms":3,"title":"Hillegomstraat 57-1","images":["https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/fccdebc5-cc6a-477e-97e2-32651664f739?options=width=720","https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/fdb09cc2-b7a5-48d9-9243-455de8545155?options=width=720","https://cloud.funda.nl/tiara-media/4d4baf74-f6c7-4d23-85d6-7a031ab7b45c/88438efd-80b7-4838-b423-9cf7b52c5ec5?options=width=720"],"street":"Hillegomstraat","zoning":"residential","country":"NL","bedrooms":2,"currency":"EUR","district":"Hoofddorppleinbuurt","province":"Noord-Holland","global_id":8209743,"plot_area":null,"floor_area":60,"price_type":"regular","promo_text":"Sfeervol appartement met verdiept balkon in de Hoofdorppleinbuurt!","media_types":["floor_plan","photo_360","video"],"object_type":"apartment","postal_code":"1058 LR","energy_label":"D","house_number":"57","listing_type":"single","municipality":"Amsterdam","publish_date":"2026-10-29T15:19:55.3584664+01:00","neighbourhood":"Westlandgrachtbuurt","offering_type":"koop","price_display":"€ 565.000 k.k.","price_condition":"kosten_koper","construction_type":"resale","house_number_suffix":"1"}],"pagination":{"next":"https://www.funda.nl/zoeken/koop/?selected_area=amsterdam&search_result=2","page":1,"per_page":15,"total_pages":467,"total_results":7003}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/funda/property":{"get":{"summary":"Funda Property","description":"Read one Funda listing from its URL. You get the asking price, living area, and the feature groups.\n\n**Credit cost:** 2 credits per call","operationId":"get-funda-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Listing URL on www.funda.nl, under /detail/koop or /detail/huur.\n\n**Example:**\n\n```\nhttps://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/\n```\n\nThe price matches the search card. A search URL returns 400.","schema":{"type":"string","description":"Listing URL on www.funda.nl, under /detail/koop or /detail/huur.\n\n**Example:**\n\n```\nhttps://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/\n```\n\nThe price matches the search card. A search URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"city":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string"}}}},"photos":{"type":"array","items":{"type":"string"}},"videos":{"type":"array","items":{"type":"string"}},"country":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}}}},"title":{"type":"string"}}}},"latitude":{"type":"number"},"province":{"type":"string"},"subtitle":{"type":"string"},"global_id":{"type":"integer"},"longitude":{"type":"number"},"highlights":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"}}}},"is_auction":{"type":"boolean"},"photos_360":{"type":"array","items":{"type":"string"}},"promo_text":{"type":"string"},"description":{"type":"string"},"floor_plans":{"type":"array","items":{"type":"string"}},"living_area":{"type":"integer"},"object_type":{"type":"string"},"postal_code":{"type":"string"},"brochure_url":{"type":"string"},"energy_label":{"type":"string"},"house_number":{"type":"string"},"price_per_m2":{"type":"integer"},"virtual_tour":{"nullable":true},"canonical_url":{"type":"string"},"neighbourhood":{"type":"string"},"offering_type":{"type":"string"},"price_display":{"type":"string"},"publication_date":{"type":"string"},"is_sold_or_rented":{"type":"boolean"},"house_number_suffix":{"type":"string"},"neighbourhood_stats":{"type":"object","properties":{"city":{"type":"string"},"inhabitants":{"type":"integer"},"neighbourhood":{"type":"string"},"families_with_children":{"type":"number"},"average_asking_price_per_m2":{"type":"integer"}}}}},"examples":{"Hillegomstraat 57-1, Amsterdam":{"value":{"id":44654106,"url":"https://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/","city":"Amsterdam","price":565000,"title":"Hillegomstraat 57-1","labels":[{"text":"Nieuw","type":"new"}],"photos":["https://cloud.funda.nl/valentina_media/237/101/037.jpg","https://cloud.funda.nl/valentina_media/237/101/216.jpg","https://cloud.funda.nl/valentina_media/237/101/124.jpg"],"videos":["https://customer-vzk8jgcsaz84e8sb.cloudflarestream.com/5a5905ba200a2d987d171f80afdd948c/manifest/video.m3u8"],"country":"Nederland","bedrooms":2,"currency":"EUR","features":[{"id":"overdracht","items":[{"id":"overdracht-aangeboden-sinds","label":"Aangeboden sinds","value":"Vandaag"},{"label":"Aanvaarding","value":"In overleg"},{"id":"overdracht-vraagprijs","label":"Vraagprijs","value":"€ 565.000 kosten koper"},{"id":"overdracht-vraagprijsperm2","label":"Vraagprijs per m²","value":"€ 9.417"},{"id":"overdracht-status","label":"Status","value":"Beschikbaar"},{"id":"overdracht-bijdragevve","label":"Bijdrage VvE","value":"€ 100,00 per maand"}],"title":"Overdracht"},{"id":"bouw","items":[{"id":"bouw-soortobject","label":"Soort appartement","value":"Bovenwoning (appartement)"},{"id":"bouw-soortbouw","label":"Soort bouw","value":"Bestaande bouw"},{"id":"bouw-bouwjaar","label":"Bouwjaar","value":"1934"},{"id":"bouw-dak","label":"Soort dak","value":"Samengesteld dak bedekt met bitumineuze dakbedekking en pannen"}],"title":"Bouw"},{"id":"afmetingen","items":[{"items":[{"id":"afmetingen-gebruiksoppervlakten-wonen","label":"Wonen","value":"60 m²"},{"id":"afmetingen-gebruiksoppervlakte-overigeinpandigeruimte","label":"Overige inpandige ruimte","value":"1 m²"},{"id":"afmetingen-gebruiksoppervlakte-gebouwgebondenbuitenruimte","label":"Gebouwgebonden buitenruimte","value":"14 m²"}],"label":"Gebruiksoppervlakten"},{"id":"afmetingen-inhoud","label":"Inhoud","value":"194 m³"}],"title":"Oppervlakten en inhoud"},{"id":"indeling","items":[{"id":"indeling-totalrooms","label":"Aantal kamers","value":"3 kamers (2 slaapkamers)"},{"id":"indeling-totalbathroom","label":"Aantal badkamers","value":"1 badkamer"},{"id":"indeling-bathroom","label":"Badkamervoorzieningen","value":"Inloopdouche, toilet, wastafel, en wastafelmeubel"},{"id":"indeling-totalstories","label":"Aantal woonlagen","value":"1 woonlaag"},{"id":"indeling-generalfacilities","label":"Voorzieningen","value":"Mechanische ventilatie"},{"id":"indeling-locatedat","label":"Gelegen op","value":"1e woonlaag"}],"title":"Indeling"},{"id":"energie","items":[{"id":"energie-energielabel","label":"Energielabel","value":"D"},{"id":"energie-isolatie","label":"Isolatie","value":"Grotendeels dubbelglas"},{"id":"energie-verwarming","label":"Verwarming","value":"Cv-ketel"},{"id":"energie-warmwater","label":"Warm water","value":"Cv-ketel"},{"id":"energie-cv","label":"Cv-ketel","value":"Remeha intergas (gas gestookt combiketel uit 2011, eigendom)"}],"title":"Energie"},{"id":"cadastral","items":[{"id":"cadastral-parcel","items":[{"id":"cadastral-ownershipsituation","label":"Eigendomssituatie","value":"Volle eigendom"}],"label":"SLOTEN O 2521"}],"title":"Kadastrale gegevens"},{"id":"buitenruimte","items":[{"id":"buitenruimte-ligging","label":"Ligging","value":"Aan rustige weg, in woonwijk, open ligging en vrij uitzicht"},{"id":"buitenruimte-balkonterras","label":"Balkon/dakterras","value":"Balkon aanwezig"}],"title":"Buitenruimte"},{"id":"parkeergelegenheid","items":[{"label":"Soort parkeergelegenheid","value":"Betaald parkeren, openbaar parkeren en parkeervergunningen"}],"title":"Parkeergelegenheid"},{"id":"vvechecklist","items":[{"label":"Inschrijving KvK","value":"Ja"},{"label":"Jaarlijkse vergadering","value":"Ja"},{"label":"Periodieke bijdrage","value":"Ja (€ 100,00 per maand)"},{"label":"Reservefonds aanwezig","value":"Ja"},{"label":"Onderhoudsplan","value":"Ja"},{"label":"Opstalverzekering","value":"Ja"}],"title":"VvE checklist"}],"latitude":52.352062,"province":"Noord-Holland","subtitle":"1058 LR Amsterdam","global_id":8209743,"longitude":4.846501,"highlights":[{"title":"Zonnig verdiept balkon","category":"outdoor_space_and_views","description":"Balkon van circa 14 m² op het zuiden met groen uitzicht."},{"title":"Ruime vernieuwde woonkeuken","category":"kitchen_and_living","description":"Recent vernieuwde woonkeuken met plek voor grote eettafel."},{"title":"Toplocatie aan Westlandgracht","category":"location_and_surroundings","description":"Aan Westlandgracht, op loopafstand van het Vondelpark."}],"is_auction":false,"photos_360":["https://cloud.funda.nl/listing-management/e3ae662c-5ce0-4952-b3c5-eda8703c5543","https://cloud.funda.nl/listing-management/800b9f03-2cee-4b44-b1a7-286c2e3e1f87","https://cloud.funda.nl/listing-management/b2cd097e-e259-4cca-b8b2-cdf2a09ec503"],"promo_text":"Sfeervol appartement met verdiept balkon in de Hoofdorppleinbuurt!","description":"In een van de mooiste straten van de geliefde Hoofddorppleinbuurt ligt dit lichte en sfeervolle driekamerappartement van circa 60 m², met een zonnig, verdiept balkon van circa 14 m² op het zuiden. De woning heeft een praktische indeling, een ruime woonkeuken en een prachtig uitzicht over de Westlandgracht. Gelegen op eigen grond, op loopafstand van het Vondelpark en met alle gezellige hotspots van Amsterdam-Zuid binnen handbereik!\n\nOmgeving en bereikbaarheid\n\nDe woning ligt op een heerlijke locatie in de populaire Hoofddorppleinbuurt, waar rust, groen en het bruisende stadsleven samenkomen. Op zomerse dagen verandert de Westlandgracht in een populaire zwem- en ligplek voor de hele buurt, en die ligt letterlijk voor de deur. Voor een wandeling of sportieve activiteit liggen het Vondelpark, Rembrandtpark, Nieuwe Meer en Amsterdamse Bos op korte afstand.\n\nOok aan gezellige horeca geen gebrek! Begin je dag met een goede koffie bij Anne & Max of Catcha, geniet van een borrel bij Lokaal van de Stad, Bar Bonnie of Gent aan de Schinkel en schuif voor een uitgebreid diner aan bij Ron Gastrobar of Simply Fish. De nabijgelegen Amstelveenseweg, Overtoom en het Stadionplein bieden daarnaast een ruim aanbod aan winkels, speciaalzaken en restaurants. De bereikbaarheid is uitstekend, zowel met de fiets, het openbaar vervoer als met de auto.\n\nIndeling\n\nBegane grond\n\nVerzorgde gemeenschappelijke entree met toegang tot het trappenhuis, dat je met slechts één ander appartement deelt.\n\nEerste verdieping\n\nVia de hal bereik je alle vertrekken. Aan de voorzijde bevindt zich de lichte en ruime woonkamer met grote raampartijen, een charmante erker en een prachtig uitzicht over de Westlandgracht. De aangrenzende zijkamer is momenteel ingericht als thuiswerkplek. Door deuren in het portaal te plaatsen, kan deze ruimte als tweede slaapkamer worden gebruikt.\n\nAan de achterzijde ligt de recent vernieuwde woonkeuken, uitgevoerd met eikenhoutkleurige kasten, een wit werkblad en diverse inbouwapparatuur. Er is voldoende ruimte voor een royale eettafel. Vanaf vroeg in de winter valt er direct zonlicht de keuken binnen, wat het een bijzonder fijne plek maakt om te koken en te eten.\n\nVanuit de keuken heb je direct toegang tot het zonnige, verdiepte balkon van circa 14 m² op het zuiden. Een heerlijke plek om bijna het hele jaar van de zon te genieten, met uitzicht op de rustige en groene binnentuinen.\n\nDe ruime slaapkamer beschikt over openslaande deuren naar het balkon en biedt voldoende ruimte voor een kingsize bed en een grote kastenwand.\n\nCentraal in de woning bevindt zich de moderne badkamer, stijlvol afgewerkt met donkerkleurige beton ciré en voorzien van een inloopdouche, toilet en wastafelmeubel.\n\nWat de eigenaren gaan missen\n\n“’s Ochtends de balkondeuren vanuit de slaapkamer openslaan en de vogels horen fluiten in de groene binnentuinen. En op zomerse avonden met een bordje avondeten aan de Westlandgracht liggen, daarna een duik nemen en nog even van de zon genieten. Dat voelt als een minivakantie, gewoon voor de deur. Er is altijd leven en gezelligheid.”\n\nVereniging van Eigenaren\n\nDe woning maakt deel uit van een kleinschalige, gezonde Vereniging van Eigenaren, die beschikt over een onderhoudsplan. De maandelijkse servicekosten bedragen € 100,-.\n\nBijzonderheden\n- Zonnig, verdiept balkon van circa 14 m² op het zuiden;\n- Prachtig uitzicht over de Westlandgracht;\n- Gelegen op eigen grond, dus géén erfpacht;\n- Tweede slaapkamer te realiseren door het plaatsen van deuren in het portaal;\n- Recent vernieuwde woonkeuken met ruimte voor een royale eettafel;\n- Kleinschalige, gezonde VvE met onderhoudsplan;\n- Gelegen in de geliefde Hoofddorppleinbuurt in Amsterdam-Zuid;\n\nKerngegevens woning\nOppervlakte: ca. 59,5m² (NEN 2580 rapportage aanwezig) \nAantal kamers: 3 waarvan 2e slaapkamer is eenvoudig te creëren\nBuitenruimte: 13,5 m²\nEnergielabel: D geldig tot 19-10-2036\nBouwjaar: 1934\nVerwarming: Remeha intergas uit 2011\n\nKadastrale gegevens\nGemeente: Sloten N/H \nSectie + nummer: O 2521 A7\nAandeel: 6/20\nEigen grond\n\nVvE\nAantal leden: 3\nEigen beheer\nServicekosten: €100,- per maand \nMJOP: Aanwezig en geldig tot 2036\n\nOverig\nOuderdomsclausule is van toepassing \nNotaris: ring Amsterdam\nOplevering in: in overleg \n\nDeze informatie is door ons met de nodige zorgvuldigheid samengesteld. Onzerzijds wordt echter geen enkele aansprakelijkheid aanvaard voor enige onvolledigheid, onjuistheid of anderszins, dan wel de gevolgen daarvan. Alle opgegeven maten en oppervlakten zijn indicatief. Koper heeft de eigen onderzoeksplicht naar alle zaken die voor hem of haar van belang zijn. Met betrekking tot deze woning is de makelaar adviseur van verkoper. Wij adviseren u een deskundige makelaar in te schakelen die u begeleidt bij het aankoopproces. Indien u specifieke wensen heeft omtrent de woning, adviseren wij u deze tijdig kenbaar te maken aan uw aankopend makelaar en hiernaar zelfstandig onderzoek te (laten) doen. Indien u geen deskundige vertegenwoordiger inschakelt, acht u zich volgens de wet deskundig genoeg om alle zaken die van belang zijn te kunnen voorzien.","floor_plans":["https://cloud.funda.nl/listing-management/0008624c-4bac-4051-b047-6afa4c941642"],"living_area":60,"object_type":"apartment","postal_code":"1058 LR","brochure_url":"https://cloud.funda.nl/valentina_media/237/101/200.pdf","energy_label":"D","house_number":"57","price_per_m2":9417,"virtual_tour":null,"canonical_url":"https://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/17381479/","neighbourhood":"Westlandgrachtbuurt","offering_type":"koop","price_display":"€ 565.000 k.k.","publication_date":"2026-10-29T00:00:00","is_sold_or_rented":false,"house_number_suffix":"1","neighbourhood_stats":{"city":"Amsterdam","inhabitants":3585,"neighbourhood":"Westlandgrachtbuurt","families_with_children":18.44,"average_asking_price_per_m2":8939}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Funda Property","description":"Read one Funda listing from its URL. You get the asking price, living area, and the feature groups.\n\n**Credit cost:** 2 credits per call","operationId":"post-funda-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Listing URL on www.funda.nl, under /detail/koop or /detail/huur.\n\n**Example:**\n\n```\nhttps://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/\n```\n\nThe price matches the search card. A search URL returns 400.","schema":{"type":"string","description":"Listing URL on www.funda.nl, under /detail/koop or /detail/huur.\n\n**Example:**\n\n```\nhttps://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/\n```\n\nThe price matches the search card. A search URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"city":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string"}}}},"photos":{"type":"array","items":{"type":"string"}},"videos":{"type":"array","items":{"type":"string"}},"country":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}}}},"title":{"type":"string"}}}},"latitude":{"type":"number"},"province":{"type":"string"},"subtitle":{"type":"string"},"global_id":{"type":"integer"},"longitude":{"type":"number"},"highlights":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"}}}},"is_auction":{"type":"boolean"},"photos_360":{"type":"array","items":{"type":"string"}},"promo_text":{"type":"string"},"description":{"type":"string"},"floor_plans":{"type":"array","items":{"type":"string"}},"living_area":{"type":"integer"},"object_type":{"type":"string"},"postal_code":{"type":"string"},"brochure_url":{"type":"string"},"energy_label":{"type":"string"},"house_number":{"type":"string"},"price_per_m2":{"type":"integer"},"virtual_tour":{"nullable":true},"canonical_url":{"type":"string"},"neighbourhood":{"type":"string"},"offering_type":{"type":"string"},"price_display":{"type":"string"},"publication_date":{"type":"string"},"is_sold_or_rented":{"type":"boolean"},"house_number_suffix":{"type":"string"},"neighbourhood_stats":{"type":"object","properties":{"city":{"type":"string"},"inhabitants":{"type":"integer"},"neighbourhood":{"type":"string"},"families_with_children":{"type":"number"},"average_asking_price_per_m2":{"type":"integer"}}}}},"examples":{"Hillegomstraat 57-1, Amsterdam":{"value":{"id":44654106,"url":"https://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/44654106/","city":"Amsterdam","price":565000,"title":"Hillegomstraat 57-1","labels":[{"text":"Nieuw","type":"new"}],"photos":["https://cloud.funda.nl/valentina_media/237/101/037.jpg","https://cloud.funda.nl/valentina_media/237/101/216.jpg","https://cloud.funda.nl/valentina_media/237/101/124.jpg"],"videos":["https://customer-vzk8jgcsaz84e8sb.cloudflarestream.com/5a5905ba200a2d987d171f80afdd948c/manifest/video.m3u8"],"country":"Nederland","bedrooms":2,"currency":"EUR","features":[{"id":"overdracht","items":[{"id":"overdracht-aangeboden-sinds","label":"Aangeboden sinds","value":"Vandaag"},{"label":"Aanvaarding","value":"In overleg"},{"id":"overdracht-vraagprijs","label":"Vraagprijs","value":"€ 565.000 kosten koper"},{"id":"overdracht-vraagprijsperm2","label":"Vraagprijs per m²","value":"€ 9.417"},{"id":"overdracht-status","label":"Status","value":"Beschikbaar"},{"id":"overdracht-bijdragevve","label":"Bijdrage VvE","value":"€ 100,00 per maand"}],"title":"Overdracht"},{"id":"bouw","items":[{"id":"bouw-soortobject","label":"Soort appartement","value":"Bovenwoning (appartement)"},{"id":"bouw-soortbouw","label":"Soort bouw","value":"Bestaande bouw"},{"id":"bouw-bouwjaar","label":"Bouwjaar","value":"1934"},{"id":"bouw-dak","label":"Soort dak","value":"Samengesteld dak bedekt met bitumineuze dakbedekking en pannen"}],"title":"Bouw"},{"id":"afmetingen","items":[{"items":[{"id":"afmetingen-gebruiksoppervlakten-wonen","label":"Wonen","value":"60 m²"},{"id":"afmetingen-gebruiksoppervlakte-overigeinpandigeruimte","label":"Overige inpandige ruimte","value":"1 m²"},{"id":"afmetingen-gebruiksoppervlakte-gebouwgebondenbuitenruimte","label":"Gebouwgebonden buitenruimte","value":"14 m²"}],"label":"Gebruiksoppervlakten"},{"id":"afmetingen-inhoud","label":"Inhoud","value":"194 m³"}],"title":"Oppervlakten en inhoud"},{"id":"indeling","items":[{"id":"indeling-totalrooms","label":"Aantal kamers","value":"3 kamers (2 slaapkamers)"},{"id":"indeling-totalbathroom","label":"Aantal badkamers","value":"1 badkamer"},{"id":"indeling-bathroom","label":"Badkamervoorzieningen","value":"Inloopdouche, toilet, wastafel, en wastafelmeubel"},{"id":"indeling-totalstories","label":"Aantal woonlagen","value":"1 woonlaag"},{"id":"indeling-generalfacilities","label":"Voorzieningen","value":"Mechanische ventilatie"},{"id":"indeling-locatedat","label":"Gelegen op","value":"1e woonlaag"}],"title":"Indeling"},{"id":"energie","items":[{"id":"energie-energielabel","label":"Energielabel","value":"D"},{"id":"energie-isolatie","label":"Isolatie","value":"Grotendeels dubbelglas"},{"id":"energie-verwarming","label":"Verwarming","value":"Cv-ketel"},{"id":"energie-warmwater","label":"Warm water","value":"Cv-ketel"},{"id":"energie-cv","label":"Cv-ketel","value":"Remeha intergas (gas gestookt combiketel uit 2011, eigendom)"}],"title":"Energie"},{"id":"cadastral","items":[{"id":"cadastral-parcel","items":[{"id":"cadastral-ownershipsituation","label":"Eigendomssituatie","value":"Volle eigendom"}],"label":"SLOTEN O 2521"}],"title":"Kadastrale gegevens"},{"id":"buitenruimte","items":[{"id":"buitenruimte-ligging","label":"Ligging","value":"Aan rustige weg, in woonwijk, open ligging en vrij uitzicht"},{"id":"buitenruimte-balkonterras","label":"Balkon/dakterras","value":"Balkon aanwezig"}],"title":"Buitenruimte"},{"id":"parkeergelegenheid","items":[{"label":"Soort parkeergelegenheid","value":"Betaald parkeren, openbaar parkeren en parkeervergunningen"}],"title":"Parkeergelegenheid"},{"id":"vvechecklist","items":[{"label":"Inschrijving KvK","value":"Ja"},{"label":"Jaarlijkse vergadering","value":"Ja"},{"label":"Periodieke bijdrage","value":"Ja (€ 100,00 per maand)"},{"label":"Reservefonds aanwezig","value":"Ja"},{"label":"Onderhoudsplan","value":"Ja"},{"label":"Opstalverzekering","value":"Ja"}],"title":"VvE checklist"}],"latitude":52.352062,"province":"Noord-Holland","subtitle":"1058 LR Amsterdam","global_id":8209743,"longitude":4.846501,"highlights":[{"title":"Zonnig verdiept balkon","category":"outdoor_space_and_views","description":"Balkon van circa 14 m² op het zuiden met groen uitzicht."},{"title":"Ruime vernieuwde woonkeuken","category":"kitchen_and_living","description":"Recent vernieuwde woonkeuken met plek voor grote eettafel."},{"title":"Toplocatie aan Westlandgracht","category":"location_and_surroundings","description":"Aan Westlandgracht, op loopafstand van het Vondelpark."}],"is_auction":false,"photos_360":["https://cloud.funda.nl/listing-management/e3ae662c-5ce0-4952-b3c5-eda8703c5543","https://cloud.funda.nl/listing-management/800b9f03-2cee-4b44-b1a7-286c2e3e1f87","https://cloud.funda.nl/listing-management/b2cd097e-e259-4cca-b8b2-cdf2a09ec503"],"promo_text":"Sfeervol appartement met verdiept balkon in de Hoofdorppleinbuurt!","description":"In een van de mooiste straten van de geliefde Hoofddorppleinbuurt ligt dit lichte en sfeervolle driekamerappartement van circa 60 m², met een zonnig, verdiept balkon van circa 14 m² op het zuiden. De woning heeft een praktische indeling, een ruime woonkeuken en een prachtig uitzicht over de Westlandgracht. Gelegen op eigen grond, op loopafstand van het Vondelpark en met alle gezellige hotspots van Amsterdam-Zuid binnen handbereik!\n\nOmgeving en bereikbaarheid\n\nDe woning ligt op een heerlijke locatie in de populaire Hoofddorppleinbuurt, waar rust, groen en het bruisende stadsleven samenkomen. Op zomerse dagen verandert de Westlandgracht in een populaire zwem- en ligplek voor de hele buurt, en die ligt letterlijk voor de deur. Voor een wandeling of sportieve activiteit liggen het Vondelpark, Rembrandtpark, Nieuwe Meer en Amsterdamse Bos op korte afstand.\n\nOok aan gezellige horeca geen gebrek! Begin je dag met een goede koffie bij Anne & Max of Catcha, geniet van een borrel bij Lokaal van de Stad, Bar Bonnie of Gent aan de Schinkel en schuif voor een uitgebreid diner aan bij Ron Gastrobar of Simply Fish. De nabijgelegen Amstelveenseweg, Overtoom en het Stadionplein bieden daarnaast een ruim aanbod aan winkels, speciaalzaken en restaurants. De bereikbaarheid is uitstekend, zowel met de fiets, het openbaar vervoer als met de auto.\n\nIndeling\n\nBegane grond\n\nVerzorgde gemeenschappelijke entree met toegang tot het trappenhuis, dat je met slechts één ander appartement deelt.\n\nEerste verdieping\n\nVia de hal bereik je alle vertrekken. Aan de voorzijde bevindt zich de lichte en ruime woonkamer met grote raampartijen, een charmante erker en een prachtig uitzicht over de Westlandgracht. De aangrenzende zijkamer is momenteel ingericht als thuiswerkplek. Door deuren in het portaal te plaatsen, kan deze ruimte als tweede slaapkamer worden gebruikt.\n\nAan de achterzijde ligt de recent vernieuwde woonkeuken, uitgevoerd met eikenhoutkleurige kasten, een wit werkblad en diverse inbouwapparatuur. Er is voldoende ruimte voor een royale eettafel. Vanaf vroeg in de winter valt er direct zonlicht de keuken binnen, wat het een bijzonder fijne plek maakt om te koken en te eten.\n\nVanuit de keuken heb je direct toegang tot het zonnige, verdiepte balkon van circa 14 m² op het zuiden. Een heerlijke plek om bijna het hele jaar van de zon te genieten, met uitzicht op de rustige en groene binnentuinen.\n\nDe ruime slaapkamer beschikt over openslaande deuren naar het balkon en biedt voldoende ruimte voor een kingsize bed en een grote kastenwand.\n\nCentraal in de woning bevindt zich de moderne badkamer, stijlvol afgewerkt met donkerkleurige beton ciré en voorzien van een inloopdouche, toilet en wastafelmeubel.\n\nWat de eigenaren gaan missen\n\n“’s Ochtends de balkondeuren vanuit de slaapkamer openslaan en de vogels horen fluiten in de groene binnentuinen. En op zomerse avonden met een bordje avondeten aan de Westlandgracht liggen, daarna een duik nemen en nog even van de zon genieten. Dat voelt als een minivakantie, gewoon voor de deur. Er is altijd leven en gezelligheid.”\n\nVereniging van Eigenaren\n\nDe woning maakt deel uit van een kleinschalige, gezonde Vereniging van Eigenaren, die beschikt over een onderhoudsplan. De maandelijkse servicekosten bedragen € 100,-.\n\nBijzonderheden\n- Zonnig, verdiept balkon van circa 14 m² op het zuiden;\n- Prachtig uitzicht over de Westlandgracht;\n- Gelegen op eigen grond, dus géén erfpacht;\n- Tweede slaapkamer te realiseren door het plaatsen van deuren in het portaal;\n- Recent vernieuwde woonkeuken met ruimte voor een royale eettafel;\n- Kleinschalige, gezonde VvE met onderhoudsplan;\n- Gelegen in de geliefde Hoofddorppleinbuurt in Amsterdam-Zuid;\n\nKerngegevens woning\nOppervlakte: ca. 59,5m² (NEN 2580 rapportage aanwezig) \nAantal kamers: 3 waarvan 2e slaapkamer is eenvoudig te creëren\nBuitenruimte: 13,5 m²\nEnergielabel: D geldig tot 19-10-2036\nBouwjaar: 1934\nVerwarming: Remeha intergas uit 2011\n\nKadastrale gegevens\nGemeente: Sloten N/H \nSectie + nummer: O 2521 A7\nAandeel: 6/20\nEigen grond\n\nVvE\nAantal leden: 3\nEigen beheer\nServicekosten: €100,- per maand \nMJOP: Aanwezig en geldig tot 2036\n\nOverig\nOuderdomsclausule is van toepassing \nNotaris: ring Amsterdam\nOplevering in: in overleg \n\nDeze informatie is door ons met de nodige zorgvuldigheid samengesteld. Onzerzijds wordt echter geen enkele aansprakelijkheid aanvaard voor enige onvolledigheid, onjuistheid of anderszins, dan wel de gevolgen daarvan. Alle opgegeven maten en oppervlakten zijn indicatief. Koper heeft de eigen onderzoeksplicht naar alle zaken die voor hem of haar van belang zijn. Met betrekking tot deze woning is de makelaar adviseur van verkoper. Wij adviseren u een deskundige makelaar in te schakelen die u begeleidt bij het aankoopproces. Indien u specifieke wensen heeft omtrent de woning, adviseren wij u deze tijdig kenbaar te maken aan uw aankopend makelaar en hiernaar zelfstandig onderzoek te (laten) doen. Indien u geen deskundige vertegenwoordiger inschakelt, acht u zich volgens de wet deskundig genoeg om alle zaken die van belang zijn te kunnen voorzien.","floor_plans":["https://cloud.funda.nl/listing-management/0008624c-4bac-4051-b047-6afa4c941642"],"living_area":60,"object_type":"apartment","postal_code":"1058 LR","brochure_url":"https://cloud.funda.nl/valentina_media/237/101/200.pdf","energy_label":"D","house_number":"57","price_per_m2":9417,"virtual_tour":null,"canonical_url":"https://www.funda.nl/detail/koop/amsterdam/appartement-hillegomstraat-57-1/17381479/","neighbourhood":"Westlandgrachtbuurt","offering_type":"koop","price_display":"€ 565.000 k.k.","publication_date":"2026-10-29T00:00:00","is_sold_or_rented":false,"house_number_suffix":"1","neighbourhood_stats":{"city":"Amsterdam","inhabitants":3585,"neighbourhood":"Westlandgrachtbuurt","families_with_children":18.44,"average_asking_price_per_m2":8939}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/immobilienscout24/property":{"get":{"summary":"ImmobilienScout24 Property","description":"Read one ImmobilienScout24 expose by URL or numeric id. You get cold rent or purchase price, address, and area.\n\n**Credit cost:** 2 credits per call","operationId":"get-immobilienscout24-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The expose id, or the expose page URL.\n\n**Id:**\n\n```\n168052908\n```\n\n**URL:**\n\n```\nhttps://www.immobilienscout24.de/expose/168052908\n```\n\nA search URL is rejected.","schema":{"type":"string","default":"168052908","description":"The expose id, or the expose page URL.\n\n**Id:**\n\n```\n168052908\n```\n\n**URL:**\n\n```\nhttps://www.immobilienscout24.de/expose/168052908\n```\n\nA search URL is rejected."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML in `result` instead of the parsed expose.","schema":{"type":"boolean","description":"When true, return the raw HTML in `result` instead of the parsed expose."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"floor":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"caption":{"type":"string"}}}},"street":{"type":"string"},"address":{"type":"string"},"currency":{"type":"string"},"district":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"condition":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"offer_type":{"type":"string"},"total_rent":{"type":"integer"},"address_url":{"type":"string"},"description":{"type":"string"},"contact_name":{"type":"string"},"heating_type":{"type":"string"},"listing_type":{"type":"string"},"living_space":{"type":"number"},"realtor_logo":{"type":"string"},"energy_source":{"type":"string"},"price_display":{"type":"string"},"price_per_sqm":{"type":"integer"},"private_offer":{"type":"boolean"},"property_type":{"type":"string"},"available_from":{"type":"string"},"deposit_display":{"nullable":true},"realtor_company":{"type":"string"},"construction_year":{"type":"string"},"other_description":{"type":"string"},"energy_certificate":{"type":"string"},"energy_consumption":{"type":"string"},"furnishing_quality":{"type":"string"},"total_rent_display":{"type":"string"},"heating_cost_display":{"type":"string"},"living_space_display":{"type":"string"},"location_description":{"type":"string"},"price_per_sqm_display":{"type":"string"},"furnishing_description":{"type":"string"},"additional_cost_display":{"nullable":true},"energy_certificate_type":{"type":"string"},"energy_efficiency_class":{"nullable":true}}},"examples":{"Berlin rental expose":{"value":{"id":"168052908","url":"https://www.immobilienscout24.de/expose/168052908","city":"Berlin","floor":"0","price":362,"rooms":2,"title":"Naturverbunden wohnen in kompakter 2-Zimmer-Gartenwohnung mit WBS-140-Förderung","images":[{"url":"https://pictures.immobilienscout24.de/listings/7059e813-0eb0-4e71-82d6-e98b247a3755-2033933665.jpg/ORIG/resize/1106x830%3E/format/webp/quality/73","caption":"Außenvisualisierung"}],"street":"Hellersdorfer Straße 91","address":"Hellersdorfer Straße 91, Hellersdorf, 12619 Berlin","currency":"EUR","district":"Hellersdorf","features":["Wohnberechtigungsschein erforderlich"],"postcode":"12619","condition":"Erstbezug","attributes":[{"label":"Typ","value":"Erdgeschosswohnung"},{"label":"Etage","value":"0"},{"label":"Wohnfläche ca.","value":"51,7 m²"},{"label":"Bezugsfrei ab","value":"16.10.2026"},{"label":"Zimmer","value":"2"},{"label":"Internet","value":"Verfügbarkeit prüfen"},{"label":"Kaltmiete","value":"362 €"},{"label":"Preis/m²","value":"7 €/m²"},{"label":"Heizkosten","value":"keine Angabe"},{"label":"Gesamtmiete","value":"569 € (zzgl. Nebenkosten & Heizkosten)"},{"label":"Baujahr","value":"2025"},{"label":"Objektzustand","value":"Erstbezug"},{"label":"Ausstattung","value":"Gehobene Qualität"},{"label":"Heizungsart","value":"Fernwärme"},{"label":"Wesentliche Energieträger","value":"Fernwärme"},{"label":"Energieausweis","value":"liegt vor"},{"label":"Energieausweistyp","value":"Bedarfsausweis"},{"label":"Endenergiebedarf","value":"59,9 kWh/(m²*a)"},{"label":"Baujahr laut Energieausweis","value":"2025"}],"offer_type":"rent","total_rent":569,"address_url":"https://orte.immobilienscout24.de/adresse/berlin-12619-hellersdorfer-strasse-nr-91","description":"Die Wohnung wird ausschließlich an einen 2-Personen-Haushalt vermietet, dessen Jahres-Netto-Einkommen die Voraussetzungen für einen Wohnberechtigungsschein (WBS 140) erfüllt.","contact_name":"Alex Martin","heating_type":"Fernwärme","listing_type":"XXL","living_space":51.7,"realtor_logo":"https://pictures.immobilienscout24.de/usercontent/c9e73109-7e88-4e3c-9268-6966f3659c90.JPG/ORIG/resize/150x150%3E/quality/73","energy_source":"Fernwärme","price_display":"362 €","price_per_sqm":7,"private_offer":false,"property_type":"Erdgeschosswohnung","available_from":"16.10.2026","deposit_display":null,"realtor_company":"GESOBAU AG","construction_year":"2025","other_description":"Bei der GESOBAU bleiben keine Wünsche offen. Wir helfen Ihnen bei der Wohnungssuche in Berlin.","energy_certificate":"liegt vor","energy_consumption":"59,9 kWh/(m²*a)","furnishing_quality":"Gehobene Qualität","total_rent_display":"569 € (zzgl. Nebenkosten & Heizkosten)","heating_cost_display":"keine Angabe","living_space_display":"51,7 m²","location_description":"Das Cecilien-Carré befindet sich im Berliner Ortsteil Hellersdorf und verbindet kurze Wege im Alltag mit viel Freiraum im direkten Umfeld.","price_per_sqm_display":"7 €/m²","furnishing_description":"Die Ausstattung im Cecilien-Carré orientiert sich am Alltag moderner Stadtbewohner und verbindet praktische Wohnqualität mit nachhaltigen Lösungen.","additional_cost_display":null,"energy_certificate_type":"Bedarfsausweis","energy_efficiency_class":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ImmobilienScout24 Property","description":"Read one ImmobilienScout24 expose by URL or numeric id. You get cold rent or purchase price, address, and area.\n\n**Credit cost:** 2 credits per call","operationId":"post-immobilienscout24-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The expose id, or the expose page URL.\n\n**Id:**\n\n```\n168052908\n```\n\n**URL:**\n\n```\nhttps://www.immobilienscout24.de/expose/168052908\n```\n\nA search URL is rejected.","schema":{"type":"string","default":"168052908","description":"The expose id, or the expose page URL.\n\n**Id:**\n\n```\n168052908\n```\n\n**URL:**\n\n```\nhttps://www.immobilienscout24.de/expose/168052908\n```\n\nA search URL is rejected."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML in `result` instead of the parsed expose.","schema":{"type":"boolean","description":"When true, return the raw HTML in `result` instead of the parsed expose."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"floor":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"caption":{"type":"string"}}}},"street":{"type":"string"},"address":{"type":"string"},"currency":{"type":"string"},"district":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"condition":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"offer_type":{"type":"string"},"total_rent":{"type":"integer"},"address_url":{"type":"string"},"description":{"type":"string"},"contact_name":{"type":"string"},"heating_type":{"type":"string"},"listing_type":{"type":"string"},"living_space":{"type":"number"},"realtor_logo":{"type":"string"},"energy_source":{"type":"string"},"price_display":{"type":"string"},"price_per_sqm":{"type":"integer"},"private_offer":{"type":"boolean"},"property_type":{"type":"string"},"available_from":{"type":"string"},"deposit_display":{"nullable":true},"realtor_company":{"type":"string"},"construction_year":{"type":"string"},"other_description":{"type":"string"},"energy_certificate":{"type":"string"},"energy_consumption":{"type":"string"},"furnishing_quality":{"type":"string"},"total_rent_display":{"type":"string"},"heating_cost_display":{"type":"string"},"living_space_display":{"type":"string"},"location_description":{"type":"string"},"price_per_sqm_display":{"type":"string"},"furnishing_description":{"type":"string"},"additional_cost_display":{"nullable":true},"energy_certificate_type":{"type":"string"},"energy_efficiency_class":{"nullable":true}}},"examples":{"Berlin rental expose":{"value":{"id":"168052908","url":"https://www.immobilienscout24.de/expose/168052908","city":"Berlin","floor":"0","price":362,"rooms":2,"title":"Naturverbunden wohnen in kompakter 2-Zimmer-Gartenwohnung mit WBS-140-Förderung","images":[{"url":"https://pictures.immobilienscout24.de/listings/7059e813-0eb0-4e71-82d6-e98b247a3755-2033933665.jpg/ORIG/resize/1106x830%3E/format/webp/quality/73","caption":"Außenvisualisierung"}],"street":"Hellersdorfer Straße 91","address":"Hellersdorfer Straße 91, Hellersdorf, 12619 Berlin","currency":"EUR","district":"Hellersdorf","features":["Wohnberechtigungsschein erforderlich"],"postcode":"12619","condition":"Erstbezug","attributes":[{"label":"Typ","value":"Erdgeschosswohnung"},{"label":"Etage","value":"0"},{"label":"Wohnfläche ca.","value":"51,7 m²"},{"label":"Bezugsfrei ab","value":"16.10.2026"},{"label":"Zimmer","value":"2"},{"label":"Internet","value":"Verfügbarkeit prüfen"},{"label":"Kaltmiete","value":"362 €"},{"label":"Preis/m²","value":"7 €/m²"},{"label":"Heizkosten","value":"keine Angabe"},{"label":"Gesamtmiete","value":"569 € (zzgl. Nebenkosten & Heizkosten)"},{"label":"Baujahr","value":"2025"},{"label":"Objektzustand","value":"Erstbezug"},{"label":"Ausstattung","value":"Gehobene Qualität"},{"label":"Heizungsart","value":"Fernwärme"},{"label":"Wesentliche Energieträger","value":"Fernwärme"},{"label":"Energieausweis","value":"liegt vor"},{"label":"Energieausweistyp","value":"Bedarfsausweis"},{"label":"Endenergiebedarf","value":"59,9 kWh/(m²*a)"},{"label":"Baujahr laut Energieausweis","value":"2025"}],"offer_type":"rent","total_rent":569,"address_url":"https://orte.immobilienscout24.de/adresse/berlin-12619-hellersdorfer-strasse-nr-91","description":"Die Wohnung wird ausschließlich an einen 2-Personen-Haushalt vermietet, dessen Jahres-Netto-Einkommen die Voraussetzungen für einen Wohnberechtigungsschein (WBS 140) erfüllt.","contact_name":"Alex Martin","heating_type":"Fernwärme","listing_type":"XXL","living_space":51.7,"realtor_logo":"https://pictures.immobilienscout24.de/usercontent/c9e73109-7e88-4e3c-9268-6966f3659c90.JPG/ORIG/resize/150x150%3E/quality/73","energy_source":"Fernwärme","price_display":"362 €","price_per_sqm":7,"private_offer":false,"property_type":"Erdgeschosswohnung","available_from":"16.10.2026","deposit_display":null,"realtor_company":"GESOBAU AG","construction_year":"2025","other_description":"Bei der GESOBAU bleiben keine Wünsche offen. Wir helfen Ihnen bei der Wohnungssuche in Berlin.","energy_certificate":"liegt vor","energy_consumption":"59,9 kWh/(m²*a)","furnishing_quality":"Gehobene Qualität","total_rent_display":"569 € (zzgl. Nebenkosten & Heizkosten)","heating_cost_display":"keine Angabe","living_space_display":"51,7 m²","location_description":"Das Cecilien-Carré befindet sich im Berliner Ortsteil Hellersdorf und verbindet kurze Wege im Alltag mit viel Freiraum im direkten Umfeld.","price_per_sqm_display":"7 €/m²","furnishing_description":"Die Ausstattung im Cecilien-Carré orientiert sich am Alltag moderner Stadtbewohner und verbindet praktische Wohnqualität mit nachhaltigen Lösungen.","additional_cost_display":null,"energy_certificate_type":"Bedarfsausweis","energy_efficiency_class":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/immobilienscout24/search":{"get":{"summary":"ImmobilienScout24 Search","description":"Search ImmobilienScout24 by region and property type. real_estate_type covers rent, buy, house, and land. Page with pagenumber.\n\n**Credit cost:** 2 credits per call","operationId":"get-immobilienscout24-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Where to search.\n\n**Berlin rent:**\n\n```\nberlin/berlin\n```\n\n**Berlin buy:** the same region, with real_estate_type set to buy.\n\n**Another city:**\n\n```\nbayern/muenchen\n```\n\n**Full search URL:**\n\n```\nhttps://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten\n```\n\n`berlin` alone is the same as `berlin/berlin`. An expose URL is rejected.","schema":{"type":"string","default":"berlin/berlin","description":"Where to search.\n\n**Berlin rent:**\n\n```\nberlin/berlin\n```\n\n**Berlin buy:** the same region, with real_estate_type set to buy.\n\n**Another city:**\n\n```\nbayern/muenchen\n```\n\n**Full search URL:**\n\n```\nhttps://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten\n```\n\n`berlin` alone is the same as `berlin/berlin`. An expose URL is rejected."}},{"name":"real_estate_type","in":"query","required":false,"description":"Rent or buy.\n\n**Berlin rent:**\n\n```\nrent\n```\n\n**Berlin buy:**\n\n```\nbuy\n```\n\nAlso accepted: wohnung-mieten, wohnung-kaufen, haus-mieten, haus-kaufen, grundstueck-kaufen, wg-zimmer, wohnen-auf-zeit.\n\nOn a full URL this replaces the kind already in the path.","schema":{"type":"string","description":"Rent or buy.\n\n**Berlin rent:**\n\n```\nrent\n```\n\n**Berlin buy:**\n\n```\nbuy\n```\n\nAlso accepted: wohnung-mieten, wohnung-kaufen, haus-mieten, haus-kaufen, grundstueck-kaufen, wg-zimmer, wohnen-auf-zeit.\n\nOn a full URL this replaces the kind already in the path."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1.\n\n**Next page of a Berlin rent search:**\n\n```\n2\n```\n\nPage 2 returns different listing ids from page 1.","schema":{"type":"number","description":"Page number, starting at 1.\n\n**Next page of a Berlin rent search:**\n\n```\n2\n```\n\nPage 2 returns different listing ids from page 1."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML in `result` instead of the parsed JSON.","schema":{"type":"boolean","description":"When true, return the raw HTML in `result` instead of the parsed JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"tags":{"type":"array","items":{}},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"garden":{"type":"boolean"},"images":{"type":"array","items":{"type":"string"}},"is_new":{"type":"boolean"},"street":{"type":"string"},"address":{"type":"string"},"balcony":{"type":"boolean"},"project":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"address":{"type":"string"},"price_display":{"type":"string"},"available_from":{"type":"string"},"living_space_display":{"type":"string"},"grouped_listing_count":{"type":"integer"}}},"quarter":{"type":"string"},"realtor":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"floorplan":{"type":"boolean"},"longitude":{"type":"number"},"offer_type":{"type":"string"},"total_rent":{"type":"integer"},"house_number":{"type":"string"},"listing_type":{"type":"string"},"living_space":{"type":"number"},"published_at":{"type":"string"},"price_display":{"type":"string"},"private_offer":{"type":"boolean"},"price_interval":{"type":"string"},"built_in_kitchen":{"type":"boolean"},"floorplan_images":{"type":"array","items":{}},"real_estate_type":{"type":"string"},"construction_year":{"type":"integer"},"total_rent_display":{"type":"string"},"living_space_display":{"type":"string"},"energy_efficiency_class":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Berlin apartment for rent":{"value":{"results":[{"id":"168052908","url":"https://www.immobilienscout24.de/expose/168052908","city":"Berlin","tags":[],"price":362,"rooms":2,"title":"Naturverbunden wohnen in kompakter 2-Zimmer-Gartenwohnung mit WBS-140-Förderung","garden":false,"images":["https://pictures.immobilienscout24.de/listings/7059e813-0eb0-4e71-82d6-e98b247a3755-2033933665.jpg/ORIG/legacy_thumbnail/800x600/format/webp/quality/50"],"is_new":false,"street":"Hellersdorfer Straße","address":"Hellersdorfer Straße 91, Hellersdorf, Berlin","balcony":false,"project":{"id":"147913","url":"https://www.immobilienscout24.de/neubau/gesobau-ag/cecilien-carr/147913.html","name":"Cecilien-Carré","title":"Moderne Neubauwohnungen im grünen Berlin-Hellersdorf – WBS 220 erforderlich","address":"Hellersdorfer Straße 91, 12619 Berlin","price_display":"362 - 1.271 €","available_from":"16.10.2026","living_space_display":"52 - 87 m²","grouped_listing_count":10},"quarter":"Kaulsdorf (Hellersdorf)","realtor":"GESOBAU AG","currency":"EUR","latitude":52.52485,"postcode":"12619","floorplan":false,"longitude":13.58695,"offer_type":"rent","total_rent":569,"house_number":"91","listing_type":"XXL","living_space":51.7,"published_at":"2026-10-07T12:56:54.000+02:00","price_display":"362 €","private_offer":false,"price_interval":"month","built_in_kitchen":false,"floorplan_images":[],"real_estate_type":"apartment_rent","construction_year":2025,"total_rent_display":"569 €","living_space_display":"51,7 m²","energy_efficiency_class":"B"}],"pagination":{"next":"https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten?pagenumber=2","page":1,"per_page":20,"total_pages":632,"total_results":13214}}},"Berlin apartment for sale":{"value":{"results":[{"id":"166798088","url":"https://www.immobilienscout24.de/expose/166798088","city":"Berlin","tags":["Balkon/Terrasse"],"price":519464,"rooms":3,"title":"Altbau-Charme in Treptow-Köpenick – Gemütliche 3-Zimmer-Wohnung mit zwei Balkonen","garden":false,"images":["https://pictures.immobilienscout24.de/listings/74f381ed-e8e8-45c7-9cfa-b98bcc835c72-2011215447.jpg/ORIG/legacy_thumbnail/800x600/format/webp/quality/50"],"is_new":false,"street":"Baumschulenstraße","address":"Baumschulenstraße 27/29, Baumschulenweg, Berlin","balcony":true,"project":{"id":"127686","url":"https://www.immobilienscout24.de/neubau/escon-gmbh/baumschulenstrasse-27-29/127686.html","name":"Baumschulenstraße 27/29","title":"Sanierter Altbau in zentraler Lage mit klimatisierten Dachgeschosswohnungen","address":"Baumschulenstraße 27/29, 12437 Berlin","price_display":"222.500 - 741.000 €","available_from":"07/2026","living_space_display":"33 - 101 m²","grouped_listing_count":null},"quarter":"Baumschulenweg (Treptow)","realtor":"ESCON GmbH","currency":"EUR","latitude":52.46454,"postcode":"12437","floorplan":true,"longitude":13.48634,"offer_type":"buy","total_rent":null,"house_number":"27/29","listing_type":"XXL","living_space":84.65,"published_at":"2026-04-08T15:40:53.000+02:00","price_display":"519.464 €","private_offer":false,"price_interval":"one_time_charge","built_in_kitchen":false,"floorplan_images":["https://pictures.immobilienscout24.de/listings/f46e6ba8-dbc2-4714-b4aa-d4bb72d88010-2011215445.jpg/ORIG/legacy_thumbnail/800x600/format/webp/quality/50"],"real_estate_type":"apartment_buy","construction_year":null,"total_rent_display":null,"living_space_display":"84,65 m²","energy_efficiency_class":null}],"pagination":{"next":"https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-kaufen?pagenumber=2","page":1,"per_page":20,"total_pages":642,"total_results":13741}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ImmobilienScout24 Search","description":"Search ImmobilienScout24 by region and property type. real_estate_type covers rent, buy, house, and land. Page with pagenumber.\n\n**Credit cost:** 2 credits per call","operationId":"post-immobilienscout24-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Where to search.\n\n**Berlin rent:**\n\n```\nberlin/berlin\n```\n\n**Berlin buy:** the same region, with real_estate_type set to buy.\n\n**Another city:**\n\n```\nbayern/muenchen\n```\n\n**Full search URL:**\n\n```\nhttps://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten\n```\n\n`berlin` alone is the same as `berlin/berlin`. An expose URL is rejected.","schema":{"type":"string","default":"berlin/berlin","description":"Where to search.\n\n**Berlin rent:**\n\n```\nberlin/berlin\n```\n\n**Berlin buy:** the same region, with real_estate_type set to buy.\n\n**Another city:**\n\n```\nbayern/muenchen\n```\n\n**Full search URL:**\n\n```\nhttps://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten\n```\n\n`berlin` alone is the same as `berlin/berlin`. An expose URL is rejected."}},{"name":"real_estate_type","in":"query","required":false,"description":"Rent or buy.\n\n**Berlin rent:**\n\n```\nrent\n```\n\n**Berlin buy:**\n\n```\nbuy\n```\n\nAlso accepted: wohnung-mieten, wohnung-kaufen, haus-mieten, haus-kaufen, grundstueck-kaufen, wg-zimmer, wohnen-auf-zeit.\n\nOn a full URL this replaces the kind already in the path.","schema":{"type":"string","description":"Rent or buy.\n\n**Berlin rent:**\n\n```\nrent\n```\n\n**Berlin buy:**\n\n```\nbuy\n```\n\nAlso accepted: wohnung-mieten, wohnung-kaufen, haus-mieten, haus-kaufen, grundstueck-kaufen, wg-zimmer, wohnen-auf-zeit.\n\nOn a full URL this replaces the kind already in the path."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1.\n\n**Next page of a Berlin rent search:**\n\n```\n2\n```\n\nPage 2 returns different listing ids from page 1.","schema":{"type":"number","description":"Page number, starting at 1.\n\n**Next page of a Berlin rent search:**\n\n```\n2\n```\n\nPage 2 returns different listing ids from page 1."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML in `result` instead of the parsed JSON.","schema":{"type":"boolean","description":"When true, return the raw HTML in `result` instead of the parsed JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"tags":{"type":"array","items":{}},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"garden":{"type":"boolean"},"images":{"type":"array","items":{"type":"string"}},"is_new":{"type":"boolean"},"street":{"type":"string"},"address":{"type":"string"},"balcony":{"type":"boolean"},"project":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"address":{"type":"string"},"price_display":{"type":"string"},"available_from":{"type":"string"},"living_space_display":{"type":"string"},"grouped_listing_count":{"type":"integer"}}},"quarter":{"type":"string"},"realtor":{"type":"string"},"currency":{"type":"string"},"latitude":{"type":"number"},"postcode":{"type":"string"},"floorplan":{"type":"boolean"},"longitude":{"type":"number"},"offer_type":{"type":"string"},"total_rent":{"type":"integer"},"house_number":{"type":"string"},"listing_type":{"type":"string"},"living_space":{"type":"number"},"published_at":{"type":"string"},"price_display":{"type":"string"},"private_offer":{"type":"boolean"},"price_interval":{"type":"string"},"built_in_kitchen":{"type":"boolean"},"floorplan_images":{"type":"array","items":{}},"real_estate_type":{"type":"string"},"construction_year":{"type":"integer"},"total_rent_display":{"type":"string"},"living_space_display":{"type":"string"},"energy_efficiency_class":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Berlin apartment for rent":{"value":{"results":[{"id":"168052908","url":"https://www.immobilienscout24.de/expose/168052908","city":"Berlin","tags":[],"price":362,"rooms":2,"title":"Naturverbunden wohnen in kompakter 2-Zimmer-Gartenwohnung mit WBS-140-Förderung","garden":false,"images":["https://pictures.immobilienscout24.de/listings/7059e813-0eb0-4e71-82d6-e98b247a3755-2033933665.jpg/ORIG/legacy_thumbnail/800x600/format/webp/quality/50"],"is_new":false,"street":"Hellersdorfer Straße","address":"Hellersdorfer Straße 91, Hellersdorf, Berlin","balcony":false,"project":{"id":"147913","url":"https://www.immobilienscout24.de/neubau/gesobau-ag/cecilien-carr/147913.html","name":"Cecilien-Carré","title":"Moderne Neubauwohnungen im grünen Berlin-Hellersdorf – WBS 220 erforderlich","address":"Hellersdorfer Straße 91, 12619 Berlin","price_display":"362 - 1.271 €","available_from":"16.10.2026","living_space_display":"52 - 87 m²","grouped_listing_count":10},"quarter":"Kaulsdorf (Hellersdorf)","realtor":"GESOBAU AG","currency":"EUR","latitude":52.52485,"postcode":"12619","floorplan":false,"longitude":13.58695,"offer_type":"rent","total_rent":569,"house_number":"91","listing_type":"XXL","living_space":51.7,"published_at":"2026-10-07T12:56:54.000+02:00","price_display":"362 €","private_offer":false,"price_interval":"month","built_in_kitchen":false,"floorplan_images":[],"real_estate_type":"apartment_rent","construction_year":2025,"total_rent_display":"569 €","living_space_display":"51,7 m²","energy_efficiency_class":"B"}],"pagination":{"next":"https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten?pagenumber=2","page":1,"per_page":20,"total_pages":632,"total_results":13214}}},"Berlin apartment for sale":{"value":{"results":[{"id":"166798088","url":"https://www.immobilienscout24.de/expose/166798088","city":"Berlin","tags":["Balkon/Terrasse"],"price":519464,"rooms":3,"title":"Altbau-Charme in Treptow-Köpenick – Gemütliche 3-Zimmer-Wohnung mit zwei Balkonen","garden":false,"images":["https://pictures.immobilienscout24.de/listings/74f381ed-e8e8-45c7-9cfa-b98bcc835c72-2011215447.jpg/ORIG/legacy_thumbnail/800x600/format/webp/quality/50"],"is_new":false,"street":"Baumschulenstraße","address":"Baumschulenstraße 27/29, Baumschulenweg, Berlin","balcony":true,"project":{"id":"127686","url":"https://www.immobilienscout24.de/neubau/escon-gmbh/baumschulenstrasse-27-29/127686.html","name":"Baumschulenstraße 27/29","title":"Sanierter Altbau in zentraler Lage mit klimatisierten Dachgeschosswohnungen","address":"Baumschulenstraße 27/29, 12437 Berlin","price_display":"222.500 - 741.000 €","available_from":"07/2026","living_space_display":"33 - 101 m²","grouped_listing_count":null},"quarter":"Baumschulenweg (Treptow)","realtor":"ESCON GmbH","currency":"EUR","latitude":52.46454,"postcode":"12437","floorplan":true,"longitude":13.48634,"offer_type":"buy","total_rent":null,"house_number":"27/29","listing_type":"XXL","living_space":84.65,"published_at":"2026-04-08T15:40:53.000+02:00","price_display":"519.464 €","private_offer":false,"price_interval":"one_time_charge","built_in_kitchen":false,"floorplan_images":["https://pictures.immobilienscout24.de/listings/f46e6ba8-dbc2-4714-b4aa-d4bb72d88010-2011215445.jpg/ORIG/legacy_thumbnail/800x600/format/webp/quality/50"],"real_estate_type":"apartment_buy","construction_year":null,"total_rent_display":null,"living_space_display":"84,65 m²","energy_efficiency_class":null}],"pagination":{"next":"https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-kaufen?pagenumber=2","page":1,"per_page":20,"total_pages":642,"total_results":13741}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/cultura/search":{"get":{"summary":"Cultura Search","description":"Search Cultura by keyword and page through books, games, and culture products. Cards include title, price, availability, and the product link.\n\n**Credit cost:** 2 credits per call","operationId":"get-cultura-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Words to search for on Cultura, or the search page link.\n\n**Examples:**\n\n```\nharry potter\n```\n\n```\nhttps://www.cultura.com/search/results?search_query=harry+potter\n```\n\nA product link (`/p-....html`) returns 400.","schema":{"type":"string","description":"Words to search for on Cultura, or the search page link.\n\n**Examples:**\n\n```\nharry potter\n```\n\n```\nhttps://www.cultura.com/search/results?search_query=harry+potter\n```\n\nA product link (`/p-....html`) returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. For example, 2 returns the next page of results.\n\nWhen query is a search link, a number above 1 replaces the page in that link.","schema":{"type":"number","description":"Page number, starting at 1. For example, 2 returns the next page of results.\n\nWhen query is a search link, a number above 1 replaces the page in that link."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"rating":{"nullable":true},"currency":{"type":"string"},"position":{"type":"integer"},"availability":{"type":"string"},"review_count":{"nullable":true},"price_display":{"type":"string"},"new_offers_count":{"nullable":true},"new_offers_price":{"nullable":true},"used_offers_count":{"nullable":true},"used_offers_price":{"nullable":true},"new_offers_price_display":{"nullable":true},"used_offers_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"harry potter, first product":{"value":{"results":[{"sku":"13432454","url":"https://www.cultura.com/p-harry-potter-a-l-ecole-des-sorciers-9782075253147.html","name":"Harry Potter à l'école des sorciers","badge":"Précommande","brand":"J. K. Rowling","image":"https://cdn.cultura.com/media/pim/13432454_8wuv0xn9_1_95486","price":8.95,"rating":null,"currency":"EUR","position":1,"availability":"Précommande - sortie le 05/11/26","review_count":null,"price_display":"8,95 €","new_offers_count":null,"new_offers_price":null,"used_offers_count":null,"used_offers_price":null,"new_offers_price_display":null,"used_offers_price_display":null}],"pagination":{"next":"https://www.cultura.com/search/results?search_query=harry+potter&page=2","page":1,"per_page":60,"total_pages":50,"total_results":3371}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Cultura Search","description":"Search Cultura by keyword and page through books, games, and culture products. Cards include title, price, availability, and the product link.\n\n**Credit cost:** 2 credits per call","operationId":"post-cultura-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Words to search for on Cultura, or the search page link.\n\n**Examples:**\n\n```\nharry potter\n```\n\n```\nhttps://www.cultura.com/search/results?search_query=harry+potter\n```\n\nA product link (`/p-....html`) returns 400.","schema":{"type":"string","description":"Words to search for on Cultura, or the search page link.\n\n**Examples:**\n\n```\nharry potter\n```\n\n```\nhttps://www.cultura.com/search/results?search_query=harry+potter\n```\n\nA product link (`/p-....html`) returns 400."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. For example, 2 returns the next page of results.\n\nWhen query is a search link, a number above 1 replaces the page in that link.","schema":{"type":"number","description":"Page number, starting at 1. For example, 2 returns the next page of results.\n\nWhen query is a search link, a number above 1 replaces the page in that link."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"rating":{"nullable":true},"currency":{"type":"string"},"position":{"type":"integer"},"availability":{"type":"string"},"review_count":{"nullable":true},"price_display":{"type":"string"},"new_offers_count":{"nullable":true},"new_offers_price":{"nullable":true},"used_offers_count":{"nullable":true},"used_offers_price":{"nullable":true},"new_offers_price_display":{"nullable":true},"used_offers_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"harry potter, first product":{"value":{"results":[{"sku":"13432454","url":"https://www.cultura.com/p-harry-potter-a-l-ecole-des-sorciers-9782075253147.html","name":"Harry Potter à l'école des sorciers","badge":"Précommande","brand":"J. K. Rowling","image":"https://cdn.cultura.com/media/pim/13432454_8wuv0xn9_1_95486","price":8.95,"rating":null,"currency":"EUR","position":1,"availability":"Précommande - sortie le 05/11/26","review_count":null,"price_display":"8,95 €","new_offers_count":null,"new_offers_price":null,"used_offers_count":null,"used_offers_price":null,"new_offers_price_display":null,"used_offers_price_display":null}],"pagination":{"next":"https://www.cultura.com/search/results?search_query=harry+potter&page=2","page":1,"per_page":60,"total_pages":50,"total_results":3371}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/cultura/product":{"get":{"summary":"Cultura Product","description":"Read one Cultura product from its URL or SKU. You get price, EAN, seller, condition, and stock wording.\n\n**Credit cost:** 2 credits per call","operationId":"get-cultura-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Link of the Cultura product page.\n\n**Example:**\n\n```\nhttps://www.cultura.com/p-harry-potter-et-le-prisonnier-d-azkaban-illustre-par-minalima-9782075193993.html\n```\n\nA search link returns 400.","schema":{"type":"string","description":"Link of the Cultura product page.\n\n**Example:**\n\n```\nhttps://www.cultura.com/p-harry-potter-et-le-prisonnier-d-azkaban-illustre-par-minalima-9782075193993.html\n```\n\nA search link returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"availability":{"type":"string"},"contributors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"role":{"type":"string"}}}},"price_display":{"type":"string"},"favorite_count":{"type":"integer"}}},"examples":{"Harry Potter et le prisonnier d'Azkaban":{"value":{"ean":"9782075193993","sku":"10016146","url":"https://www.cultura.com/p-harry-potter-et-le-prisonnier-d-azkaban-illustre-par-minalima-9782075193993.html","name":"Harry Potter Tome 3 : Harry Potter et le prisonnier d'Azkaban","badge":"Coup de cœur","brand":"J. K. Rowling","image":"https://cdn.cultura.com/media/pim/10016146_10vq8xg2_1_e5a37","price":42.5,"images":["https://cdn.cultura.com/media/pim/10016146_10vq8xg2_1_e5a37","https://cdn.cultura.com/media/pim/10016146_15393428","https://cdn.cultura.com/media/pim/10016146_image_type_open_view_SODIS_10_FR_7cbe7","https://cdn.cultura.com/media/pim/9782075193993_11.jpg","https://cdn.cultura.com/media/pim/9782075193993_8.jpg","https://cdn.cultura.com/media/pim/9782075193993_9.jpg","https://cdn.cultura.com/media/pim/10016146_81758431"],"seller":"Cultura","currency":"EUR","condition":"Neuf","breadcrumbs":[{"url":"https://www.cultura.com/","name":"Accueil"},{"url":"https://www.cultura.com/univers-enfant.html","name":"Enfant"},{"url":"https://www.cultura.com/univers-enfant/livres-enfant.html","name":"Livres Enfants"},{"url":"https://www.cultura.com/univers-enfant/livres-enfant/livres-des-9-ans.html","name":"Livres pour enfants de 9 à 11 ans"},{"url":null,"name":"Harry Potter Tome 3 : Harry Potter et le prisonnier d'Azkaban"}],"description":"Sublimes illustrations en couleurs et huit prouesses d'ingénierie papier interactives : une édition unique du deuxième tome de la saga Harry Potter et un précieux cadeau pour les fans de tous âges. Depuis douze longues années, l'infâme criminel Sirius Black, partisan de Lord Voldemort et reconnu coupable d'avoir tué treize personnes d'un coup, était enfermé dans la forteresse d'Azkaban. Mais il s'est évadé et il recherche Harry Potter. Les gardiens de la prison l'ont entendu murmurer dans son sommeil : \"Il est à Poudlard...\" Malgré les défenses magiques de l'école de sorcellerie, Harry Potter n'est en sécurité nulle part, même entouré de ses amis... car un traitre pourrait bien se cacher parmi eux.","availability":"en stock Cultura","contributors":[{"name":"J. K. Rowling","role":"Auteur"},{"name":"Minalima","role":"Illustrateur"}],"price_display":"42,50 €","favorite_count":6}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Cultura Product","description":"Read one Cultura product from its URL or SKU. You get price, EAN, seller, condition, and stock wording.\n\n**Credit cost:** 2 credits per call","operationId":"post-cultura-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Link of the Cultura product page.\n\n**Example:**\n\n```\nhttps://www.cultura.com/p-harry-potter-et-le-prisonnier-d-azkaban-illustre-par-minalima-9782075193993.html\n```\n\nA search link returns 400.","schema":{"type":"string","description":"Link of the Cultura product page.\n\n**Example:**\n\n```\nhttps://www.cultura.com/p-harry-potter-et-le-prisonnier-d-azkaban-illustre-par-minalima-9782075193993.html\n```\n\nA search link returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"availability":{"type":"string"},"contributors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"role":{"type":"string"}}}},"price_display":{"type":"string"},"favorite_count":{"type":"integer"}}},"examples":{"Harry Potter et le prisonnier d'Azkaban":{"value":{"ean":"9782075193993","sku":"10016146","url":"https://www.cultura.com/p-harry-potter-et-le-prisonnier-d-azkaban-illustre-par-minalima-9782075193993.html","name":"Harry Potter Tome 3 : Harry Potter et le prisonnier d'Azkaban","badge":"Coup de cœur","brand":"J. K. Rowling","image":"https://cdn.cultura.com/media/pim/10016146_10vq8xg2_1_e5a37","price":42.5,"images":["https://cdn.cultura.com/media/pim/10016146_10vq8xg2_1_e5a37","https://cdn.cultura.com/media/pim/10016146_15393428","https://cdn.cultura.com/media/pim/10016146_image_type_open_view_SODIS_10_FR_7cbe7","https://cdn.cultura.com/media/pim/9782075193993_11.jpg","https://cdn.cultura.com/media/pim/9782075193993_8.jpg","https://cdn.cultura.com/media/pim/9782075193993_9.jpg","https://cdn.cultura.com/media/pim/10016146_81758431"],"seller":"Cultura","currency":"EUR","condition":"Neuf","breadcrumbs":[{"url":"https://www.cultura.com/","name":"Accueil"},{"url":"https://www.cultura.com/univers-enfant.html","name":"Enfant"},{"url":"https://www.cultura.com/univers-enfant/livres-enfant.html","name":"Livres Enfants"},{"url":"https://www.cultura.com/univers-enfant/livres-enfant/livres-des-9-ans.html","name":"Livres pour enfants de 9 à 11 ans"},{"url":null,"name":"Harry Potter Tome 3 : Harry Potter et le prisonnier d'Azkaban"}],"description":"Sublimes illustrations en couleurs et huit prouesses d'ingénierie papier interactives : une édition unique du deuxième tome de la saga Harry Potter et un précieux cadeau pour les fans de tous âges. Depuis douze longues années, l'infâme criminel Sirius Black, partisan de Lord Voldemort et reconnu coupable d'avoir tué treize personnes d'un coup, était enfermé dans la forteresse d'Azkaban. Mais il s'est évadé et il recherche Harry Potter. Les gardiens de la prison l'ont entendu murmurer dans son sommeil : \"Il est à Poudlard...\" Malgré les défenses magiques de l'école de sorcellerie, Harry Potter n'est en sécurité nulle part, même entouré de ses amis... car un traitre pourrait bien se cacher parmi eux.","availability":"en stock Cultura","contributors":[{"name":"J. K. Rowling","role":"Auteur"},{"name":"Minalima","role":"Illustrateur"}],"price_display":"42,50 €","favorite_count":6}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/centris/property":{"get":{"summary":"Centris Property","description":"Read one Centris property from its URL or listing id. You get price, address, rooms, and the broker.\n\n**Credit cost:** 1 credit per call","operationId":"get-centris-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Centris listing URL, in English or French.\n\nUse the url from a search result. The listing id is the number at the end of the path. A bare id returns 400. A trailing /photos suffix resolves back to the listing.\n\n**Examples:**\n\n```\nhttps://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540\n```\n\n```\nhttps://www.centris.ca/fr/condo~a-vendre~montreal-villeray-saint-michel-parc-extension/17926206\n```","schema":{"type":"string","description":"Full Centris listing URL, in English or French.\n\nUse the url from a search result. The listing id is the number at the end of the path. A bare id returns 400. A trailing /photos suffix resolves back to the listing.\n\n**Examples:**\n\n```\nhttps://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540\n```\n\n```\nhttps://www.centris.ca/fr/condo~a-vendre~montreal-villeray-saint-michel-parc-extension/17926206\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"broker":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"agency":{"type":"string"},"phones":{"type":"array","items":{}},"agency_type":{"type":"string"},"contact_url":{"type":"string"},"profile_url":{"type":"string"}}},"images":{"type":"array","items":{"type":"string"}},"nearby":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"latitude":{"type":"number"},"area_name":{"type":"string"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"photos_url":{"type":"string"},"walk_score":{"type":"integer"},"description":{"type":"string"},"area_summary":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"price_display":{"type":"string"},"area_statistics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"title":{"type":"string"},"slices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"integer"}}}},"average":{"type":"string"}}}},"characteristics":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"municipality_id":{"type":"string"},"walk_score_label":{"type":"string"},"financial_details":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"period":{"nullable":true}}}},"detailed_sheet_url":{"type":"string"}}},"examples":{"Condo 17796540, 2365 Rue Saint-Patrick, Montreal":{"value":{"id":"17796540","url":"https://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540","price":568000,"rooms":5,"title":"Condo for sale in Montréal (Le Sud-Ouest), Montréal (Island), 2365, Rue Saint-Patrick, apt. 207, 17796540 - Centris.ca","broker":{"name":"Alex Martin","image":"https://mediaserver.centris.ca/placeholder/example-user.jpg","title":"Residential Real Estate Broker","agency":"SOTHEBY'S INTERNATIONAL REALTY QUÉBEC","phones":[],"agency_type":"Real Estate Agency","contact_url":"https://www.centris.ca/en/contact-broker/g5475/property/example-user","profile_url":"https://www.centris.ca/en/real-estate-broker~cassian-bopp~sotheby-s-international-realty-quebec-siege-social/example-user"},"images":["https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CC4DDDDDDDDDD2&t=pi&w=640&h=480&sm=c","https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CCBDDDDDDDDDDF&t=pi&w=640&h=480&sm=c","https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CCCDDDDDDDDDDE&t=pi&w=640&h=480&sm=c"],"nearby":"Next to Highway, Daycare, Metro, Park, Bicycle path, Elementary school, High school, Public transit","address":"2365, Rue Saint-Patrick, apt. 207, Montréal (Le Sud-Ouest)","bedrooms":1,"category":"Condo for sale","currency":"CAD","language":"en","latitude":45.482041,"area_name":"Montréal (Le Sud-Ouest)","bathrooms":1,"longitude":-73.569347,"photos_url":"https://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540/photos","walk_score":95,"description":"Goldilocks unit offering a beautifully balanced layout, high-end finishes and exceptional livability. Thoughtfully designed, the spacious kitchen with large island opens seamlessly onto the living and dining areas, creating an inviting and functional space ideal for both everyday living and entertaining. The unit stands out with its rare, extra-large south-facing balcony, an extension of the living space that brings in natural light and offers a comfortable outdoor setting. A dedicated office nook adds versatility, while the refined bathroom, conceived as a true wet-room with premium finishes, enhances the overall sense of quality.","area_summary":[{"label":"Population (2021)","value":"84,553"},{"label":"Population variation between 2016 and 2021","value":"8%"},{"label":"Population density","value":"5,392 hab/km 2"},{"label":"Unemployment rate (2021)","value":"10%"}],"price_display":"$568,000","area_statistics":[{"id":"age","label":"Age","title":"Population By Age Group","slices":[{"label":"< 15 years","value":13},{"label":"15 to 24 years","value":10},{"label":"25 to 44 years","value":41},{"label":"45 to 64 years","value":22},{"label":"> 65 years","value":13}],"average":"Average 39 years"},{"id":"income","label":"Incomes","title":"Household Income","slices":[{"label":"Less than $60,000","value":46},{"label":"Between $60,000 and $80,000","value":14},{"label":"Between $80,000 and $100,000","value":11},{"label":"Between $100,000 and $125,000","value":10},{"label":"Between $125,000 and $150,000","value":6},{"label":"More than $150,000","value":14}],"average":"Average $90,100"}],"characteristics":[{"name":"Condominium type","value":"Divided"},{"name":"Net area","value":"690 sqft"},{"name":"Year built","value":"2015"},{"name":"Parking (total)","value":"Garage (1)"},{"name":"Pool","value":"Heated"},{"name":"Additional features","value":"Located on a canal, Pets allowed with conditions, Elevator, Roof terrace, Fitness room, Bicycle storage area"},{"name":"Move-in date","value":"30 days after acceptance of promise to purchase or rent"}],"municipality_id":"839","walk_score_label":"Walker’s Paradise","financial_details":[{"name":"Municipal assessment (2026)","rows":[{"label":"Lot","value":"$67,300"},{"label":"Building","value":"$467,700"},{"label":"Total","value":"$535,000"}],"period":null},{"name":"Taxes","rows":[{"label":"Municipal (2026)","value":"$3,299"},{"label":"School (2026)","value":"$379"},{"label":"Total","value":"$3,678"}],"period":"yearly"}],"detailed_sheet_url":"https://passerelle.centris.ca/redirect.aspx?NoMLS=17796540&Lang=E&source=centris.ca"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Centris Property","description":"Read one Centris property from its URL or listing id. You get price, address, rooms, and the broker.\n\n**Credit cost:** 1 credit per call","operationId":"post-centris-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Centris listing URL, in English or French.\n\nUse the url from a search result. The listing id is the number at the end of the path. A bare id returns 400. A trailing /photos suffix resolves back to the listing.\n\n**Examples:**\n\n```\nhttps://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540\n```\n\n```\nhttps://www.centris.ca/fr/condo~a-vendre~montreal-villeray-saint-michel-parc-extension/17926206\n```","schema":{"type":"string","description":"Full Centris listing URL, in English or French.\n\nUse the url from a search result. The listing id is the number at the end of the path. A bare id returns 400. A trailing /photos suffix resolves back to the listing.\n\n**Examples:**\n\n```\nhttps://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540\n```\n\n```\nhttps://www.centris.ca/fr/condo~a-vendre~montreal-villeray-saint-michel-parc-extension/17926206\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"broker":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"agency":{"type":"string"},"phones":{"type":"array","items":{}},"agency_type":{"type":"string"},"contact_url":{"type":"string"},"profile_url":{"type":"string"}}},"images":{"type":"array","items":{"type":"string"}},"nearby":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"latitude":{"type":"number"},"area_name":{"type":"string"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"photos_url":{"type":"string"},"walk_score":{"type":"integer"},"description":{"type":"string"},"area_summary":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"price_display":{"type":"string"},"area_statistics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"title":{"type":"string"},"slices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"integer"}}}},"average":{"type":"string"}}}},"characteristics":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"municipality_id":{"type":"string"},"walk_score_label":{"type":"string"},"financial_details":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"period":{"nullable":true}}}},"detailed_sheet_url":{"type":"string"}}},"examples":{"Condo 17796540, 2365 Rue Saint-Patrick, Montreal":{"value":{"id":"17796540","url":"https://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540","price":568000,"rooms":5,"title":"Condo for sale in Montréal (Le Sud-Ouest), Montréal (Island), 2365, Rue Saint-Patrick, apt. 207, 17796540 - Centris.ca","broker":{"name":"Alex Martin","image":"https://mediaserver.centris.ca/placeholder/example-user.jpg","title":"Residential Real Estate Broker","agency":"SOTHEBY'S INTERNATIONAL REALTY QUÉBEC","phones":[],"agency_type":"Real Estate Agency","contact_url":"https://www.centris.ca/en/contact-broker/g5475/property/example-user","profile_url":"https://www.centris.ca/en/real-estate-broker~cassian-bopp~sotheby-s-international-realty-quebec-siege-social/example-user"},"images":["https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CC4DDDDDDDDDD2&t=pi&w=640&h=480&sm=c","https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CCBDDDDDDDDDDF&t=pi&w=640&h=480&sm=c","https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CCCDDDDDDDDDDE&t=pi&w=640&h=480&sm=c"],"nearby":"Next to Highway, Daycare, Metro, Park, Bicycle path, Elementary school, High school, Public transit","address":"2365, Rue Saint-Patrick, apt. 207, Montréal (Le Sud-Ouest)","bedrooms":1,"category":"Condo for sale","currency":"CAD","language":"en","latitude":45.482041,"area_name":"Montréal (Le Sud-Ouest)","bathrooms":1,"longitude":-73.569347,"photos_url":"https://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540/photos","walk_score":95,"description":"Goldilocks unit offering a beautifully balanced layout, high-end finishes and exceptional livability. Thoughtfully designed, the spacious kitchen with large island opens seamlessly onto the living and dining areas, creating an inviting and functional space ideal for both everyday living and entertaining. The unit stands out with its rare, extra-large south-facing balcony, an extension of the living space that brings in natural light and offers a comfortable outdoor setting. A dedicated office nook adds versatility, while the refined bathroom, conceived as a true wet-room with premium finishes, enhances the overall sense of quality.","area_summary":[{"label":"Population (2021)","value":"84,553"},{"label":"Population variation between 2016 and 2021","value":"8%"},{"label":"Population density","value":"5,392 hab/km 2"},{"label":"Unemployment rate (2021)","value":"10%"}],"price_display":"$568,000","area_statistics":[{"id":"age","label":"Age","title":"Population By Age Group","slices":[{"label":"< 15 years","value":13},{"label":"15 to 24 years","value":10},{"label":"25 to 44 years","value":41},{"label":"45 to 64 years","value":22},{"label":"> 65 years","value":13}],"average":"Average 39 years"},{"id":"income","label":"Incomes","title":"Household Income","slices":[{"label":"Less than $60,000","value":46},{"label":"Between $60,000 and $80,000","value":14},{"label":"Between $80,000 and $100,000","value":11},{"label":"Between $100,000 and $125,000","value":10},{"label":"Between $125,000 and $150,000","value":6},{"label":"More than $150,000","value":14}],"average":"Average $90,100"}],"characteristics":[{"name":"Condominium type","value":"Divided"},{"name":"Net area","value":"690 sqft"},{"name":"Year built","value":"2015"},{"name":"Parking (total)","value":"Garage (1)"},{"name":"Pool","value":"Heated"},{"name":"Additional features","value":"Located on a canal, Pets allowed with conditions, Elevator, Roof terrace, Fitness room, Bicycle storage area"},{"name":"Move-in date","value":"30 days after acceptance of promise to purchase or rent"}],"municipality_id":"839","walk_score_label":"Walker’s Paradise","financial_details":[{"name":"Municipal assessment (2026)","rows":[{"label":"Lot","value":"$67,300"},{"label":"Building","value":"$467,700"},{"label":"Total","value":"$535,000"}],"period":null},{"name":"Taxes","rows":[{"label":"Municipal (2026)","value":"$3,299"},{"label":"School (2026)","value":"$379"},{"label":"Total","value":"$3,678"}],"period":"yearly"}],"detailed_sheet_url":"https://passerelle.centris.ca/redirect.aspx?NoMLS=17796540&Lang=E&source=centris.ca"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/darty/product":{"get":{"summary":"Darty Product","description":"Read one Darty product sheet from a product URL or a Darty product id. You get price, brand, availability, rating, and specifications.\n\n**Credit cost:** 2 credits per call","operationId":"get-darty-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL on www.darty.com. The path is under `/nav/achat/` and ends in `.html`.\n\n**Example:**\n\n```\nhttps://www.darty.com/nav/achat/petit_electromenager/aspirateur-balai_main/aspirateur_balai/dyson_piston_animal.html\n```\n\nA keyword or a search URL returns 400.","schema":{"type":"string","description":"Product URL on www.darty.com. The path is under `/nav/achat/` and ends in `.html`.\n\n**Example:**\n\n```\nhttps://www.darty.com/nav/achat/petit_electromenager/aspirateur-balai_main/aspirateur_balai/dyson_piston_animal.html\n```\n\nA keyword or a search URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"codic":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"seller":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"delivery":{"type":"string"},"condition":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"rating_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Dyson V16 Piston Animal":{"value":{"url":"https://www.darty.com/nav/achat/petit_electromenager/aspirateur-balai_main/aspirateur_balai/dyson_piston_animal.html","gtin":"5025155114834","name":"Aspirateur balai Dyson V16 Piston Animal","brand":"Dyson","codic":"8069573","image":"https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3723_1.jpg&height=227","price":849,"images":["https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3723_1.jpg&height=227","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_1.jpg","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_2.jpg","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_3.jpg","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_4.jpg"],"rating":3.9,"seller":"Darty","category":"Aspirateur balai","currency":"EUR","delivery":"Livré dès le 31/10","condition":"Neuf","reference":"V16 Piston Animal","description":"Le plus puissant des aspirateurs sans fil Dyson : le V16 Piston Animal Nouvelle brosse adaptative auto-démêlante All Floor Cones Sense : La brosse All Floor Cones™ Sense est équipée de deux rouleaux coniques. Lorsque les cheveux et poils d’animaux sont attrapés, chaque rouleau les démêle afin qu’ils soient immédiatement aspirés dans le collecteur, sans jamais s’emmêler, même les cheveux les plus longs (testé sur des cheveux de 63 cm de long). Le moteur et la brosse fonctionnent intelligemment ensemble pour détecter et s’adapter au type de sol en fonction du mode sélectionné. De plus, l’éclairage révèle la poussière microscopique. L’aspirateur Dyson sans fil auto-démêlant le plus puissant : Le nouveau moteur HyperdymiumMC 900W de Dyson (Gen4.1) génère une puissance d’aspiration de 315 AW. En le faisant pivoter de 180° et en modifiant sa position, nous avons créé une machine plus puissante et plus compacte. Collecteur Clean Compaktor™ pour 3 fois plus de capacité1 : Le collecteur le plus hygiénique de Dyson. Nous avons repensé l’intérieur pour faciliter le nettoyage, compresser la poussière et améliorer la circulation de l’air. Il contient jusqu’à 3 fois plus de saletés et de débris, et jusqu’à 30 jours de poussière. La filtration HEPA capture 99,99 % des particules microscopique2 :&nbsp; La filtration HEPA entièrement étanche de la machine capture la poussière, les particules et les allergènes aussi petits que 0,1 micron. Brosses et accessoires inclus : Nouveau système à bouton poussoir &nbsp;: Bouton poussoir permettant de détacher les accessoires et brosses à l’extrémité du tube, sans se pencher. Smart tool compatible &nbsp;: Détecte intelligemment l’accessoire utilisé et augmente automatiquement la puissance d’aspiration pour les poussières difficiles à enlever. Brosse All Floors Cones™ Sense :&nbsp; Nouvelle brosse adaptative auto-démêlante qui aspire les poils d’animaux et les cheveux, même les plus longs. L’éclairage révèle la poussière microscopique. Mini brosse motorisée auto-démêlante &nbsp;: Le rouleau conique de la brosse motorisée attrape les cheveux longs et les poils d’animaux, et évite que les cheveux ne s’enroulent autour du rouleau de la brosse. Accessoire combiné &nbsp;: Deux accessoires en un incluant une brosse et un embout large. Pour changer facilement d’accessoire entre les tâches. Suceurs longs &nbsp;: Inclut 3 suceurs longs conçus pour le nettoyage de précision sur les bords et dans les espaces étroits. Deux suceurs longs directement disposés sur le collecteur et sur le tube. Un suceur long supplémentaire en accessoire.","availability":"En stock dans plus de 20 magasins","review_count":53,"price_display":"849,00 €","rating_display":"3,9/5","specifications":[{"name":"Pays de fabrication","value":"Malaisie"},{"name":"Origine de fabrication","value":"Fabriqué hors Europe"},{"name":"Dimensions","value":"259 x 1298 x 250 mm"},{"name":"Usage aspirateur","value":"Sol, meuble et hauteur"},{"name":"Type de brosse aspirateur / nettoyeur","value":"Brosse spéciale animaux, Brosse sols durs, Brosse éclairée, Multi surfaces"},{"name":"Autonomie maximale","value":"70 MN"},{"name":"Autonomie en mode standard","value":"70 MN"},{"name":"Puissance","value":"900 W"},{"name":"Puissance (volt)","value":"25,2 V"},{"name":"Gamme d'aspirateur","value":"Autre"},{"name":"Capacité du réservoir","value":"1,35 l"},{"name":"Nombre de vitesses","value":"2"},{"name":"Temps de chargement","value":"210 min"},{"name":"Type de batterie","value":"Lithium"},{"name":"Type de support","value":"Mural"},{"name":"Accessoires fournis","value":"Brosse All Floors Cones Sense - Mini brosse motorisée autodémêlante - Accessoire combiné - Suceurs longs"},{"name":"Caractéristiques complémentaires","value":"Collecteur Clean Compaktor pour 3 fois plus de capacité"},{"name":"Garantie d'origine","value":"2 ans"},{"name":"Couleur","value":"Noir/Doré"},{"name":"Poids","value":"3,4 kg"},{"name":"Hauteur","value":"25,9 cm"},{"name":"Puissance d’aspiration","value":"315 AW"},{"name":"Indice de réparabilité","value":"8,3 /10"},{"name":"Fonctionnalités aspirateur balai/à main","value":"Modèle léger (<5 kg), Avec variateur de puissance"},{"name":"Largeur","value":"25 cm"},{"name":"Profondeur","value":"129,8 cm"},{"name":"Disponibilité des pièces détachées","value":"13 ans"},{"name":"Codic","value":"8069573"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Darty Product","description":"Read one Darty product sheet from a product URL or a Darty product id. You get price, brand, availability, rating, and specifications.\n\n**Credit cost:** 2 credits per call","operationId":"post-darty-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL on www.darty.com. The path is under `/nav/achat/` and ends in `.html`.\n\n**Example:**\n\n```\nhttps://www.darty.com/nav/achat/petit_electromenager/aspirateur-balai_main/aspirateur_balai/dyson_piston_animal.html\n```\n\nA keyword or a search URL returns 400.","schema":{"type":"string","description":"Product URL on www.darty.com. The path is under `/nav/achat/` and ends in `.html`.\n\n**Example:**\n\n```\nhttps://www.darty.com/nav/achat/petit_electromenager/aspirateur-balai_main/aspirateur_balai/dyson_piston_animal.html\n```\n\nA keyword or a search URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"codic":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"seller":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"delivery":{"type":"string"},"condition":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"rating_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Dyson V16 Piston Animal":{"value":{"url":"https://www.darty.com/nav/achat/petit_electromenager/aspirateur-balai_main/aspirateur_balai/dyson_piston_animal.html","gtin":"5025155114834","name":"Aspirateur balai Dyson V16 Piston Animal","brand":"Dyson","codic":"8069573","image":"https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3723_1.jpg&height=227","price":849,"images":["https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3723_1.jpg&height=227","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_1.jpg","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_2.jpg","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_3.jpg","https://image.darty.com/darty?type=image&source=/market/2025/09/04/28613358_3724_4.jpg"],"rating":3.9,"seller":"Darty","category":"Aspirateur balai","currency":"EUR","delivery":"Livré dès le 31/10","condition":"Neuf","reference":"V16 Piston Animal","description":"Le plus puissant des aspirateurs sans fil Dyson : le V16 Piston Animal Nouvelle brosse adaptative auto-démêlante All Floor Cones Sense : La brosse All Floor Cones™ Sense est équipée de deux rouleaux coniques. Lorsque les cheveux et poils d’animaux sont attrapés, chaque rouleau les démêle afin qu’ils soient immédiatement aspirés dans le collecteur, sans jamais s’emmêler, même les cheveux les plus longs (testé sur des cheveux de 63 cm de long). Le moteur et la brosse fonctionnent intelligemment ensemble pour détecter et s’adapter au type de sol en fonction du mode sélectionné. De plus, l’éclairage révèle la poussière microscopique. L’aspirateur Dyson sans fil auto-démêlant le plus puissant : Le nouveau moteur HyperdymiumMC 900W de Dyson (Gen4.1) génère une puissance d’aspiration de 315 AW. En le faisant pivoter de 180° et en modifiant sa position, nous avons créé une machine plus puissante et plus compacte. Collecteur Clean Compaktor™ pour 3 fois plus de capacité1 : Le collecteur le plus hygiénique de Dyson. Nous avons repensé l’intérieur pour faciliter le nettoyage, compresser la poussière et améliorer la circulation de l’air. Il contient jusqu’à 3 fois plus de saletés et de débris, et jusqu’à 30 jours de poussière. La filtration HEPA capture 99,99 % des particules microscopique2 :&nbsp; La filtration HEPA entièrement étanche de la machine capture la poussière, les particules et les allergènes aussi petits que 0,1 micron. Brosses et accessoires inclus : Nouveau système à bouton poussoir &nbsp;: Bouton poussoir permettant de détacher les accessoires et brosses à l’extrémité du tube, sans se pencher. Smart tool compatible &nbsp;: Détecte intelligemment l’accessoire utilisé et augmente automatiquement la puissance d’aspiration pour les poussières difficiles à enlever. Brosse All Floors Cones™ Sense :&nbsp; Nouvelle brosse adaptative auto-démêlante qui aspire les poils d’animaux et les cheveux, même les plus longs. L’éclairage révèle la poussière microscopique. Mini brosse motorisée auto-démêlante &nbsp;: Le rouleau conique de la brosse motorisée attrape les cheveux longs et les poils d’animaux, et évite que les cheveux ne s’enroulent autour du rouleau de la brosse. Accessoire combiné &nbsp;: Deux accessoires en un incluant une brosse et un embout large. Pour changer facilement d’accessoire entre les tâches. Suceurs longs &nbsp;: Inclut 3 suceurs longs conçus pour le nettoyage de précision sur les bords et dans les espaces étroits. Deux suceurs longs directement disposés sur le collecteur et sur le tube. Un suceur long supplémentaire en accessoire.","availability":"En stock dans plus de 20 magasins","review_count":53,"price_display":"849,00 €","rating_display":"3,9/5","specifications":[{"name":"Pays de fabrication","value":"Malaisie"},{"name":"Origine de fabrication","value":"Fabriqué hors Europe"},{"name":"Dimensions","value":"259 x 1298 x 250 mm"},{"name":"Usage aspirateur","value":"Sol, meuble et hauteur"},{"name":"Type de brosse aspirateur / nettoyeur","value":"Brosse spéciale animaux, Brosse sols durs, Brosse éclairée, Multi surfaces"},{"name":"Autonomie maximale","value":"70 MN"},{"name":"Autonomie en mode standard","value":"70 MN"},{"name":"Puissance","value":"900 W"},{"name":"Puissance (volt)","value":"25,2 V"},{"name":"Gamme d'aspirateur","value":"Autre"},{"name":"Capacité du réservoir","value":"1,35 l"},{"name":"Nombre de vitesses","value":"2"},{"name":"Temps de chargement","value":"210 min"},{"name":"Type de batterie","value":"Lithium"},{"name":"Type de support","value":"Mural"},{"name":"Accessoires fournis","value":"Brosse All Floors Cones Sense - Mini brosse motorisée autodémêlante - Accessoire combiné - Suceurs longs"},{"name":"Caractéristiques complémentaires","value":"Collecteur Clean Compaktor pour 3 fois plus de capacité"},{"name":"Garantie d'origine","value":"2 ans"},{"name":"Couleur","value":"Noir/Doré"},{"name":"Poids","value":"3,4 kg"},{"name":"Hauteur","value":"25,9 cm"},{"name":"Puissance d’aspiration","value":"315 AW"},{"name":"Indice de réparabilité","value":"8,3 /10"},{"name":"Fonctionnalités aspirateur balai/à main","value":"Modèle léger (<5 kg), Avec variateur de puissance"},{"name":"Largeur","value":"25 cm"},{"name":"Profondeur","value":"129,8 cm"},{"name":"Disponibilité des pièces détachées","value":"13 ans"},{"name":"Codic","value":"8069573"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/darty/search":{"get":{"summary":"Darty Search","description":"Search Darty by keyword or search URL and page through the listing. Each card has title, price, brand, seller, and product link.\n\n**Credit cost:** 2 credits per call","operationId":"get-darty-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a Darty search URL on www.darty.com.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.darty.com/nav/recherche?text=aspirateur\n```\n\nA product URL returns 400. `page` replaces any offset already present in a search URL.","schema":{"type":"string","description":"Keyword or a Darty search URL on www.darty.com.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.darty.com/nav/recherche?text=aspirateur\n```\n\nA product URL returns 400. `page` replaces any offset already present in a search URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number. Defaults to `1`. Page 2 returns the next 30 products.\n\n**Example:** `2`","schema":{"type":"number","description":"1-based page number. Defaults to `1`. Page 2 returns the next 30 products.\n\n**Example:** `2`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"codic":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"pickup":{"type":"string"},"rating":{"type":"number"},"seller":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"delivery":{"type":"string"},"position":{"type":"integer"},"reference":{"type":"string"},"was_price":{"type":"number"},"shipped_by":{"nullable":true},"review_count":{"type":"integer"},"price_display":{"type":"string"},"rating_display":{"type":"string"},"discount_display":{"type":"string"},"reparability_index":{"type":"number"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Aspirateur Rowenta":{"value":{"results":[{"url":"https://www.darty.com/nav/achat/petit_electromenager/aspirateur-avec_sac_sans_sac/aspirateur_sans_sac/rowenta_ro4b36.html","name":"Aspirateur sans sac Rowenta COMPACT POWER XXL Modele Parquet RO4B36EA","badge":"Bon Plan 21%","brand":"Rowenta","codic":"7522991","image":"https://image.darty.com/server?type=image&source=photos%2F2024%2F04%2F20%2F7522991A_211747457.jpg&width=230&height=345","price":119.99,"pickup":"Retrait dès le 05/11","rating":4.4,"seller":"Darty","category":"Aspirateur sans sac","currency":"EUR","delivery":"Livré dès le 05/11","position":1,"reference":"COMPACT POWER XXL Modele Parquet RO4B36EA","was_price":151.99,"shipped_by":null,"review_count":461,"price_display":"119,99 €","rating_display":"4,4/5","discount_display":"21%","reparability_index":9.8}],"pagination":{"next":"https://www.darty.com/nav/recherche?s=relevence&text=aspirateur&o=30","page":1,"per_page":30,"total_pages":300,"total_results":17644}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Darty Search","description":"Search Darty by keyword or search URL and page through the listing. Each card has title, price, brand, seller, and product link.\n\n**Credit cost:** 2 credits per call","operationId":"post-darty-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a Darty search URL on www.darty.com.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.darty.com/nav/recherche?text=aspirateur\n```\n\nA product URL returns 400. `page` replaces any offset already present in a search URL.","schema":{"type":"string","description":"Keyword or a Darty search URL on www.darty.com.\n\n**Examples:**\n\n```\naspirateur\n```\n\n```\nhttps://www.darty.com/nav/recherche?text=aspirateur\n```\n\nA product URL returns 400. `page` replaces any offset already present in a search URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number. Defaults to `1`. Page 2 returns the next 30 products.\n\n**Example:** `2`","schema":{"type":"number","description":"1-based page number. Defaults to `1`. Page 2 returns the next 30 products.\n\n**Example:** `2`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"badge":{"type":"string"},"brand":{"type":"string"},"codic":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"pickup":{"type":"string"},"rating":{"type":"number"},"seller":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"delivery":{"type":"string"},"position":{"type":"integer"},"reference":{"type":"string"},"was_price":{"type":"number"},"shipped_by":{"nullable":true},"review_count":{"type":"integer"},"price_display":{"type":"string"},"rating_display":{"type":"string"},"discount_display":{"type":"string"},"reparability_index":{"type":"number"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Aspirateur Rowenta":{"value":{"results":[{"url":"https://www.darty.com/nav/achat/petit_electromenager/aspirateur-avec_sac_sans_sac/aspirateur_sans_sac/rowenta_ro4b36.html","name":"Aspirateur sans sac Rowenta COMPACT POWER XXL Modele Parquet RO4B36EA","badge":"Bon Plan 21%","brand":"Rowenta","codic":"7522991","image":"https://image.darty.com/server?type=image&source=photos%2F2024%2F04%2F20%2F7522991A_211747457.jpg&width=230&height=345","price":119.99,"pickup":"Retrait dès le 05/11","rating":4.4,"seller":"Darty","category":"Aspirateur sans sac","currency":"EUR","delivery":"Livré dès le 05/11","position":1,"reference":"COMPACT POWER XXL Modele Parquet RO4B36EA","was_price":151.99,"shipped_by":null,"review_count":461,"price_display":"119,99 €","rating_display":"4,4/5","discount_display":"21%","reparability_index":9.8}],"pagination":{"next":"https://www.darty.com/nav/recherche?s=relevence&text=aspirateur&o=30","page":1,"per_page":30,"total_pages":300,"total_results":17644}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/intermarche/product":{"get":{"summary":"Intermarché Product","description":"Get an Intermarché product sheet for a store (shop_id). Try an EAN or product URL with shop_id=11301. 3 credits per call.\n\n**Credit cost:** 3 credits per call","operationId":"get-intermarche-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Intermarché product URL, or an EAN barcode.\n\n**Examples:**\n\n```\nhttps://www.intermarche.com/produit/flan-patissier-cuit-&-dore-au-four/3250391522828\n```\n\n```\n3250391522828\n```","schema":{"type":"string","description":"Full Intermarché product URL, or an EAN barcode.\n\n**Examples:**\n\n```\nhttps://www.intermarche.com/produit/flan-patissier-cuit-&-dore-au-four/3250391522828\n```\n\n```\n3250391522828\n```"}},{"name":"shop_id","in":"query","required":true,"description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```","schema":{"type":"string","description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"stock":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"origin":{"type":"string"},"shop_id":{"type":"string"},"capacity":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"packaging":{"type":"string"},"was_price":{"nullable":true},"nutriscore":{"type":"string"},"unit_price":{"type":"number"},"description":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Flan pâtissier in store 11301":{"value":{"ean":"3250391522828","url":"https://www.intermarche.com/produit/flan-patissier-cuit-&-dore-au-four/3250391522828","unit":"€/Kg","brand":"Pâturages, une marque Intermarché","image":"https://assets-big.cdn-mousquetaires.com/medias/domain11815/media131044/9313237-larns7kgb4-ecommint.jpg","price":3.06,"stock":8,"title":"Flan pâtissier, cuit & doré au four","images":["https://assets-big.cdn-mousquetaires.com/medias/domain11815/media131044/9313237-larns7kgb4-ecommint.jpg"],"origin":"France","shop_id":"11301","capacity":400,"currency":"EUR","in_stock":true,"packaging":"les 4 pots de 100 g - 400g","was_price":null,"nutriscore":"C","unit_price":7.65,"description":"Flan Pâtissier","price_display":"3,06 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Intermarché Product","description":"Get an Intermarché product sheet for a store (shop_id). Try an EAN or product URL with shop_id=11301. 3 credits per call.\n\n**Credit cost:** 3 credits per call","operationId":"post-intermarche-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Intermarché product URL, or an EAN barcode.\n\n**Examples:**\n\n```\nhttps://www.intermarche.com/produit/flan-patissier-cuit-&-dore-au-four/3250391522828\n```\n\n```\n3250391522828\n```","schema":{"type":"string","description":"Full Intermarché product URL, or an EAN barcode.\n\n**Examples:**\n\n```\nhttps://www.intermarche.com/produit/flan-patissier-cuit-&-dore-au-four/3250391522828\n```\n\n```\n3250391522828\n```"}},{"name":"shop_id","in":"query","required":true,"description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```","schema":{"type":"string","description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"stock":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"origin":{"type":"string"},"shop_id":{"type":"string"},"capacity":{"type":"integer"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"packaging":{"type":"string"},"was_price":{"nullable":true},"nutriscore":{"type":"string"},"unit_price":{"type":"number"},"description":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Flan pâtissier in store 11301":{"value":{"ean":"3250391522828","url":"https://www.intermarche.com/produit/flan-patissier-cuit-&-dore-au-four/3250391522828","unit":"€/Kg","brand":"Pâturages, une marque Intermarché","image":"https://assets-big.cdn-mousquetaires.com/medias/domain11815/media131044/9313237-larns7kgb4-ecommint.jpg","price":3.06,"stock":8,"title":"Flan pâtissier, cuit & doré au four","images":["https://assets-big.cdn-mousquetaires.com/medias/domain11815/media131044/9313237-larns7kgb4-ecommint.jpg"],"origin":"France","shop_id":"11301","capacity":400,"currency":"EUR","in_stock":true,"packaging":"les 4 pots de 100 g - 400g","was_price":null,"nutriscore":"C","unit_price":7.65,"description":"Flan Pâtissier","price_display":"3,06 €"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/intermarche/search":{"get":{"summary":"Intermarché Search","description":"Search Intermarché products for a store (shop_id). Try query=lait and shop_id=11301. 3 credits per call.\n\n**Credit cost:** 3 credits per call","operationId":"get-intermarche-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Intermarché search URL.\n\n**Examples:**\n\n```\nlait\n```\n\n```\npates\n```\n\n```\nhttps://www.intermarche.com/recherche/lait\n```\n\nUse the Product endpoint when you already have a product URL or EAN.","schema":{"type":"string","description":"Search keyword or full Intermarché search URL.\n\n**Examples:**\n\n```\nlait\n```\n\n```\npates\n```\n\n```\nhttps://www.intermarche.com/recherche/lait\n```\n\nUse the Product endpoint when you already have a product URL or EAN."}},{"name":"shop_id","in":"query","required":true,"description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```","schema":{"type":"string","description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at `1`. Use `pagination.total_pages` from a previous response to iterate.\n\n**Example:** `2`","schema":{"type":"number","description":"Page number starting at `1`. Use `pagination.total_pages` from a previous response to iterate.\n\n**Example:** `2`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"shop_id":{"type":"string"},"currency":{"type":"string"},"position":{"type":"integer"},"packaging":{"type":"string"},"unit_price":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'lait' in store 11301":{"value":{"results":[{"ean":"3533630097654","url":"https://www.intermarche.com/produit/grandlait-frais-lait-frais-de-montagne-entier/3533630097654","brand":"Grandlait","image":"https://assets-big.cdn-mousquetaires.com/medias/domain11815/media140040/12012075-ubbxcayb3o-ecommint.jpg","price":1.61,"title":"Grandlait frais - Lait frais de Montagne entier","shop_id":"11301","currency":"EUR","position":1,"packaging":"la bouteille de 1 l","unit_price":"1,61 €/L","price_display":"1,61 €"},{"ean":"3451790000840","url":"https://www.intermarche.com/produit/candia-grandlait-lait-entier/3451790000840","brand":"Candia","image":null,"price":1.29,"title":"Candia GrandLait - Lait entier","shop_id":"11301","currency":"EUR","position":2,"packaging":"la bouteille de 1 l","unit_price":"1,29 €/L","price_display":"1,29 €"}],"pagination":{"next":"https://www.intermarche.com/recherche/lait?page=2","page":1,"per_page":40,"total_pages":15,"total_results":588}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Intermarché Search","description":"Search Intermarché products for a store (shop_id). Try query=lait and shop_id=11301. 3 credits per call.\n\n**Credit cost:** 3 credits per call","operationId":"post-intermarche-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Intermarché search URL.\n\n**Examples:**\n\n```\nlait\n```\n\n```\npates\n```\n\n```\nhttps://www.intermarche.com/recherche/lait\n```\n\nUse the Product endpoint when you already have a product URL or EAN.","schema":{"type":"string","description":"Search keyword or full Intermarché search URL.\n\n**Examples:**\n\n```\nlait\n```\n\n```\npates\n```\n\n```\nhttps://www.intermarche.com/recherche/lait\n```\n\nUse the Product endpoint when you already have a product URL or EAN."}},{"name":"shop_id","in":"query","required":true,"description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```","schema":{"type":"string","description":"Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example `query=Paris`).\n\n**Example:**\n\n```\n11301\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at `1`. Use `pagination.total_pages` from a previous response to iterate.\n\n**Example:** `2`","schema":{"type":"number","description":"Page number starting at `1`. Use `pagination.total_pages` from a previous response to iterate.\n\n**Example:** `2`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"shop_id":{"type":"string"},"currency":{"type":"string"},"position":{"type":"integer"},"packaging":{"type":"string"},"unit_price":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'lait' in store 11301":{"value":{"results":[{"ean":"3533630097654","url":"https://www.intermarche.com/produit/grandlait-frais-lait-frais-de-montagne-entier/3533630097654","brand":"Grandlait","image":"https://assets-big.cdn-mousquetaires.com/medias/domain11815/media140040/12012075-ubbxcayb3o-ecommint.jpg","price":1.61,"title":"Grandlait frais - Lait frais de Montagne entier","shop_id":"11301","currency":"EUR","position":1,"packaging":"la bouteille de 1 l","unit_price":"1,61 €/L","price_display":"1,61 €"},{"ean":"3451790000840","url":"https://www.intermarche.com/produit/candia-grandlait-lait-entier/3451790000840","brand":"Candia","image":null,"price":1.29,"title":"Candia GrandLait - Lait entier","shop_id":"11301","currency":"EUR","position":2,"packaging":"la bouteille de 1 l","unit_price":"1,29 €/L","price_display":"1,29 €"}],"pagination":{"next":"https://www.intermarche.com/recherche/lait?page=2","page":1,"per_page":40,"total_pages":15,"total_results":588}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/tradeaplane/listing":{"get":{"summary":"Trade-A-Plane Listing","description":"Read one Trade-A-Plane aircraft listing from its URL. You get the asking price, the airframe details, and the seller.\n\n**Credit cost:** 2 credits per call","operationId":"get-tradeaplane-listing","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Listing URL that includes listing_id.\n\n**Examples:**\n\n```\nhttps://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine\n```\n\nA search URL without listing_id returns 400.","schema":{"type":"string","description":"Listing URL that includes listing_id.\n\n**Examples:**\n\n```\nhttps://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine\n```\n\nA search URL without listing_id returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"make":{"type":"string"},"year":{"nullable":true},"model":{"type":"string"},"phone":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"seller":{"type":"string"},"country":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"warranty":{"nullable":true},"condition":{"type":"string"},"listing_id":{"type":"string"},"price_note":{"type":"string"},"description":{"type":"string"},"postal_code":{"type":"string"},"sale_status":{"type":"string"},"listing_type":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Rolls Royce Packard V-1650":{"value":{"url":"https://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine","city":"Spring","make":"ROLLS ROYCE","year":null,"model":"PACKARD V-1650","phone":"(281) 467-4348","price":61750,"title":"ROLLS ROYCE PACKARD V-1650","images":["https://dsgiipnwy1jd8.cloudfront.net/eyJrZXkiOiIxMTAyNjQ4LmpwZyIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJyIjoyNTUsImIiOjI1NSwiYWxwaGEiOjEsImciOjI1NX19LCJzbWFydE92ZXJsYXkiOnsia2V5Ijoid2F0ZXJtYXJrLnBuZyIsImJ1Y2tldCI6InRhcC1hc3NldHMxIn19LCJidWNrZXQiOiJ0YXAtYXNzZXRzMSJ9","https://dsgiipnwy1jd8.cloudfront.net/eyJlZGl0cyI6eyJzbWFydE92ZXJsYXkiOnsia2V5Ijoid2F0ZXJtYXJrLnBuZyIsImJ1Y2tldCI6InRhcC1hc3NldHMxIn0sInJlc2l6ZSI6eyJiYWNrZ3JvdW5kIjp7ImFscGhhIjoxLCJnIjoyNTUsInIiOjI1NSwiYiI6MjU1fSwiZml0IjoiY29udGFpbiJ9fSwiYnVja2V0IjoidGFwLWFzc2V0czEiLCJrZXkiOiIxMTAyNjQ5LmpwZyJ9","https://dsgiipnwy1jd8.cloudfront.net/eyJidWNrZXQiOiJ0YXAtYXNzZXRzMSIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJiIjoyNTUsInIiOjI1NSwiZyI6MjU1LCJhbHBoYSI6MX19LCJzbWFydE92ZXJsYXkiOnsiYnVja2V0IjoidGFwLWFzc2V0czEiLCJrZXkiOiJ3YXRlcm1hcmsucG5nIn19LCJrZXkiOiIxMTAyNjUxLmpwZyJ9","https://dsgiipnwy1jd8.cloudfront.net/eyJidWNrZXQiOiJ0YXAtYXNzZXRzMSIsImVkaXRzIjp7InNtYXJ0T3ZlcmxheSI6eyJidWNrZXQiOiJ0YXAtYXNzZXRzMSIsImtleSI6IndhdGVybWFyay5wbmcifSwicmVzaXplIjp7ImZpdCI6ImNvbnRhaW4iLCJiYWNrZ3JvdW5kIjp7ImciOjI1NSwiYWxwaGEiOjEsInIiOjI1NSwiYiI6MjU1fX19LCJrZXkiOiIxMTAyNjYzLmpwZyJ9"],"region":"TX","seller":"Terry Sonday","country":"USA","category":"Piston Engine","currency":"USD","warranty":null,"condition":"Overhauled","listing_id":"2419556","price_note":"OBO Will Consider All Trades","description":"Set of -9 heads and banks on transport plates, Going to be having them refreshed at a maintenance shop of your choice, $61,750. These also come with an extra set of -7 heads and banks with valves and springs but NO liners. I sold my Mustang and I have a lot of parts left over P-63 wheels and brakes, 1 overhauled oil cooler. Drop tank hard wear, automotive ignition, canopy frame, overhauled starter motor, like new tail wheel, several brand new canopy covers, Oil Temperature control valve, and lots more parts. Located in Houston, Texas. Call Terry with any question 281-467-4348.","postal_code":"77379","sale_status":"For Sale","listing_type":"engine","price_display":"$61,750","specifications":[{"name":"Sale Status","value":"For Sale"},{"name":"Category","value":"Piston Engine"},{"name":"Make/Model","value":"ROLLS ROYCE PACKARD V-1650"},{"name":"Condition","value":"Overhauled"},{"name":"Warranty","value":"Not Listed"},{"name":"Location","value":"Spring , TX USA 77379"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Trade-A-Plane Listing","description":"Read one Trade-A-Plane aircraft listing from its URL. You get the asking price, the airframe details, and the seller.\n\n**Credit cost:** 2 credits per call","operationId":"post-tradeaplane-listing","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Listing URL that includes listing_id.\n\n**Examples:**\n\n```\nhttps://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine\n```\n\nA search URL without listing_id returns 400.","schema":{"type":"string","description":"Listing URL that includes listing_id.\n\n**Examples:**\n\n```\nhttps://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine\n```\n\nA search URL without listing_id returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"make":{"type":"string"},"year":{"nullable":true},"model":{"type":"string"},"phone":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"seller":{"type":"string"},"country":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"warranty":{"nullable":true},"condition":{"type":"string"},"listing_id":{"type":"string"},"price_note":{"type":"string"},"description":{"type":"string"},"postal_code":{"type":"string"},"sale_status":{"type":"string"},"listing_type":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Rolls Royce Packard V-1650":{"value":{"url":"https://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine","city":"Spring","make":"ROLLS ROYCE","year":null,"model":"PACKARD V-1650","phone":"(281) 467-4348","price":61750,"title":"ROLLS ROYCE PACKARD V-1650","images":["https://dsgiipnwy1jd8.cloudfront.net/eyJrZXkiOiIxMTAyNjQ4LmpwZyIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJyIjoyNTUsImIiOjI1NSwiYWxwaGEiOjEsImciOjI1NX19LCJzbWFydE92ZXJsYXkiOnsia2V5Ijoid2F0ZXJtYXJrLnBuZyIsImJ1Y2tldCI6InRhcC1hc3NldHMxIn19LCJidWNrZXQiOiJ0YXAtYXNzZXRzMSJ9","https://dsgiipnwy1jd8.cloudfront.net/eyJlZGl0cyI6eyJzbWFydE92ZXJsYXkiOnsia2V5Ijoid2F0ZXJtYXJrLnBuZyIsImJ1Y2tldCI6InRhcC1hc3NldHMxIn0sInJlc2l6ZSI6eyJiYWNrZ3JvdW5kIjp7ImFscGhhIjoxLCJnIjoyNTUsInIiOjI1NSwiYiI6MjU1fSwiZml0IjoiY29udGFpbiJ9fSwiYnVja2V0IjoidGFwLWFzc2V0czEiLCJrZXkiOiIxMTAyNjQ5LmpwZyJ9","https://dsgiipnwy1jd8.cloudfront.net/eyJidWNrZXQiOiJ0YXAtYXNzZXRzMSIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJiIjoyNTUsInIiOjI1NSwiZyI6MjU1LCJhbHBoYSI6MX19LCJzbWFydE92ZXJsYXkiOnsiYnVja2V0IjoidGFwLWFzc2V0czEiLCJrZXkiOiJ3YXRlcm1hcmsucG5nIn19LCJrZXkiOiIxMTAyNjUxLmpwZyJ9","https://dsgiipnwy1jd8.cloudfront.net/eyJidWNrZXQiOiJ0YXAtYXNzZXRzMSIsImVkaXRzIjp7InNtYXJ0T3ZlcmxheSI6eyJidWNrZXQiOiJ0YXAtYXNzZXRzMSIsImtleSI6IndhdGVybWFyay5wbmcifSwicmVzaXplIjp7ImZpdCI6ImNvbnRhaW4iLCJiYWNrZ3JvdW5kIjp7ImciOjI1NSwiYWxwaGEiOjEsInIiOjI1NSwiYiI6MjU1fX19LCJrZXkiOiIxMTAyNjYzLmpwZyJ9"],"region":"TX","seller":"Terry Sonday","country":"USA","category":"Piston Engine","currency":"USD","warranty":null,"condition":"Overhauled","listing_id":"2419556","price_note":"OBO Will Consider All Trades","description":"Set of -9 heads and banks on transport plates, Going to be having them refreshed at a maintenance shop of your choice, $61,750. These also come with an extra set of -7 heads and banks with valves and springs but NO liners. I sold my Mustang and I have a lot of parts left over P-63 wheels and brakes, 1 overhauled oil cooler. Drop tank hard wear, automotive ignition, canopy frame, overhauled starter motor, like new tail wheel, several brand new canopy covers, Oil Temperature control valve, and lots more parts. Located in Houston, Texas. Call Terry with any question 281-467-4348.","postal_code":"77379","sale_status":"For Sale","listing_type":"engine","price_display":"$61,750","specifications":[{"name":"Sale Status","value":"For Sale"},{"name":"Category","value":"Piston Engine"},{"name":"Make/Model","value":"ROLLS ROYCE PACKARD V-1650"},{"name":"Condition","value":"Overhauled"},{"name":"Warranty","value":"Not Listed"},{"name":"Location","value":"Spring , TX USA 77379"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/tradeaplane/search":{"get":{"summary":"Trade-A-Plane Search","description":"Search Trade-A-Plane aircraft listings by keyword and page the results. Cards include title, price, and the listing link.\n\n**Credit cost:** 2 credits per call","operationId":"get-tradeaplane-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Trade-A-Plane search URL without listing_id.\n\n**Examples:**\n\n```\nrol\n```\n\n```\nspirit\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=engine&s-keyword-search=rol&s-original-search=rol\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=aircraft&s-keyword-search=spirit&s-original-search=spirit\n```\n\nA listing URL returns 400. A keyword needs listing_type aircraft or engine.","schema":{"type":"string","description":"Keyword, or a Trade-A-Plane search URL without listing_id.\n\n**Examples:**\n\n```\nrol\n```\n\n```\nspirit\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=engine&s-keyword-search=rol&s-original-search=rol\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=aircraft&s-keyword-search=spirit&s-original-search=spirit\n```\n\nA listing URL returns 400. A keyword needs listing_type aircraft or engine."}},{"name":"listing_type","in":"query","required":false,"description":"aircraft or engine when query is a keyword. Ignored when query is a URL.","schema":{"type":"string","description":"aircraft or engine when query is a keyword. Ignored when query is a URL."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Sent as s-page.","schema":{"type":"number","description":"Page from 1. Sent as s-page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"make":{"type":"string"},"year":{"nullable":true},"image":{"type":"string"},"model":{"type":"string"},"phone":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"region":{"type":"string"},"seller":{"type":"string"},"country":{"type":"string"},"summary":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"position":{"type":"integer"},"condition":{"type":"string"},"listing_id":{"type":"string"},"total_time":{"nullable":true},"updated_at":{"type":"string"},"listing_type":{"type":"string"},"registration":{"nullable":true},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"rol engines":{"value":{"results":[{"url":"https://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine","city":"Spring","make":"ROLLS ROYCE","year":null,"image":"https://dsgiipnwy1jd8.cloudfront.net/eyJlZGl0cyI6eyJzbWFydE92ZXJsYXkiOnsiYnVja2V0IjoidGFwLWFzc2V0czEiLCJrZXkiOiJ3YXRlcm1hcmsucG5nIn0sInJlc2l6ZSI6eyJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJhbHBoYSI6MSwiYiI6MjU1LCJyIjoyNTUsImciOjI1NX0sIndpZHRoIjozMDB9fSwia2V5IjoiMTEwMjY0OC5qcGciLCJidWNrZXQiOiJ0YXAtYXNzZXRzMSJ9","model":"PACKARD V-1650","phone":"(281) 467-4348","price":61750,"title":"ROLLS ROYCE PACKARD V-1650 (For Sale)","region":"TX","seller":"Terry Sonday","country":"USA","summary":"Set of -9 heads and banks on transport plates, Going to be having them refreshed at a maintenance shop of your choice, $61,750. These also come with an ext...","category":"Piston Engine","currency":"USD","position":1,"condition":"Overhauled","listing_id":"2419556","total_time":null,"updated_at":"08/25/2023","listing_type":"engine","registration":null,"price_display":"$61,750"},{"url":"https://www.trade-a-plane.com/search?category_level1=Turbine+Engine&make=ALLISON&model=250-B17F&listing_id=2456631&s-type=engine","city":"Moodus","make":"ALLISON","year":null,"image":"/display-asset?asset_id=1&width=300","model":"250-B17F","phone":null,"price":500000,"title":"ALLISON 250-B17F (For Sale)","region":"CT","seller":"Colleen Pollard","country":"USA","summary":"The Rolls-Royce (Allison) 250-B17F/2 is a lightweight, highly reliable turboprop engine delivering 450 shaft-horsepower (shp). Part of the renowned M250 fa...","category":"Turbine Engine","currency":"USD","position":2,"condition":"New","listing_id":"2456631","total_time":null,"updated_at":"10/17/2026","listing_type":"engine","registration":null,"price_display":"$500,000"}],"pagination":{"next":null,"page":1,"per_page":5,"total_pages":1,"total_results":5}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Trade-A-Plane Search","description":"Search Trade-A-Plane aircraft listings by keyword and page the results. Cards include title, price, and the listing link.\n\n**Credit cost:** 2 credits per call","operationId":"post-tradeaplane-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Trade-A-Plane search URL without listing_id.\n\n**Examples:**\n\n```\nrol\n```\n\n```\nspirit\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=engine&s-keyword-search=rol&s-original-search=rol\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=aircraft&s-keyword-search=spirit&s-original-search=spirit\n```\n\nA listing URL returns 400. A keyword needs listing_type aircraft or engine.","schema":{"type":"string","description":"Keyword, or a Trade-A-Plane search URL without listing_id.\n\n**Examples:**\n\n```\nrol\n```\n\n```\nspirit\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=engine&s-keyword-search=rol&s-original-search=rol\n```\n\n```\nhttps://www.trade-a-plane.com/filtered/search?s-type=aircraft&s-keyword-search=spirit&s-original-search=spirit\n```\n\nA listing URL returns 400. A keyword needs listing_type aircraft or engine."}},{"name":"listing_type","in":"query","required":false,"description":"aircraft or engine when query is a keyword. Ignored when query is a URL.","schema":{"type":"string","description":"aircraft or engine when query is a keyword. Ignored when query is a URL."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Sent as s-page.","schema":{"type":"number","description":"Page from 1. Sent as s-page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"make":{"type":"string"},"year":{"nullable":true},"image":{"type":"string"},"model":{"type":"string"},"phone":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"region":{"type":"string"},"seller":{"type":"string"},"country":{"type":"string"},"summary":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"position":{"type":"integer"},"condition":{"type":"string"},"listing_id":{"type":"string"},"total_time":{"nullable":true},"updated_at":{"type":"string"},"listing_type":{"type":"string"},"registration":{"nullable":true},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"rol engines":{"value":{"results":[{"url":"https://www.trade-a-plane.com/search?category_level1=Piston+Engine&make=ROLLS+ROYCE&model=PACKARD+V-1650&listing_id=2419556&s-type=engine","city":"Spring","make":"ROLLS ROYCE","year":null,"image":"https://dsgiipnwy1jd8.cloudfront.net/eyJlZGl0cyI6eyJzbWFydE92ZXJsYXkiOnsiYnVja2V0IjoidGFwLWFzc2V0czEiLCJrZXkiOiJ3YXRlcm1hcmsucG5nIn0sInJlc2l6ZSI6eyJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJhbHBoYSI6MSwiYiI6MjU1LCJyIjoyNTUsImciOjI1NX0sIndpZHRoIjozMDB9fSwia2V5IjoiMTEwMjY0OC5qcGciLCJidWNrZXQiOiJ0YXAtYXNzZXRzMSJ9","model":"PACKARD V-1650","phone":"(281) 467-4348","price":61750,"title":"ROLLS ROYCE PACKARD V-1650 (For Sale)","region":"TX","seller":"Terry Sonday","country":"USA","summary":"Set of -9 heads and banks on transport plates, Going to be having them refreshed at a maintenance shop of your choice, $61,750. These also come with an ext...","category":"Piston Engine","currency":"USD","position":1,"condition":"Overhauled","listing_id":"2419556","total_time":null,"updated_at":"08/25/2023","listing_type":"engine","registration":null,"price_display":"$61,750"},{"url":"https://www.trade-a-plane.com/search?category_level1=Turbine+Engine&make=ALLISON&model=250-B17F&listing_id=2456631&s-type=engine","city":"Moodus","make":"ALLISON","year":null,"image":"/display-asset?asset_id=1&width=300","model":"250-B17F","phone":null,"price":500000,"title":"ALLISON 250-B17F (For Sale)","region":"CT","seller":"Colleen Pollard","country":"USA","summary":"The Rolls-Royce (Allison) 250-B17F/2 is a lightweight, highly reliable turboprop engine delivering 450 shaft-horsepower (shp). Part of the renowned M250 fa...","category":"Turbine Engine","currency":"USD","position":2,"condition":"New","listing_id":"2456631","total_time":null,"updated_at":"10/17/2026","listing_type":"engine","registration":null,"price_display":"$500,000"}],"pagination":{"next":null,"page":1,"per_page":5,"total_pages":1,"total_results":5}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bricorama/product":{"get":{"summary":"Bricorama Product","description":"Read one Bricorama product from its URL. You get price, brand, and the product details.\n\n**Credit cost:** 1 credit per call","operationId":"get-bricorama-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL `/p/{slug}/{ean}`.\n\n**Examples:**\n\n```\nhttps://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267\n```\n\nA keyword or a `/search` URL returns 400.","schema":{"type":"string","description":"Product URL `/p/{slug}/{ean}`.\n\n**Examples:**\n\n```\nhttps://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267\n```\n\nA keyword or a `/search` URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"delivery":{"type":"string"},"was_price":{"nullable":true},"description":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"discount_display":{"nullable":true},"was_price_display":{"nullable":true}}},"examples":{"Perceuse visseuse sans fil 18V":{"value":{"ean":"3999991691267","url":"https://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267","name":"Perceuse visseuse sans fil 18V","brand":"GO/ON","price":27.9,"images":["https://assets-big.cdn-mousquetaires.com/medias/domain11440/media2624/393739-2ftpvnauip-epreview.jpg"],"currency":"EUR","delivery":"Retrait en 2h en magasin","was_price":null,"description":"Découvrez la perceuse visseuse sans fil 18V de la marque GO/ON, un outil performant et pratique conçu pour faciliter tous vos travaux de perçage et de vissage, que vous soyez un bricoleur novice ou expérimenté. Cette perceuse visseuse est équipée d'une batterie Lithium-ion de 1300mAh offrant une bonne autonomie et un temps de charge rapide de seulement 3 heures. Sa puissance de 18 volts assure une efficacité optimale pour une large variété de tâches. Elle dispose d'un mandrin sans clé de 10 mm, ce qui permet un changement rapide et facile des embouts. Grâce à sa fonction réversible et sa vitesse variable, vous pouvez adapter la puissance et la rotation selon vos besoins, pour un contrôle précis et un travail soigné. Le réglage de couple est particulièrement pratique avec 21+1 positions et une force maximale de 16 Nm, ce qui permet de travailler sur différents matériaux sans risque d'endommager les vis ou la surface. Cette perceuse est capable de percer jusqu'à 10 mm dans l'acier et 25 mm dans le bois, ce qui la rend idéale pour des travaux de bricolage courants, comme la fixation d'étagères, le montage de meubles ou la réalisation de petits travaux de construction. Compacte et légère, elle offre une bonne prise en main grâce à sa poignée ergonomique, ce qui limite la fatigue lors d'une utilisation prolongée. Son design sans fil apporte une grande liberté de mouvement et facilite l'accès aux endroits difficiles d'accès sans contrainte de câble. Caractéristiques : Perceuse visseuse sans fil Puissance : 18V Batterie Lithium-ion 1300mAh Chargeur 3 heures Réversible Vitesse variable Mandrin sans clé 10 mm Réglage de couple 16 Nm, 21+1 positions Capacité de perçage acier : 10 mm Capacité de perçage bois : 25 mm GO/ON est une marque reconnue pour son savoir-faire dans la fabrication d’outils électroportatifs destinés aux bricoleurs. Elle allie performance, robustesse et simplicité d’utilisation pour proposer des produits adaptés aux besoins de tous, du novice au plus expérimenté, facilitant ainsi la réalisation de travaux de bricolage variés.","price_display":"27,90 €","specifications":[{"name":"Marque","value":"GO/ON"},{"name":"Éclairage intégré","value":"Non"},{"name":"Vitesse variable","value":"Oui"},{"name":"Diamètre de perçage dans le bois (en mm)","value":"25"},{"name":"Diamètre de perçage dans le métal (en mm)","value":"10"},{"name":"Type de produit","value":"Perceuse visseuse"},{"name":"Hauteur du produit déballé","value":"7 cm"},{"name":"Largeur du produit déballé","value":"19 cm"},{"name":"Profondeur du produit déballé","value":"20 cm"},{"name":"Poids du produit déballé","value":"1.3 kg"},{"name":"Disponibilité des pièces détachées","value":"Non communiquée"},{"name":"Hauteur du produit emballé","value":"20.3 cm"},{"name":"Largeur du produit emballé","value":"8.5 cm"},{"name":"Profondeur du produit emballé","value":"21.3 cm"},{"name":"Poids du produit emballé","value":"1.3 kg"},{"name":"Références produit","value":"25077430 / 3999991691267"}],"discount_display":null,"was_price_display":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Bricorama Product","description":"Read one Bricorama product from its URL. You get price, brand, and the product details.\n\n**Credit cost:** 1 credit per call","operationId":"post-bricorama-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL `/p/{slug}/{ean}`.\n\n**Examples:**\n\n```\nhttps://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267\n```\n\nA keyword or a `/search` URL returns 400.","schema":{"type":"string","description":"Product URL `/p/{slug}/{ean}`.\n\n**Examples:**\n\n```\nhttps://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267\n```\n\nA keyword or a `/search` URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"delivery":{"type":"string"},"was_price":{"nullable":true},"description":{"type":"string"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"discount_display":{"nullable":true},"was_price_display":{"nullable":true}}},"examples":{"Perceuse visseuse sans fil 18V":{"value":{"ean":"3999991691267","url":"https://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267","name":"Perceuse visseuse sans fil 18V","brand":"GO/ON","price":27.9,"images":["https://assets-big.cdn-mousquetaires.com/medias/domain11440/media2624/393739-2ftpvnauip-epreview.jpg"],"currency":"EUR","delivery":"Retrait en 2h en magasin","was_price":null,"description":"Découvrez la perceuse visseuse sans fil 18V de la marque GO/ON, un outil performant et pratique conçu pour faciliter tous vos travaux de perçage et de vissage, que vous soyez un bricoleur novice ou expérimenté. Cette perceuse visseuse est équipée d'une batterie Lithium-ion de 1300mAh offrant une bonne autonomie et un temps de charge rapide de seulement 3 heures. Sa puissance de 18 volts assure une efficacité optimale pour une large variété de tâches. Elle dispose d'un mandrin sans clé de 10 mm, ce qui permet un changement rapide et facile des embouts. Grâce à sa fonction réversible et sa vitesse variable, vous pouvez adapter la puissance et la rotation selon vos besoins, pour un contrôle précis et un travail soigné. Le réglage de couple est particulièrement pratique avec 21+1 positions et une force maximale de 16 Nm, ce qui permet de travailler sur différents matériaux sans risque d'endommager les vis ou la surface. Cette perceuse est capable de percer jusqu'à 10 mm dans l'acier et 25 mm dans le bois, ce qui la rend idéale pour des travaux de bricolage courants, comme la fixation d'étagères, le montage de meubles ou la réalisation de petits travaux de construction. Compacte et légère, elle offre une bonne prise en main grâce à sa poignée ergonomique, ce qui limite la fatigue lors d'une utilisation prolongée. Son design sans fil apporte une grande liberté de mouvement et facilite l'accès aux endroits difficiles d'accès sans contrainte de câble. Caractéristiques : Perceuse visseuse sans fil Puissance : 18V Batterie Lithium-ion 1300mAh Chargeur 3 heures Réversible Vitesse variable Mandrin sans clé 10 mm Réglage de couple 16 Nm, 21+1 positions Capacité de perçage acier : 10 mm Capacité de perçage bois : 25 mm GO/ON est une marque reconnue pour son savoir-faire dans la fabrication d’outils électroportatifs destinés aux bricoleurs. Elle allie performance, robustesse et simplicité d’utilisation pour proposer des produits adaptés aux besoins de tous, du novice au plus expérimenté, facilitant ainsi la réalisation de travaux de bricolage variés.","price_display":"27,90 €","specifications":[{"name":"Marque","value":"GO/ON"},{"name":"Éclairage intégré","value":"Non"},{"name":"Vitesse variable","value":"Oui"},{"name":"Diamètre de perçage dans le bois (en mm)","value":"25"},{"name":"Diamètre de perçage dans le métal (en mm)","value":"10"},{"name":"Type de produit","value":"Perceuse visseuse"},{"name":"Hauteur du produit déballé","value":"7 cm"},{"name":"Largeur du produit déballé","value":"19 cm"},{"name":"Profondeur du produit déballé","value":"20 cm"},{"name":"Poids du produit déballé","value":"1.3 kg"},{"name":"Disponibilité des pièces détachées","value":"Non communiquée"},{"name":"Hauteur du produit emballé","value":"20.3 cm"},{"name":"Largeur du produit emballé","value":"8.5 cm"},{"name":"Profondeur du produit emballé","value":"21.3 cm"},{"name":"Poids du produit emballé","value":"1.3 kg"},{"name":"Références produit","value":"25077430 / 3999991691267"}],"discount_display":null,"was_price_display":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bricorama/search":{"get":{"summary":"Bricorama Search","description":"Search Bricorama by keyword or search URL and page the home-improvement grid.\n\n**Credit cost:** 1 credit per call","operationId":"get-bricorama-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Bricorama /search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.bricorama.fr/search?q=perceuse\n```\n\nA product URL (`/p/...`) returns 400. `page` starts at 1 and is sent as `?page=`.","schema":{"type":"string","description":"Keyword, or a Bricorama /search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.bricorama.fr/search?q=perceuse\n```\n\nA product URL (`/p/...`) returns 400. `page` starts at 1 and is sent as `?page=`."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Sent as ?page= on the listing.","schema":{"type":"number","description":"Page from 1. Sent as ?page= on the listing."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"seller":{"nullable":true},"currency":{"type":"string"},"delivery":{"type":"string"},"position":{"type":"integer"},"was_price":{"nullable":true},"availability":{"type":"string"},"price_display":{"type":"string"},"discount_display":{"nullable":true},"was_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"perceuse, first product":{"value":{"results":[{"ean":"3999991691267","url":"https://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267","name":"Perceuse visseuse sans fil 18V","brand":"GO/ON","image":"https://assets-big.cdn-mousquetaires.com/medias/domain11440/media2624/393739-2ftpvnauip-large.jpg","price":27.9,"seller":null,"currency":"EUR","delivery":"Retrait en 2h en magasin","position":1,"was_price":null,"availability":"En stock selon magasin","price_display":"27,90 €","discount_display":null,"was_price_display":null}],"pagination":{"next":"https://www.bricorama.fr/search?q=perceuse&page=2","page":1,"per_page":48,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Bricorama Search","description":"Search Bricorama by keyword or search URL and page the home-improvement grid.\n\n**Credit cost:** 1 credit per call","operationId":"post-bricorama-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Bricorama /search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.bricorama.fr/search?q=perceuse\n```\n\nA product URL (`/p/...`) returns 400. `page` starts at 1 and is sent as `?page=`.","schema":{"type":"string","description":"Keyword, or a Bricorama /search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.bricorama.fr/search?q=perceuse\n```\n\nA product URL (`/p/...`) returns 400. `page` starts at 1 and is sent as `?page=`."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Sent as ?page= on the listing.","schema":{"type":"number","description":"Page from 1. Sent as ?page= on the listing."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"seller":{"nullable":true},"currency":{"type":"string"},"delivery":{"type":"string"},"position":{"type":"integer"},"was_price":{"nullable":true},"availability":{"type":"string"},"price_display":{"type":"string"},"discount_display":{"nullable":true},"was_price_display":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"perceuse, first product":{"value":{"results":[{"ean":"3999991691267","url":"https://www.bricorama.fr/p/perceuse-visseuse-sans-fil-18v/3999991691267","name":"Perceuse visseuse sans fil 18V","brand":"GO/ON","image":"https://assets-big.cdn-mousquetaires.com/medias/domain11440/media2624/393739-2ftpvnauip-large.jpg","price":27.9,"seller":null,"currency":"EUR","delivery":"Retrait en 2h en magasin","position":1,"was_price":null,"availability":"En stock selon magasin","price_display":"27,90 €","discount_display":null,"was_price_display":null}],"pagination":{"next":"https://www.bricorama.fr/search?q=perceuse&page=2","page":1,"per_page":48,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/castorama/search":{"get":{"summary":"Castorama Search","description":"Search Castorama by keyword or search URL and page the DIY listings. Cards include title, price, and product link.\n\n**Credit cost:** 1 credit per call","operationId":"get-castorama-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Castorama listing URL (`/search` or a `.cat` category).\n\n**Examples:**\n\n```\njoint-silicone\n```\n\n```\nhttps://www.castorama.fr/search?term=joint-silicone\n```\n\n```\nhttps://www.castorama.fr/outillage/outillage-electroportatif/perceuse-visseuse-perceuse-a-percussion-et-tournevis-sans-fil/cat_id_3796.cat\n```\n\nA product URL (`_CAFR.prd`) returns 400. `page` starts at 1 and is sent as `?page=`.","schema":{"type":"string","description":"Keyword, or a Castorama listing URL (`/search` or a `.cat` category).\n\n**Examples:**\n\n```\njoint-silicone\n```\n\n```\nhttps://www.castorama.fr/search?term=joint-silicone\n```\n\n```\nhttps://www.castorama.fr/outillage/outillage-electroportatif/perceuse-visseuse-perceuse-a-percussion-et-tournevis-sans-fil/cat_id_3796.cat\n```\n\nA product URL (`_CAFR.prd`) returns 400. `page` starts at 1 and is sent as `?page=`."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Sent as ?page= on the listing.","schema":{"type":"number","description":"Page from 1. Sent as ?page= on the listing."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"rating":{"type":"number"},"currency":{"type":"string"},"position":{"type":"integer"},"was_price":{"nullable":true},"unit_price":{"type":"number"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"was_price_display":{"nullable":true},"unit_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"joint-silicone, first product":{"value":{"results":[{"ean":"5410091628840","url":"https://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd","name":"Mastic bain et cuisine Rubson blanc 280ml","image":"https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_30c_FR_CF","price":10.9,"rating":4.5,"currency":"EUR","position":1,"was_price":null,"unit_price":38.93,"review_count":55,"price_display":"10,90 €","was_price_display":null,"unit_price_display":"38,93 € / L"}],"pagination":{"next":"https://www.castorama.fr/search?term=joint-silicone&page=2","page":1,"per_page":48,"total_pages":189,"total_results":9050}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Castorama Search","description":"Search Castorama by keyword or search URL and page the DIY listings. Cards include title, price, and product link.\n\n**Credit cost:** 1 credit per call","operationId":"post-castorama-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a Castorama listing URL (`/search` or a `.cat` category).\n\n**Examples:**\n\n```\njoint-silicone\n```\n\n```\nhttps://www.castorama.fr/search?term=joint-silicone\n```\n\n```\nhttps://www.castorama.fr/outillage/outillage-electroportatif/perceuse-visseuse-perceuse-a-percussion-et-tournevis-sans-fil/cat_id_3796.cat\n```\n\nA product URL (`_CAFR.prd`) returns 400. `page` starts at 1 and is sent as `?page=`.","schema":{"type":"string","description":"Keyword, or a Castorama listing URL (`/search` or a `.cat` category).\n\n**Examples:**\n\n```\njoint-silicone\n```\n\n```\nhttps://www.castorama.fr/search?term=joint-silicone\n```\n\n```\nhttps://www.castorama.fr/outillage/outillage-electroportatif/perceuse-visseuse-perceuse-a-percussion-et-tournevis-sans-fil/cat_id_3796.cat\n```\n\nA product URL (`_CAFR.prd`) returns 400. `page` starts at 1 and is sent as `?page=`."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Sent as ?page= on the listing.","schema":{"type":"number","description":"Page from 1. Sent as ?page= on the listing."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"rating":{"type":"number"},"currency":{"type":"string"},"position":{"type":"integer"},"was_price":{"nullable":true},"unit_price":{"type":"number"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"was_price_display":{"nullable":true},"unit_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"joint-silicone, first product":{"value":{"results":[{"ean":"5410091628840","url":"https://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd","name":"Mastic bain et cuisine Rubson blanc 280ml","image":"https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_30c_FR_CF","price":10.9,"rating":4.5,"currency":"EUR","position":1,"was_price":null,"unit_price":38.93,"review_count":55,"price_display":"10,90 €","was_price_display":null,"unit_price_display":"38,93 € / L"}],"pagination":{"next":"https://www.castorama.fr/search?term=joint-silicone&page=2","page":1,"per_page":48,"total_pages":189,"total_results":9050}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/castorama/product":{"get":{"summary":"Castorama Product","description":"Read one Castorama product from its URL. You get price, brand, and specifications.\n\n**Credit cost:** 1 credit per call","operationId":"get-castorama-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL ending in `_CAFR.prd`.\n\n**Examples:**\n\n```\nhttps://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd\n```\n\nA keyword, a `/search` URL, or a `.cat` category URL returns 400.","schema":{"type":"string","description":"Product URL ending in `_CAFR.prd`.\n\n**Examples:**\n\n```\nhttps://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd\n```\n\nA keyword, a `/search` URL, or a `.cat` category URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"was_price":{"nullable":true},"description":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"was_price_display":{"nullable":true}}},"examples":{"Mastic bain et cuisine Rubson blanc 280ml":{"value":{"ean":"5410091628840","url":"https://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd","name":"Mastic bain et cuisine Rubson blanc 280ml","brand":"Rubson","price":10.9,"images":["https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_30c_FR_CF","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_30t_FR_CF","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_10i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_11i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_12i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_13i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_14i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_01t_FR_CF"],"rating":4.5,"currency":"EUR","in_stock":true,"was_price":null,"description":"Le mastic sanitaire Rubson blanc de 280 ml garantit une étanchéité parfaite et durable pour vos baignoires, éviers et douches. Conçu spécialement pour faire face à l'humidité constante de la salle de bains et de la cuisine, cet élastomère silicone de haute qualité résiste efficacement aux moisissures grâce à ses agents antifongiques puissants. Sa formule avancée adhère sans faille sur des surfaces variées comme l'émail, la faïence ou le verre, tout en conservant sa blancheur éclatante sans jaunir dans le temps. Facile à appliquer et résistant aux détergents ménagers, ce produit est le choix idéal des bricoleurs pour un résultat professionnel et soigné chez Castorama.","review_count":55,"price_display":"10,90 €","specifications":[{"name":"Type d'article","value":"Mastic cuisine et salle de bains"},{"name":"Marque","value":"Rubson"},{"name":"Type de pack","value":"À l'unité"},{"name":"Type de conteneur","value":"Cartouche"},{"name":"Couleur","value":"Blanc"},{"name":"Contenance","value":"280ml"},{"name":"Résistant à l'eau","value":"Résistant à l'eau"},{"name":"Temps de traitement (en h)","value":"24h"},{"name":"Peut être peint","value":"Ne peut pas être peint"},{"name":"Mode d’emploi","value":"Avant d'appliquer un mastic de cuisine ou un mastic de salle de bain, le support doit être propre, sec et dégraissé. Éliminer l'ancien joint à l'aide d'un cutter et de Rubson Enlève Joints (joints silicones). Ouvrir l'extrémité de la cartouche avec le Cutter & Lisseur Rubson. Visser la canule et la couper avec le Cutter & Lisseur Rubson en fonction de la largeur du joint souhaité. Placer la cartouche dans le Super Pistolet Mastic Pliable Rubson. Délimiter la largeur du joint de cuisine ou du joint de baignoire avec un ruban adhésif. Appliquer un cordon régulier de mastic en poussant la cartouche vers l'avant. Lisser avec le Cutter et Lisseur de Joint humidifié ou avec une spatule mouillée. Retirer le ruban adhésif. Revisser le bouchon sur la canule afin de prolonger la conservation du mastic"},{"name":"Norme","value":"EN 15651-3"},{"name":"Poids du produit","value":"274g"},{"name":"Résiste à la moisissure","value":"Résistant à la moisissure"},{"name":"Lieu","value":"Intérieur"},{"name":"Informations de sécurité","value":"Dangereux - respecter les précautions d'emploi. Conserver hors de la portée et de la vue des enfants"},{"name":"Type d'utilisation approprié","value":"Vasque, baignoire, élément sanitaire et douche"},{"name":"Usage","value":"Mastic d'étanchéité sanitaire"},{"name":"Référence produit","value":"5410091628840"}],"was_price_display":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Castorama Product","description":"Read one Castorama product from its URL. You get price, brand, and specifications.\n\n**Credit cost:** 1 credit per call","operationId":"post-castorama-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL ending in `_CAFR.prd`.\n\n**Examples:**\n\n```\nhttps://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd\n```\n\nA keyword, a `/search` URL, or a `.cat` category URL returns 400.","schema":{"type":"string","description":"Product URL ending in `_CAFR.prd`.\n\n**Examples:**\n\n```\nhttps://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd\n```\n\nA keyword, a `/search` URL, or a `.cat` category URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"was_price":{"nullable":true},"description":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"was_price_display":{"nullable":true}}},"examples":{"Mastic bain et cuisine Rubson blanc 280ml":{"value":{"ean":"5410091628840","url":"https://www.castorama.fr/mastic-bain-et-cuisine-rubson-blanc-280ml/5410091628840_CAFR.prd","name":"Mastic bain et cuisine Rubson blanc 280ml","brand":"Rubson","price":10.9,"images":["https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_30c_FR_CF","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_30t_FR_CF","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_10i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_11i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_12i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_13i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_14i_fr_cf","https://media.castorama.fr/is/image/Castorama/mastic-bain-et-cuisine-rubson-blanc-280ml~5410091628840_01t_FR_CF"],"rating":4.5,"currency":"EUR","in_stock":true,"was_price":null,"description":"Le mastic sanitaire Rubson blanc de 280 ml garantit une étanchéité parfaite et durable pour vos baignoires, éviers et douches. Conçu spécialement pour faire face à l'humidité constante de la salle de bains et de la cuisine, cet élastomère silicone de haute qualité résiste efficacement aux moisissures grâce à ses agents antifongiques puissants. Sa formule avancée adhère sans faille sur des surfaces variées comme l'émail, la faïence ou le verre, tout en conservant sa blancheur éclatante sans jaunir dans le temps. Facile à appliquer et résistant aux détergents ménagers, ce produit est le choix idéal des bricoleurs pour un résultat professionnel et soigné chez Castorama.","review_count":55,"price_display":"10,90 €","specifications":[{"name":"Type d'article","value":"Mastic cuisine et salle de bains"},{"name":"Marque","value":"Rubson"},{"name":"Type de pack","value":"À l'unité"},{"name":"Type de conteneur","value":"Cartouche"},{"name":"Couleur","value":"Blanc"},{"name":"Contenance","value":"280ml"},{"name":"Résistant à l'eau","value":"Résistant à l'eau"},{"name":"Temps de traitement (en h)","value":"24h"},{"name":"Peut être peint","value":"Ne peut pas être peint"},{"name":"Mode d’emploi","value":"Avant d'appliquer un mastic de cuisine ou un mastic de salle de bain, le support doit être propre, sec et dégraissé. Éliminer l'ancien joint à l'aide d'un cutter et de Rubson Enlève Joints (joints silicones). Ouvrir l'extrémité de la cartouche avec le Cutter & Lisseur Rubson. Visser la canule et la couper avec le Cutter & Lisseur Rubson en fonction de la largeur du joint souhaité. Placer la cartouche dans le Super Pistolet Mastic Pliable Rubson. Délimiter la largeur du joint de cuisine ou du joint de baignoire avec un ruban adhésif. Appliquer un cordon régulier de mastic en poussant la cartouche vers l'avant. Lisser avec le Cutter et Lisseur de Joint humidifié ou avec une spatule mouillée. Retirer le ruban adhésif. Revisser le bouchon sur la canule afin de prolonger la conservation du mastic"},{"name":"Norme","value":"EN 15651-3"},{"name":"Poids du produit","value":"274g"},{"name":"Résiste à la moisissure","value":"Résistant à la moisissure"},{"name":"Lieu","value":"Intérieur"},{"name":"Informations de sécurité","value":"Dangereux - respecter les précautions d'emploi. Conserver hors de la portée et de la vue des enfants"},{"name":"Type d'utilisation approprié","value":"Vasque, baignoire, élément sanitaire et douche"},{"name":"Usage","value":"Mastic d'étanchéité sanitaire"},{"name":"Référence produit","value":"5410091628840"}],"was_price_display":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/europages/company":{"get":{"summary":"Europages Company","description":"Europages company profile with address, supplier type and the products listed on the page (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-europages-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Profile URL copied from a search card, or a slug.\n\n**Examples:**\n\n```\nhttps://www.europages.fr/fr/company/synyco-sas-22106635\n```\n\n```\nsynyco-sas-22106635\n```\n\n```\nhttps://www.europages.de/de/firma/lab-fill-22400551\n```\n\n```\nhttps://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html\n```\n\nA `/products/` URL returns 400. With a slug, `domain` builds `/{language}/company/{slug}` (`fr` by default). A German card must be passed as its full `/de/firma/…` URL.","schema":{"type":"string","description":"Profile URL copied from a search card, or a slug.\n\n**Examples:**\n\n```\nhttps://www.europages.fr/fr/company/synyco-sas-22106635\n```\n\n```\nsynyco-sas-22106635\n```\n\n```\nhttps://www.europages.de/de/firma/lab-fill-22400551\n```\n\n```\nhttps://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html\n```\n\nA `/products/` URL returns 400. With a slug, `domain` builds `/{language}/company/{slug}` (`fr` by default). A German card must be passed as its full `/de/firma/…` URL."}},{"name":"domain","in":"query","required":false,"description":"Site when query is a slug. Same values as search. Default fr. Ignored when query is a URL.","schema":{"type":"string","default":"fr","description":"Site when query is a slug. Same values as search. Default fr. Ignored when query is a URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"formatted":{"type":"string"},"postal_code":{"type":"string"}}},"country":{"type":"string"},"website":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"price_display":{"type":"string"},"minimum_order_quantity":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"string"}},"company_id":{"type":"string"},"description":{"type":"string"},"delivery_area":{"type":"string"},"supplier_types":{"type":"array","items":{"type":"string"}}}},"examples":{"SYNYCO SAS":{"value":{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635","name":"SYNYCO SAS","address":{"city":"Hautmont","street":"64 Avenue General Leclerc","formatted":"64 Avenue General Leclerc, Hautmont 59330","postal_code":"59330"},"country":"France","website":"http://www.synyco.com","products":[{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635/products/mix-electromenager-appareils-electromenagers-mixtes-35944406","name":"Mix électroménager / appareils électroménagers mixtes","price":500,"currency":"EUR","price_display":"500,00 €","minimum_order_quantity":"2 palettes"},{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635/products/tissu-destockage-pour-meuble-et-rideaux-stocklot-fabrics-for-furniture-made-in-eu-35881295","name":"Tissu destockage pour meuble et rideaux / stocklot fabrics for furniture made in EU","price":1.5,"currency":"EUR","price_display":"1,50 €","minimum_order_quantity":"6000 m"},{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635/products/lot-hygiene-stocklot-of-personal-care-35951778","name":"Lot hygiene / stocklot of personal care","price":0.7,"currency":"EUR","price_display":"0,70 €","minimum_order_quantity":"5000 pièces"}],"categories":["Appareils ménagers (Autre)","Produits cosmétiques (Autre)","Tissus (Autre)"],"company_id":"22106635","description":"Synyco Sas, une entreprise spécialisée dans les surplus et les produits finis pour le marché local, toute l'Europe, l'Afrique, l'Amérique du Sud et le Moyen-Orient. Nous achetons et vendons des produits de fin de série, des invendus, des produits d'hygiène, des articles pour bébé, des articles de bricolage, des textiles de maison, des appareils électroménagers et des meubles. En tant que spécialistes du dédouanement à l'export, Synyco est à votre disposition pour l'achat et le dédouanement de vos produits de fin de série et invendus dans les domaines des textiles, des articles pour bébé, des textiles de maison, des meubles, des tissus, des produits d'hygiène et de nettoyage, des appareils électroménagers, des articles de bricolage, des fixations, de la quincaillerie et des produits divers.","delivery_area":"Mondiale","supplier_types":["Prestataire de services","Grossiste"]}},"ALYA PACKAGING":{"value":{"url":"https://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html","name":"ALYA PACKAGING","address":{"city":"Istanbul","street":"Vizyon Park 5.plaza no:508 29ekim cd.","formatted":"Vizyon Park 5.plaza no:508 29ekim cd., Istanbul 34197","postal_code":"34197"},"country":"Turquie","website":"https://alyapackaging.com","products":[{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-apparel-shirt-boxes-custom-printed-packaging-boxes-35372297","name":"Vêtements Imprimés – Boîtes à Chemises - Boîtes d'Emballage Imprimées sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/luxury-paper-bags-with-high-gsm-and-custom-printing-36448909","name":"Sacs en papier de luxe avec un GSM élevé et impression personnalisée","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-pastry-cake-boxes-custom-printed-packaging-boxes-35494295","name":"Pâtisserie Imprimée – Boîtes à Gâteaux - Boîtes d'Emballage Personnalisées","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-laminated-paper-bags-custom-printed-luxury-paper-bags-35498387","name":"Sacs en Papier Laminé Imprimés - Sacs en Papier de Luxe Imprimés sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/laminated-non-woven-pp-bags-custom-printed-resusable-eco-bags-35275581","name":"Sacs en PP non tissés laminés - Sacs écologiques réutilisables imprimés sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/logo-printed-ribbon-gift-wrapping-35358558","name":"Ruban Imprimé avec Logo - Emballage Cadeau","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"3000 m"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/custom-rigid-shoe-boxes-presentation-gift-35384857","name":"Boîtes à chaussures rigides personnalisées - Cadeau de présentation","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"500 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-gift-card-boxes-rigid-presentation-35401467","name":"Boîtes de Cartes Cadeaux Imprimées - Présentation Rigide","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/luxury-kraft-paper-bags-custom-printed-luxury-paper-bags-35562115","name":"Sacs en papier kraft de luxe - Sacs en papier de luxe imprimés sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/self-seal-mailing-boxes-with-custom-printing-and-lightweight-protection-35796583","name":"Boîtes d'expédition auto-adhésives avec impression personnalisée et protection légère","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/custom-printed-folding-boxes-custom-printed-packaging-boxes-35435304","name":"Boîtes pliantes imprimées sur mesure - Boîtes d'emballage imprimées sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-gable-boxes-paper-lunch-boxes-custom-printed-packaging-boxes-35395877","name":"Boîtes à Pente Imprimées – Boîtes à Lunch en Papier - Boîtes d'Emballage Imprimées sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/laminated-luxury-postal-boxes-custom-printed-postal-and-e-commerce-boxes-35460553","name":"Boîtes Postales de Luxe Laminées - Boîtes Postales et E-Commerce Imprimées sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"100 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/rigid-presentation-gift-boxes-custom-printed-designs-35300021","name":"Boîtes Cadeaux de Présentation Rigides - Designs Imprimés Personnalisés","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"250 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-fast-food-packaging-boxes-custom-printed-packaging-boxes-35789029","name":"Boîtes d'emballage de restauration rapide imprimées - Boîtes d'emballage personnalisées imprimées","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/custom-corrugated-cardboard-boxes-custom-printed-packaging-boxes-35489916","name":"Boîtes en carton ondulé sur mesure - Boîtes d'emballage imprimées sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"}],"categories":["Boîtes","Boîtes cadeaux","Boîtes en carton","Boîtes oreiller","Boîtes pliantes","Boîtes à bijoux","Cartons d'expédition","Classeurs à anneaux","Emballage alimentaire","Emballage d'expédition (Autre)","Emballage manchon","Emballage pour bouteilles","Emballage spécial","Papier cadeau","Produits d'emballage (Autre)"],"company_id":"22159521","description":"Alya Packaging, située à Istanbul, met plus de 30 ans d'expertise au service de solutions d'emballage imprimées sur mesure. Nos capacités de conception et de production internes façonnent la marque Alya pour le marché mondial de l'exportation et dépassent constamment les attentes des clients avec des solutions rentables. Notre installation de pointe, située entre l'Europe et l'Asie, nous permet de servir le marché international. Chez Alya Packaging, notre objectif principal est de produire de manière écologique avec des matériaux recyclables et certifiés FSC. La satisfaction client est notre priorité absolue chez Alya Packaging. En tant que fournisseur de premier plan pour des revendeurs et agents à travers le monde, nous sommes spécialisés dans les emballages personnalisés en marque blanche. Notre large gamme de produits, comprenant des sacs en papier personnalisés de luxe faits main, des boîtes rigides, des sacs en papier à poignées torsadées, des boîtes magnétiques, des coffrets cadeaux de présentation, des boîtes aux lettres, des boîtes à chocolat, des serviettes en papier imprimées, des sacs en tissu réutilisables, des sacs en coton et d'autres produits sur mesure, est soigneusement préparée sur commande. Nous sommes engagés à respecter les normes d'exportation de la plus haute qualité, servant diverses industries. Pourquoi choisir Alya Packaging ? : • Tarification transparente et compétitive • Options de vente en gros pour revendeurs, agents et particuliers • Garantie de confidentialité sur chaque commande • Délais de réponse rapides et livraison centrée sur l'Europe • Exportation mondiale vers plus de 40 pays Élevez votre expérience d'emballage avec nos solutions globales uniques. Contactez-nous dès maintenant !","delivery_area":"Mondiale","supplier_types":["Fabricant/Producteur"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Europages Company","description":"Europages company profile with address, supplier type and the products listed on the page (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-europages-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Profile URL copied from a search card, or a slug.\n\n**Examples:**\n\n```\nhttps://www.europages.fr/fr/company/synyco-sas-22106635\n```\n\n```\nsynyco-sas-22106635\n```\n\n```\nhttps://www.europages.de/de/firma/lab-fill-22400551\n```\n\n```\nhttps://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html\n```\n\nA `/products/` URL returns 400. With a slug, `domain` builds `/{language}/company/{slug}` (`fr` by default). A German card must be passed as its full `/de/firma/…` URL.","schema":{"type":"string","description":"Profile URL copied from a search card, or a slug.\n\n**Examples:**\n\n```\nhttps://www.europages.fr/fr/company/synyco-sas-22106635\n```\n\n```\nsynyco-sas-22106635\n```\n\n```\nhttps://www.europages.de/de/firma/lab-fill-22400551\n```\n\n```\nhttps://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html\n```\n\nA `/products/` URL returns 400. With a slug, `domain` builds `/{language}/company/{slug}` (`fr` by default). A German card must be passed as its full `/de/firma/…` URL."}},{"name":"domain","in":"query","required":false,"description":"Site when query is a slug. Same values as search. Default fr. Ignored when query is a URL.","schema":{"type":"string","default":"fr","description":"Site when query is a slug. Same values as search. Default fr. Ignored when query is a URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"formatted":{"type":"string"},"postal_code":{"type":"string"}}},"country":{"type":"string"},"website":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"price_display":{"type":"string"},"minimum_order_quantity":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"string"}},"company_id":{"type":"string"},"description":{"type":"string"},"delivery_area":{"type":"string"},"supplier_types":{"type":"array","items":{"type":"string"}}}},"examples":{"SYNYCO SAS":{"value":{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635","name":"SYNYCO SAS","address":{"city":"Hautmont","street":"64 Avenue General Leclerc","formatted":"64 Avenue General Leclerc, Hautmont 59330","postal_code":"59330"},"country":"France","website":"http://www.synyco.com","products":[{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635/products/mix-electromenager-appareils-electromenagers-mixtes-35944406","name":"Mix électroménager / appareils électroménagers mixtes","price":500,"currency":"EUR","price_display":"500,00 €","minimum_order_quantity":"2 palettes"},{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635/products/tissu-destockage-pour-meuble-et-rideaux-stocklot-fabrics-for-furniture-made-in-eu-35881295","name":"Tissu destockage pour meuble et rideaux / stocklot fabrics for furniture made in EU","price":1.5,"currency":"EUR","price_display":"1,50 €","minimum_order_quantity":"6000 m"},{"url":"https://www.europages.fr/fr/company/synyco-sas-22106635/products/lot-hygiene-stocklot-of-personal-care-35951778","name":"Lot hygiene / stocklot of personal care","price":0.7,"currency":"EUR","price_display":"0,70 €","minimum_order_quantity":"5000 pièces"}],"categories":["Appareils ménagers (Autre)","Produits cosmétiques (Autre)","Tissus (Autre)"],"company_id":"22106635","description":"Synyco Sas, une entreprise spécialisée dans les surplus et les produits finis pour le marché local, toute l'Europe, l'Afrique, l'Amérique du Sud et le Moyen-Orient. Nous achetons et vendons des produits de fin de série, des invendus, des produits d'hygiène, des articles pour bébé, des articles de bricolage, des textiles de maison, des appareils électroménagers et des meubles. En tant que spécialistes du dédouanement à l'export, Synyco est à votre disposition pour l'achat et le dédouanement de vos produits de fin de série et invendus dans les domaines des textiles, des articles pour bébé, des textiles de maison, des meubles, des tissus, des produits d'hygiène et de nettoyage, des appareils électroménagers, des articles de bricolage, des fixations, de la quincaillerie et des produits divers.","delivery_area":"Mondiale","supplier_types":["Prestataire de services","Grossiste"]}},"ALYA PACKAGING":{"value":{"url":"https://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html","name":"ALYA PACKAGING","address":{"city":"Istanbul","street":"Vizyon Park 5.plaza no:508 29ekim cd.","formatted":"Vizyon Park 5.plaza no:508 29ekim cd., Istanbul 34197","postal_code":"34197"},"country":"Turquie","website":"https://alyapackaging.com","products":[{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-apparel-shirt-boxes-custom-printed-packaging-boxes-35372297","name":"Vêtements Imprimés – Boîtes à Chemises - Boîtes d'Emballage Imprimées sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/luxury-paper-bags-with-high-gsm-and-custom-printing-36448909","name":"Sacs en papier de luxe avec un GSM élevé et impression personnalisée","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-pastry-cake-boxes-custom-printed-packaging-boxes-35494295","name":"Pâtisserie Imprimée – Boîtes à Gâteaux - Boîtes d'Emballage Personnalisées","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-laminated-paper-bags-custom-printed-luxury-paper-bags-35498387","name":"Sacs en Papier Laminé Imprimés - Sacs en Papier de Luxe Imprimés sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/laminated-non-woven-pp-bags-custom-printed-resusable-eco-bags-35275581","name":"Sacs en PP non tissés laminés - Sacs écologiques réutilisables imprimés sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/logo-printed-ribbon-gift-wrapping-35358558","name":"Ruban Imprimé avec Logo - Emballage Cadeau","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"3000 m"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/custom-rigid-shoe-boxes-presentation-gift-35384857","name":"Boîtes à chaussures rigides personnalisées - Cadeau de présentation","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"500 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-gift-card-boxes-rigid-presentation-35401467","name":"Boîtes de Cartes Cadeaux Imprimées - Présentation Rigide","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/luxury-kraft-paper-bags-custom-printed-luxury-paper-bags-35562115","name":"Sacs en papier kraft de luxe - Sacs en papier de luxe imprimés sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/self-seal-mailing-boxes-with-custom-printing-and-lightweight-protection-35796583","name":"Boîtes d'expédition auto-adhésives avec impression personnalisée et protection légère","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/custom-printed-folding-boxes-custom-printed-packaging-boxes-35435304","name":"Boîtes pliantes imprimées sur mesure - Boîtes d'emballage imprimées sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-gable-boxes-paper-lunch-boxes-custom-printed-packaging-boxes-35395877","name":"Boîtes à Pente Imprimées – Boîtes à Lunch en Papier - Boîtes d'Emballage Imprimées sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":null},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/laminated-luxury-postal-boxes-custom-printed-postal-and-e-commerce-boxes-35460553","name":"Boîtes Postales de Luxe Laminées - Boîtes Postales et E-Commerce Imprimées sur Mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"100 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/rigid-presentation-gift-boxes-custom-printed-designs-35300021","name":"Boîtes Cadeaux de Présentation Rigides - Designs Imprimés Personnalisés","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"250 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/printed-fast-food-packaging-boxes-custom-printed-packaging-boxes-35789029","name":"Boîtes d'emballage de restauration rapide imprimées - Boîtes d'emballage personnalisées imprimées","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"},{"url":"https://www.europages.fr/fr/company/alya-packaging-22159521/products/custom-corrugated-cardboard-boxes-custom-printed-packaging-boxes-35489916","name":"Boîtes en carton ondulé sur mesure - Boîtes d'emballage imprimées sur mesure","price":null,"currency":null,"price_display":null,"minimum_order_quantity":"1000 pièces"}],"categories":["Boîtes","Boîtes cadeaux","Boîtes en carton","Boîtes oreiller","Boîtes pliantes","Boîtes à bijoux","Cartons d'expédition","Classeurs à anneaux","Emballage alimentaire","Emballage d'expédition (Autre)","Emballage manchon","Emballage pour bouteilles","Emballage spécial","Papier cadeau","Produits d'emballage (Autre)"],"company_id":"22159521","description":"Alya Packaging, située à Istanbul, met plus de 30 ans d'expertise au service de solutions d'emballage imprimées sur mesure. Nos capacités de conception et de production internes façonnent la marque Alya pour le marché mondial de l'exportation et dépassent constamment les attentes des clients avec des solutions rentables. Notre installation de pointe, située entre l'Europe et l'Asie, nous permet de servir le marché international. Chez Alya Packaging, notre objectif principal est de produire de manière écologique avec des matériaux recyclables et certifiés FSC. La satisfaction client est notre priorité absolue chez Alya Packaging. En tant que fournisseur de premier plan pour des revendeurs et agents à travers le monde, nous sommes spécialisés dans les emballages personnalisés en marque blanche. Notre large gamme de produits, comprenant des sacs en papier personnalisés de luxe faits main, des boîtes rigides, des sacs en papier à poignées torsadées, des boîtes magnétiques, des coffrets cadeaux de présentation, des boîtes aux lettres, des boîtes à chocolat, des serviettes en papier imprimées, des sacs en tissu réutilisables, des sacs en coton et d'autres produits sur mesure, est soigneusement préparée sur commande. Nous sommes engagés à respecter les normes d'exportation de la plus haute qualité, servant diverses industries. Pourquoi choisir Alya Packaging ? : • Tarification transparente et compétitive • Options de vente en gros pour revendeurs, agents et particuliers • Garantie de confidentialité sur chaque commande • Délais de réponse rapides et livraison centrée sur l'Europe • Exportation mondiale vers plus de 40 pays Élevez votre expérience d'emballage avec nos solutions globales uniques. Contactez-nous dès maintenant !","delivery_area":"Mondiale","supplier_types":["Fabricant/Producteur"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/europages/search":{"get":{"summary":"Europages Search","description":"Search Europages suppliers by keyword or category URL. Returns company cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-europages-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a category / search URL on Europages.\n\n**Examples:**\n\n```\nemballage\n```\n\n```\nhttps://www.europages.fr/entreprises/emballage.html\n```\n\n```\nhttps://www.europages.de/de/suche/verpackung\n```\n\nA company profile or a `/products/` URL returns 400. `domain` applies only to a keyword (`fr` by default, `de` uses `/de/suche/`).","schema":{"type":"string","description":"Keyword, or a category / search URL on Europages.\n\n**Examples:**\n\n```\nemballage\n```\n\n```\nhttps://www.europages.fr/entreprises/emballage.html\n```\n\n```\nhttps://www.europages.de/de/suche/verpackung\n```\n\nA company profile or a `/products/` URL returns 400. `domain` applies only to a keyword (`fr` by default, `de` uses `/de/suche/`)."}},{"name":"domain","in":"query","required":false,"description":"Site of a keyword: fr (default), de, co.uk (en, uk, gb), es, it, nl, and the other Europages TLDs. Ignored when query is a URL. German uses /suche/.","schema":{"type":"string","default":"fr","description":"Site of a keyword: fr (default), de, co.uk (en, uk, gb), es, it, nl, and the other Europages TLDs. Ignored when query is a URL. German uses /suche/."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Page 2 and after use /pg-N/. 30 companies per page.","schema":{"type":"number","description":"Page from 1. Page 2 and after use /pg-N/. 30 companies per page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"country":{"type":"string"},"position":{"type":"integer"},"employees":{"type":"string"},"company_id":{"type":"string"},"description":{"type":"string"},"delivery_area":{"type":"string"},"founding_year":{"nullable":true},"supplier_types":{"type":"array","items":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Emballage":{"value":{"results":[{"url":"https://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html","city":"Istanbul","name":"ALYA PACKAGING","country":"Turquie","position":1,"employees":"50-99","company_id":"5424124","description":"Alya Packaging, située à Istanbul, met plus de 30 ans d'expertise au service de solutions d' emballage imprimées sur mesure. Nos capacités de conception et de production internes façonnent la...","delivery_area":"Mondiale","founding_year":null,"supplier_types":["Fabricant/Producteur"]}],"pagination":{"next":"https://www.europages.fr/entreprises/pg-2/emballage.html","page":1,"per_page":30,"total_pages":2327,"total_results":69799}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Europages Search","description":"Search Europages suppliers by keyword or category URL. Returns company cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-europages-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, or a category / search URL on Europages.\n\n**Examples:**\n\n```\nemballage\n```\n\n```\nhttps://www.europages.fr/entreprises/emballage.html\n```\n\n```\nhttps://www.europages.de/de/suche/verpackung\n```\n\nA company profile or a `/products/` URL returns 400. `domain` applies only to a keyword (`fr` by default, `de` uses `/de/suche/`).","schema":{"type":"string","description":"Keyword, or a category / search URL on Europages.\n\n**Examples:**\n\n```\nemballage\n```\n\n```\nhttps://www.europages.fr/entreprises/emballage.html\n```\n\n```\nhttps://www.europages.de/de/suche/verpackung\n```\n\nA company profile or a `/products/` URL returns 400. `domain` applies only to a keyword (`fr` by default, `de` uses `/de/suche/`)."}},{"name":"domain","in":"query","required":false,"description":"Site of a keyword: fr (default), de, co.uk (en, uk, gb), es, it, nl, and the other Europages TLDs. Ignored when query is a URL. German uses /suche/.","schema":{"type":"string","default":"fr","description":"Site of a keyword: fr (default), de, co.uk (en, uk, gb), es, it, nl, and the other Europages TLDs. Ignored when query is a URL. German uses /suche/."}},{"name":"page","in":"query","required":false,"description":"Page from 1. Page 2 and after use /pg-N/. 30 companies per page.","schema":{"type":"number","description":"Page from 1. Page 2 and after use /pg-N/. 30 companies per page."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"country":{"type":"string"},"position":{"type":"integer"},"employees":{"type":"string"},"company_id":{"type":"string"},"description":{"type":"string"},"delivery_area":{"type":"string"},"founding_year":{"nullable":true},"supplier_types":{"type":"array","items":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Emballage":{"value":{"results":[{"url":"https://www.europages.fr/ALYA-PACKAGING/00000005424124-761159001.html","city":"Istanbul","name":"ALYA PACKAGING","country":"Turquie","position":1,"employees":"50-99","company_id":"5424124","description":"Alya Packaging, située à Istanbul, met plus de 30 ans d'expertise au service de solutions d' emballage imprimées sur mesure. Nos capacités de conception et de production internes façonnent la...","delivery_area":"Mondiale","founding_year":null,"supplier_types":["Fabricant/Producteur"]}],"pagination":{"next":"https://www.europages.fr/entreprises/pg-2/emballage.html","page":1,"per_page":30,"total_pages":2327,"total_results":69799}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/welcometothejungle/search":{"get":{"summary":"Welcome to the Jungle Search","description":"Search Welcome to the Jungle jobs. Returns offer cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-welcometothejungle-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Job keyword or a Welcome to the Jungle jobs-search URL.\n\n**Example (keyword):**\n\n    python\n\n**Example (jobs URL):**\n\n    https://www.welcometothejungle.com/fr/jobs?query=python\n\n**Notes:**\n- `language` defaults to `fr`. `en`, `en-GB` and `en-US` use the English index.\n- A company profile URL (`/companies/{slug}` without a jobs search) returns 400.\n- Another host returns 400.","schema":{"type":"string","description":"Job keyword or a Welcome to the Jungle jobs-search URL.\n\n**Example (keyword):**\n\n    python\n\n**Example (jobs URL):**\n\n    https://www.welcometothejungle.com/fr/jobs?query=python\n\n**Notes:**\n- `language` defaults to `fr`. `en`, `en-GB` and `en-US` use the English index.\n- A company profile URL (`/companies/{slug}` without a jobs search) returns 400.\n- Another host returns 400."}},{"name":"language","in":"query","required":false,"description":"fr (default) or en. en-gb and en-us count as en. A /fr/ or /en/ path in the URL overrides this.","schema":{"type":"string","default":"fr","description":"fr (default) or en. en-gb and en-us count as en. A /fr/ or /en/ path in the URL overrides this."}},{"name":"page","in":"query","required":false,"description":"Page from 1, 30 offers. A page value already in the URL overrides this.","schema":{"type":"number","description":"Page from 1, 30 offers. A page value already in the URL overrides this."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"remote":{"type":"string"},"company":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"logo_url":{"type":"string"},"reference":{"type":"string"}}},"country":{"type":"string"},"sectors":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"},"reference":{"type":"string"},"profession":{"type":"string"},"salary_max":{"type":"integer"},"salary_min":{"type":"integer"},"published_at":{"type":"string"},"contract_type":{"type":"string"},"salary_period":{"type":"string"},"salary_currency":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Python jobs in France":{"value":{"results":[{"url":"https://www.welcometothejungle.com/fr/companies/warren-walter/jobs/developpeur-senior-python-node-js-ia-llm-rag-machine-learning-freelance-h-f_paris","city":"Paris","slug":"developpeur-senior-python-node-js-ia-llm-rag-machine-learning-freelance-h-f_paris","title":"Développeur Senior Python / Node.js – IA, LLM, RAG & Machine Learning Freelance (H/F)","remote":"partial","company":{"name":"Warren Walter","slug":"warren-walter","logo_url":"https://cdn-images.welcometothejungle.com/fvPxjAqiAdHkDVgw0Wv2mGh7J1agohB0wDryhKh1vog/rs:auto:400/q:85/czM6Ly93dHRqLXByb2R1Y3Rpb24vdXBsb2Fkcy9vcmdhbml6YXRpb24vbG9nby81NzY3LzE2NDg4MS9kZjlmMzY5MS0xNTZmLTQwYTItOWRjMC0xOGQ5NGM1YjUwMTIucG5n","reference":"9onX3U"},"country":"FR","sectors":["Application mobile","Logiciels","Digital Marketing / Data Marketing","IT / Digital"],"position":1,"reference":"51c6ad1d-9fe0-431e-9c42-566fef3a08f2","profession":"Développeur de logiciels","salary_max":550,"salary_min":450,"published_at":"2026-10-26T09:49:08Z","contract_type":"freelance","salary_period":"daily","salary_currency":"EUR"}],"pagination":{"next":"https://www.welcometothejungle.com/fr/jobs?query=python&page=2","page":1,"per_page":30,"total_pages":34,"total_results":6712}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Welcome to the Jungle Search","description":"Search Welcome to the Jungle jobs. Returns offer cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-welcometothejungle-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Job keyword or a Welcome to the Jungle jobs-search URL.\n\n**Example (keyword):**\n\n    python\n\n**Example (jobs URL):**\n\n    https://www.welcometothejungle.com/fr/jobs?query=python\n\n**Notes:**\n- `language` defaults to `fr`. `en`, `en-GB` and `en-US` use the English index.\n- A company profile URL (`/companies/{slug}` without a jobs search) returns 400.\n- Another host returns 400.","schema":{"type":"string","description":"Job keyword or a Welcome to the Jungle jobs-search URL.\n\n**Example (keyword):**\n\n    python\n\n**Example (jobs URL):**\n\n    https://www.welcometothejungle.com/fr/jobs?query=python\n\n**Notes:**\n- `language` defaults to `fr`. `en`, `en-GB` and `en-US` use the English index.\n- A company profile URL (`/companies/{slug}` without a jobs search) returns 400.\n- Another host returns 400."}},{"name":"language","in":"query","required":false,"description":"fr (default) or en. en-gb and en-us count as en. A /fr/ or /en/ path in the URL overrides this.","schema":{"type":"string","default":"fr","description":"fr (default) or en. en-gb and en-us count as en. A /fr/ or /en/ path in the URL overrides this."}},{"name":"page","in":"query","required":false,"description":"Page from 1, 30 offers. A page value already in the URL overrides this.","schema":{"type":"number","description":"Page from 1, 30 offers. A page value already in the URL overrides this."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"city":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"remote":{"type":"string"},"company":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"logo_url":{"type":"string"},"reference":{"type":"string"}}},"country":{"type":"string"},"sectors":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"},"reference":{"type":"string"},"profession":{"type":"string"},"salary_max":{"type":"integer"},"salary_min":{"type":"integer"},"published_at":{"type":"string"},"contract_type":{"type":"string"},"salary_period":{"type":"string"},"salary_currency":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Python jobs in France":{"value":{"results":[{"url":"https://www.welcometothejungle.com/fr/companies/warren-walter/jobs/developpeur-senior-python-node-js-ia-llm-rag-machine-learning-freelance-h-f_paris","city":"Paris","slug":"developpeur-senior-python-node-js-ia-llm-rag-machine-learning-freelance-h-f_paris","title":"Développeur Senior Python / Node.js – IA, LLM, RAG & Machine Learning Freelance (H/F)","remote":"partial","company":{"name":"Warren Walter","slug":"warren-walter","logo_url":"https://cdn-images.welcometothejungle.com/fvPxjAqiAdHkDVgw0Wv2mGh7J1agohB0wDryhKh1vog/rs:auto:400/q:85/czM6Ly93dHRqLXByb2R1Y3Rpb24vdXBsb2Fkcy9vcmdhbml6YXRpb24vbG9nby81NzY3LzE2NDg4MS9kZjlmMzY5MS0xNTZmLTQwYTItOWRjMC0xOGQ5NGM1YjUwMTIucG5n","reference":"9onX3U"},"country":"FR","sectors":["Application mobile","Logiciels","Digital Marketing / Data Marketing","IT / Digital"],"position":1,"reference":"51c6ad1d-9fe0-431e-9c42-566fef3a08f2","profession":"Développeur de logiciels","salary_max":550,"salary_min":450,"published_at":"2026-10-26T09:49:08Z","contract_type":"freelance","salary_period":"daily","salary_currency":"EUR"}],"pagination":{"next":"https://www.welcometothejungle.com/fr/jobs?query=python&page=2","page":1,"per_page":30,"total_pages":34,"total_results":6712}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/welcometothejungle/company":{"get":{"summary":"Welcome to the Jungle Company","description":"Welcome to the Jungle company profile: headcount, offices, sectors and website (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-welcometothejungle-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Slug, company name, or a Welcome to the Jungle company URL.\n\n**Example (slug):**\n\n    alan\n\n**Example (company URL):**\n\n    https://www.welcometothejungle.com/fr/companies/alan\n\n**Notes:**\n- Case is ignored: `Alan` and `alan` open the same profile.\n- A name such as `Doctolib` or `Société Générale` is resolved from the directory.\n- A job URL under `/companies/{slug}/jobs/...` uses the company slug.\n- Another host returns 400.","schema":{"type":"string","description":"Slug, company name, or a Welcome to the Jungle company URL.\n\n**Example (slug):**\n\n    alan\n\n**Example (company URL):**\n\n    https://www.welcometothejungle.com/fr/companies/alan\n\n**Notes:**\n- Case is ignored: `Alan` and `alan` open the same profile.\n- A name such as `Doctolib` or `Société Générale` is resolved from the directory.\n- A job URL under `/companies/{slug}/jobs/...` uses the company slug.\n- Another host returns 400."}},{"name":"language","in":"query","required":false,"description":"fr (default) or en. en-gb and en-us count as en. Chooses the language of the profile text and URL.","schema":{"type":"string","default":"fr","description":"fr (default) or en. en-gb and en-us count as en. Chooses the language of the profile text and URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"kind":{"type":"string"}}}},"labels":{"type":"array","items":{}},"offices":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"zip_code":{"type":"string"},"longitude":{"type":"number"},"is_headquarter":{"type":"boolean"}}}},"sectors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"parent":{"type":"string"}}}},"website":{"type":"string"},"logo_url":{"type":"string"},"cover_url":{"type":"string"},"employees":{"type":"integer"},"reference":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"equality_index":{"type":"integer"},"equality_index_year":{"type":"integer"}}},"examples":{"Alan":{"value":{"url":"https://www.welcometothejungle.com/fr/companies/alan","name":"Alan","slug":"alan","links":[{"url":"https://www.welcometothejungle.com/en/companies/alan","kind":"canonical"},{"url":"https://www.welcometothejungle.com/en/companies/alan","kind":"alternate"},{"url":"https://www.welcometothejungle.com/en/companies/alan","kind":"alternate"}],"labels":[],"offices":[{"city":"Paris","address":"117 Quai de Valmy","country":"FR","latitude":48.87544,"zip_code":"75010","longitude":2.36335,"is_headquarter":true}],"sectors":[{"name":"FinTech / InsurTech","parent":"Banking / Insurance / Finance"}],"website":"https://alan.com/","logo_url":"https://cdn-images.welcometothejungle.com/9328mOxCAEq-4wFUg5LlLDkXZLLxIu1AZ-m93WhZqUM/rs:auto:400/q:85/czM6Ly93dHRqLXByb2R1Y3Rpb24vdXBsb2Fkcy9vcmdhbml6YXRpb24vbG9nby8wOTY3LzE2MjQ5Ny80NWRmNjVhMC0yNDAxLTRlNWMtODJkZi0xNDQ5ODc2ZWNlODcucG5n","cover_url":"https://cdn-images.welcometothejungle.com/LsvS1ejrz95JwWILFuMmUc65SMuLrvkbdSw-kAU6kRk/rs:auto:2000:450/g:fp:0:0.5/q:85/czM6Ly93dHRqLXByb2R1Y3Rpb24vdXBsb2Fkcy93ZWJzaXRlX29yZ2FuaXphdGlvbi9jb3Zlcl9pbWFnZS93dHRqX2ZyL2VuLTkzMjZjNDY3LWMzYmItNDk4Ny1hZGE1LTBhYTcxZjBiYjk4Ny5qcGc","employees":400,"reference":"0dgXRez","updated_at":"2026-10-27T15:35:19.451306Z","description":"**🐼Who we are** **Alan is the healthcare super-app offering personalised healthcare & wellbeing to our members.** Founded in 2016 by Jean-Charles Samuelian and Charles Gorintin, Alan is the first independent digital health insurance in France since 1986. By providing our members…","equality_index":92,"equality_index_year":2025}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Welcome to the Jungle Company","description":"Welcome to the Jungle company profile: headcount, offices, sectors and website (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-welcometothejungle-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Slug, company name, or a Welcome to the Jungle company URL.\n\n**Example (slug):**\n\n    alan\n\n**Example (company URL):**\n\n    https://www.welcometothejungle.com/fr/companies/alan\n\n**Notes:**\n- Case is ignored: `Alan` and `alan` open the same profile.\n- A name such as `Doctolib` or `Société Générale` is resolved from the directory.\n- A job URL under `/companies/{slug}/jobs/...` uses the company slug.\n- Another host returns 400.","schema":{"type":"string","description":"Slug, company name, or a Welcome to the Jungle company URL.\n\n**Example (slug):**\n\n    alan\n\n**Example (company URL):**\n\n    https://www.welcometothejungle.com/fr/companies/alan\n\n**Notes:**\n- Case is ignored: `Alan` and `alan` open the same profile.\n- A name such as `Doctolib` or `Société Générale` is resolved from the directory.\n- A job URL under `/companies/{slug}/jobs/...` uses the company slug.\n- Another host returns 400."}},{"name":"language","in":"query","required":false,"description":"fr (default) or en. en-gb and en-us count as en. Chooses the language of the profile text and URL.","schema":{"type":"string","default":"fr","description":"fr (default) or en. en-gb and en-us count as en. Chooses the language of the profile text and URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"kind":{"type":"string"}}}},"labels":{"type":"array","items":{}},"offices":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"zip_code":{"type":"string"},"longitude":{"type":"number"},"is_headquarter":{"type":"boolean"}}}},"sectors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"parent":{"type":"string"}}}},"website":{"type":"string"},"logo_url":{"type":"string"},"cover_url":{"type":"string"},"employees":{"type":"integer"},"reference":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"equality_index":{"type":"integer"},"equality_index_year":{"type":"integer"}}},"examples":{"Alan":{"value":{"url":"https://www.welcometothejungle.com/fr/companies/alan","name":"Alan","slug":"alan","links":[{"url":"https://www.welcometothejungle.com/en/companies/alan","kind":"canonical"},{"url":"https://www.welcometothejungle.com/en/companies/alan","kind":"alternate"},{"url":"https://www.welcometothejungle.com/en/companies/alan","kind":"alternate"}],"labels":[],"offices":[{"city":"Paris","address":"117 Quai de Valmy","country":"FR","latitude":48.87544,"zip_code":"75010","longitude":2.36335,"is_headquarter":true}],"sectors":[{"name":"FinTech / InsurTech","parent":"Banking / Insurance / Finance"}],"website":"https://alan.com/","logo_url":"https://cdn-images.welcometothejungle.com/9328mOxCAEq-4wFUg5LlLDkXZLLxIu1AZ-m93WhZqUM/rs:auto:400/q:85/czM6Ly93dHRqLXByb2R1Y3Rpb24vdXBsb2Fkcy9vcmdhbml6YXRpb24vbG9nby8wOTY3LzE2MjQ5Ny80NWRmNjVhMC0yNDAxLTRlNWMtODJkZi0xNDQ5ODc2ZWNlODcucG5n","cover_url":"https://cdn-images.welcometothejungle.com/LsvS1ejrz95JwWILFuMmUc65SMuLrvkbdSw-kAU6kRk/rs:auto:2000:450/g:fp:0:0.5/q:85/czM6Ly93dHRqLXByb2R1Y3Rpb24vdXBsb2Fkcy93ZWJzaXRlX29yZ2FuaXphdGlvbi9jb3Zlcl9pbWFnZS93dHRqX2ZyL2VuLTkzMjZjNDY3LWMzYmItNDk4Ny1hZGE1LTBhYTcxZjBiYjk4Ny5qcGc","employees":400,"reference":"0dgXRez","updated_at":"2026-10-27T15:35:19.451306Z","description":"**🐼Who we are** **Alan is the healthcare super-app offering personalised healthcare & wellbeing to our members.** Founded in 2016 by Jean-Charles Samuelian and Charles Gorintin, Alan is the first independent digital health insurance in France since 1986. By providing our members…","equality_index":92,"equality_index_year":2025}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ted/search":{"get":{"summary":"TED Search","description":"Search TED procurement notices by keyword or filters. Returns notice cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-ted-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Keyword, publication number, or a TED search URL.\n\n**Example (keyword):**\n\n    software\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (search URL):**\n\n    https://ted.europa.eu/en/search/result?query=software\n\n**Notes:**\n- A notice URL (`/notice/`) returns 400. Use the notice endpoint.\n- Filters (`country=FR`, `cpv`, `buyer`, …) can be set with or without `query`.\n- `page` starts at 1. Pass the next page yourself.","schema":{"type":"string","description":"Keyword, publication number, or a TED search URL.\n\n**Example (keyword):**\n\n    software\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (search URL):**\n\n    https://ted.europa.eu/en/search/result?query=software\n\n**Notes:**\n- A notice URL (`/notice/`) returns 400. Use the notice endpoint.\n- Filters (`country=FR`, `cpv`, `buyer`, …) can be set with or without `query`.\n- `page` starts at 1. Pass the next page yourself."}},{"name":"notice_type","in":"query","required":false,"description":"Notice code such as cn-standard or can-standard. Combined with AND.","schema":{"type":"string","description":"Notice code such as cn-standard or can-standard. Combined with AND."}},{"name":"country","in":"query","required":false,"description":"Buyer country, ISO alpha-2 or alpha-3. FR becomes FRA. A country name returns 400.","schema":{"type":"string","description":"Buyer country, ISO alpha-2 or alpha-3. FR becomes FRA. A country name returns 400."}},{"name":"place","in":"query","required":false,"description":"Place of performance: country code or NUTS code such as FRK24.","schema":{"type":"string","description":"Place of performance: country code or NUTS code such as FRK24."}},{"name":"cpv","in":"query","required":false,"description":"CPV code or prefix. Digits and an optional star, for example 72000000 or 30*.","schema":{"type":"string","description":"CPV code or prefix. Digits and an optional star, for example 72000000 or 30*."}},{"name":"buyer","in":"query","required":false,"description":"Buyer name, matched as a phrase.","schema":{"type":"string","description":"Buyer name, matched as a phrase."}},{"name":"page","in":"query","required":false,"description":"Page from 1. next is always null: pass page + 1. A page past the last one returns 404.","schema":{"type":"number","description":"Page from 1. next is always null: pass page + 1. A page past the last one returns 404."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"cpv":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"place":{"type":"string"},"title":{"type":"string"},"currency":{"nullable":true},"deadline":{"type":"string"},"buyer_name":{"type":"string"},"notice_type":{"type":"string"},"buyer_country":{"type":"string"},"value_display":{"nullable":true},"estimated_value":{"nullable":true},"publication_date":{"type":"string"},"publication_number":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Notice 30-2026":{"value":{"results":[{"cpv":["50312610","35125100"],"url":"https://ted.europa.eu/en/notice/-/detail/30-2026","place":"FRK24","title":"France – Maintenance of information technology equipment – OBSERVATOIRE DES MOBILITES. FOURNITURE, INSTALLATION D'INFRASTRUCTURES DE MATERIELS DE COMPTAGES DES MODES ACTIFS ET MAINTENANCE","currency":null,"deadline":"2026-02-02","buyer_name":"SMMAG, Syndicat Mixte des Mobilités de l'Aire Grenobloise, Grenoble-Alpes Métropole","notice_type":"cn-standard","buyer_country":"FRA","value_display":null,"estimated_value":null,"publication_date":"2026-01-02","publication_number":"30-2026"}],"pagination":{"next":null,"page":1,"per_page":20,"total_pages":1,"total_results":1}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TED Search","description":"Search TED procurement notices by keyword or filters. Returns notice cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-ted-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Keyword, publication number, or a TED search URL.\n\n**Example (keyword):**\n\n    software\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (search URL):**\n\n    https://ted.europa.eu/en/search/result?query=software\n\n**Notes:**\n- A notice URL (`/notice/`) returns 400. Use the notice endpoint.\n- Filters (`country=FR`, `cpv`, `buyer`, …) can be set with or without `query`.\n- `page` starts at 1. Pass the next page yourself.","schema":{"type":"string","description":"Keyword, publication number, or a TED search URL.\n\n**Example (keyword):**\n\n    software\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (search URL):**\n\n    https://ted.europa.eu/en/search/result?query=software\n\n**Notes:**\n- A notice URL (`/notice/`) returns 400. Use the notice endpoint.\n- Filters (`country=FR`, `cpv`, `buyer`, …) can be set with or without `query`.\n- `page` starts at 1. Pass the next page yourself."}},{"name":"notice_type","in":"query","required":false,"description":"Notice code such as cn-standard or can-standard. Combined with AND.","schema":{"type":"string","description":"Notice code such as cn-standard or can-standard. Combined with AND."}},{"name":"country","in":"query","required":false,"description":"Buyer country, ISO alpha-2 or alpha-3. FR becomes FRA. A country name returns 400.","schema":{"type":"string","description":"Buyer country, ISO alpha-2 or alpha-3. FR becomes FRA. A country name returns 400."}},{"name":"place","in":"query","required":false,"description":"Place of performance: country code or NUTS code such as FRK24.","schema":{"type":"string","description":"Place of performance: country code or NUTS code such as FRK24."}},{"name":"cpv","in":"query","required":false,"description":"CPV code or prefix. Digits and an optional star, for example 72000000 or 30*.","schema":{"type":"string","description":"CPV code or prefix. Digits and an optional star, for example 72000000 or 30*."}},{"name":"buyer","in":"query","required":false,"description":"Buyer name, matched as a phrase.","schema":{"type":"string","description":"Buyer name, matched as a phrase."}},{"name":"page","in":"query","required":false,"description":"Page from 1. next is always null: pass page + 1. A page past the last one returns 404.","schema":{"type":"number","description":"Page from 1. next is always null: pass page + 1. A page past the last one returns 404."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"cpv":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"place":{"type":"string"},"title":{"type":"string"},"currency":{"nullable":true},"deadline":{"type":"string"},"buyer_name":{"type":"string"},"notice_type":{"type":"string"},"buyer_country":{"type":"string"},"value_display":{"nullable":true},"estimated_value":{"nullable":true},"publication_date":{"type":"string"},"publication_number":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Notice 30-2026":{"value":{"results":[{"cpv":["50312610","35125100"],"url":"https://ted.europa.eu/en/notice/-/detail/30-2026","place":"FRK24","title":"France – Maintenance of information technology equipment – OBSERVATOIRE DES MOBILITES. FOURNITURE, INSTALLATION D'INFRASTRUCTURES DE MATERIELS DE COMPTAGES DES MODES ACTIFS ET MAINTENANCE","currency":null,"deadline":"2026-02-02","buyer_name":"SMMAG, Syndicat Mixte des Mobilités de l'Aire Grenobloise, Grenoble-Alpes Métropole","notice_type":"cn-standard","buyer_country":"FRA","value_display":null,"estimated_value":null,"publication_date":"2026-01-02","publication_number":"30-2026"}],"pagination":{"next":null,"page":1,"per_page":20,"total_pages":1,"total_results":1}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ted/notice":{"get":{"summary":"TED Notice","description":"TED notice profile: buyer, lots, deadline, value and documents (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-ted-notice","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Publication number, or a TED notice URL.\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (notice URL):**\n\n    https://ted.europa.eu/en/notice/-/detail/30-2026\n\n**Notes:**\n- The number is 1 to 8 digits, a hyphen, then a 4-digit year.\n- A keyword or a search URL returns 400.","schema":{"type":"string","description":"Publication number, or a TED notice URL.\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (notice URL):**\n\n    https://ted.europa.eu/en/notice/-/detail/30-2026\n\n**Notes:**\n- The number is 1 to 8 digits, a hyphen, then a 4-digit year.\n- A keyword or a search URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cpv":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"lots":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"oj_s":{"type":"string"},"place":{"type":"string"},"title":{"type":"string"},"awards":{"type":"array","items":{}},"currency":{"nullable":true},"deadline":{"type":"string"},"documents":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"}},"procedure":{"type":"string"},"buyer_name":{"type":"string"},"description":{"type":"string"},"legal_basis":{"type":"string"},"notice_type":{"type":"string"},"buyer_country":{"type":"string"},"dispatch_date":{"type":"string"},"value_display":{"nullable":true},"estimated_value":{"nullable":true},"publication_date":{"type":"string"},"publication_number":{"type":"string"}}},"examples":{"Notice 30-2026":{"value":{"cpv":["50312610","35125100"],"url":"https://ted.europa.eu/en/notice/-/detail/30-2026","lots":[{"title":"Analyse, télétransmission des données, maintenance des matériels existants","description":"Analyse, télétransmission des données, maintenance des matériels existants"},{"title":"Maintenance, télétransmission, acquisition et installation de nouveaux matériels de comptages","description":"Maintenance, télétransmission, acquisition et installation de nouveaux matériels de comptages"}],"oj_s":"1/2026","place":"FRK24","title":"France – Maintenance of information technology equipment – OBSERVATOIRE DES MOBILITES. FOURNITURE, INSTALLATION D'INFRASTRUCTURES DE MATERIELS DE COMPTAGES DES MODES ACTIFS ET MAINTENANCE","awards":[],"currency":null,"deadline":"2026-02-02","documents":["https://www.marches-publics.info/mpiaws/index.cfm?fuseaction=dematEnt.login&type=DCE&IDM=1760411"],"languages":["bul","ces","dan","deu","ell","eng","est","fin","fra","gle","hrv","hun","ita","lav","lit","mlt","nld","pol","por","ron","slk","slv","spa","swe"],"procedure":"open","buyer_name":"SMMAG, Syndicat Mixte des Mobilités de l'Aire Grenobloise, Grenoble-Alpes Métropole","description":"Le syndicat Mixte des Mobilités de l'Aire Grenobloise souhaite lancer en groupement de commandes avec Grenoble-Alpes Métropole, une consultation relative à la Fourniture, l'installation d'infrastructures de matériels de comptages des modes actifs et maintenance. Le ou les futurs prestataires auront en charge de fournir des compteurs, réaliser l'installation, et entretenir les matériels de comptages (existants et futurs). Cette consultation se divise en deux lots : - Lot 1 : Analyse, télétransmission des données et maintenance des matériels existants - Lot 2 : Maintenance, télétransmission, acquisition et installation de nouveaux matériels de comptage L'accord-cadre sera exécuté par l'émission de bons de commande. Chaque lot fera l'objet d'une attribution séparée. Les prestations sont réglées par des prix unitaires. L'accord-cadre est conclu pour une période initiale de 2 ans, reconductible 1 fois 2 ans (4 ans au total). La date de démarrage des prestations est purement indicative","legal_basis":"32014L0024","notice_type":"cn-standard","buyer_country":"FRA","dispatch_date":"2025-12-31","value_display":null,"estimated_value":null,"publication_date":"2026-01-02","publication_number":"30-2026"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TED Notice","description":"TED notice profile: buyer, lots, deadline, value and documents (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-ted-notice","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Publication number, or a TED notice URL.\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (notice URL):**\n\n    https://ted.europa.eu/en/notice/-/detail/30-2026\n\n**Notes:**\n- The number is 1 to 8 digits, a hyphen, then a 4-digit year.\n- A keyword or a search URL returns 400.","schema":{"type":"string","description":"Publication number, or a TED notice URL.\n\n**Example (publication number):**\n\n    30-2026\n\n**Example (notice URL):**\n\n    https://ted.europa.eu/en/notice/-/detail/30-2026\n\n**Notes:**\n- The number is 1 to 8 digits, a hyphen, then a 4-digit year.\n- A keyword or a search URL returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cpv":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"lots":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"oj_s":{"type":"string"},"place":{"type":"string"},"title":{"type":"string"},"awards":{"type":"array","items":{}},"currency":{"nullable":true},"deadline":{"type":"string"},"documents":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"}},"procedure":{"type":"string"},"buyer_name":{"type":"string"},"description":{"type":"string"},"legal_basis":{"type":"string"},"notice_type":{"type":"string"},"buyer_country":{"type":"string"},"dispatch_date":{"type":"string"},"value_display":{"nullable":true},"estimated_value":{"nullable":true},"publication_date":{"type":"string"},"publication_number":{"type":"string"}}},"examples":{"Notice 30-2026":{"value":{"cpv":["50312610","35125100"],"url":"https://ted.europa.eu/en/notice/-/detail/30-2026","lots":[{"title":"Analyse, télétransmission des données, maintenance des matériels existants","description":"Analyse, télétransmission des données, maintenance des matériels existants"},{"title":"Maintenance, télétransmission, acquisition et installation de nouveaux matériels de comptages","description":"Maintenance, télétransmission, acquisition et installation de nouveaux matériels de comptages"}],"oj_s":"1/2026","place":"FRK24","title":"France – Maintenance of information technology equipment – OBSERVATOIRE DES MOBILITES. FOURNITURE, INSTALLATION D'INFRASTRUCTURES DE MATERIELS DE COMPTAGES DES MODES ACTIFS ET MAINTENANCE","awards":[],"currency":null,"deadline":"2026-02-02","documents":["https://www.marches-publics.info/mpiaws/index.cfm?fuseaction=dematEnt.login&type=DCE&IDM=1760411"],"languages":["bul","ces","dan","deu","ell","eng","est","fin","fra","gle","hrv","hun","ita","lav","lit","mlt","nld","pol","por","ron","slk","slv","spa","swe"],"procedure":"open","buyer_name":"SMMAG, Syndicat Mixte des Mobilités de l'Aire Grenobloise, Grenoble-Alpes Métropole","description":"Le syndicat Mixte des Mobilités de l'Aire Grenobloise souhaite lancer en groupement de commandes avec Grenoble-Alpes Métropole, une consultation relative à la Fourniture, l'installation d'infrastructures de matériels de comptages des modes actifs et maintenance. Le ou les futurs prestataires auront en charge de fournir des compteurs, réaliser l'installation, et entretenir les matériels de comptages (existants et futurs). Cette consultation se divise en deux lots : - Lot 1 : Analyse, télétransmission des données et maintenance des matériels existants - Lot 2 : Maintenance, télétransmission, acquisition et installation de nouveaux matériels de comptage L'accord-cadre sera exécuté par l'émission de bons de commande. Chaque lot fera l'objet d'une attribution séparée. Les prestations sont réglées par des prix unitaires. L'accord-cadre est conclu pour une période initiale de 2 ans, reconductible 1 fois 2 ans (4 ans au total). La date de démarrage des prestations est purement indicative","legal_basis":"32014L0024","notice_type":"cn-standard","buyer_country":"FRA","dispatch_date":"2025-12-31","value_display":null,"estimated_value":null,"publication_date":"2026-01-02","publication_number":"30-2026"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/northdata/company":{"get":{"summary":"North Data Company","description":"North Data company profile: register, address, financials and history (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-northdata-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company name, North Data id, or a profile URL.\n\n**Example (company name):**\n\n    Maison Boinaud\n\n**Example (profile URL):**\n\n    https://www.northdata.com/Rolls-Royce%20plc,%20London/Companies%20House%2001003142\n\n**Notes:**\n- A name opens the first company suggestion. Pass `countries=FR` to narrow it.\n- An id has 10 digits or more, for example `5854348650`.\n- A suggest URL returns 400.","schema":{"type":"string","description":"Company name, North Data id, or a profile URL.\n\n**Example (company name):**\n\n    Maison Boinaud\n\n**Example (profile URL):**\n\n    https://www.northdata.com/Rolls-Royce%20plc,%20London/Companies%20House%2001003142\n\n**Notes:**\n- A name opens the first company suggestion. Pass `countries=FR` to narrow it.\n- An id has 10 digits or more, for example `5854348650`.\n- A suggest URL returns 400."}},{"name":"countries","in":"query","required":false,"description":"ISO alpha-2, used only when query is a name. Same form as search: FR or FR,DE.","schema":{"type":"string","description":"ISO alpha-2, used only when query is a name. Same form as search: FR or FR,DE."}},{"name":"domain","in":"query","required":false,"description":"fr (default), com or en, de. Ignored when query is a URL.","schema":{"type":"string","default":"fr","description":"fr (default), com or en, de. Ignored when query is a URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"lei":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"eu_id":{"nullable":true},"events":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string"},"category":{"type":"integer"},"description":{"type":"string"}}}},"extras":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"status":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"state":{"nullable":true},"street":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"formatted":{"type":"string"},"longitude":{"type":"number"},"postal_code":{"type":"string"}}},"capital":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"unit":{"type":"string"},"value":{"type":"number"},"display":{"type":"string"}}},"filings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"source":{"nullable":true}}}},"persons":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string"},"category":{"type":"integer"},"description":{"type":"string"}}}},"subject":{"type":"string"},"elf_code":{"type":"string"},"register":{"type":"object","properties":{"id":{"type":"string"},"city":{"nullable":true},"country":{"type":"string"},"unique_key":{"type":"string"}}},"company_id":{"type":"string"},"financials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"unit":{"type":"string"},"value":{"type":"number"},"display":{"type":"string"}}}},"legal_form":{"type":"string"},"risk_level":{"type":"string"},"former_names":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"name":{"type":"string"},"legal_form":{"type":"string"}}}},"segment_codes":{"type":"object","properties":{"naf":{"type":"array","items":{}},"isic":{"type":"array","items":{"type":"string"}},"nace":{"type":"array","items":{"type":"string"}},"naics":{"type":"array","items":{"type":"string"}},"uksic":{"type":"array","items":{"type":"string"}},"naf_2025":{"type":"array","items":{}},"nace_2025":{"type":"array","items":{"type":"string"}}}},"other_registers":{"type":"array","items":{"type":"object","properties":{"city":{"nullable":true},"date":{"type":"string"},"country":{"type":"string"},"unique_key":{"type":"string"},"register_id":{"type":"string"}}}},"last_update_time":{"type":"string"},"original_subject":{"type":"string"},"original_subject_language":{"type":"string"}}},"examples":{"Rolls-Royce plc":{"value":{"lei":"X57JK1U580XATGR67572","url":"https://www.northdata.com/Rolls-Royce%20plc,%20London/Companies%20House%2001003142","name":"Rolls-Royce plc","eu_id":null,"events":[{"url":"https://www.northdata.com/?id=6137794862","date":"1971-02-23","category":1,"description":"Registration"},{"url":"https://www.northdata.com/?id=6228341741846528","date":"1995-01-01","category":1,"description":"Registration France"},{"url":"https://www.northdata.com/?id=6137794862","date":"1978-01-02","category":2,"description":"Legal form: Ltd. → plc"},{"url":"https://www.northdata.com/?id=6137794862","date":"1978-01-02","category":2,"description":"Name: Rolls-Royce plc"}],"extras":[{"id":"phone","name":"Phone","value":"+44 07770442315"},{"id":"url","name":"Website","value":"https://www.rolls-royce.com"},{"id":"email","name":"Email","value":"enquiries@rolls-royce.com"}],"status":"active","address":{"city":"London","state":null,"street":"90 York Way","country":"GB","latitude":51.5349626,"formatted":"90 York Way, Kings Place, London N1 9FX, United Kingdom","longitude":-0.1217676933974402,"postal_code":"N1 9FX"},"capital":{"id":"Capital","date":"2016-06-13","name":"Base/share capital","unit":"GBP","value":326199301.6,"display":"£326.2M"},"filings":[{"id":"Siret 42218357400017","name":"Siret 42218357400017","type":"Siret","source":null},{"id":"X57JK1U580XATGR67572","name":"X57JK1U580XATGR67572","type":"Lei","source":"Lei"}],"persons":[{"url":"https://www.northdata.com/?id=6513855692","date":"2026-03-24","category":9,"description":"Director Alex Martin"},{"url":"https://www.northdata.com/?id=6513855692","date":"2023-08-04","category":9,"description":"Director Jordan Lee"}],"subject":"Aircraft and spacecraft repair and maintenance","elf_code":"B6ES","register":{"id":"01003142","city":null,"country":"GB","unique_key":"GB_01003142"},"company_id":"5854348650","financials":[{"id":"Capital","date":"2025-12-31","name":"Base/share capital","unit":"GBP","value":326199301.6,"display":"£326.2M"},{"id":"BalanceTotal","date":"2025-12-31","name":"Total assets","unit":"GBP","value":40308,"display":"£40,308"},{"id":"Earnings","date":"2025-12-31","name":"Earnings","unit":"GBP","value":5836,"display":"£5,836.00"},{"id":"Revenue","date":"2025-12-31","name":"Revenue","unit":"GBP","value":21207,"display":"£21,207"},{"id":"ReturnOnSales","date":"2025-12-31","name":"Return on sales","unit":"%","value":27.51921535342104,"display":"27.5%"},{"id":"Equity","date":"2025-12-31","name":"Equity","unit":"GBP","value":4977,"display":"£4,977.00"}],"legal_form":"plc","risk_level":"GREEN","former_names":[{"date":"1977-12-31","name":"Rolls-Royce (1971) Ltd.","legal_form":"Ltd."}],"segment_codes":{"naf":[],"isic":["2513","2592","2811"],"nace":["25.30","25.62","28.11"],"naics":["332313","332410","339910","332710"],"uksic":["25.30","25.62","28.11"],"naf_2025":[],"nace_2025":["25.21","25.53","28.11"]},"other_registers":[{"city":null,"date":"2025-12-06","country":"FR","unique_key":"FR_422183574","register_id":"422183574"},{"city":null,"date":"2022-11-11","country":"NO","unique_key":"NO_974230151","register_id":"974230151"}],"last_update_time":"2026-10-27T17:03:32.364Z","original_subject":"Aircraft and spacecraft repair and maintenance","original_subject_language":"en"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"North Data Company","description":"North Data company profile: register, address, financials and history (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-northdata-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company name, North Data id, or a profile URL.\n\n**Example (company name):**\n\n    Maison Boinaud\n\n**Example (profile URL):**\n\n    https://www.northdata.com/Rolls-Royce%20plc,%20London/Companies%20House%2001003142\n\n**Notes:**\n- A name opens the first company suggestion. Pass `countries=FR` to narrow it.\n- An id has 10 digits or more, for example `5854348650`.\n- A suggest URL returns 400.","schema":{"type":"string","description":"Company name, North Data id, or a profile URL.\n\n**Example (company name):**\n\n    Maison Boinaud\n\n**Example (profile URL):**\n\n    https://www.northdata.com/Rolls-Royce%20plc,%20London/Companies%20House%2001003142\n\n**Notes:**\n- A name opens the first company suggestion. Pass `countries=FR` to narrow it.\n- An id has 10 digits or more, for example `5854348650`.\n- A suggest URL returns 400."}},{"name":"countries","in":"query","required":false,"description":"ISO alpha-2, used only when query is a name. Same form as search: FR or FR,DE.","schema":{"type":"string","description":"ISO alpha-2, used only when query is a name. Same form as search: FR or FR,DE."}},{"name":"domain","in":"query","required":false,"description":"fr (default), com or en, de. Ignored when query is a URL.","schema":{"type":"string","default":"fr","description":"fr (default), com or en, de. Ignored when query is a URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"lei":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"eu_id":{"nullable":true},"events":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string"},"category":{"type":"integer"},"description":{"type":"string"}}}},"extras":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"status":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"state":{"nullable":true},"street":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"formatted":{"type":"string"},"longitude":{"type":"number"},"postal_code":{"type":"string"}}},"capital":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"unit":{"type":"string"},"value":{"type":"number"},"display":{"type":"string"}}},"filings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"source":{"nullable":true}}}},"persons":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string"},"category":{"type":"integer"},"description":{"type":"string"}}}},"subject":{"type":"string"},"elf_code":{"type":"string"},"register":{"type":"object","properties":{"id":{"type":"string"},"city":{"nullable":true},"country":{"type":"string"},"unique_key":{"type":"string"}}},"company_id":{"type":"string"},"financials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"unit":{"type":"string"},"value":{"type":"number"},"display":{"type":"string"}}}},"legal_form":{"type":"string"},"risk_level":{"type":"string"},"former_names":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"name":{"type":"string"},"legal_form":{"type":"string"}}}},"segment_codes":{"type":"object","properties":{"naf":{"type":"array","items":{}},"isic":{"type":"array","items":{"type":"string"}},"nace":{"type":"array","items":{"type":"string"}},"naics":{"type":"array","items":{"type":"string"}},"uksic":{"type":"array","items":{"type":"string"}},"naf_2025":{"type":"array","items":{}},"nace_2025":{"type":"array","items":{"type":"string"}}}},"other_registers":{"type":"array","items":{"type":"object","properties":{"city":{"nullable":true},"date":{"type":"string"},"country":{"type":"string"},"unique_key":{"type":"string"},"register_id":{"type":"string"}}}},"last_update_time":{"type":"string"},"original_subject":{"type":"string"},"original_subject_language":{"type":"string"}}},"examples":{"Rolls-Royce plc":{"value":{"lei":"X57JK1U580XATGR67572","url":"https://www.northdata.com/Rolls-Royce%20plc,%20London/Companies%20House%2001003142","name":"Rolls-Royce plc","eu_id":null,"events":[{"url":"https://www.northdata.com/?id=6137794862","date":"1971-02-23","category":1,"description":"Registration"},{"url":"https://www.northdata.com/?id=6228341741846528","date":"1995-01-01","category":1,"description":"Registration France"},{"url":"https://www.northdata.com/?id=6137794862","date":"1978-01-02","category":2,"description":"Legal form: Ltd. → plc"},{"url":"https://www.northdata.com/?id=6137794862","date":"1978-01-02","category":2,"description":"Name: Rolls-Royce plc"}],"extras":[{"id":"phone","name":"Phone","value":"+44 07770442315"},{"id":"url","name":"Website","value":"https://www.rolls-royce.com"},{"id":"email","name":"Email","value":"enquiries@rolls-royce.com"}],"status":"active","address":{"city":"London","state":null,"street":"90 York Way","country":"GB","latitude":51.5349626,"formatted":"90 York Way, Kings Place, London N1 9FX, United Kingdom","longitude":-0.1217676933974402,"postal_code":"N1 9FX"},"capital":{"id":"Capital","date":"2016-06-13","name":"Base/share capital","unit":"GBP","value":326199301.6,"display":"£326.2M"},"filings":[{"id":"Siret 42218357400017","name":"Siret 42218357400017","type":"Siret","source":null},{"id":"X57JK1U580XATGR67572","name":"X57JK1U580XATGR67572","type":"Lei","source":"Lei"}],"persons":[{"url":"https://www.northdata.com/?id=6513855692","date":"2026-03-24","category":9,"description":"Director Alex Martin"},{"url":"https://www.northdata.com/?id=6513855692","date":"2023-08-04","category":9,"description":"Director Jordan Lee"}],"subject":"Aircraft and spacecraft repair and maintenance","elf_code":"B6ES","register":{"id":"01003142","city":null,"country":"GB","unique_key":"GB_01003142"},"company_id":"5854348650","financials":[{"id":"Capital","date":"2025-12-31","name":"Base/share capital","unit":"GBP","value":326199301.6,"display":"£326.2M"},{"id":"BalanceTotal","date":"2025-12-31","name":"Total assets","unit":"GBP","value":40308,"display":"£40,308"},{"id":"Earnings","date":"2025-12-31","name":"Earnings","unit":"GBP","value":5836,"display":"£5,836.00"},{"id":"Revenue","date":"2025-12-31","name":"Revenue","unit":"GBP","value":21207,"display":"£21,207"},{"id":"ReturnOnSales","date":"2025-12-31","name":"Return on sales","unit":"%","value":27.51921535342104,"display":"27.5%"},{"id":"Equity","date":"2025-12-31","name":"Equity","unit":"GBP","value":4977,"display":"£4,977.00"}],"legal_form":"plc","risk_level":"GREEN","former_names":[{"date":"1977-12-31","name":"Rolls-Royce (1971) Ltd.","legal_form":"Ltd."}],"segment_codes":{"naf":[],"isic":["2513","2592","2811"],"nace":["25.30","25.62","28.11"],"naics":["332313","332410","339910","332710"],"uksic":["25.30","25.62","28.11"],"naf_2025":[],"nace_2025":["25.21","25.53","28.11"]},"other_registers":[{"city":null,"date":"2025-12-06","country":"FR","unique_key":"FR_422183574","register_id":"422183574"},{"city":null,"date":"2022-11-11","country":"NO","unique_key":"NO_974230151","register_id":"974230151"}],"last_update_time":"2026-10-27T17:03:32.364Z","original_subject":"Aircraft and spacecraft repair and maintenance","original_subject_language":"en"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/northdata/search":{"get":{"summary":"North Data Search","description":"Search North Data companies and people by name. Returns suggestion cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-northdata-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company or person name, or a North Data suggest URL.\n\n**Example (keyword):**\n\n    BMW\n\n**Example (suggest URL):**\n\n    https://www.northdata.fr/suggest.json?query=BMW&countries=FR\n\n**Notes:**\n- A profile URL returns 400. Use the company endpoint.\n- `domain` defaults to `fr`. `countries` is optional (`FR` or `FR,DE`).\n- Only page 1 exists.","schema":{"type":"string","description":"Company or person name, or a North Data suggest URL.\n\n**Example (keyword):**\n\n    BMW\n\n**Example (suggest URL):**\n\n    https://www.northdata.fr/suggest.json?query=BMW&countries=FR\n\n**Notes:**\n- A profile URL returns 400. Use the company endpoint.\n- `domain` defaults to `fr`. `countries` is optional (`FR` or `FR,DE`).\n- Only page 1 exists."}},{"name":"countries","in":"query","required":false,"description":"ISO alpha-2 codes, separated by comma, pipe or space (FR or FR,DE). Empty searches every country. A URL that already has countries wins.","schema":{"type":"string","description":"ISO alpha-2 codes, separated by comma, pipe or space (FR or FR,DE). Empty searches every country. A URL that already has countries wins."}},{"name":"domain","in":"query","required":false,"description":"Host of a name: fr (default), com or en, de. Ignored when query is a URL.","schema":{"type":"string","default":"fr","description":"Host of a name: fr (default), com or en, de. Ignored when query is a URL."}},{"name":"page","in":"query","required":false,"description":"Only 1. Below 1 returns 400. Above 1 returns 404. At most 15 rows.","schema":{"type":"number","description":"Only 1. Below 1 returns 400. Above 1 returns 404. At most 15 rows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"string"},"position":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"BMW in France":{"value":{"results":[{"url":"https://www.northdata.fr/Maison%20Boinaud%20SAS,%20Angeac-Champagne/Siren%20907120216","name":"Maison Boinaud SAS","type":"company","location":"Angeac-Champagne","position":1}],"pagination":{"next":null,"page":1,"per_page":15,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"North Data Search","description":"Search North Data companies and people by name. Returns suggestion cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-northdata-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company or person name, or a North Data suggest URL.\n\n**Example (keyword):**\n\n    BMW\n\n**Example (suggest URL):**\n\n    https://www.northdata.fr/suggest.json?query=BMW&countries=FR\n\n**Notes:**\n- A profile URL returns 400. Use the company endpoint.\n- `domain` defaults to `fr`. `countries` is optional (`FR` or `FR,DE`).\n- Only page 1 exists.","schema":{"type":"string","description":"Company or person name, or a North Data suggest URL.\n\n**Example (keyword):**\n\n    BMW\n\n**Example (suggest URL):**\n\n    https://www.northdata.fr/suggest.json?query=BMW&countries=FR\n\n**Notes:**\n- A profile URL returns 400. Use the company endpoint.\n- `domain` defaults to `fr`. `countries` is optional (`FR` or `FR,DE`).\n- Only page 1 exists."}},{"name":"countries","in":"query","required":false,"description":"ISO alpha-2 codes, separated by comma, pipe or space (FR or FR,DE). Empty searches every country. A URL that already has countries wins.","schema":{"type":"string","description":"ISO alpha-2 codes, separated by comma, pipe or space (FR or FR,DE). Empty searches every country. A URL that already has countries wins."}},{"name":"domain","in":"query","required":false,"description":"Host of a name: fr (default), com or en, de. Ignored when query is a URL.","schema":{"type":"string","default":"fr","description":"Host of a name: fr (default), com or en, de. Ignored when query is a URL."}},{"name":"page","in":"query","required":false,"description":"Only 1. Below 1 returns 400. Above 1 returns 404. At most 15 rows.","schema":{"type":"number","description":"Only 1. Below 1 returns 400. Above 1 returns 404. At most 15 rows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"string"},"position":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"BMW in France":{"value":{"results":[{"url":"https://www.northdata.fr/Maison%20Boinaud%20SAS,%20Angeac-Champagne/Siren%20907120216","name":"Maison Boinaud SAS","type":"company","location":"Angeac-Champagne","position":1}],"pagination":{"next":null,"page":1,"per_page":15,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/glassdoor/company/info":{"get":{"summary":"Glassdoor Company Info","description":"Get one Glassdoor company profile by URL or employer id (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-glassdoor-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company URL or employer id.\\n\\n**Example:**\\n\\n    1692882","schema":{"type":"string","description":"Company URL or employer id.\\n\\n**Example:**\\n\\n    1692882"}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD when query is not a full URL.","schema":{"type":"string","default":"fr","description":"Glassdoor TLD when query is not a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"domain":{"type":"string"},"rating":{"type":"number"},"founded":{"type":"string"},"revenue":{"type":"string"},"website":{"type":"string"},"industry":{"type":"string"},"logo_url":{"type":"string"},"description":{"type":"string"},"employer_id":{"type":"string"},"headquarters":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Scalian":{"value":{"url":"https://www.glassdoor.fr/Présentation/Travailler-chez-Scalian-EI_IE1692882.16,23.htm","name":"Scalian","size":"De 5 001 à 10 000 employés","domain":"fr","rating":3.6,"founded":"1989","revenue":"Entre 500 millions et 1 milliard $ (USD)","website":"https://www.scalian.com","industry":"Solutions logicielles et réseau d’entreprise","logo_url":"https://media.glassdoor.com/sql/1692882/scalian-squarelogo-1502869323027.png","description":"Créé en 1989, Scalian est un pure player dans les domaines des logiciels critiques…","employer_id":"1692882","headquarters":"Toulouse, France","review_count":1099}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Glassdoor Company Info","description":"Get one Glassdoor company profile by URL or employer id (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-glassdoor-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company URL or employer id.\\n\\n**Example:**\\n\\n    1692882","schema":{"type":"string","description":"Company URL or employer id.\\n\\n**Example:**\\n\\n    1692882"}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD when query is not a full URL.","schema":{"type":"string","default":"fr","description":"Glassdoor TLD when query is not a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"domain":{"type":"string"},"rating":{"type":"number"},"founded":{"type":"string"},"revenue":{"type":"string"},"website":{"type":"string"},"industry":{"type":"string"},"logo_url":{"type":"string"},"description":{"type":"string"},"employer_id":{"type":"string"},"headquarters":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Scalian":{"value":{"url":"https://www.glassdoor.fr/Présentation/Travailler-chez-Scalian-EI_IE1692882.16,23.htm","name":"Scalian","size":"De 5 001 à 10 000 employés","domain":"fr","rating":3.6,"founded":"1989","revenue":"Entre 500 millions et 1 milliard $ (USD)","website":"https://www.scalian.com","industry":"Solutions logicielles et réseau d’entreprise","logo_url":"https://media.glassdoor.com/sql/1692882/scalian-squarelogo-1502869323027.png","description":"Créé en 1989, Scalian est un pure player dans les domaines des logiciels critiques…","employer_id":"1692882","headquarters":"Toulouse, France","review_count":1099}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/glassdoor/job/search":{"get":{"summary":"Glassdoor Job Search","description":"Search Glassdoor jobs by keyword or SEO URL, with domain and filters (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-glassdoor-job-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Glassdoor job search URL.","schema":{"type":"string","description":"Keyword or full Glassdoor job search URL."}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD when query is not a full URL.","schema":{"type":"string","default":"fr","description":"Glassdoor TLD when query is not a full URL."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"number","description":"Page number."}},{"name":"sort_by","in":"query","required":false,"description":"Glassdoor sortBy value (e.g. date_desc).","schema":{"type":"string","description":"Glassdoor sortBy value (e.g. date_desc)."}},{"name":"remote","in":"query","required":false,"description":"When true, set remoteWorkType=1.","schema":{"type":"boolean","description":"When true, set remoteWorkType=1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"age":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"salary":{"nullable":true},"company":{"type":"string"},"summary":{"type":"string"},"location":{"type":"string"},"logo_url":{"type":"string"},"job_listing_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Paris security jobs":{"value":{"results":[{"age":"30j+","url":"https://www.glassdoor.fr/job-listing/ingénieur-e-expérimenté-e-soc-cert-automotive-hf-cybersécurité-ile-de-france-sopra-steria-JV_IC4337427_KO0,76_KE77,89.htm?jl=1010044566651","title":"Ingénieur(e) expérimenté(e) SOC/CERT Automotive (H/F) - Cybersécurité - Ile de France","salary":null,"company":"Sopra Steria","summary":"Vous interviendrez pour l'un de nos clients majeurs dans le secteur de l'automobile…","location":"Courbevoie","logo_url":"https://media.glassdoor.com/sql/466295/sopra-steria-squareLogo-1612703737891.png","job_listing_id":"1010044566651"}],"pagination":{"next":"https://www.glassdoor.fr/Emploi/paris-information-security-analyst-emplois-SRCH_IL.0,5_IC2881970_KO6,34.htm?page=2","page":1,"per_page":30,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Glassdoor Job Search","description":"Search Glassdoor jobs by keyword or SEO URL, with domain and filters (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-glassdoor-job-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Glassdoor job search URL.","schema":{"type":"string","description":"Keyword or full Glassdoor job search URL."}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD when query is not a full URL.","schema":{"type":"string","default":"fr","description":"Glassdoor TLD when query is not a full URL."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"number","description":"Page number."}},{"name":"sort_by","in":"query","required":false,"description":"Glassdoor sortBy value (e.g. date_desc).","schema":{"type":"string","description":"Glassdoor sortBy value (e.g. date_desc)."}},{"name":"remote","in":"query","required":false,"description":"When true, set remoteWorkType=1.","schema":{"type":"boolean","description":"When true, set remoteWorkType=1."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"age":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"salary":{"nullable":true},"company":{"type":"string"},"summary":{"type":"string"},"location":{"type":"string"},"logo_url":{"type":"string"},"job_listing_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Paris security jobs":{"value":{"results":[{"age":"30j+","url":"https://www.glassdoor.fr/job-listing/ingénieur-e-expérimenté-e-soc-cert-automotive-hf-cybersécurité-ile-de-france-sopra-steria-JV_IC4337427_KO0,76_KE77,89.htm?jl=1010044566651","title":"Ingénieur(e) expérimenté(e) SOC/CERT Automotive (H/F) - Cybersécurité - Ile de France","salary":null,"company":"Sopra Steria","summary":"Vous interviendrez pour l'un de nos clients majeurs dans le secteur de l'automobile…","location":"Courbevoie","logo_url":"https://media.glassdoor.com/sql/466295/sopra-steria-squareLogo-1612703737891.png","job_listing_id":"1010044566651"}],"pagination":{"next":"https://www.glassdoor.fr/Emploi/paris-information-security-analyst-emplois-SRCH_IL.0,5_IC2881970_KO6,34.htm?page=2","page":1,"per_page":30,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/glassdoor/job/info":{"get":{"summary":"Glassdoor Job Info","description":"Get one Glassdoor job listing by URL or jl id (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-glassdoor-job-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Job listing URL or jl id.\\n\\n**Example:**\\n\\n    1010283388161","schema":{"type":"string","description":"Job listing URL or jl id.\\n\\n**Example:**\\n\\n    1010283388161"}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD when query is not a full URL.","schema":{"type":"string","default":"fr","description":"Glassdoor TLD when query is not a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"salary":{"nullable":true},"company":{"type":"string"},"location":{"type":"string"},"logo_url":{"type":"string"},"company_url":{"type":"string"},"date_posted":{"type":"string"},"description":{"type":"string"},"job_listing_id":{"type":"string"},"employment_type":{"type":"array","items":{"type":"string"}}}},"examples":{"DevOps internship":{"value":{"url":"https://www.glassdoor.fr/job-listing/stage-devops-docker-kubernetes-et-ci-cd-niveau-bac-34-it-systèmes-d-information-la-defense-ile-de-france-france-societe-generale-JV_IC2881970_KO0,111_KE112,128.htm?jl=1010283388161","title":"Stage DevOps - Docker, Kubernetes et CI/CD (niveau bac +3/4) - IT (Systèmes d'information) - La Defense, Ile de France, France","domain":"fr","salary":null,"company":"SOCIETE GENERALE","location":"Paris, Île-de-France, France","logo_url":"https://media.glassdoor.com/sql/10350/société-générale-squareLogo-1625070831989.png","company_url":"https://www.glassdoor.fr/Présentation/Travailler-chez-Société-Générale-EI_IE10350.16,32.htm","date_posted":"2026-10-02T00:00:00","description":"<div><b>Vos missions au quotidien</b>…</div>","job_listing_id":"1010283388161","employment_type":["FULL_TIME"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Glassdoor Job Info","description":"Get one Glassdoor job listing by URL or jl id (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-glassdoor-job-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Job listing URL or jl id.\\n\\n**Example:**\\n\\n    1010283388161","schema":{"type":"string","description":"Job listing URL or jl id.\\n\\n**Example:**\\n\\n    1010283388161"}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD when query is not a full URL.","schema":{"type":"string","default":"fr","description":"Glassdoor TLD when query is not a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"salary":{"nullable":true},"company":{"type":"string"},"location":{"type":"string"},"logo_url":{"type":"string"},"company_url":{"type":"string"},"date_posted":{"type":"string"},"description":{"type":"string"},"job_listing_id":{"type":"string"},"employment_type":{"type":"array","items":{"type":"string"}}}},"examples":{"DevOps internship":{"value":{"url":"https://www.glassdoor.fr/job-listing/stage-devops-docker-kubernetes-et-ci-cd-niveau-bac-34-it-systèmes-d-information-la-defense-ile-de-france-france-societe-generale-JV_IC2881970_KO0,111_KE112,128.htm?jl=1010283388161","title":"Stage DevOps - Docker, Kubernetes et CI/CD (niveau bac +3/4) - IT (Systèmes d'information) - La Defense, Ile de France, France","domain":"fr","salary":null,"company":"SOCIETE GENERALE","location":"Paris, Île-de-France, France","logo_url":"https://media.glassdoor.com/sql/10350/société-générale-squareLogo-1625070831989.png","company_url":"https://www.glassdoor.fr/Présentation/Travailler-chez-Société-Générale-EI_IE10350.16,32.htm","date_posted":"2026-10-02T00:00:00","description":"<div><b>Vos missions au quotidien</b>…</div>","job_listing_id":"1010283388161","employment_type":["FULL_TIME"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/glassdoor/company/search":{"get":{"summary":"Glassdoor Company Search","description":"Search Glassdoor employers by keyword across country sites (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-glassdoor-company-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Employer keyword, or a full Glassdoor autocomplete URL.\\n\\n**Example:**\\n\\n    airbus","schema":{"type":"string","description":"Employer keyword, or a full Glassdoor autocomplete URL.\\n\\n**Example:**\\n\\n    airbus"}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD (`fr`, `com`, `co.uk`, …).","schema":{"type":"string","default":"fr","description":"Glassdoor TLD (`fr`, `com`, `co.uk`, …)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"website":{"type":"string"},"logo_url":{"type":"string"},"short_name":{"type":"string"},"employer_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Airbus on glassdoor.fr":{"value":{"results":[{"url":"https://www.glassdoor.fr/Présentation/Travailler-chez-Airbus-EI_IE3059.htm","name":"Airbus S.A.S.","website":"www.airbus-group.com","logo_url":"https://media.glassdoor.com/sqlm/3059/airbus-squarelogo-1702511286787.png","short_name":"Airbus","employer_id":"3059"}],"pagination":{"next":null,"page":1,"per_page":12,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Glassdoor Company Search","description":"Search Glassdoor employers by keyword across country sites (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-glassdoor-company-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Employer keyword, or a full Glassdoor autocomplete URL.\\n\\n**Example:**\\n\\n    airbus","schema":{"type":"string","description":"Employer keyword, or a full Glassdoor autocomplete URL.\\n\\n**Example:**\\n\\n    airbus"}},{"name":"domain","in":"query","required":false,"description":"Glassdoor TLD (`fr`, `com`, `co.uk`, …).","schema":{"type":"string","default":"fr","description":"Glassdoor TLD (`fr`, `com`, `co.uk`, …)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"website":{"type":"string"},"logo_url":{"type":"string"},"short_name":{"type":"string"},"employer_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Airbus on glassdoor.fr":{"value":{"results":[{"url":"https://www.glassdoor.fr/Présentation/Travailler-chez-Airbus-EI_IE3059.htm","name":"Airbus S.A.S.","website":"www.airbus-group.com","logo_url":"https://media.glassdoor.com/sqlm/3059/airbus-squarelogo-1702511286787.png","short_name":"Airbus","employer_id":"3059"}],"pagination":{"next":null,"page":1,"per_page":12,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/eventbrite/event":{"get":{"summary":"Eventbrite Event","description":"Get one Eventbrite event by detail URL or numeric id: venue, organizer, schedule, and description (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-eventbrite-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Event detail URL or numeric id.\n\n**Examples:**\n\n    2002625586037\n    https://www.eventbrite.fr/e/soiree-de-gala-du-festival-international-danimation-dissy-tickets-2002625586037","schema":{"type":"string","description":"Event detail URL or numeric id.\n\n**Examples:**\n\n    2002625586037\n    https://www.eventbrite.fr/e/soiree-de-gala-du-festival-international-danimation-dissy-tickets-2002625586037"}},{"name":"domain","in":"query","required":false,"description":"Country TLD when query is a bare id (`fr`, `com`, `es`, `com.mx`, …). Ignored if query is a full URL.","schema":{"type":"string","default":"fr","description":"Country TLD when query is a bare id (`fr`, `com`, `es`, `com.mx`, …). Ignored if query is a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tags":{"nullable":true},"venue":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"region":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"postal_code":{"nullable":true}}},"domain":{"type":"string"},"format":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"status":{"type":"string"},"is_free":{"type":"boolean"},"summary":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"end_date":{"type":"string"},"event_id":{"type":"string"},"timezone":{"type":"string"},"image_url":{"type":"string"},"is_listed":{"type":"boolean"},"is_online":{"type":"boolean"},"is_series":{"type":"boolean"},"organizer":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"nullable":true},"verified":{"type":"boolean"},"num_events":{"type":"integer"},"total_attendees":{"type":"integer"}}},"highlights":{"type":"object","properties":{"location_type":{"type":"string"},"duration_minutes":{"type":"integer"}}},"start_date":{"type":"string"},"description":{"type":"string"},"subcategory":{"type":"string"},"end_date_utc":{"type":"string"},"sales_status":{"type":"string"},"start_date_utc":{"type":"string"},"duration_seconds":{"type":"integer"}}},"examples":{"Issy gala (URL query)":{"value":{"url":"https://www.eventbrite.fr/e/soiree-de-gala-du-festival-international-danimation-dissy-tickets-2002625586037","name":"Soirée de Gala du Festival International d'Animation d'Issy","tags":null,"venue":{"id":"299647843","city":"Issy-les-Moulineaux","name":"Palais des Arts et des Congrès d'Issy","region":"IDF","address":"25 Avenue Victor Cresson, 92130 Issy-les-Moulineaux","country":"FR","latitude":48.8229941,"longitude":2.2699164,"postal_code":null},"domain":"fr","format":"Festival","images":["https://img.evbuc.com/cover.jpg"],"locale":"fr_FR","status":"live","is_free":true,"summary":"Une occasion unique de plonger dans l’univers fascinant des films d’animation chinois.","category":"Film & Media","currency":"EUR","end_date":"2026-10-09T22:30:00","event_id":"2002625586037","timezone":"Europe/Paris","image_url":"https://img.evbuc.com/cover.jpg","is_listed":true,"is_online":false,"is_series":false,"organizer":{"id":"112804898271","url":"https://www.eventbrite.fr/o/112804898271","name":null,"verified":false,"num_events":11,"total_attendees":911},"highlights":{"location_type":"in_person","duration_minutes":150},"start_date":"2026-10-09T20:00:00","description":"<p>Assistez à la première édition…</p>","subcategory":"Film","end_date_utc":"2026-10-09T20:30:00Z","sales_status":"on_sale","start_date_utc":"2026-10-09T18:00:00Z","duration_seconds":9000}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Eventbrite Event","description":"Get one Eventbrite event by detail URL or numeric id: venue, organizer, schedule, and description (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-eventbrite-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Event detail URL or numeric id.\n\n**Examples:**\n\n    2002625586037\n    https://www.eventbrite.fr/e/soiree-de-gala-du-festival-international-danimation-dissy-tickets-2002625586037","schema":{"type":"string","description":"Event detail URL or numeric id.\n\n**Examples:**\n\n    2002625586037\n    https://www.eventbrite.fr/e/soiree-de-gala-du-festival-international-danimation-dissy-tickets-2002625586037"}},{"name":"domain","in":"query","required":false,"description":"Country TLD when query is a bare id (`fr`, `com`, `es`, `com.mx`, …). Ignored if query is a full URL.","schema":{"type":"string","default":"fr","description":"Country TLD when query is a bare id (`fr`, `com`, `es`, `com.mx`, …). Ignored if query is a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tags":{"nullable":true},"venue":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"region":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"postal_code":{"nullable":true}}},"domain":{"type":"string"},"format":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"status":{"type":"string"},"is_free":{"type":"boolean"},"summary":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"end_date":{"type":"string"},"event_id":{"type":"string"},"timezone":{"type":"string"},"image_url":{"type":"string"},"is_listed":{"type":"boolean"},"is_online":{"type":"boolean"},"is_series":{"type":"boolean"},"organizer":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"nullable":true},"verified":{"type":"boolean"},"num_events":{"type":"integer"},"total_attendees":{"type":"integer"}}},"highlights":{"type":"object","properties":{"location_type":{"type":"string"},"duration_minutes":{"type":"integer"}}},"start_date":{"type":"string"},"description":{"type":"string"},"subcategory":{"type":"string"},"end_date_utc":{"type":"string"},"sales_status":{"type":"string"},"start_date_utc":{"type":"string"},"duration_seconds":{"type":"integer"}}},"examples":{"Issy gala (URL query)":{"value":{"url":"https://www.eventbrite.fr/e/soiree-de-gala-du-festival-international-danimation-dissy-tickets-2002625586037","name":"Soirée de Gala du Festival International d'Animation d'Issy","tags":null,"venue":{"id":"299647843","city":"Issy-les-Moulineaux","name":"Palais des Arts et des Congrès d'Issy","region":"IDF","address":"25 Avenue Victor Cresson, 92130 Issy-les-Moulineaux","country":"FR","latitude":48.8229941,"longitude":2.2699164,"postal_code":null},"domain":"fr","format":"Festival","images":["https://img.evbuc.com/cover.jpg"],"locale":"fr_FR","status":"live","is_free":true,"summary":"Une occasion unique de plonger dans l’univers fascinant des films d’animation chinois.","category":"Film & Media","currency":"EUR","end_date":"2026-10-09T22:30:00","event_id":"2002625586037","timezone":"Europe/Paris","image_url":"https://img.evbuc.com/cover.jpg","is_listed":true,"is_online":false,"is_series":false,"organizer":{"id":"112804898271","url":"https://www.eventbrite.fr/o/112804898271","name":null,"verified":false,"num_events":11,"total_attendees":911},"highlights":{"location_type":"in_person","duration_minutes":150},"start_date":"2026-10-09T20:00:00","description":"<p>Assistez à la première édition…</p>","subcategory":"Film","end_date_utc":"2026-10-09T20:30:00Z","sales_status":"on_sale","start_date_utc":"2026-10-09T18:00:00Z","duration_seconds":9000}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/eventbrite/search":{"get":{"summary":"Eventbrite Search","description":"Search Eventbrite events by keyword or paste a city/category URL. Returns event cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-eventbrite-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Keyword, or paste a full Eventbrite city / category / search URL.\n\n**Examples:**\n\n    rock\n    https://www.eventbrite.com/d/france--paris/rock/\n    https://www.eventbrite.fr/d/france--paris/events/?q=concert","schema":{"type":"string","description":"Keyword, or paste a full Eventbrite city / category / search URL.\n\n**Examples:**\n\n    rock\n    https://www.eventbrite.com/d/france--paris/rock/\n    https://www.eventbrite.fr/d/france--paris/events/?q=concert"}},{"name":"domain","in":"query","required":false,"description":"Eventbrite TLD when query is a keyword (`fr`, `com`, `es`, `com.mx`, `co.uk`, …). Ignored if query is a full URL.","schema":{"type":"string","default":"fr","description":"Eventbrite TLD when query is a keyword (`fr`, `com`, `es`, `com.mx`, `co.uk`, …). Ignored if query is a full URL."}},{"name":"location","in":"query","required":false,"description":"Location slug such as `france--paris` (keyword searches only).","schema":{"type":"string","description":"Location slug such as `france--paris` (keyword searches only)."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"number","description":"Page number."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"venue":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"region":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"postal_code":{"type":"string"}}},"summary":{"type":"string"},"end_date":{"type":"string"},"end_time":{"type":"string"},"event_id":{"type":"string"},"language":{"type":"string"},"timezone":{"type":"string"},"image_url":{"type":"string"},"is_online":{"type":"boolean"},"start_date":{"type":"string"},"start_time":{"type":"string"},"tickets_url":{"type":"string"},"organizer_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Paris rock (URL query)":{"value":{"results":[{"url":"https://www.eventbrite.com/e/paris-classical-concert-ave-maria-alleluia-tickets-1999267177948","name":"Paris Classical Concert – Ave Maria & Alleluia","tags":["Classical","Music","Concert or Performance"],"venue":{"id":"299211756","city":"Paris","name":"Église de la Madeleine","region":"IDF","address":"Place de la Madeleine, 75008 Paris","country":"FR","latitude":48.8700435,"longitude":2.3245502,"postal_code":"75008"},"summary":"Experience Ave Maria & Alleluia live at La Madeleine Church, Paris.","end_date":"2026-10-22","end_time":"21:15","event_id":"1999267177948","language":"en-gb","timezone":"Europe/Paris","image_url":"https://img.evbuc.com/cover.jpg","is_online":false,"start_date":"2026-10-22","start_time":"20:00","tickets_url":"https://www.eventbrite.com/checkout-external?eid=1999267177948","organizer_id":"121326821059"}],"pagination":{"next":"https://www.eventbrite.com/d/france--paris/rock/?page=2","page":1,"per_page":20,"total_pages":12,"total_results":230}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Eventbrite Search","description":"Search Eventbrite events by keyword or paste a city/category URL. Returns event cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-eventbrite-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Keyword, or paste a full Eventbrite city / category / search URL.\n\n**Examples:**\n\n    rock\n    https://www.eventbrite.com/d/france--paris/rock/\n    https://www.eventbrite.fr/d/france--paris/events/?q=concert","schema":{"type":"string","description":"Keyword, or paste a full Eventbrite city / category / search URL.\n\n**Examples:**\n\n    rock\n    https://www.eventbrite.com/d/france--paris/rock/\n    https://www.eventbrite.fr/d/france--paris/events/?q=concert"}},{"name":"domain","in":"query","required":false,"description":"Eventbrite TLD when query is a keyword (`fr`, `com`, `es`, `com.mx`, `co.uk`, …). Ignored if query is a full URL.","schema":{"type":"string","default":"fr","description":"Eventbrite TLD when query is a keyword (`fr`, `com`, `es`, `com.mx`, `co.uk`, …). Ignored if query is a full URL."}},{"name":"location","in":"query","required":false,"description":"Location slug such as `france--paris` (keyword searches only).","schema":{"type":"string","description":"Location slug such as `france--paris` (keyword searches only)."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"number","description":"Page number."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"venue":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"region":{"type":"string"},"address":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"postal_code":{"type":"string"}}},"summary":{"type":"string"},"end_date":{"type":"string"},"end_time":{"type":"string"},"event_id":{"type":"string"},"language":{"type":"string"},"timezone":{"type":"string"},"image_url":{"type":"string"},"is_online":{"type":"boolean"},"start_date":{"type":"string"},"start_time":{"type":"string"},"tickets_url":{"type":"string"},"organizer_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Paris rock (URL query)":{"value":{"results":[{"url":"https://www.eventbrite.com/e/paris-classical-concert-ave-maria-alleluia-tickets-1999267177948","name":"Paris Classical Concert – Ave Maria & Alleluia","tags":["Classical","Music","Concert or Performance"],"venue":{"id":"299211756","city":"Paris","name":"Église de la Madeleine","region":"IDF","address":"Place de la Madeleine, 75008 Paris","country":"FR","latitude":48.8700435,"longitude":2.3245502,"postal_code":"75008"},"summary":"Experience Ave Maria & Alleluia live at La Madeleine Church, Paris.","end_date":"2026-10-22","end_time":"21:15","event_id":"1999267177948","language":"en-gb","timezone":"Europe/Paris","image_url":"https://img.evbuc.com/cover.jpg","is_online":false,"start_date":"2026-10-22","start_time":"20:00","tickets_url":"https://www.eventbrite.com/checkout-external?eid=1999267177948","organizer_id":"121326821059"}],"pagination":{"next":"https://www.eventbrite.com/d/france--paris/rock/?page=2","page":1,"per_page":20,"total_pages":12,"total_results":230}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/tiktoktopads/search":{"get":{"summary":"TikTok Top Ads Search","description":"Search TikTok Creative Center Top Ads by region, objective, period, and keyword. Returns ad cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-tiktoktopads-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Full TikTok Top Ads search URL, or a keyword.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/inspiration/topads/pc/en?period=30&region=AR","schema":{"type":"string","description":"Full TikTok Top Ads search URL, or a keyword.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/inspiration/topads/pc/en?period=30&region=AR"}},{"name":"keyword","in":"query","required":false,"description":"Brand or product keyword.","schema":{"type":"string","description":"Brand or product keyword."}},{"name":"region","in":"query","required":false,"description":"ISO country code (`country_code`).\n\n**Example:**\n\n    AR","schema":{"type":"string","description":"ISO country code (`country_code`).\n\n**Example:**\n\n    AR"}},{"name":"objective","in":"query","required":false,"description":"Campaign objective id (URL param `object`).\n\n**Example:**\n\n    4","schema":{"type":"string","description":"Campaign objective id (URL param `object`).\n\n**Example:**\n\n    4"}},{"name":"period","in":"query","required":false,"description":"Lookback window: `7`, `30`, or `180`.","schema":{"type":"string","default":"30","description":"Lookback window: `7`, `30`, or `180`."}},{"name":"order_by","in":"query","required":false,"description":"Sort: `for_you`, `reach`/`impression`, `ctr`/`like`.","schema":{"type":"string","description":"Sort: `for_you`, `reach`/`impression`, `ctr`/`like`."}},{"name":"industry","in":"query","required":false,"description":"Industry key filter.","schema":{"type":"string","description":"Industry key filter."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"number","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"Page size (max 20).","schema":{"type":"number","description":"Page size (max 20)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ctr":{"type":"number"},"url":{"type":"string"},"cost":{"type":"integer"},"ad_id":{"type":"string"},"format":{"type":"string"},"headline":{"type":"string"},"image_url":{"type":"string"},"objective":{"type":"string"},"video_url":{"type":"string"},"like_count":{"type":"integer"},"industry_key":{"type":"string"},"advertiser_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"cursor":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Argentina last 30 days":{"value":{"results":[{"ctr":0.97,"url":"https://ads.tiktok.com/business/creativecenter/topads/7683821191329005569/pc/en?period=30","cost":0,"ad_id":"7683821191329005569","format":"video","headline":"DESCUBRE","image_url":"https://p16.tiktokcdn.com/cover.jpg","objective":"campaign_objective_lead_generation","video_url":"https://v16.tiktokcdn.com/video.mp4","like_count":4120,"industry_key":"label_10104000000","advertiser_name":"Example Brand"}],"pagination":{"next":"https://ads.tiktok.com/business/creativecenter/inspiration/topads/pc/en?period=30&region=AR&page=2","page":1,"cursor":"2","per_page":20,"total_pages":3,"total_results":47}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TikTok Top Ads Search","description":"Search TikTok Creative Center Top Ads by region, objective, period, and keyword. Returns ad cards and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-tiktoktopads-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Full TikTok Top Ads search URL, or a keyword.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/inspiration/topads/pc/en?period=30&region=AR","schema":{"type":"string","description":"Full TikTok Top Ads search URL, or a keyword.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/inspiration/topads/pc/en?period=30&region=AR"}},{"name":"keyword","in":"query","required":false,"description":"Brand or product keyword.","schema":{"type":"string","description":"Brand or product keyword."}},{"name":"region","in":"query","required":false,"description":"ISO country code (`country_code`).\n\n**Example:**\n\n    AR","schema":{"type":"string","description":"ISO country code (`country_code`).\n\n**Example:**\n\n    AR"}},{"name":"objective","in":"query","required":false,"description":"Campaign objective id (URL param `object`).\n\n**Example:**\n\n    4","schema":{"type":"string","description":"Campaign objective id (URL param `object`).\n\n**Example:**\n\n    4"}},{"name":"period","in":"query","required":false,"description":"Lookback window: `7`, `30`, or `180`.","schema":{"type":"string","default":"30","description":"Lookback window: `7`, `30`, or `180`."}},{"name":"order_by","in":"query","required":false,"description":"Sort: `for_you`, `reach`/`impression`, `ctr`/`like`.","schema":{"type":"string","description":"Sort: `for_you`, `reach`/`impression`, `ctr`/`like`."}},{"name":"industry","in":"query","required":false,"description":"Industry key filter.","schema":{"type":"string","description":"Industry key filter."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"number","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"Page size (max 20).","schema":{"type":"number","description":"Page size (max 20)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ctr":{"type":"number"},"url":{"type":"string"},"cost":{"type":"integer"},"ad_id":{"type":"string"},"format":{"type":"string"},"headline":{"type":"string"},"image_url":{"type":"string"},"objective":{"type":"string"},"video_url":{"type":"string"},"like_count":{"type":"integer"},"industry_key":{"type":"string"},"advertiser_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"cursor":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Argentina last 30 days":{"value":{"results":[{"ctr":0.97,"url":"https://ads.tiktok.com/business/creativecenter/topads/7683821191329005569/pc/en?period=30","cost":0,"ad_id":"7683821191329005569","format":"video","headline":"DESCUBRE","image_url":"https://p16.tiktokcdn.com/cover.jpg","objective":"campaign_objective_lead_generation","video_url":"https://v16.tiktokcdn.com/video.mp4","like_count":4120,"industry_key":"label_10104000000","advertiser_name":"Example Brand"}],"pagination":{"next":"https://ads.tiktok.com/business/creativecenter/inspiration/topads/pc/en?period=30&region=AR&page=2","page":1,"cursor":"2","per_page":20,"total_pages":3,"total_results":47}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/tiktoktopads/ad":{"get":{"summary":"TikTok Top Ads Ad","description":"Get one TikTok Creative Center Top Ad by URL or id: creative, landing page, CTR, and engagement (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-tiktoktopads-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/topads/7686267188656750612/pc/en?period=30","schema":{"type":"string","description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/topads/7686267188656750612/pc/en?period=30"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ctr":{"type":"number"},"url":{"type":"string"},"cost":{"type":"integer"},"ad_id":{"type":"string"},"format":{"type":"string"},"source":{"type":"string"},"duration":{"type":"number"},"headline":{"type":"string"},"countries":{"type":"array","items":{"type":"string"}},"image_url":{"type":"string"},"objective":{"type":"string"},"video_url":{"type":"string"},"like_count":{"type":"integer"},"objectives":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"integer"}}}},"voice_over":{"nullable":true},"share_count":{"type":"integer"},"industry_key":{"type":"string"},"keyword_list":{"nullable":true},"landing_page":{"type":"string"},"comment_count":{"type":"integer"},"advertiser_name":{"type":"string"}}},"examples":{"Crafted Elements creative":{"value":{"ctr":0.22,"url":"https://ads.tiktok.com/business/creativecenter/topads/7686267188656750612/pc/en?period=30","cost":1,"ad_id":"7686267188656750612","format":"video","source":"TikTok Ads Manager","duration":32.9,"headline":"25% Off Our Popular Juice Groove Router Jig. Limited Time Sale!","countries":["US"],"image_url":"https://p16.tiktokcdn.com/detail-cover.jpg","objective":"campaign_objective_conversion","video_url":"https://v16.tiktokcdn.com/detail.mp4","like_count":39,"objectives":[{"label":"campaign_objective_conversion","value":3}],"voice_over":null,"share_count":1,"industry_key":"label_21103000000","keyword_list":null,"landing_page":"https://craftedelements.com/products/juice-groove-router-jig","comment_count":0,"advertiser_name":"crafted elements"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TikTok Top Ads Ad","description":"Get one TikTok Creative Center Top Ad by URL or id: creative, landing page, CTR, and engagement (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-tiktoktopads-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/topads/7686267188656750612/pc/en?period=30","schema":{"type":"string","description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://ads.tiktok.com/business/creativecenter/topads/7686267188656750612/pc/en?period=30"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ctr":{"type":"number"},"url":{"type":"string"},"cost":{"type":"integer"},"ad_id":{"type":"string"},"format":{"type":"string"},"source":{"type":"string"},"duration":{"type":"number"},"headline":{"type":"string"},"countries":{"type":"array","items":{"type":"string"}},"image_url":{"type":"string"},"objective":{"type":"string"},"video_url":{"type":"string"},"like_count":{"type":"integer"},"objectives":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"integer"}}}},"voice_over":{"nullable":true},"share_count":{"type":"integer"},"industry_key":{"type":"string"},"keyword_list":{"nullable":true},"landing_page":{"type":"string"},"comment_count":{"type":"integer"},"advertiser_name":{"type":"string"}}},"examples":{"Crafted Elements creative":{"value":{"ctr":0.22,"url":"https://ads.tiktok.com/business/creativecenter/topads/7686267188656750612/pc/en?period=30","cost":1,"ad_id":"7686267188656750612","format":"video","source":"TikTok Ads Manager","duration":32.9,"headline":"25% Off Our Popular Juice Groove Router Jig. Limited Time Sale!","countries":["US"],"image_url":"https://p16.tiktokcdn.com/detail-cover.jpg","objective":"campaign_objective_conversion","video_url":"https://v16.tiktokcdn.com/detail.mp4","like_count":39,"objectives":[{"label":"campaign_objective_conversion","value":3}],"voice_over":null,"share_count":1,"industry_key":"label_21103000000","keyword_list":null,"landing_page":"https://craftedelements.com/products/juice-groove-router-jig","comment_count":0,"advertiser_name":"crafted elements"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedinadlibrary/ad":{"get":{"summary":"LinkedIn Ad Library Ad","description":"Get one LinkedIn Ad Library creative by URL or id: copy, CTA, payer, impressions, and targeting (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-linkedinadlibrary-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://www.linkedin.com/ad-library/detail/1585536544","schema":{"type":"string","description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://www.linkedin.com/ad-library/detail/1585536544"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"ad_id":{"type":"string"},"format":{"type":"string"},"status":{"type":"string"},"paid_by":{"type":"string"},"carousel":{"nullable":true},"cta_text":{"type":"string"},"end_date":{"nullable":true},"headline":{"type":"string"},"image_url":{"type":"string"},"targeting":{"nullable":true},"video_url":{"nullable":true},"start_date":{"nullable":true},"target_url":{"nullable":true},"description":{"type":"string"},"impressions":{"nullable":true},"format_label":{"type":"string"},"advertiser_url":{"type":"string"},"follower_count":{"nullable":true},"advertiser_name":{"type":"string"},"advertiser_image_url":{"type":"string"}}},"examples":{"Airbus hiring creative":{"value":{"url":"https://www.linkedin.com/ad-library/detail/1585536544","ad_id":"1585536544","format":"image","status":"active","paid_by":"Focused Image","carousel":null,"cta_text":"Apply","end_date":null,"headline":"Airbus is Hiring","image_url":"https://media.licdn.com/dms/image/v2/D4E10AQFZ54-UGWaraQ/image_627_1200/B56Z6EWmiMG0AU-/0/1780336978225/Airbus2026Q2Kinston1200x627jpg","targeting":null,"video_url":null,"start_date":null,"target_url":null,"description":"Airbus is hiring in Kinston, NC where we are building advanced composite structures for the A350.","impressions":null,"format_label":"Single Image Ad","advertiser_url":"https://www.linkedin.com/company/2734","follower_count":null,"advertiser_name":"Airbus","advertiser_image_url":"https://media.licdn.com/dms/image/v2/C4D0BAQF2j_LDG_TOzg/company-logo_100_100/company-logo_100_100/0/1631375371456/airbusgroup_logo"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Ad Library Ad","description":"Get one LinkedIn Ad Library creative by URL or id: copy, CTA, payer, impressions, and targeting (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-linkedinadlibrary-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://www.linkedin.com/ad-library/detail/1585536544","schema":{"type":"string","description":"Ad id or detail URL from search.\n\n**Example:**\n\n    https://www.linkedin.com/ad-library/detail/1585536544"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"ad_id":{"type":"string"},"format":{"type":"string"},"status":{"type":"string"},"paid_by":{"type":"string"},"carousel":{"nullable":true},"cta_text":{"type":"string"},"end_date":{"nullable":true},"headline":{"type":"string"},"image_url":{"type":"string"},"targeting":{"nullable":true},"video_url":{"nullable":true},"start_date":{"nullable":true},"target_url":{"nullable":true},"description":{"type":"string"},"impressions":{"nullable":true},"format_label":{"type":"string"},"advertiser_url":{"type":"string"},"follower_count":{"nullable":true},"advertiser_name":{"type":"string"},"advertiser_image_url":{"type":"string"}}},"examples":{"Airbus hiring creative":{"value":{"url":"https://www.linkedin.com/ad-library/detail/1585536544","ad_id":"1585536544","format":"image","status":"active","paid_by":"Focused Image","carousel":null,"cta_text":"Apply","end_date":null,"headline":"Airbus is Hiring","image_url":"https://media.licdn.com/dms/image/v2/D4E10AQFZ54-UGWaraQ/image_627_1200/B56Z6EWmiMG0AU-/0/1780336978225/Airbus2026Q2Kinston1200x627jpg","targeting":null,"video_url":null,"start_date":null,"target_url":null,"description":"Airbus is hiring in Kinston, NC where we are building advanced composite structures for the A350.","impressions":null,"format_label":"Single Image Ad","advertiser_url":"https://www.linkedin.com/company/2734","follower_count":null,"advertiser_name":"Airbus","advertiser_image_url":"https://media.licdn.com/dms/image/v2/C4D0BAQF2j_LDG_TOzg/company-logo_100_100/company-logo_100_100/0/1631375371456/airbusgroup_logo"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedinadlibrary/search":{"get":{"summary":"LinkedIn Ad Library Search","description":"Search the LinkedIn Ad Library by advertiser, keyword, country, and date. Returns ad cards and pagination (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-linkedinadlibrary-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Full LinkedIn Ad Library search URL, or a keyword when `account_owner` is empty.\n\n**Example 1 (URL):**\n\n    https://www.linkedin.com/ad-library/search?accountOwner=airbus\n\n**Example 2 (keyword):**\n\n    aerospace","schema":{"type":"string","description":"Full LinkedIn Ad Library search URL, or a keyword when `account_owner` is empty.\n\n**Example 1 (URL):**\n\n    https://www.linkedin.com/ad-library/search?accountOwner=airbus\n\n**Example 2 (keyword):**\n\n    aerospace"}},{"name":"account_owner","in":"query","required":false,"description":"Advertiser / company name filter (`accountOwner`).\n\n**Example:**\n\n    airbus","schema":{"type":"string","description":"Advertiser / company name filter (`accountOwner`).\n\n**Example:**\n\n    airbus"}},{"name":"keyword","in":"query","required":false,"description":"Keyword filter on ad copy.","schema":{"type":"string","description":"Keyword filter on ad copy."}},{"name":"countries","in":"query","required":false,"description":"Comma-separated ISO country codes, or `ALL`.\n\n**Example:**\n\n    US,FR","schema":{"type":"string","description":"Comma-separated ISO country codes, or `ALL`.\n\n**Example:**\n\n    US,FR"}},{"name":"date_option","in":"query","required":false,"description":"Date window: `last-30-days`, `current-month`, `current-year`, `last-year`, `custom-date-range`.","schema":{"type":"string","description":"Date window: `last-30-days`, `current-month`, `current-year`, `last-year`, `custom-date-range`."}},{"name":"start_date","in":"query","required":false,"description":"Start date `YYYY-MM-DD` when `date_option=custom-date-range`.","schema":{"type":"string","description":"Start date `YYYY-MM-DD` when `date_option=custom-date-range`."}},{"name":"end_date","in":"query","required":false,"description":"End date `YYYY-MM-DD` when `date_option=custom-date-range`.","schema":{"type":"string","description":"End date `YYYY-MM-DD` when `date_option=custom-date-range`."}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from `pagination.cursor` / `pagination.next`.","schema":{"type":"string","description":"Opaque cursor from `pagination.cursor` / `pagination.next`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"ad_id":{"type":"string"},"format":{"type":"string"},"headline":{"type":"string"},"image_url":{"type":"string"},"description":{"type":"string"},"advertiser_name":{"type":"string"},"advertiser_image_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"cursor":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Airbus advertiser search":{"value":{"results":[{"url":"https://www.linkedin.com/ad-library/detail/1585536544","ad_id":"1585536544","format":"image","headline":"Airbus is Hiring","image_url":"https://media.licdn.com/dms/image/v2/D4E10AQFZ54-UGWaraQ/image_627_1200/B56Z6EWmiMG0AU-/0/1780336978225/Airbus2026Q2Kinston1200x627jpg","description":"Airbus is hiring in Kinston, NC where we are building advanced composite structures for the A350.","advertiser_name":"Airbus","advertiser_image_url":"https://media.licdn.com/dms/image/v2/C4D0BAQF2j_LDG_TOzg/company-logo_100_100/company-logo_100_100/0/1631375371456/airbusgroup_logo"}],"pagination":{"next":"https://www.linkedin.com/ad-library/search?accountOwner=airbus&paginationToken=1585433394-1790883234944","page":1,"cursor":"1585433394-1790883234944","per_page":24,"total_pages":54,"total_results":1293}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Ad Library Search","description":"Search the LinkedIn Ad Library by advertiser, keyword, country, and date. Returns ad cards and pagination (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-linkedinadlibrary-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Full LinkedIn Ad Library search URL, or a keyword when `account_owner` is empty.\n\n**Example 1 (URL):**\n\n    https://www.linkedin.com/ad-library/search?accountOwner=airbus\n\n**Example 2 (keyword):**\n\n    aerospace","schema":{"type":"string","description":"Full LinkedIn Ad Library search URL, or a keyword when `account_owner` is empty.\n\n**Example 1 (URL):**\n\n    https://www.linkedin.com/ad-library/search?accountOwner=airbus\n\n**Example 2 (keyword):**\n\n    aerospace"}},{"name":"account_owner","in":"query","required":false,"description":"Advertiser / company name filter (`accountOwner`).\n\n**Example:**\n\n    airbus","schema":{"type":"string","description":"Advertiser / company name filter (`accountOwner`).\n\n**Example:**\n\n    airbus"}},{"name":"keyword","in":"query","required":false,"description":"Keyword filter on ad copy.","schema":{"type":"string","description":"Keyword filter on ad copy."}},{"name":"countries","in":"query","required":false,"description":"Comma-separated ISO country codes, or `ALL`.\n\n**Example:**\n\n    US,FR","schema":{"type":"string","description":"Comma-separated ISO country codes, or `ALL`.\n\n**Example:**\n\n    US,FR"}},{"name":"date_option","in":"query","required":false,"description":"Date window: `last-30-days`, `current-month`, `current-year`, `last-year`, `custom-date-range`.","schema":{"type":"string","description":"Date window: `last-30-days`, `current-month`, `current-year`, `last-year`, `custom-date-range`."}},{"name":"start_date","in":"query","required":false,"description":"Start date `YYYY-MM-DD` when `date_option=custom-date-range`.","schema":{"type":"string","description":"Start date `YYYY-MM-DD` when `date_option=custom-date-range`."}},{"name":"end_date","in":"query","required":false,"description":"End date `YYYY-MM-DD` when `date_option=custom-date-range`.","schema":{"type":"string","description":"End date `YYYY-MM-DD` when `date_option=custom-date-range`."}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from `pagination.cursor` / `pagination.next`.","schema":{"type":"string","description":"Opaque cursor from `pagination.cursor` / `pagination.next`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"ad_id":{"type":"string"},"format":{"type":"string"},"headline":{"type":"string"},"image_url":{"type":"string"},"description":{"type":"string"},"advertiser_name":{"type":"string"},"advertiser_image_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"cursor":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Airbus advertiser search":{"value":{"results":[{"url":"https://www.linkedin.com/ad-library/detail/1585536544","ad_id":"1585536544","format":"image","headline":"Airbus is Hiring","image_url":"https://media.licdn.com/dms/image/v2/D4E10AQFZ54-UGWaraQ/image_627_1200/B56Z6EWmiMG0AU-/0/1780336978225/Airbus2026Q2Kinston1200x627jpg","description":"Airbus is hiring in Kinston, NC where we are building advanced composite structures for the A350.","advertiser_name":"Airbus","advertiser_image_url":"https://media.licdn.com/dms/image/v2/C4D0BAQF2j_LDG_TOzg/company-logo_100_100/company-logo_100_100/0/1631375371456/airbusgroup_logo"}],"pagination":{"next":"https://www.linkedin.com/ad-library/search?accountOwner=airbus&paginationToken=1585433394-1790883234944","page":1,"cursor":"1585433394-1790883234944","per_page":24,"total_pages":54,"total_results":1293}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/googleadstransparency/ad":{"get":{"summary":"Google Ads Transparency Ad","description":"Get one Google Ads Transparency creative by URL: dates, impressions, platforms, regions, and the text read from the preview image (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-googleadstransparency-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Creative URL from search.\n\n**Example:**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR","schema":{"type":"string","description":"Creative URL from search.\n\n**Example:**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR"}},{"name":"region","in":"query","required":false,"description":"ISO alpha-2. The matching region is returned first.\n\n**Example:**\n\n    FR","schema":{"type":"string","description":"ISO alpha-2. The matching region is returned first.\n\n**Example:**\n\n    FR"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"format":{"type":"string"},"regions":{"type":"array","items":{"type":"object","properties":{"region":{"type":"string"},"platforms":{"type":"array","items":{}},"last_shown":{"nullable":true},"first_shown":{"nullable":true},"region_code":{"type":"integer"},"impressions_max":{"nullable":true},"impressions_min":{"nullable":true}}}},"video_id":{"nullable":true},"image_url":{"nullable":true},"platforms":{"type":"array","items":{}},"last_shown":{"nullable":true},"variations":{"type":"array","items":{}},"creative_id":{"type":"string"},"first_shown":{"nullable":true},"image_width":{"nullable":true},"preview_url":{"nullable":true},"image_height":{"nullable":true},"advertiser_id":{"type":"string"},"creative_text":{"nullable":true},"last_shown_at":{"nullable":true},"first_shown_at":{"nullable":true},"advertiser_name":{"type":"string"},"impressions_max":{"nullable":true},"impressions_min":{"nullable":true}}},"examples":{"WebAPI Group creative in France":{"value":{"url":"https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR","format":"text","regions":[{"region":"FR","platforms":[],"last_shown":null,"first_shown":null,"region_code":2250,"impressions_max":null,"impressions_min":null}],"video_id":null,"image_url":null,"platforms":[],"last_shown":null,"variations":[],"creative_id":"CR10927354991047868417","first_shown":null,"image_width":null,"preview_url":null,"image_height":null,"advertiser_id":"AR10904289436120383489","creative_text":null,"last_shown_at":null,"first_shown_at":null,"advertiser_name":"WebAPI Group","impressions_max":null,"impressions_min":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Ads Transparency Ad","description":"Get one Google Ads Transparency creative by URL: dates, impressions, platforms, regions, and the text read from the preview image (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-googleadstransparency-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Creative URL from search.\n\n**Example:**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR","schema":{"type":"string","description":"Creative URL from search.\n\n**Example:**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR"}},{"name":"region","in":"query","required":false,"description":"ISO alpha-2. The matching region is returned first.\n\n**Example:**\n\n    FR","schema":{"type":"string","description":"ISO alpha-2. The matching region is returned first.\n\n**Example:**\n\n    FR"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"format":{"type":"string"},"regions":{"type":"array","items":{"type":"object","properties":{"region":{"type":"string"},"platforms":{"type":"array","items":{}},"last_shown":{"nullable":true},"first_shown":{"nullable":true},"region_code":{"type":"integer"},"impressions_max":{"nullable":true},"impressions_min":{"nullable":true}}}},"video_id":{"nullable":true},"image_url":{"nullable":true},"platforms":{"type":"array","items":{}},"last_shown":{"nullable":true},"variations":{"type":"array","items":{}},"creative_id":{"type":"string"},"first_shown":{"nullable":true},"image_width":{"nullable":true},"preview_url":{"nullable":true},"image_height":{"nullable":true},"advertiser_id":{"type":"string"},"creative_text":{"nullable":true},"last_shown_at":{"nullable":true},"first_shown_at":{"nullable":true},"advertiser_name":{"type":"string"},"impressions_max":{"nullable":true},"impressions_min":{"nullable":true}}},"examples":{"WebAPI Group creative in France":{"value":{"url":"https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR","format":"text","regions":[{"region":"FR","platforms":[],"last_shown":null,"first_shown":null,"region_code":2250,"impressions_max":null,"impressions_min":null}],"video_id":null,"image_url":null,"platforms":[],"last_shown":null,"variations":[],"creative_id":"CR10927354991047868417","first_shown":null,"image_width":null,"preview_url":null,"image_height":null,"advertiser_id":"AR10904289436120383489","creative_text":null,"last_shown_at":null,"first_shown_at":null,"advertiser_name":"WebAPI Group","impressions_max":null,"impressions_min":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/googleadstransparency/search":{"get":{"summary":"Google Ads Transparency Search","description":"Search the Google Ads Transparency Center by domain, advertiser, region, format, platform, and date. Returns creative cards and pagination (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-googleadstransparency-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain name, advertiser name, advertiser id, or a full Ads Transparency URL.\n\n**Example 1 (domain):**\n\n    webapi.group\n\n**Example 2 (advertiser URL):**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489?region=FR\n\n**Example 3 (advertiser id):**\n\n    AR10904289436120383489\n\n**Example 4 (advertiser name):**\n\n    WebAPI Group","schema":{"type":"string","description":"Domain name, advertiser name, advertiser id, or a full Ads Transparency URL.\n\n**Example 1 (domain):**\n\n    webapi.group\n\n**Example 2 (advertiser URL):**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489?region=FR\n\n**Example 3 (advertiser id):**\n\n    AR10904289436120383489\n\n**Example 4 (advertiser name):**\n\n    WebAPI Group"}},{"name":"region","in":"query","required":false,"description":"Country. ISO alpha-2 (`FR`), `anywhere`, or a Transparency region code (`2250` for France, `250` is also accepted).\n\nOmitted means no region filter.","schema":{"type":"string","description":"Country. ISO alpha-2 (`FR`), `anywhere`, or a Transparency region code (`2250` for France, `250` is also accepted).\n\nOmitted means no region filter."}},{"name":"domain","in":"query","required":false,"description":"Domain filter. Used when `query` is not already a domain.\n\n**Example:**\n\n    webapi.group","schema":{"type":"string","description":"Domain filter. Used when `query` is not already a domain.\n\n**Example:**\n\n    webapi.group"}},{"name":"advertiser_id","in":"query","required":false,"description":"Advertiser id, `AR` followed by digits.\n\n**Example:**\n\n    AR10904289436120383489","schema":{"type":"string","description":"Advertiser id, `AR` followed by digits.\n\n**Example:**\n\n    AR10904289436120383489"}},{"name":"format","in":"query","required":false,"description":"Creative format.\n\n- `text`\n- `image`\n- `video`","schema":{"type":"string","description":"Creative format.\n\n- `text`\n- `image`\n- `video`"}},{"name":"platform","in":"query","required":false,"description":"Comma-separated surfaces.\n\n- `play`\n- `maps`\n- `search`\n- `shopping`\n- `youtube`\n\n**Example:**\n\n    search,youtube","schema":{"type":"string","description":"Comma-separated surfaces.\n\n- `play`\n- `maps`\n- `search`\n- `shopping`\n- `youtube`\n\n**Example:**\n\n    search,youtube"}},{"name":"preset_date","in":"query","required":false,"description":"Relative window.\n\n- `today`\n- `yesterday`\n- `last_7_days`\n- `last_30_days`\n\nFrench URL labels such as `7 derniers jours`, `Aujourd'hui`, and `Hier` are accepted.","schema":{"type":"string","description":"Relative window.\n\n- `today`\n- `yesterday`\n- `last_7_days`\n- `last_30_days`\n\nFrench URL labels such as `7 derniers jours`, `Aujourd'hui`, and `Hier` are accepted."}},{"name":"start_date","in":"query","required":false,"description":"Inclusive start date, `YYYY-MM-DD` or `YYYYMMDD`.\n\n**Example:**\n\n    2026-09-10","schema":{"type":"string","description":"Inclusive start date, `YYYY-MM-DD` or `YYYYMMDD`.\n\n**Example:**\n\n    2026-09-10"}},{"name":"end_date","in":"query","required":false,"description":"Inclusive end date, `YYYY-MM-DD` or `YYYYMMDD`. A single day uses the same value as `start_date`.","schema":{"type":"string","description":"Inclusive end date, `YYYY-MM-DD` or `YYYYMMDD`. A single day uses the same value as `start_date`."}},{"name":"topic","in":"query","required":false,"description":"Ad topic. Default: `commercial`.\n\n- `commercial`\n- `political`\n- `shopping`\n- `travel_hotel`\n- `local_services`","schema":{"type":"string","default":"commercial","description":"Ad topic. Default: `commercial`.\n\n- `commercial`\n- `political`\n- `shopping`\n- `travel_hotel`\n- `local_services`"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1 to 20. Default: `1`.","schema":{"type":"number","default":"1","description":"Page number, from 1 to 20. Default: `1`."}},{"name":"per_page","in":"query","required":false,"description":"Page size, from 1 to 100. Default: `40`.","schema":{"type":"number","default":"40","description":"Page size, from 1 to 100. Default: `40`."}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor copied from `pagination.next`.","schema":{"type":"string","description":"Opaque cursor copied from `pagination.next`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"domain":{"type":"string"},"format":{"type":"string"},"image_url":{"nullable":true},"creative_id":{"type":"string"},"image_width":{"nullable":true},"preview_url":{"nullable":true},"image_height":{"nullable":true},"advertiser_id":{"type":"string"},"last_shown_at":{"nullable":true},"first_shown_at":{"nullable":true},"advertiser_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true},"total_results_max":{"nullable":true},"total_results_min":{"nullable":true}}}}},"examples":{"WebAPI Group advertiser in France":{"value":{"results":[{"url":"https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR","domain":"webapi.group","format":"text","image_url":null,"creative_id":"CR10927354991047868417","image_width":null,"preview_url":null,"image_height":null,"advertiser_id":"AR10904289436120383489","last_shown_at":null,"first_shown_at":null,"advertiser_name":"WebAPI Group"}],"pagination":{"next":null,"page":1,"per_page":40,"total_pages":null,"total_results":null,"total_results_max":null,"total_results_min":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Ads Transparency Search","description":"Search the Google Ads Transparency Center by domain, advertiser, region, format, platform, and date. Returns creative cards and pagination (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-googleadstransparency-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain name, advertiser name, advertiser id, or a full Ads Transparency URL.\n\n**Example 1 (domain):**\n\n    webapi.group\n\n**Example 2 (advertiser URL):**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489?region=FR\n\n**Example 3 (advertiser id):**\n\n    AR10904289436120383489\n\n**Example 4 (advertiser name):**\n\n    WebAPI Group","schema":{"type":"string","description":"Domain name, advertiser name, advertiser id, or a full Ads Transparency URL.\n\n**Example 1 (domain):**\n\n    webapi.group\n\n**Example 2 (advertiser URL):**\n\n    https://adstransparency.google.com/advertiser/AR10904289436120383489?region=FR\n\n**Example 3 (advertiser id):**\n\n    AR10904289436120383489\n\n**Example 4 (advertiser name):**\n\n    WebAPI Group"}},{"name":"region","in":"query","required":false,"description":"Country. ISO alpha-2 (`FR`), `anywhere`, or a Transparency region code (`2250` for France, `250` is also accepted).\n\nOmitted means no region filter.","schema":{"type":"string","description":"Country. ISO alpha-2 (`FR`), `anywhere`, or a Transparency region code (`2250` for France, `250` is also accepted).\n\nOmitted means no region filter."}},{"name":"domain","in":"query","required":false,"description":"Domain filter. Used when `query` is not already a domain.\n\n**Example:**\n\n    webapi.group","schema":{"type":"string","description":"Domain filter. Used when `query` is not already a domain.\n\n**Example:**\n\n    webapi.group"}},{"name":"advertiser_id","in":"query","required":false,"description":"Advertiser id, `AR` followed by digits.\n\n**Example:**\n\n    AR10904289436120383489","schema":{"type":"string","description":"Advertiser id, `AR` followed by digits.\n\n**Example:**\n\n    AR10904289436120383489"}},{"name":"format","in":"query","required":false,"description":"Creative format.\n\n- `text`\n- `image`\n- `video`","schema":{"type":"string","description":"Creative format.\n\n- `text`\n- `image`\n- `video`"}},{"name":"platform","in":"query","required":false,"description":"Comma-separated surfaces.\n\n- `play`\n- `maps`\n- `search`\n- `shopping`\n- `youtube`\n\n**Example:**\n\n    search,youtube","schema":{"type":"string","description":"Comma-separated surfaces.\n\n- `play`\n- `maps`\n- `search`\n- `shopping`\n- `youtube`\n\n**Example:**\n\n    search,youtube"}},{"name":"preset_date","in":"query","required":false,"description":"Relative window.\n\n- `today`\n- `yesterday`\n- `last_7_days`\n- `last_30_days`\n\nFrench URL labels such as `7 derniers jours`, `Aujourd'hui`, and `Hier` are accepted.","schema":{"type":"string","description":"Relative window.\n\n- `today`\n- `yesterday`\n- `last_7_days`\n- `last_30_days`\n\nFrench URL labels such as `7 derniers jours`, `Aujourd'hui`, and `Hier` are accepted."}},{"name":"start_date","in":"query","required":false,"description":"Inclusive start date, `YYYY-MM-DD` or `YYYYMMDD`.\n\n**Example:**\n\n    2026-09-10","schema":{"type":"string","description":"Inclusive start date, `YYYY-MM-DD` or `YYYYMMDD`.\n\n**Example:**\n\n    2026-09-10"}},{"name":"end_date","in":"query","required":false,"description":"Inclusive end date, `YYYY-MM-DD` or `YYYYMMDD`. A single day uses the same value as `start_date`.","schema":{"type":"string","description":"Inclusive end date, `YYYY-MM-DD` or `YYYYMMDD`. A single day uses the same value as `start_date`."}},{"name":"topic","in":"query","required":false,"description":"Ad topic. Default: `commercial`.\n\n- `commercial`\n- `political`\n- `shopping`\n- `travel_hotel`\n- `local_services`","schema":{"type":"string","default":"commercial","description":"Ad topic. Default: `commercial`.\n\n- `commercial`\n- `political`\n- `shopping`\n- `travel_hotel`\n- `local_services`"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1 to 20. Default: `1`.","schema":{"type":"number","default":"1","description":"Page number, from 1 to 20. Default: `1`."}},{"name":"per_page","in":"query","required":false,"description":"Page size, from 1 to 100. Default: `40`.","schema":{"type":"number","default":"40","description":"Page size, from 1 to 100. Default: `40`."}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor copied from `pagination.next`.","schema":{"type":"string","description":"Opaque cursor copied from `pagination.next`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"domain":{"type":"string"},"format":{"type":"string"},"image_url":{"nullable":true},"creative_id":{"type":"string"},"image_width":{"nullable":true},"preview_url":{"nullable":true},"image_height":{"nullable":true},"advertiser_id":{"type":"string"},"last_shown_at":{"nullable":true},"first_shown_at":{"nullable":true},"advertiser_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true},"total_results_max":{"nullable":true},"total_results_min":{"nullable":true}}}}},"examples":{"WebAPI Group advertiser in France":{"value":{"results":[{"url":"https://adstransparency.google.com/advertiser/AR10904289436120383489/creative/CR10927354991047868417?region=FR","domain":"webapi.group","format":"text","image_url":null,"creative_id":"CR10927354991047868417","image_width":null,"preview_url":null,"image_height":null,"advertiser_id":"AR10904289436120383489","last_shown_at":null,"first_shown_at":null,"advertiser_name":"WebAPI Group"}],"pagination":{"next":null,"page":1,"per_page":40,"total_pages":null,"total_results":null,"total_results_max":null,"total_results_min":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/starbucks/menu":{"get":{"summary":"Starbucks Menu","description":"Full Starbucks menu for one café, with the default-size price of each item. Prices use browser rendering.\n\n**Credit cost:** 3 credits per call","operationId":"get-starbucks-menu","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_number","in":"query","required":false,"description":"Café number from Search, short (`9230`) or full (`9230-154245`).","schema":{"type":"string","description":"Café number from Search, short (`9230`) or full (`9230-154245`)."}},{"name":"query","in":"query","required":false,"description":"Same café number, or a menu URL that contains `storeNumber`. Used when `store_number` is empty.","schema":{"type":"string","description":"Same café number, or a menu URL that contains `storeNumber`. Used when `store_number` is empty."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"store":{"type":"object","properties":{"name":{"type":"string"},"open":{"type":"boolean"},"phone":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"line1":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"formatted":{"type":"string"},"postal_code":{"type":"string"}}},"distance":{"nullable":true},"schedule":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"open":{"type":"boolean"},"hours":{"type":"string"}}}},"store_id":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"time_zone":{"type":"string"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"open_status":{"type":"string"},"hours_status":{"type":"string"},"store_number":{"type":"string"},"ownership_type_code":{"type":"string"},"recommendation_reason":{"type":"string"}}},"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"uri":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"price":{"type":"number"},"sizes":{"type":"array","items":{"type":"string"}},"calories":{"type":"string"},"currency":{"type":"string"},"form_code":{"type":"string"},"image_url":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"availability":{"type":"string"},"product_type":{"type":"string"},"product_number":{"type":"integer"}}}},"currency":{"type":"string"},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"DTLA Grand Park menu, default-size prices":{"value":{"store":{"name":"DTLA Grand Park","open":false,"phone":"+1 213-625-2205","address":{"city":"Los Angeles","line1":"217 N. Hill Street","region":"CA","country":"US","formatted":"217 N. Hill Street, Los Angeles","postal_code":"90012"},"distance":null,"schedule":[{"day":"thursday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"friday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"saturday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"sunday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"monday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"tuesday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"wednesday","open":true,"hours":"4:30 AM to 9:00 PM"}],"store_id":"69543","amenities":["In café","Mobile Order and Pay","MOP ASAP + Scheduled Ordering","Nitro Cold Brew","Oven-warmed Food","Redeem Rewards","Starbucks Wi-Fi"],"time_zone":"GMT-07:00 America/Los_Angeles","coordinates":{"latitude":34.05612,"longitude":-118.24698},"open_status":"Opens Thursday at 4:30 AM","hours_status":"Open 4:30 AM-9:00 PM","store_number":"9230-154245","ownership_type_code":"co","recommendation_reason":"nearby"},"results":[{"sku":"183887","uri":"/product/418/hot","url":"https://www.starbucks.com/menu/product/418/hot","name":"Pumpkin Spice Latte","size":"grande","price":6.75,"sizes":["short","tall","grande","venti"],"calories":"390 calories","currency":"usd","form_code":"hot","image_url":"https://cloudassets.starbucks.com/is/image/sbuxcorp/PumpkinSpiceLatteV1","categories":["The Latest > Pumpkin Picks","Coffee & Espresso > Hot Coffee & Espresso > Latte"],"availability":"purchasable","product_type":"beverage","product_number":418}],"currency":"usd","pagination":{"next":null,"page":1,"per_page":275,"total_pages":1,"total_results":275}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Starbucks Menu","description":"Full Starbucks menu for one café, with the default-size price of each item. Prices use browser rendering.\n\n**Credit cost:** 3 credits per call","operationId":"post-starbucks-menu","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_number","in":"query","required":false,"description":"Café number from Search, short (`9230`) or full (`9230-154245`).","schema":{"type":"string","description":"Café number from Search, short (`9230`) or full (`9230-154245`)."}},{"name":"query","in":"query","required":false,"description":"Same café number, or a menu URL that contains `storeNumber`. Used when `store_number` is empty.","schema":{"type":"string","description":"Same café number, or a menu URL that contains `storeNumber`. Used when `store_number` is empty."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"store":{"type":"object","properties":{"name":{"type":"string"},"open":{"type":"boolean"},"phone":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"line1":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"formatted":{"type":"string"},"postal_code":{"type":"string"}}},"distance":{"nullable":true},"schedule":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"open":{"type":"boolean"},"hours":{"type":"string"}}}},"store_id":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"time_zone":{"type":"string"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"open_status":{"type":"string"},"hours_status":{"type":"string"},"store_number":{"type":"string"},"ownership_type_code":{"type":"string"},"recommendation_reason":{"type":"string"}}},"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"uri":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"price":{"type":"number"},"sizes":{"type":"array","items":{"type":"string"}},"calories":{"type":"string"},"currency":{"type":"string"},"form_code":{"type":"string"},"image_url":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"availability":{"type":"string"},"product_type":{"type":"string"},"product_number":{"type":"integer"}}}},"currency":{"type":"string"},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"DTLA Grand Park menu, default-size prices":{"value":{"store":{"name":"DTLA Grand Park","open":false,"phone":"+1 213-625-2205","address":{"city":"Los Angeles","line1":"217 N. Hill Street","region":"CA","country":"US","formatted":"217 N. Hill Street, Los Angeles","postal_code":"90012"},"distance":null,"schedule":[{"day":"thursday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"friday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"saturday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"sunday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"monday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"tuesday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"wednesday","open":true,"hours":"4:30 AM to 9:00 PM"}],"store_id":"69543","amenities":["In café","Mobile Order and Pay","MOP ASAP + Scheduled Ordering","Nitro Cold Brew","Oven-warmed Food","Redeem Rewards","Starbucks Wi-Fi"],"time_zone":"GMT-07:00 America/Los_Angeles","coordinates":{"latitude":34.05612,"longitude":-118.24698},"open_status":"Opens Thursday at 4:30 AM","hours_status":"Open 4:30 AM-9:00 PM","store_number":"9230-154245","ownership_type_code":"co","recommendation_reason":"nearby"},"results":[{"sku":"183887","uri":"/product/418/hot","url":"https://www.starbucks.com/menu/product/418/hot","name":"Pumpkin Spice Latte","size":"grande","price":6.75,"sizes":["short","tall","grande","venti"],"calories":"390 calories","currency":"usd","form_code":"hot","image_url":"https://cloudassets.starbucks.com/is/image/sbuxcorp/PumpkinSpiceLatteV1","categories":["The Latest > Pumpkin Picks","Coffee & Espresso > Hot Coffee & Espresso > Latte"],"availability":"purchasable","product_type":"beverage","product_number":418}],"currency":"usd","pagination":{"next":null,"page":1,"per_page":275,"total_pages":1,"total_results":275}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/starbucks/product":{"get":{"summary":"Starbucks Product","description":"One Starbucks item at one café, with a price for every size. Get the café from Search first. Prices use browser rendering.\n\n**Credit cost:** 3 credits per call","operationId":"get-starbucks-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product and form, or a Starbucks product URL.\n\n**Examples:**\n\n```\n418/hot\n```\n\n```\nhttps://www.starbucks.com/menu/product/418/hot\n```","schema":{"type":"string","description":"Product and form, or a Starbucks product URL.\n\n**Examples:**\n\n```\n418/hot\n```\n\n```\nhttps://www.starbucks.com/menu/product/418/hot\n```"}},{"name":"store_number","in":"query","required":false,"description":"Café number from Search, short (`9230`) or full (`9230-154245`). Required when the product URL has no `storeNumber`.","schema":{"type":"string","description":"Café number from Search, short (`9230`) or full (`9230-154245`). Required when the product URL has no `storeNumber`."}},{"name":"form_code","in":"query","required":false,"description":"Form when `query` is only a product number. Usually `hot` or `iced`.","schema":{"type":"string","description":"Form when `query` is only a product number. Usually `hot` or `iced`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"sizes":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"default":{"type":"boolean"},"calories":{"type":"string"},"currency":{"type":"string"},"size_code":{"type":"string"}}}},"currency":{"type":"string"},"form_code":{"type":"string"},"image_url":{"type":"string"},"store_name":{"type":"string"},"description":{"type":"string"},"product_type":{"type":"string"},"store_number":{"type":"string"},"product_number":{"type":"integer"}}},"examples":{"Pumpkin Spice Latte at DTLA Grand Park":{"value":{"url":"https://www.starbucks.com/menu/product/418/hot","name":"Pumpkin Spice Latte","sizes":[{"sku":"183885","name":"short","price":6.15,"default":false,"calories":"210 calories","currency":"usd","size_code":"short"},{"sku":"183886","name":"tall","price":6.25,"default":false,"calories":"300 calories","currency":"usd","size_code":"tall"},{"sku":"183887","name":"grande","price":6.75,"default":true,"calories":"390 calories","currency":"usd","size_code":"grande"},{"sku":"183888","name":"venti","price":7.25,"default":false,"calories":"470 calories","currency":"usd","size_code":"venti"}],"currency":"usd","form_code":"hot","image_url":"https://cloudassets.starbucks.com/is/image/sbuxcorp/PumpkinSpiceLatteV1","store_name":"DTLA Grand Park","description":"Our signature Espresso Roast and steamed milk with the celebrated flavor combination of pumpkin, cinnamon, nutmeg and clove. Enjoy it topped with whipped cream and real pumpkin-pie spices.","product_type":"beverages","store_number":"9230-154245","product_number":418}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Starbucks Product","description":"One Starbucks item at one café, with a price for every size. Get the café from Search first. Prices use browser rendering.\n\n**Credit cost:** 3 credits per call","operationId":"post-starbucks-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product and form, or a Starbucks product URL.\n\n**Examples:**\n\n```\n418/hot\n```\n\n```\nhttps://www.starbucks.com/menu/product/418/hot\n```","schema":{"type":"string","description":"Product and form, or a Starbucks product URL.\n\n**Examples:**\n\n```\n418/hot\n```\n\n```\nhttps://www.starbucks.com/menu/product/418/hot\n```"}},{"name":"store_number","in":"query","required":false,"description":"Café number from Search, short (`9230`) or full (`9230-154245`). Required when the product URL has no `storeNumber`.","schema":{"type":"string","description":"Café number from Search, short (`9230`) or full (`9230-154245`). Required when the product URL has no `storeNumber`."}},{"name":"form_code","in":"query","required":false,"description":"Form when `query` is only a product number. Usually `hot` or `iced`.","schema":{"type":"string","description":"Form when `query` is only a product number. Usually `hot` or `iced`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"sizes":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"default":{"type":"boolean"},"calories":{"type":"string"},"currency":{"type":"string"},"size_code":{"type":"string"}}}},"currency":{"type":"string"},"form_code":{"type":"string"},"image_url":{"type":"string"},"store_name":{"type":"string"},"description":{"type":"string"},"product_type":{"type":"string"},"store_number":{"type":"string"},"product_number":{"type":"integer"}}},"examples":{"Pumpkin Spice Latte at DTLA Grand Park":{"value":{"url":"https://www.starbucks.com/menu/product/418/hot","name":"Pumpkin Spice Latte","sizes":[{"sku":"183885","name":"short","price":6.15,"default":false,"calories":"210 calories","currency":"usd","size_code":"short"},{"sku":"183886","name":"tall","price":6.25,"default":false,"calories":"300 calories","currency":"usd","size_code":"tall"},{"sku":"183887","name":"grande","price":6.75,"default":true,"calories":"390 calories","currency":"usd","size_code":"grande"},{"sku":"183888","name":"venti","price":7.25,"default":false,"calories":"470 calories","currency":"usd","size_code":"venti"}],"currency":"usd","form_code":"hot","image_url":"https://cloudassets.starbucks.com/is/image/sbuxcorp/PumpkinSpiceLatteV1","store_name":"DTLA Grand Park","description":"Our signature Espresso Roast and steamed milk with the celebrated flavor combination of pumpkin, cinnamon, nutmeg and clove. Enjoy it topped with whipped cream and real pumpkin-pie spices.","product_type":"beverages","store_number":"9230-154245","product_number":418}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/starbucks/search":{"get":{"summary":"Starbucks Search","description":"Nearest Starbucks cafés from coordinates or a store-locator URL. Returns address, hours, amenities, and the store number used by Menu and Product.\n\n**Credit cost:** 3 credits per call","operationId":"get-starbucks-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Store-locator URL, or a `lat,lng` pair. Required when `lat` and `lng` are empty.\n\n**Example:**\n\n```\nhttps://www.starbucks.com/store-locator?map=40.71391,-74.01121,12z\n```","schema":{"type":"string","description":"Store-locator URL, or a `lat,lng` pair. Required when `lat` and `lng` are empty.\n\n**Example:**\n\n```\nhttps://www.starbucks.com/store-locator?map=40.71391,-74.01121,12z\n```"}},{"name":"lat","in":"query","required":false,"description":"Latitude. Send it with `lng`. If both are set, they replace any coordinates found in `query`.","schema":{"type":"number","description":"Latitude. Send it with `lng`. If both are set, they replace any coordinates found in `query`."}},{"name":"lng","in":"query","required":false,"description":"Longitude. Send it with `lat`.","schema":{"type":"number","description":"Longitude. Send it with `lat`."}},{"name":"place","in":"query","required":false,"description":"Optional place label sent with the coordinates, for example `New York, NY`. Coordinates are still required.","schema":{"type":"string","description":"Optional place label sent with the coordinates, for example `New York, NY`. Coordinates are still required."}},{"name":"features","in":"query","required":false,"description":"Optional amenity filter. Separate codes with commas. `ON` keeps cafés that offer mobile order.","schema":{"type":"string","description":"Optional amenity filter. Separate codes with commas. `ON` keeps cafés that offer mobile order."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"open":{"type":"boolean"},"phone":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"line1":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"formatted":{"type":"string"},"postal_code":{"type":"string"}}},"distance":{"type":"number"},"schedule":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"open":{"type":"boolean"},"hours":{"type":"string"}}}},"store_id":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"time_zone":{"type":"string"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"open_status":{"type":"string"},"hours_status":{"type":"string"},"store_number":{"type":"string"},"ownership_type_code":{"type":"string"},"recommendation_reason":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Nearest café to downtown Los Angeles":{"value":{"results":[{"name":"DTLA Grand Park","open":false,"phone":"+1 213-625-2205","address":{"city":"Los Angeles","line1":"217 N. Hill Street","region":"CA","country":"US","formatted":"217 N. Hill Street, Los Angeles","postal_code":"90012"},"distance":0.262,"schedule":[{"day":"thursday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"friday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"saturday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"sunday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"monday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"tuesday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"wednesday","open":true,"hours":"4:30 AM to 9:00 PM"}],"store_id":"69543","amenities":["In café","Mobile Order and Pay","MOP ASAP + Scheduled Ordering","Nitro Cold Brew","Oven-warmed Food","Redeem Rewards","Starbucks Wi-Fi"],"time_zone":"GMT-07:00 America/Los_Angeles","coordinates":{"latitude":34.05612,"longitude":-118.24698},"open_status":"Opens Thursday at 4:30 AM","hours_status":"Open 4:30 AM-9:00 PM","store_number":"9230-154245","ownership_type_code":"co","recommendation_reason":"nearby"}],"pagination":{"next":null,"page":1,"per_page":50,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Starbucks Search","description":"Nearest Starbucks cafés from coordinates or a store-locator URL. Returns address, hours, amenities, and the store number used by Menu and Product.\n\n**Credit cost:** 3 credits per call","operationId":"post-starbucks-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Store-locator URL, or a `lat,lng` pair. Required when `lat` and `lng` are empty.\n\n**Example:**\n\n```\nhttps://www.starbucks.com/store-locator?map=40.71391,-74.01121,12z\n```","schema":{"type":"string","description":"Store-locator URL, or a `lat,lng` pair. Required when `lat` and `lng` are empty.\n\n**Example:**\n\n```\nhttps://www.starbucks.com/store-locator?map=40.71391,-74.01121,12z\n```"}},{"name":"lat","in":"query","required":false,"description":"Latitude. Send it with `lng`. If both are set, they replace any coordinates found in `query`.","schema":{"type":"number","description":"Latitude. Send it with `lng`. If both are set, they replace any coordinates found in `query`."}},{"name":"lng","in":"query","required":false,"description":"Longitude. Send it with `lat`.","schema":{"type":"number","description":"Longitude. Send it with `lat`."}},{"name":"place","in":"query","required":false,"description":"Optional place label sent with the coordinates, for example `New York, NY`. Coordinates are still required.","schema":{"type":"string","description":"Optional place label sent with the coordinates, for example `New York, NY`. Coordinates are still required."}},{"name":"features","in":"query","required":false,"description":"Optional amenity filter. Separate codes with commas. `ON` keeps cafés that offer mobile order.","schema":{"type":"string","description":"Optional amenity filter. Separate codes with commas. `ON` keeps cafés that offer mobile order."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"open":{"type":"boolean"},"phone":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"line1":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"formatted":{"type":"string"},"postal_code":{"type":"string"}}},"distance":{"type":"number"},"schedule":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"open":{"type":"boolean"},"hours":{"type":"string"}}}},"store_id":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"time_zone":{"type":"string"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"open_status":{"type":"string"},"hours_status":{"type":"string"},"store_number":{"type":"string"},"ownership_type_code":{"type":"string"},"recommendation_reason":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Nearest café to downtown Los Angeles":{"value":{"results":[{"name":"DTLA Grand Park","open":false,"phone":"+1 213-625-2205","address":{"city":"Los Angeles","line1":"217 N. Hill Street","region":"CA","country":"US","formatted":"217 N. Hill Street, Los Angeles","postal_code":"90012"},"distance":0.262,"schedule":[{"day":"thursday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"friday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"saturday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"sunday","open":true,"hours":"5:00 AM to 5:00 PM"},{"day":"monday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"tuesday","open":true,"hours":"4:30 AM to 9:00 PM"},{"day":"wednesday","open":true,"hours":"4:30 AM to 9:00 PM"}],"store_id":"69543","amenities":["In café","Mobile Order and Pay","MOP ASAP + Scheduled Ordering","Nitro Cold Brew","Oven-warmed Food","Redeem Rewards","Starbucks Wi-Fi"],"time_zone":"GMT-07:00 America/Los_Angeles","coordinates":{"latitude":34.05612,"longitude":-118.24698},"open_status":"Opens Thursday at 4:30 AM","hours_status":"Open 4:30 AM-9:00 PM","store_number":"9230-154245","ownership_type_code":"co","recommendation_reason":"nearby"}],"pagination":{"next":null,"page":1,"per_page":50,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/search/ai":{"get":{"summary":"Google AI Mode","description":"Scrape real-time Google AI Mode answers: text_blocks, references, and shopping_results.\n\n**Credit cost:** 3 credits per call","operationId":"get-google-search-ai","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The question or search query to send to Google AI Mode. Natural-language questions work best; advanced operators are also accepted.\n\n**Examples:**\n- `what is mozilla firefox`: factual overview\n- `best espresso machine 2026`: comparison-style answer\n- `site:mozilla.org firefox privacy`: restrict cited sources\n\n**Example:**\n\n    what is mozilla firefox","schema":{"type":"string","description":"The question or search query to send to Google AI Mode. Natural-language questions work best; advanced operators are also accepted.\n\n**Examples:**\n- `what is mozilla firefox`: factual overview\n- `best espresso machine 2026`: comparison-style answer\n- `site:mozilla.org firefox privacy`: restrict cited sources\n\n**Example:**\n\n    what is mozilla firefox"}},{"name":"location","in":"query","required":false,"description":"City or region from which the AI Mode search should originate. Simulates a real user searching from that location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```","schema":{"type":"string","description":"City or region from which the AI Mode search should originate. Simulates a real user searching from that location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting. Mutually exclusive with `location`.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting. Mutually exclusive with `location`."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google AI Mode country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google AI Mode country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google AI Mode interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google AI Mode interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"references":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"index":{"type":"integer"},"title":{"type":"string"},"source":{"type":"string"},"snippet":{"type":"string"},"thumbnail":{"type":"string"},"source_icon":{"type":"string"}}}},"text_blocks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"snippet":{"type":"string"}}}},"shopping_results":{"type":"array","items":{}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"engine":{"type":"string"}}},"reconstructed_markdown":{"type":"string"}}},"examples":{"AI Mode 'what is mozilla firefox'. US/English":{"value":{"references":[{"link":"https://www.mozilla.org/firefox/","index":0,"title":"Firefox Browser","source":"mozilla.org","snippet":"Official Firefox download and overview.","thumbnail":"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcFirefoxThumb","source_icon":"https://www.google.com/s2/favicons?domain=mozilla.org&sz=128"},{"link":"https://en.wikipedia.org/wiki/Firefox","index":1,"title":"Firefox - Wikipedia","source":"en.wikipedia.org"}],"text_blocks":[{"type":"paragraph","snippet":"Mozilla Firefox is a free, open-source web browser developed by the Mozilla Foundation. It is available on desktop and mobile, supports extensions, and focuses on privacy controls such as Enhanced Tracking Protection."},{"type":"heading","level":3,"snippet":"Key features"},{"list":[{"title":"Open source","snippet":"Free and open-source, maintained by the Mozilla Foundation.","snippet_links":[{"link":"https://www.mozilla.org/","text":"Mozilla Foundation"}],"reference_indexes":[0]},{"snippet":"Available on desktop and mobile platforms."},{"snippet":"Enhanced Tracking Protection to limit cross-site tracking."}],"type":"list"}],"shopping_results":[],"search_parameters":{"q":"what is mozilla firefox","gl":"us","hl":"en","engine":"google_ai_mode"},"reconstructed_markdown":"Mozilla Firefox is a free, open-source web browser developed by the Mozilla Foundation. It is available on desktop and mobile, supports extensions, and focuses on privacy controls such as Enhanced Tracking Protection.\n\n### Key features\n\n- Free and open-source, maintained by the Mozilla Foundation.\n- Available on desktop and mobile platforms.\n- Enhanced Tracking Protection to limit cross-site tracking."}},"AI Mode 'meilleure machine espresso 2026'. Paris/French":{"value":{"references":[{"link":"https://www.example.com/espresso-2026","index":0,"title":"Guide machines espresso","source":"example.com"}],"text_blocks":[{"type":"paragraph","snippet":"Les machines espresso les plus citées en 2026 mélangent modèles super-automatiques et machines à levier pour un usage quotidien. Les critères récurrents sont la stabilité thermique, la facilité d'entretien et le rapport qualité-prix."}],"shopping_results":[],"search_parameters":{"q":"meilleure machine espresso 2026","gl":"fr","hl":"fr","engine":"google_ai_mode","location":"Paris, France"},"reconstructed_markdown":"Les machines espresso les plus citées en 2026 mélangent modèles super-automatiques et machines à levier pour un usage quotidien. Les critères récurrents sont la stabilité thermique, la facilité d'entretien et le rapport qualité-prix."}},"AI Mode 'antoine'. US/English":{"value":{"references":[],"text_blocks":[{"type":"paragraph","snippet":"It looks like your message was just a single name. Depending on what you're looking for, Antoine can refer to a few different things:"},{"type":"paragraph","snippet":"Could you tell me which Antoine you are looking for or what specific information you need?"}],"shopping_results":[],"search_parameters":{"q":"antoine","gl":"us","hl":"en","engine":"google_ai_mode"},"reconstructed_markdown":"It looks like your message was just a single name. Depending on what you're looking for, Antoine can refer to a few different things:\n\nCould you tell me which Antoine you are looking for or what specific information you need?"}},"No AI Mode answer":{"value":{"error":"Google hasn't returned an AI Mode answer for this query.","references":[],"text_blocks":[],"shopping_results":[],"search_parameters":{"q":"xyzzyplugh undeliverable query","gl":"us","hl":"en","engine":"google_ai_mode"}}},"AI Mode 'best noise cancelling headphones 2026'. US/English":{"value":{"references":[{"link":"https://www.google.com","index":0,"title":"Bose QuietComfort Ultra Wireless Headphones","source":"Google","snippet":"Bose QuietComfort Ultra Headphones 2nd Gen deliver personalized sound with CustomTune that adapts to your ears for a premium liste...","thumbnail":"https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcTgnGBPjPkitJyM9rsKloenNol_0MQxwOwQ_zguvFfxiSEodDWIjdPUIWEZymcgpE_YVoOluaR75vPHIdI","source_icon":"https://encrypted-tbn1.gstatic.com/faviconV2?url=https://www.google.com&client=AIM&size=128&type=FAVICON&fallback_opts=TYPE,SIZE,URL"}],"text_blocks":[{"type":"paragraph","snippet":"The landscape for active noise-cancelling (ANC) over-ear headphones features standout heavyweights delivering top-tier isolation, rich sound profiles, and all-day comfort."},{"type":"paragraph","snippet":"Here are the top picks for the best noise-cancelling headphones:"},{"list":[{"snippet":"Bose QuietComfort Ultra Headphones (2nd Gen): Widely considered the gold standard for pure silence. The CustomTune technology auto-calibrates ANC and sound performance to your specific ear shape. It features class-leading \"Quiet Mode\" and spatialized Bose Immersive Audio, alongside a comfortable build and up to 30 hours of battery life (about 23–24 hours with immersive audio enabled). Check options and pricing directly on the Bose Store.","shopping_result":{"title":"Bose QuietComfort Ultra Wireless Headphones","source":"Google","thumbnail":"https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcTgnGBPjPkitJyM9rsKloenNol_0MQxwOwQ_zguvFfxiSEodDWIjdPUIWEZymcgpE_YVoOluaR75vPHIdI","product_link":"https://www.google.com/search?q=product&prds=pvt:hg,productid:13548375814046357679,catalogid:5935180288566721863,gpcid:3222417658520627649,mid:576462841335551667&ibp=oshop"},"reference_indexes":[0]}],"type":"list"}],"shopping_results":[{"index":0,"title":"Bose QuietComfort Ultra Wireless Headphones","source":"Google","thumbnail":"https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcTgnGBPjPkitJyM9rsKloenNol_0MQxwOwQ_zguvFfxiSEodDWIjdPUIWEZymcgpE_YVoOluaR75vPHIdI","product_link":"https://www.google.com/search?q=product&prds=pvt:hg,productid:13548375814046357679,catalogid:5935180288566721863,gpcid:3222417658520627649,mid:576462841335551667&ibp=oshop"},{"index":1,"title":"Sony WH-1000XM6 Wireless Noise Canceling Headphones","source":"Google","thumbnail":"https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcT2uMw-0SbIbDoJEVqb8ywtZFPemCDzpob9t9YeaabiUq-n-LGmmge3rKJx0Rs7D8jrvqzHWXTJ0lHrmf0","product_link":"https://www.google.com/search?q=product&prds=pvt:hg,productid:6627216456244837110,catalogid:530011814861709152,gpcid:16337411903393755079,mid:576462827077625129&ibp=oshop"}],"search_parameters":{"q":"best noise cancelling headphones 2026","gl":"us","hl":"en","engine":"google_ai_mode"},"reconstructed_markdown":"The landscape for active noise-cancelling (ANC) over-ear headphones features standout heavyweights delivering top-tier isolation, rich sound profiles, and all-day comfort."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google AI Mode","description":"Scrape real-time Google AI Mode answers: text_blocks, references, and shopping_results.\n\n**Credit cost:** 3 credits per call","operationId":"post-google-search-ai","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The question or search query to send to Google AI Mode. Natural-language questions work best; advanced operators are also accepted.\n\n**Examples:**\n- `what is mozilla firefox`: factual overview\n- `best espresso machine 2026`: comparison-style answer\n- `site:mozilla.org firefox privacy`: restrict cited sources\n\n**Example:**\n\n    what is mozilla firefox","schema":{"type":"string","description":"The question or search query to send to Google AI Mode. Natural-language questions work best; advanced operators are also accepted.\n\n**Examples:**\n- `what is mozilla firefox`: factual overview\n- `best espresso machine 2026`: comparison-style answer\n- `site:mozilla.org firefox privacy`: restrict cited sources\n\n**Example:**\n\n    what is mozilla firefox"}},{"name":"location","in":"query","required":false,"description":"City or region from which the AI Mode search should originate. Simulates a real user searching from that location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```","schema":{"type":"string","description":"City or region from which the AI Mode search should originate. Simulates a real user searching from that location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting. Mutually exclusive with `location`.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting. Mutually exclusive with `location`."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google AI Mode country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google AI Mode country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google AI Mode interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google AI Mode interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"references":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"index":{"type":"integer"},"title":{"type":"string"},"source":{"type":"string"},"snippet":{"type":"string"},"thumbnail":{"type":"string"},"source_icon":{"type":"string"}}}},"text_blocks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"snippet":{"type":"string"}}}},"shopping_results":{"type":"array","items":{}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"engine":{"type":"string"}}},"reconstructed_markdown":{"type":"string"}}},"examples":{"AI Mode 'what is mozilla firefox'. US/English":{"value":{"references":[{"link":"https://www.mozilla.org/firefox/","index":0,"title":"Firefox Browser","source":"mozilla.org","snippet":"Official Firefox download and overview.","thumbnail":"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcFirefoxThumb","source_icon":"https://www.google.com/s2/favicons?domain=mozilla.org&sz=128"},{"link":"https://en.wikipedia.org/wiki/Firefox","index":1,"title":"Firefox - Wikipedia","source":"en.wikipedia.org"}],"text_blocks":[{"type":"paragraph","snippet":"Mozilla Firefox is a free, open-source web browser developed by the Mozilla Foundation. It is available on desktop and mobile, supports extensions, and focuses on privacy controls such as Enhanced Tracking Protection."},{"type":"heading","level":3,"snippet":"Key features"},{"list":[{"title":"Open source","snippet":"Free and open-source, maintained by the Mozilla Foundation.","snippet_links":[{"link":"https://www.mozilla.org/","text":"Mozilla Foundation"}],"reference_indexes":[0]},{"snippet":"Available on desktop and mobile platforms."},{"snippet":"Enhanced Tracking Protection to limit cross-site tracking."}],"type":"list"}],"shopping_results":[],"search_parameters":{"q":"what is mozilla firefox","gl":"us","hl":"en","engine":"google_ai_mode"},"reconstructed_markdown":"Mozilla Firefox is a free, open-source web browser developed by the Mozilla Foundation. It is available on desktop and mobile, supports extensions, and focuses on privacy controls such as Enhanced Tracking Protection.\n\n### Key features\n\n- Free and open-source, maintained by the Mozilla Foundation.\n- Available on desktop and mobile platforms.\n- Enhanced Tracking Protection to limit cross-site tracking."}},"AI Mode 'meilleure machine espresso 2026'. Paris/French":{"value":{"references":[{"link":"https://www.example.com/espresso-2026","index":0,"title":"Guide machines espresso","source":"example.com"}],"text_blocks":[{"type":"paragraph","snippet":"Les machines espresso les plus citées en 2026 mélangent modèles super-automatiques et machines à levier pour un usage quotidien. Les critères récurrents sont la stabilité thermique, la facilité d'entretien et le rapport qualité-prix."}],"shopping_results":[],"search_parameters":{"q":"meilleure machine espresso 2026","gl":"fr","hl":"fr","engine":"google_ai_mode","location":"Paris, France"},"reconstructed_markdown":"Les machines espresso les plus citées en 2026 mélangent modèles super-automatiques et machines à levier pour un usage quotidien. Les critères récurrents sont la stabilité thermique, la facilité d'entretien et le rapport qualité-prix."}},"AI Mode 'antoine'. US/English":{"value":{"references":[],"text_blocks":[{"type":"paragraph","snippet":"It looks like your message was just a single name. Depending on what you're looking for, Antoine can refer to a few different things:"},{"type":"paragraph","snippet":"Could you tell me which Antoine you are looking for or what specific information you need?"}],"shopping_results":[],"search_parameters":{"q":"antoine","gl":"us","hl":"en","engine":"google_ai_mode"},"reconstructed_markdown":"It looks like your message was just a single name. Depending on what you're looking for, Antoine can refer to a few different things:\n\nCould you tell me which Antoine you are looking for or what specific information you need?"}},"No AI Mode answer":{"value":{"error":"Google hasn't returned an AI Mode answer for this query.","references":[],"text_blocks":[],"shopping_results":[],"search_parameters":{"q":"xyzzyplugh undeliverable query","gl":"us","hl":"en","engine":"google_ai_mode"}}},"AI Mode 'best noise cancelling headphones 2026'. US/English":{"value":{"references":[{"link":"https://www.google.com","index":0,"title":"Bose QuietComfort Ultra Wireless Headphones","source":"Google","snippet":"Bose QuietComfort Ultra Headphones 2nd Gen deliver personalized sound with CustomTune that adapts to your ears for a premium liste...","thumbnail":"https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcTgnGBPjPkitJyM9rsKloenNol_0MQxwOwQ_zguvFfxiSEodDWIjdPUIWEZymcgpE_YVoOluaR75vPHIdI","source_icon":"https://encrypted-tbn1.gstatic.com/faviconV2?url=https://www.google.com&client=AIM&size=128&type=FAVICON&fallback_opts=TYPE,SIZE,URL"}],"text_blocks":[{"type":"paragraph","snippet":"The landscape for active noise-cancelling (ANC) over-ear headphones features standout heavyweights delivering top-tier isolation, rich sound profiles, and all-day comfort."},{"type":"paragraph","snippet":"Here are the top picks for the best noise-cancelling headphones:"},{"list":[{"snippet":"Bose QuietComfort Ultra Headphones (2nd Gen): Widely considered the gold standard for pure silence. The CustomTune technology auto-calibrates ANC and sound performance to your specific ear shape. It features class-leading \"Quiet Mode\" and spatialized Bose Immersive Audio, alongside a comfortable build and up to 30 hours of battery life (about 23–24 hours with immersive audio enabled). Check options and pricing directly on the Bose Store.","shopping_result":{"title":"Bose QuietComfort Ultra Wireless Headphones","source":"Google","thumbnail":"https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcTgnGBPjPkitJyM9rsKloenNol_0MQxwOwQ_zguvFfxiSEodDWIjdPUIWEZymcgpE_YVoOluaR75vPHIdI","product_link":"https://www.google.com/search?q=product&prds=pvt:hg,productid:13548375814046357679,catalogid:5935180288566721863,gpcid:3222417658520627649,mid:576462841335551667&ibp=oshop"},"reference_indexes":[0]}],"type":"list"}],"shopping_results":[{"index":0,"title":"Bose QuietComfort Ultra Wireless Headphones","source":"Google","thumbnail":"https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcTgnGBPjPkitJyM9rsKloenNol_0MQxwOwQ_zguvFfxiSEodDWIjdPUIWEZymcgpE_YVoOluaR75vPHIdI","product_link":"https://www.google.com/search?q=product&prds=pvt:hg,productid:13548375814046357679,catalogid:5935180288566721863,gpcid:3222417658520627649,mid:576462841335551667&ibp=oshop"},{"index":1,"title":"Sony WH-1000XM6 Wireless Noise Canceling Headphones","source":"Google","thumbnail":"https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcT2uMw-0SbIbDoJEVqb8ywtZFPemCDzpob9t9YeaabiUq-n-LGmmge3rKJx0Rs7D8jrvqzHWXTJ0lHrmf0","product_link":"https://www.google.com/search?q=product&prds=pvt:hg,productid:6627216456244837110,catalogid:530011814861709152,gpcid:16337411903393755079,mid:576462827077625129&ibp=oshop"}],"search_parameters":{"q":"best noise cancelling headphones 2026","gl":"us","hl":"en","engine":"google_ai_mode"},"reconstructed_markdown":"The landscape for active noise-cancelling (ANC) over-ear headphones features standout heavyweights delivering top-tier isolation, rich sound profiles, and all-day comfort."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/idealo/search":{"get":{"summary":"Idealo Search","description":"Search Idealo Spain, France, and Germany. Keyword or search URL. Prices, shipping, ratings, and pagination via WebUnlocker (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"get-idealo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Idealo search URL for Spain, France, or Germany.\n\n**Example 1 (Spain keyword):**\n\n    maison\n\n**Example 2 (France URL):**\n\n    https://www.idealo.fr/prechcat.html?q=asics\n\n**Example 3 (Germany URL):**\n\n    https://www.idealo.de/preisvergleich/MainSearchProductCategory.html?q=asics\n\n**Notes:**\n- Keywords need `country` (`es` default, `fr`, `de`).\n- A full search URL is used as-is. Add `page` or `?page=2` to paginate.\n- France uses `/prechcat.html`, not `/resultats.html`.","schema":{"type":"string","description":"Keyword or full Idealo search URL for Spain, France, or Germany.\n\n**Example 1 (Spain keyword):**\n\n    maison\n\n**Example 2 (France URL):**\n\n    https://www.idealo.fr/prechcat.html?q=asics\n\n**Example 3 (Germany URL):**\n\n    https://www.idealo.de/preisvergleich/MainSearchProductCategory.html?q=asics\n\n**Notes:**\n- Keywords need `country` (`es` default, `fr`, `de`).\n- A full search URL is used as-is. Add `page` or `?page=2` to paginate.\n- France uses `/prechcat.html`, not `/resultats.html`."}},{"name":"country","in":"query","required":false,"description":"Region when `query` is a keyword.\n\n- `es`: idealo.es (default)\n- `fr`: idealo.fr\n- `de`: idealo.de\n\nIgnored when `query` is already a URL. Other values return `400`.","schema":{"type":"string","description":"Region when `query` is a keyword.\n\n- `es`: idealo.es (default)\n- `fr`: idealo.fr\n- `de`: idealo.de\n\nIgnored when `query` is already a URL. Other values return `400`."}},{"name":"page","in":"query","required":false,"description":"Search page. `2` appends `?page=2`.\n\n**Example:**\n\n    2","schema":{"type":"number","description":"Search page. `2` appends `?page=2`.\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"shipping":{"type":"number"},"shop_name":{"type":"string"},"category_id":{"type":"string"},"offer_count":{"type":"integer"},"review_count":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search maison on idealo.es":{"value":{"results":[{"id":"200139376","url":"https://www.idealo.es/precios/200139376/maison-margiela-replica-jazz-club-eau-de-toilette.html","image":"https://cdn.idealo.com/folder/Product/200139/3/200139376/s11_produktbild_mittelgross/maison-margiela-replica-jazz-club-eau-de-toilette.jpg","price":25.5,"title":"Maison Margiela Replica Jazz Club Eau de Toilette","rating":4.5,"currency":"EUR","shipping":3.95,"shop_name":"notino.es","category_id":"16252","offer_count":26,"review_count":158,"characteristics":["Eau de Toilette unisex","cuero","2013"]},{"id":"201140705","url":"https://www.idealo.es/precios/201140705/maison-margiela-replica-by-the-fireplace-eau-de-toilette.html","image":"https://cdn.idealo.com/folder/Product/201140/7/201140705/s11_produktbild_mittelgross/maison-margiela-replica-by-the-fireplace-eau-de-toilette.jpg","price":22.79,"title":"Maison Margiela Replica By the Fireplace Eau de Toilette","rating":4.5,"currency":"EUR","shipping":4.95,"shop_name":"deloox.es","category_id":"16252","offer_count":20,"review_count":11,"characteristics":["Eau de Toilette unisex","amaderado","2015","Perfumista Marie Salamagne"]}],"pagination":{"next":"https://www.idealo.es/resultados.html?q=maison&page=2","page":1,"per_page":60,"total_pages":23,"total_results":1370}}},"Search asics on idealo.fr":{"value":{"results":[{"id":"209538024","url":"https://www.idealo.fr/prix/209538024/asics-superblast-3-1013a177.html","image":"https://cdn.idealo.com/folder/Product/209538/0/209538024/s4_produktbild_mittelgross/asics-superblast-3-1013a177.jpg","price":169.99,"title":"Asics Superblast 3 (1013A177)","rating":5,"currency":"EUR","shipping":0,"shop_name":"noirfonce.fr","category_id":"22875","offer_count":379,"review_count":2,"characteristics":["Chaussures running amorti","Unisexe","Mesh","Entraînement","Supinateur","Drop 8 mm"]},{"id":"211349009","url":"https://www.idealo.fr/prix/211349009/asics-novablast-6.html","image":"https://cdn.idealo.com/folder/Product/211349/0/211349009/s4_produktbild_mittelgross/asics-novablast-6.jpg","price":126.95,"title":"Asics Novablast 6","rating":5,"currency":"EUR","shipping":0,"shop_name":"Running-Point.fr","category_id":"22875","offer_count":1259,"review_count":null,"characteristics":["Chaussures running légères","Homme","Textile","Entraînement","Foulée universelle","Drop 8 mm","Homme"]}],"pagination":{"next":"https://www.idealo.fr/prechcat.html?q=asics&page=2","page":1,"per_page":36,"total_pages":150,"total_results":5394}}},"Search asics on idealo.de":{"value":{"results":[{"id":"202763575","url":"https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html","image":"https://cdn.idealo.com/folder/Product/202763/5/202763575/s1_produktbild_mittelgross/asics-gel-nyc-1201a789.jpg","price":95,"title":"Asics Gel-NYC (1201A789)","rating":4.5,"currency":"EUR","shipping":4.99,"shop_name":"footlocker.de","category_id":"18817","offer_count":733,"review_count":27,"characteristics":["Low-Top-Sneaker","Asics GEL-NYC","Mesh","Herren"]},{"id":"208714682","url":"https://www.idealo.de/preisvergleich/OffersOfProduct/208714682_-gel-nimbus-28-asics.html","image":"https://cdn.idealo.com/folder/Product/208714/6/208714682/s1_produktbild_mittelgross/asics-gel-nimbus-28.jpg","price":120,"title":"Asics Gel-Nimbus 28","rating":5,"currency":"EUR","shipping":0,"shop_name":"nencinisport.it/de","category_id":"22875","offer_count":2086,"review_count":5,"characteristics":["Dämpfungsschuhe","Herren","Textil","Einsatzbereich im Stadion","Neutral","Sprengung 8 mm"]}],"pagination":{"next":"https://www.idealo.de/preisvergleich/MainSearchProductCategory.html?q=asics&page=2","page":1,"per_page":36,"total_pages":209,"total_results":7524}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Idealo Search","description":"Search Idealo Spain, France, and Germany. Keyword or search URL. Prices, shipping, ratings, and pagination via WebUnlocker (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"post-idealo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Idealo search URL for Spain, France, or Germany.\n\n**Example 1 (Spain keyword):**\n\n    maison\n\n**Example 2 (France URL):**\n\n    https://www.idealo.fr/prechcat.html?q=asics\n\n**Example 3 (Germany URL):**\n\n    https://www.idealo.de/preisvergleich/MainSearchProductCategory.html?q=asics\n\n**Notes:**\n- Keywords need `country` (`es` default, `fr`, `de`).\n- A full search URL is used as-is. Add `page` or `?page=2` to paginate.\n- France uses `/prechcat.html`, not `/resultats.html`.","schema":{"type":"string","description":"Keyword or full Idealo search URL for Spain, France, or Germany.\n\n**Example 1 (Spain keyword):**\n\n    maison\n\n**Example 2 (France URL):**\n\n    https://www.idealo.fr/prechcat.html?q=asics\n\n**Example 3 (Germany URL):**\n\n    https://www.idealo.de/preisvergleich/MainSearchProductCategory.html?q=asics\n\n**Notes:**\n- Keywords need `country` (`es` default, `fr`, `de`).\n- A full search URL is used as-is. Add `page` or `?page=2` to paginate.\n- France uses `/prechcat.html`, not `/resultats.html`."}},{"name":"country","in":"query","required":false,"description":"Region when `query` is a keyword.\n\n- `es`: idealo.es (default)\n- `fr`: idealo.fr\n- `de`: idealo.de\n\nIgnored when `query` is already a URL. Other values return `400`.","schema":{"type":"string","description":"Region when `query` is a keyword.\n\n- `es`: idealo.es (default)\n- `fr`: idealo.fr\n- `de`: idealo.de\n\nIgnored when `query` is already a URL. Other values return `400`."}},{"name":"page","in":"query","required":false,"description":"Search page. `2` appends `?page=2`.\n\n**Example:**\n\n    2","schema":{"type":"number","description":"Search page. `2` appends `?page=2`.\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"shipping":{"type":"number"},"shop_name":{"type":"string"},"category_id":{"type":"string"},"offer_count":{"type":"integer"},"review_count":{"type":"integer"},"characteristics":{"type":"array","items":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search maison on idealo.es":{"value":{"results":[{"id":"200139376","url":"https://www.idealo.es/precios/200139376/maison-margiela-replica-jazz-club-eau-de-toilette.html","image":"https://cdn.idealo.com/folder/Product/200139/3/200139376/s11_produktbild_mittelgross/maison-margiela-replica-jazz-club-eau-de-toilette.jpg","price":25.5,"title":"Maison Margiela Replica Jazz Club Eau de Toilette","rating":4.5,"currency":"EUR","shipping":3.95,"shop_name":"notino.es","category_id":"16252","offer_count":26,"review_count":158,"characteristics":["Eau de Toilette unisex","cuero","2013"]},{"id":"201140705","url":"https://www.idealo.es/precios/201140705/maison-margiela-replica-by-the-fireplace-eau-de-toilette.html","image":"https://cdn.idealo.com/folder/Product/201140/7/201140705/s11_produktbild_mittelgross/maison-margiela-replica-by-the-fireplace-eau-de-toilette.jpg","price":22.79,"title":"Maison Margiela Replica By the Fireplace Eau de Toilette","rating":4.5,"currency":"EUR","shipping":4.95,"shop_name":"deloox.es","category_id":"16252","offer_count":20,"review_count":11,"characteristics":["Eau de Toilette unisex","amaderado","2015","Perfumista Marie Salamagne"]}],"pagination":{"next":"https://www.idealo.es/resultados.html?q=maison&page=2","page":1,"per_page":60,"total_pages":23,"total_results":1370}}},"Search asics on idealo.fr":{"value":{"results":[{"id":"209538024","url":"https://www.idealo.fr/prix/209538024/asics-superblast-3-1013a177.html","image":"https://cdn.idealo.com/folder/Product/209538/0/209538024/s4_produktbild_mittelgross/asics-superblast-3-1013a177.jpg","price":169.99,"title":"Asics Superblast 3 (1013A177)","rating":5,"currency":"EUR","shipping":0,"shop_name":"noirfonce.fr","category_id":"22875","offer_count":379,"review_count":2,"characteristics":["Chaussures running amorti","Unisexe","Mesh","Entraînement","Supinateur","Drop 8 mm"]},{"id":"211349009","url":"https://www.idealo.fr/prix/211349009/asics-novablast-6.html","image":"https://cdn.idealo.com/folder/Product/211349/0/211349009/s4_produktbild_mittelgross/asics-novablast-6.jpg","price":126.95,"title":"Asics Novablast 6","rating":5,"currency":"EUR","shipping":0,"shop_name":"Running-Point.fr","category_id":"22875","offer_count":1259,"review_count":null,"characteristics":["Chaussures running légères","Homme","Textile","Entraînement","Foulée universelle","Drop 8 mm","Homme"]}],"pagination":{"next":"https://www.idealo.fr/prechcat.html?q=asics&page=2","page":1,"per_page":36,"total_pages":150,"total_results":5394}}},"Search asics on idealo.de":{"value":{"results":[{"id":"202763575","url":"https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html","image":"https://cdn.idealo.com/folder/Product/202763/5/202763575/s1_produktbild_mittelgross/asics-gel-nyc-1201a789.jpg","price":95,"title":"Asics Gel-NYC (1201A789)","rating":4.5,"currency":"EUR","shipping":4.99,"shop_name":"footlocker.de","category_id":"18817","offer_count":733,"review_count":27,"characteristics":["Low-Top-Sneaker","Asics GEL-NYC","Mesh","Herren"]},{"id":"208714682","url":"https://www.idealo.de/preisvergleich/OffersOfProduct/208714682_-gel-nimbus-28-asics.html","image":"https://cdn.idealo.com/folder/Product/208714/6/208714682/s1_produktbild_mittelgross/asics-gel-nimbus-28.jpg","price":120,"title":"Asics Gel-Nimbus 28","rating":5,"currency":"EUR","shipping":0,"shop_name":"nencinisport.it/de","category_id":"22875","offer_count":2086,"review_count":5,"characteristics":["Dämpfungsschuhe","Herren","Textil","Einsatzbereich im Stadion","Neutral","Sprengung 8 mm"]}],"pagination":{"next":"https://www.idealo.de/preisvergleich/MainSearchProductCategory.html?q=asics&page=2","page":1,"per_page":36,"total_pages":209,"total_results":7524}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/stats":{"get":{"summary":"Stats","description":"Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant. Enabled per account: HTTP 403 means contact support to activate it.","operationId":"stats","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"engine","in":"query","required":false,"description":"API family to check, for example `website`. Provide at least `engine` or `path`.","schema":{"type":"string","description":"API family to check, for example `website`. Provide at least `engine` or `path`."}},{"name":"path","in":"query","required":false,"description":"Specific endpoint to check, for example `/v2/website/crawler`. If you also pass `engine`, use an endpoint from that API.","schema":{"type":"string","description":"Specific endpoint to check, for example `/v2/website/crawler`. If you also pass `engine`, use an endpoint from that API."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"path":{"nullable":true},"engine":{"type":"string"},"health":{"type":"string"},"window":{"type":"string"},"success_rate":{"type":"number"},"avg_response_time_ms":{"type":"integer"}}},"examples":{"Engine health snapshot":{"value":{"path":null,"engine":"website","health":"operational","window":"1h","success_rate":99.412,"avg_response_time_ms":840}},"Path health snapshot":{"value":{"path":"/v2/website/crawler","engine":"website","health":"operational","window":"1h","success_rate":99.412,"avg_response_time_ms":840}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aliexpress/store/product":{"get":{"summary":"AliExpress Store Product","description":"AliExpress Store Product API: list products from an AliExpress seller store by URL or store ID. Returns store metadata and product cards (~40 SSR items) as JSON via browser rendering. Pagination is not supported.\n\n**Credit cost:** 2 credits per call","operationId":"get-aliexpress-store-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"AliExpress store URL or numeric store ID.\n\n**Example (store URL):**\n\n    https://www.aliexpress.com/store/1101705614\n\n**Example (all-items page URL):**\n\n    https://www.aliexpress.com/store/1101705614/pages/all-items.html\n\n**Example (store ID only):**\n\n    1101705614\n\n**Notes:**\n- Pass a `/store/{id}` URL, an all-items page URL, or the numeric store ID.\n- Search URLs and product URLs are rejected (400).\n- Returns up to ~40 store products from the SSR all-items page (AliExpress store pagination is JavaScript-only and is not supported).\n- Use each result `listing_url` with **AliExpress Product** for full PDP data.","schema":{"type":"string","description":"AliExpress store URL or numeric store ID.\n\n**Example (store URL):**\n\n    https://www.aliexpress.com/store/1101705614\n\n**Example (all-items page URL):**\n\n    https://www.aliexpress.com/store/1101705614/pages/all-items.html\n\n**Example (store ID only):**\n\n    1101705614\n\n**Notes:**\n- Pass a `/store/{id}` URL, an all-items page URL, or the numeric store ID.\n- Search URLs and product URLs are rejected (400).\n- Returns up to ~40 store products from the SSR all-items page (AliExpress store pagination is JavaScript-only and is not supported).\n- Use each result `listing_url` with **AliExpress Product** for full PDP data."}},{"name":"sort","in":"query","required":false,"description":"Optional sort alias for the store all-items page.\n\n**Accepted values:** `default`, `bestmatch`, `orders`, `new`, `price`\n\nMaps to AliExpress `shop_sortType` query params (e.g. `orders` → `orders_sort`).","schema":{"type":"string","description":"Optional sort alias for the store all-items page.\n\n**Accepted values:** `default`, `bestmatch`, `orders`, `new`, `price`\n\nMaps to AliExpress `shop_sortType` query params (e.g. `orders` → `orders_sort`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"sold_count":{"type":"integer"},"listing_url":{"type":"string"}}}},"store_id":{"type":"string"},"seller_id":{"type":"string"},"store_name":{"type":"string"},"owner_member_id":{"type":"string"}}},"examples":{"Store 1101705614 all-items listing":{"value":{"results":[{"price":0.99,"title":"Car Phone Holder Magnetic Dashboard Mount","rating":4.8,"currency":"USD","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/Sexample1.jpg","product_id":"3256802427534863","sold_count":1200,"listing_url":"https://www.aliexpress.com/item/3256802427534863.html"},{"price":8.39,"title":"Universal Car Air Vent Phone Mount Stand","rating":4.5,"currency":"USD","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/Sexample2.jpg","product_id":"1005008808856805","sold_count":800,"listing_url":"https://www.aliexpress.com/item/1005008808856805.html"}],"store_id":"1101705614","seller_id":"911768809","store_name":"Nunua Car Car Store","owner_member_id":"251242175"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"AliExpress Store Product","description":"AliExpress Store Product API: list products from an AliExpress seller store by URL or store ID. Returns store metadata and product cards (~40 SSR items) as JSON via browser rendering. Pagination is not supported.\n\n**Credit cost:** 2 credits per call","operationId":"post-aliexpress-store-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"AliExpress store URL or numeric store ID.\n\n**Example (store URL):**\n\n    https://www.aliexpress.com/store/1101705614\n\n**Example (all-items page URL):**\n\n    https://www.aliexpress.com/store/1101705614/pages/all-items.html\n\n**Example (store ID only):**\n\n    1101705614\n\n**Notes:**\n- Pass a `/store/{id}` URL, an all-items page URL, or the numeric store ID.\n- Search URLs and product URLs are rejected (400).\n- Returns up to ~40 store products from the SSR all-items page (AliExpress store pagination is JavaScript-only and is not supported).\n- Use each result `listing_url` with **AliExpress Product** for full PDP data.","schema":{"type":"string","description":"AliExpress store URL or numeric store ID.\n\n**Example (store URL):**\n\n    https://www.aliexpress.com/store/1101705614\n\n**Example (all-items page URL):**\n\n    https://www.aliexpress.com/store/1101705614/pages/all-items.html\n\n**Example (store ID only):**\n\n    1101705614\n\n**Notes:**\n- Pass a `/store/{id}` URL, an all-items page URL, or the numeric store ID.\n- Search URLs and product URLs are rejected (400).\n- Returns up to ~40 store products from the SSR all-items page (AliExpress store pagination is JavaScript-only and is not supported).\n- Use each result `listing_url` with **AliExpress Product** for full PDP data."}},{"name":"sort","in":"query","required":false,"description":"Optional sort alias for the store all-items page.\n\n**Accepted values:** `default`, `bestmatch`, `orders`, `new`, `price`\n\nMaps to AliExpress `shop_sortType` query params (e.g. `orders` → `orders_sort`).","schema":{"type":"string","description":"Optional sort alias for the store all-items page.\n\n**Accepted values:** `default`, `bestmatch`, `orders`, `new`, `price`\n\nMaps to AliExpress `shop_sortType` query params (e.g. `orders` → `orders_sort`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"sold_count":{"type":"integer"},"listing_url":{"type":"string"}}}},"store_id":{"type":"string"},"seller_id":{"type":"string"},"store_name":{"type":"string"},"owner_member_id":{"type":"string"}}},"examples":{"Store 1101705614 all-items listing":{"value":{"results":[{"price":0.99,"title":"Car Phone Holder Magnetic Dashboard Mount","rating":4.8,"currency":"USD","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/Sexample1.jpg","product_id":"3256802427534863","sold_count":1200,"listing_url":"https://www.aliexpress.com/item/3256802427534863.html"},{"price":8.39,"title":"Universal Car Air Vent Phone Mount Stand","rating":4.5,"currency":"USD","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/Sexample2.jpg","product_id":"1005008808856805","sold_count":800,"listing_url":"https://www.aliexpress.com/item/1005008808856805.html"}],"store_id":"1101705614","seller_id":"911768809","store_name":"Nunua Car Car Store","owner_member_id":"251242175"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/elcorteingles/product":{"get":{"summary":"El Corte Inglés Product","description":"El Corte Inglés Product API. Fetch a full product page from elcorteingles.es by URL or product id. Returns pricing, stock, images and identifiers via browser rendering.\n\n**Credit cost:** 3 credits per call","operationId":"get-elcorteingles-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or product id (`A…` / `MP_…`).\n\n**Examples:**\n\n```\nA200910175\n```\n\n```\nhttps://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/\n```","schema":{"type":"string","description":"Product URL or product id (`A…` / `MP_…`).\n\n**Examples:**\n\n```\nA200910175\n```\n\n```\nhttps://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"availability":{"type":"string"},"discount_percentage":{"type":"integer"}}},"examples":{"EL MUNDO MARINO Nivel 3 (A200910175)":{"value":{"url":"https://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/","brand":"VARIOS AUTORES","price":25.93,"title":"EL MUNDO MARINO. NIVEL 3  (Tapa blanda)","currency":"EUR","in_stock":true,"image_url":"https://dam.elcorteingles.es/producto/www-001025505053840-00.jpg","old_price":27.3,"product_id":"A200910175","availability":"in_stock","discount_percentage":5}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"El Corte Inglés Product","description":"El Corte Inglés Product API. Fetch a full product page from elcorteingles.es by URL or product id. Returns pricing, stock, images and identifiers via browser rendering.\n\n**Credit cost:** 3 credits per call","operationId":"post-elcorteingles-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product URL or product id (`A…` / `MP_…`).\n\n**Examples:**\n\n```\nA200910175\n```\n\n```\nhttps://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/\n```","schema":{"type":"string","description":"Product URL or product id (`A…` / `MP_…`).\n\n**Examples:**\n\n```\nA200910175\n```\n\n```\nhttps://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"availability":{"type":"string"},"discount_percentage":{"type":"integer"}}},"examples":{"EL MUNDO MARINO Nivel 3 (A200910175)":{"value":{"url":"https://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/","brand":"VARIOS AUTORES","price":25.93,"title":"EL MUNDO MARINO. NIVEL 3  (Tapa blanda)","currency":"EUR","in_stock":true,"image_url":"https://dam.elcorteingles.es/producto/www-001025505053840-00.jpg","old_price":27.3,"product_id":"A200910175","availability":"in_stock","discount_percentage":5}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/elcorteingles/search":{"get":{"summary":"El Corte Inglés Search","description":"El Corte Inglés Search API. Search product listings on elcorteingles.es by keyword or URL. Returns prices, brands, images and pagination via webunlocker.\n\n**Credit cost:** 3 credits per call","operationId":"get-elcorteingles-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full El Corte Inglés search URL.\n\n**Examples:**\n\n```\nmarino\n```\n\n```\nhttps://www.elcorteingles.es/search-nwx/?s=marino&stype=text_box\n```\n\nUse **El Corte Inglés Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full El Corte Inglés search URL.\n\n**Examples:**\n\n```\nmarino\n```\n\n```\nhttps://www.elcorteingles.es/search-nwx/?s=marino&stype=text_box\n```\n\nUse **El Corte Inglés Product** on any result `url` or `product_id` for full PDP data."}},{"name":"page","in":"query","required":false,"description":"1-based page number. Overrides `/search-nwx/{page}/` when present in the URL (default: from URL or `1`).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number. Overrides `/search-nwx/{page}/` when present in the URL (default: from URL or `1`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"discount_percentage":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'marino' on elcorteingles.es":{"value":{"results":[{"url":"https://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/","brand":"VARIOS AUTORES","price":25.93,"title":"EL MUNDO MARINO. NIVEL 3  (Tapa blanda)","currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001025505053840-00.jpg","old_price":27.3,"product_id":"A200910175","discount_percentage":5},{"url":"https://www.elcorteingles.es/libros/A200910168-el-mundo-marino-nivel-1-tapa-blanda/","brand":"VARIOS AUTORES","price":25.93,"title":"EL MUNDO MARINO. NIVEL 1  (Tapa blanda)","currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001025505053774-00.jpg","old_price":27.3,"product_id":"A200910168","discount_percentage":5},{"url":"https://www.elcorteingles.es/moda-mujer/A56842226-azul-marino-pr-bralette-lift/","brand":"Tommy Hilfiger","color":"Azul marino","price":23,"title":"Bralette Lift Azul marino","images":["https://dam.elcorteingles.es/producto/www-001027908302584-00.jpg","https://dam.elcorteingles.es/producto/www-001027908302584-01.jpg","https://dam.elcorteingles.es/producto/www-001027908302584-02.jpg","https://dam.elcorteingles.es/producto/www-001027908302584-s0.jpg"],"currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001027908302584-00.jpg","old_price":47.9,"product_id":"A56842226","discount_percentage":52},{"url":"https://www.elcorteingles.es/parafarmacia/A15542120-8436601105844-pr-180-comprimidos-colageno-marino-collmar-drasanvi/","brand":"Drasanvi","price":11.35,"title":"180 Comprimidos Colágeno Marino Collmar Drasanvi","currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001026358100498-00.jpg","product_id":"A15542120"}],"pagination":{"next":"https://www.elcorteingles.es/search-nwx/2/?s=marino&stype=text_box","page":1,"per_page":12,"total_pages":1314,"total_results":15761}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"El Corte Inglés Search","description":"El Corte Inglés Search API. Search product listings on elcorteingles.es by keyword or URL. Returns prices, brands, images and pagination via webunlocker.\n\n**Credit cost:** 3 credits per call","operationId":"post-elcorteingles-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full El Corte Inglés search URL.\n\n**Examples:**\n\n```\nmarino\n```\n\n```\nhttps://www.elcorteingles.es/search-nwx/?s=marino&stype=text_box\n```\n\nUse **El Corte Inglés Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full El Corte Inglés search URL.\n\n**Examples:**\n\n```\nmarino\n```\n\n```\nhttps://www.elcorteingles.es/search-nwx/?s=marino&stype=text_box\n```\n\nUse **El Corte Inglés Product** on any result `url` or `product_id` for full PDP data."}},{"name":"page","in":"query","required":false,"description":"1-based page number. Overrides `/search-nwx/{page}/` when present in the URL (default: from URL or `1`).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number. Overrides `/search-nwx/{page}/` when present in the URL (default: from URL or `1`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"discount_percentage":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'marino' on elcorteingles.es":{"value":{"results":[{"url":"https://www.elcorteingles.es/libros/A200910175-el-mundo-marino-nivel-3-tapa-blanda/","brand":"VARIOS AUTORES","price":25.93,"title":"EL MUNDO MARINO. NIVEL 3  (Tapa blanda)","currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001025505053840-00.jpg","old_price":27.3,"product_id":"A200910175","discount_percentage":5},{"url":"https://www.elcorteingles.es/libros/A200910168-el-mundo-marino-nivel-1-tapa-blanda/","brand":"VARIOS AUTORES","price":25.93,"title":"EL MUNDO MARINO. NIVEL 1  (Tapa blanda)","currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001025505053774-00.jpg","old_price":27.3,"product_id":"A200910168","discount_percentage":5},{"url":"https://www.elcorteingles.es/moda-mujer/A56842226-azul-marino-pr-bralette-lift/","brand":"Tommy Hilfiger","color":"Azul marino","price":23,"title":"Bralette Lift Azul marino","images":["https://dam.elcorteingles.es/producto/www-001027908302584-00.jpg","https://dam.elcorteingles.es/producto/www-001027908302584-01.jpg","https://dam.elcorteingles.es/producto/www-001027908302584-02.jpg","https://dam.elcorteingles.es/producto/www-001027908302584-s0.jpg"],"currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001027908302584-00.jpg","old_price":47.9,"product_id":"A56842226","discount_percentage":52},{"url":"https://www.elcorteingles.es/parafarmacia/A15542120-8436601105844-pr-180-comprimidos-colageno-marino-collmar-drasanvi/","brand":"Drasanvi","price":11.35,"title":"180 Comprimidos Colágeno Marino Collmar Drasanvi","currency":"EUR","image_url":"https://dam.elcorteingles.es/producto/www-001026358100498-00.jpg","product_id":"A15542120"}],"pagination":{"next":"https://www.elcorteingles.es/search-nwx/2/?s=marino&stype=text_box","page":1,"per_page":12,"total_pages":1314,"total_results":15761}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/target/search":{"get":{"summary":"Target Search","description":"Search Target.com by keyword or search URL. Returns product cards with price, rating and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-target-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or Target search URL.\n\n**Examples:**\n\n```\nshampoo\n```\n\n```\nroot touch up hair dye\n```\n\n```\nhttps://www.target.com/s?searchTerm=shampoo\n```","schema":{"type":"string","description":"Keyword or Target search URL.\n\n**Examples:**\n\n```\nshampoo\n```\n\n```\nroot touch up hair dye\n```\n\n```\nhttps://www.target.com/s?searchTerm=shampoo\n```"}},{"name":"page","in":"query","required":false,"description":"Page number (1-based).","schema":{"type":"string","description":"Page number (1-based)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tcin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"sponsored":{"type":"boolean"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Root touch up hair dye":{"value":{"results":[{"url":"https://www.target.com/p/l-oreal-paris-magic-root-rescue-10-minute-root-hair-coloring-kit/-/A-54397299","name":"L'Oreal Paris Magic Root Rescue 10 Minute Root Hair Coloring Kit","tcin":"54397299","brand":"L'Oreal Paris","price":6.99,"rating":4,"currency":"USD","image_url":"https://target.scene7.com/is/image/Target/GUEST_c22ac354-59d7-4187-ab0b-8cd8a4707e07?qlt=65&fmt=webp&hei=350&wid=350","sponsored":true,"review_count":1525}],"pagination":{"next":"https://www.target.com/s?searchTerm=root+touch+up+hair+dye&Nao=24","page":1,"per_page":24,"total_pages":9,"total_results":201}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Target Search","description":"Search Target.com by keyword or search URL. Returns product cards with price, rating and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-target-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or Target search URL.\n\n**Examples:**\n\n```\nshampoo\n```\n\n```\nroot touch up hair dye\n```\n\n```\nhttps://www.target.com/s?searchTerm=shampoo\n```","schema":{"type":"string","description":"Keyword or Target search URL.\n\n**Examples:**\n\n```\nshampoo\n```\n\n```\nroot touch up hair dye\n```\n\n```\nhttps://www.target.com/s?searchTerm=shampoo\n```"}},{"name":"page","in":"query","required":false,"description":"Page number (1-based).","schema":{"type":"string","description":"Page number (1-based)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tcin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"sponsored":{"type":"boolean"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Root touch up hair dye":{"value":{"results":[{"url":"https://www.target.com/p/l-oreal-paris-magic-root-rescue-10-minute-root-hair-coloring-kit/-/A-54397299","name":"L'Oreal Paris Magic Root Rescue 10 Minute Root Hair Coloring Kit","tcin":"54397299","brand":"L'Oreal Paris","price":6.99,"rating":4,"currency":"USD","image_url":"https://target.scene7.com/is/image/Target/GUEST_c22ac354-59d7-4187-ab0b-8cd8a4707e07?qlt=65&fmt=webp&hei=350&wid=350","sponsored":true,"review_count":1525}],"pagination":{"next":"https://www.target.com/s?searchTerm=root+touch+up+hair+dye&Nao=24","page":1,"per_page":24,"total_pages":9,"total_results":201}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/target/product":{"get":{"summary":"Target Product","description":"Get a Target.com product page: price, description, images and variations via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-target-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Target product URL or bare TCIN.\n\n**Examples:**\n\n```\n17457624\n```\n\n```\nhttps://www.target.com/p/-/A-17457624\n```\n\n```\nhttps://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624\n```","schema":{"type":"string","description":"Target product URL or bare TCIN.\n\n**Examples:**\n\n```\n17457624\n```\n\n```\nhttps://www.target.com/p/-/A-17457624\n```\n\n```\nhttps://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"upc":{"type":"string"},"url":{"type":"string"},"dpci":{"type":"string"},"name":{"type":"string"},"tcin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"currency":{"type":"string"},"ornaments":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"type":"string"}},"variations":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tcin":{"type":"string"},"value":{"type":"string"},"selected":{"type":"boolean"}}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"ingredients":{"nullable":true},"review_count":{"type":"integer"},"bullet_descriptions":{"type":"array","items":{"type":"string"}}}},"examples":{"L'Oreal Magic Root Cover Up":{"value":{"upc":"071249318553","url":"https://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624","dpci":"063-01-0615","name":"L'Oreal Paris Magic Root Cover Up - Medium Brown - 2.0oz","tcin":"17457624","brand":"L'Oreal Paris","price":11.99,"images":["https://target.scene7.com/is/image/Target/GUEST_2947578e-fc62-4731-a22a-42211a91cbe5"],"rating":4.02,"currency":"USD","ornaments":["Rarely returned","Highly rated"],"highlights":["Conceals grays in seconds for flawless roots","Lightweight formula, no smudging or sticky residue"],"variations":[{"url":"https://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624","name":"Color","tcin":"17457624","value":"Medium Brown","selected":true},{"url":"https://www.target.com/p/l-oreal-paris-magic-root-cover-up-black-2-0oz/-/A-17457618","name":"Color","tcin":"17457618","value":"Black","selected":false}],"breadcrumbs":[{"url":"https://www.target.com/","name":"Target"},{"url":"https://www.target.com/c/beauty/-/N-55r1x","name":"Beauty"}],"description":"Temporary hair color spray to cover gray roots in seconds. Ammonia-free and sulfate-free.","ingredients":null,"review_count":7057,"bullet_descriptions":["Hair Type: All Hair Types","Product Form: Aerosol","Beauty Purpose: Hair Coloring"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Target Product","description":"Get a Target.com product page: price, description, images and variations via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-target-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Target product URL or bare TCIN.\n\n**Examples:**\n\n```\n17457624\n```\n\n```\nhttps://www.target.com/p/-/A-17457624\n```\n\n```\nhttps://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624\n```","schema":{"type":"string","description":"Target product URL or bare TCIN.\n\n**Examples:**\n\n```\n17457624\n```\n\n```\nhttps://www.target.com/p/-/A-17457624\n```\n\n```\nhttps://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"upc":{"type":"string"},"url":{"type":"string"},"dpci":{"type":"string"},"name":{"type":"string"},"tcin":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"currency":{"type":"string"},"ornaments":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"type":"string"}},"variations":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tcin":{"type":"string"},"value":{"type":"string"},"selected":{"type":"boolean"}}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"description":{"type":"string"},"ingredients":{"nullable":true},"review_count":{"type":"integer"},"bullet_descriptions":{"type":"array","items":{"type":"string"}}}},"examples":{"L'Oreal Magic Root Cover Up":{"value":{"upc":"071249318553","url":"https://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624","dpci":"063-01-0615","name":"L'Oreal Paris Magic Root Cover Up - Medium Brown - 2.0oz","tcin":"17457624","brand":"L'Oreal Paris","price":11.99,"images":["https://target.scene7.com/is/image/Target/GUEST_2947578e-fc62-4731-a22a-42211a91cbe5"],"rating":4.02,"currency":"USD","ornaments":["Rarely returned","Highly rated"],"highlights":["Conceals grays in seconds for flawless roots","Lightweight formula, no smudging or sticky residue"],"variations":[{"url":"https://www.target.com/p/l-oreal-paris-magic-root-cover-up-medium-brown-2-0oz/-/A-17457624","name":"Color","tcin":"17457624","value":"Medium Brown","selected":true},{"url":"https://www.target.com/p/l-oreal-paris-magic-root-cover-up-black-2-0oz/-/A-17457618","name":"Color","tcin":"17457618","value":"Black","selected":false}],"breadcrumbs":[{"url":"https://www.target.com/","name":"Target"},{"url":"https://www.target.com/c/beauty/-/N-55r1x","name":"Beauty"}],"description":"Temporary hair color spray to cover gray roots in seconds. Ammonia-free and sulfate-free.","ingredients":null,"review_count":7057,"bullet_descriptions":["Hair Type: All Hair Types","Product Form: Aerosol","Beauty Purpose: Hair Coloring"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/pitchbook/company/info":{"get":{"summary":"PitchBook Company Info","description":"Get a PitchBook company profile: overview, funding, competitors and more via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-pitchbook-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"PitchBook company id or company profile URL.\n\n**Examples:**\n\n```\n11062-99\n```\n\n```\nhttps://pitchbook.com/profiles/company/149504-14\n```","schema":{"type":"string","description":"PitchBook company id or company profile URL.\n\n**Examples:**\n\n```\n11062-99\n```\n\n```\nhttps://pitchbook.com/profiles/company/149504-14\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"website":{"type":"string"},"employees":{"type":"integer"},"company_id":{"type":"string"},"description":{"type":"string"},"stock_symbol":{"type":"string"},"year_founded":{"type":"integer"},"corporate_office":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"}}},"primary_industry":{"type":"string"}}},"examples":{"Airbus Group":{"value":{"url":"https://pitchbook.com/profiles/company/11062-99","name":"Airbus Group","status":"Public","website":"http://www.airbus.com","employees":166876,"company_id":"11062-99","description":"Airbus is a global aerospace and defense firm.","stock_symbol":"AIR","year_founded":1960,"corporate_office":{"city":"Leiden","country":"Netherlands"},"primary_industry":"Aerospace and Defense"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PitchBook Company Info","description":"Get a PitchBook company profile: overview, funding, competitors and more via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-pitchbook-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"PitchBook company id or company profile URL.\n\n**Examples:**\n\n```\n11062-99\n```\n\n```\nhttps://pitchbook.com/profiles/company/149504-14\n```","schema":{"type":"string","description":"PitchBook company id or company profile URL.\n\n**Examples:**\n\n```\n11062-99\n```\n\n```\nhttps://pitchbook.com/profiles/company/149504-14\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"website":{"type":"string"},"employees":{"type":"integer"},"company_id":{"type":"string"},"description":{"type":"string"},"stock_symbol":{"type":"string"},"year_founded":{"type":"integer"},"corporate_office":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"}}},"primary_industry":{"type":"string"}}},"examples":{"Airbus Group":{"value":{"url":"https://pitchbook.com/profiles/company/11062-99","name":"Airbus Group","status":"Public","website":"http://www.airbus.com","employees":166876,"company_id":"11062-99","description":"Airbus is a global aerospace and defense firm.","stock_symbol":"AIR","year_founded":1960,"corporate_office":{"city":"Leiden","country":"Netherlands"},"primary_industry":"Aerospace and Defense"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/pitchbook/search":{"get":{"summary":"PitchBook Search","description":"Search PitchBook for companies, news and profiles by keyword or search URL via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-pitchbook-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or PitchBook search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://pitchbook.com/search?q=airbus\n```\n\n```\nhttps://pitchbook.com/profiles/search?q=openai\n```","schema":{"type":"string","description":"Keyword or PitchBook search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://pitchbook.com/search?q=airbus\n```\n\n```\nhttps://pitchbook.com/profiles/search?q=openai\n```"}},{"name":"page","in":"query","required":false,"description":"Page number for content search (`/search?q=...`).","schema":{"type":"string","description":"Page number for content search (`/search?q=...`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"category":{"type":"string"},"company_id":{"type":"string"},"description":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Content search airbus":{"value":{"results":[{"url":"https://pitchbook.com/profiles/company/11062-99","type":"profile","image":"https://image.pitchbook.com/example_200x200","title":"Airbus Group","category":"Profile Preview","company_id":"11062-99","description":"Airbus is a global aerospace and defense firm."}],"pagination":{"next":"https://pitchbook.com/search?q=airbus&p=2","page":1,"per_page":10,"total_pages":4,"total_results":33}}},"Profiles search openai":{"value":{"results":[{"url":"https://pitchbook.com/profiles/company/149504-14","logo":"https://image.pitchbook.com/example_200x200","type":"company","title":"OpenAI","company_id":"149504-14","profile_id":"149504-14"}],"pagination":{"next":null,"page":1,"per_page":15,"total_pages":1,"total_results":15}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PitchBook Search","description":"Search PitchBook for companies, news and profiles by keyword or search URL via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-pitchbook-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or PitchBook search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://pitchbook.com/search?q=airbus\n```\n\n```\nhttps://pitchbook.com/profiles/search?q=openai\n```","schema":{"type":"string","description":"Keyword or PitchBook search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://pitchbook.com/search?q=airbus\n```\n\n```\nhttps://pitchbook.com/profiles/search?q=openai\n```"}},{"name":"page","in":"query","required":false,"description":"Page number for content search (`/search?q=...`).","schema":{"type":"string","description":"Page number for content search (`/search?q=...`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"category":{"type":"string"},"company_id":{"type":"string"},"description":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Content search airbus":{"value":{"results":[{"url":"https://pitchbook.com/profiles/company/11062-99","type":"profile","image":"https://image.pitchbook.com/example_200x200","title":"Airbus Group","category":"Profile Preview","company_id":"11062-99","description":"Airbus is a global aerospace and defense firm."}],"pagination":{"next":"https://pitchbook.com/search?q=airbus&p=2","page":1,"per_page":10,"total_pages":4,"total_results":33}}},"Profiles search openai":{"value":{"results":[{"url":"https://pitchbook.com/profiles/company/149504-14","logo":"https://image.pitchbook.com/example_200x200","type":"company","title":"OpenAI","company_id":"149504-14","profile_id":"149504-14"}],"pagination":{"next":null,"page":1,"per_page":15,"total_pages":1,"total_results":15}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rexel/product":{"get":{"summary":"Rexel Product","description":"Get a Rexel France product page: references, EAN, descriptions, images and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-rexel-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Rexel France product URL containing `/p/{id}`.\n\n**Example:**\n\n```\nhttps://www.rexel.fr/frx/HAGWXF122/p/71742449\n```","schema":{"type":"string","description":"Rexel France product URL containing `/p/{id}`.\n\n**Example:**\n\n```\nhttps://www.rexel.fr/frx/HAGWXF122/p/71742449\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rexel_ref":{"type":"string"},"product_id":{"type":"integer"},"breadcrumbs":{"nullable":true},"description":{"type":"string"},"specifications":{"type":"object","properties":{"gamme":{"type":"string"},"intensite":{"type":"string"},"type_de_pose":{"type":"string"},"tension_nominale":{"type":"string"}}},"manufacturer_ref":{"type":"string"},"short_description":{"type":"string"}}},"examples":{"Hager WXF122":{"value":{"ean":"3250617191227","url":"https://www.rexel.fr/frx/HAGWXF122/p/71742449","name":"Prise de courant gallery 2P+T double pré cablées","brand":"Hager","images":["https://api.rexel.fr/media/api/fr/content/71742449/EXTRA_LARGE_WEBP"],"rexel_ref":"HAGWXF122","product_id":71742449,"breadcrumbs":null,"description":"Gallery est l'appareillage modulaire 45x45 pour chantiers résidentiels et tertiaires.","specifications":{"gamme":"Gallery","intensite":"16 A","type_de_pose":"encastré","tension_nominale":"250 V"},"manufacturer_ref":"WXF122","short_description":"La prise de courant double pré cablées 2P+T WXF122 fait partie de la gamme gallery."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rexel Product","description":"Get a Rexel France product page: references, EAN, descriptions, images and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-rexel-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Rexel France product URL containing `/p/{id}`.\n\n**Example:**\n\n```\nhttps://www.rexel.fr/frx/HAGWXF122/p/71742449\n```","schema":{"type":"string","description":"Rexel France product URL containing `/p/{id}`.\n\n**Example:**\n\n```\nhttps://www.rexel.fr/frx/HAGWXF122/p/71742449\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rexel_ref":{"type":"string"},"product_id":{"type":"integer"},"breadcrumbs":{"nullable":true},"description":{"type":"string"},"specifications":{"type":"object","properties":{"gamme":{"type":"string"},"intensite":{"type":"string"},"type_de_pose":{"type":"string"},"tension_nominale":{"type":"string"}}},"manufacturer_ref":{"type":"string"},"short_description":{"type":"string"}}},"examples":{"Hager WXF122":{"value":{"ean":"3250617191227","url":"https://www.rexel.fr/frx/HAGWXF122/p/71742449","name":"Prise de courant gallery 2P+T double pré cablées","brand":"Hager","images":["https://api.rexel.fr/media/api/fr/content/71742449/EXTRA_LARGE_WEBP"],"rexel_ref":"HAGWXF122","product_id":71742449,"breadcrumbs":null,"description":"Gallery est l'appareillage modulaire 45x45 pour chantiers résidentiels et tertiaires.","specifications":{"gamme":"Gallery","intensite":"16 A","type_de_pose":"encastré","tension_nominale":"250 V"},"manufacturer_ref":"WXF122","short_description":"La prise de courant double pré cablées 2P+T WXF122 fait partie de la gamme gallery."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rexel/search":{"get":{"summary":"Rexel Search","description":"Search Rexel France by keyword, EAN or search URL. Returns product cards and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-rexel-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, EAN, or Rexel France search URL.\n\n**Examples:**\n\n```\nprise\n```\n\n```\n3250617191227\n```\n\n```\nhttps://www.rexel.fr/frx/search?text=prise\n```","schema":{"type":"string","description":"Keyword, EAN, or Rexel France search URL.\n\n**Examples:**\n\n```\nprise\n```\n\n```\n3250617191227\n```\n\n```\nhttps://www.rexel.fr/frx/search?text=prise\n```"}},{"name":"page","in":"query","required":false,"description":"Page number (1-based). Page 1 omits `page` in the URL.","schema":{"type":"string","description":"Page number (1-based). Page 1 omits `page` in the URL."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"nullable":true},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image_url":{"type":"string"},"rexel_ref":{"type":"string"},"product_id":{"type":"integer"},"description":{"type":"string"},"manufacturer_ref":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Keyword prise":{"value":{"results":[{"ean":null,"url":"https://www.rexel.fr/frx/HAGWXF122/p/71742449","name":"Prise de courant gallery 2P+T double pré cablées","brand":"HAGER","image_url":"https://api.rexel.fr/media/api/fr/content/71742449/LARGE_WEBP","rexel_ref":"HAGWXF122","product_id":71742449,"description":"La prise de courant double pré cablées 2P+T WXF122 fait partie de la gamme gallery.","manufacturer_ref":"WXF122"}],"pagination":{"next":"https://www.rexel.fr/frx/search?text=prise&page=2","page":1,"per_page":24,"total_pages":2262,"total_results":54275}}},"EAN redirect":{"value":{"results":[{"ean":"3250617191227","url":"https://www.rexel.fr/frx/HAGWXF122/p/71742449","name":"Prise de courant gallery 2P+T double pré cablées","brand":"Hager","image_url":"https://api.rexel.fr/media/api/fr/content/71742449/EXTRA_LARGE_WEBP","rexel_ref":"HAGWXF122","product_id":71742449,"description":"La prise de courant double pré cablées 2P+T WXF122 fait partie de la gamme gallery.","manufacturer_ref":"WXF122"}],"pagination":{"next":null,"page":1,"per_page":24,"total_pages":1,"total_results":1}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rexel Search","description":"Search Rexel France by keyword, EAN or search URL. Returns product cards and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-rexel-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, EAN, or Rexel France search URL.\n\n**Examples:**\n\n```\nprise\n```\n\n```\n3250617191227\n```\n\n```\nhttps://www.rexel.fr/frx/search?text=prise\n```","schema":{"type":"string","description":"Keyword, EAN, or Rexel France search URL.\n\n**Examples:**\n\n```\nprise\n```\n\n```\n3250617191227\n```\n\n```\nhttps://www.rexel.fr/frx/search?text=prise\n```"}},{"name":"page","in":"query","required":false,"description":"Page number (1-based). Page 1 omits `page` in the URL.","schema":{"type":"string","description":"Page number (1-based). Page 1 omits `page` in the URL."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When `true`, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ean":{"nullable":true},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"image_url":{"type":"string"},"rexel_ref":{"type":"string"},"product_id":{"type":"integer"},"description":{"type":"string"},"manufacturer_ref":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Keyword prise":{"value":{"results":[{"ean":null,"url":"https://www.rexel.fr/frx/HAGWXF122/p/71742449","name":"Prise de courant gallery 2P+T double pré cablées","brand":"HAGER","image_url":"https://api.rexel.fr/media/api/fr/content/71742449/LARGE_WEBP","rexel_ref":"HAGWXF122","product_id":71742449,"description":"La prise de courant double pré cablées 2P+T WXF122 fait partie de la gamme gallery.","manufacturer_ref":"WXF122"}],"pagination":{"next":"https://www.rexel.fr/frx/search?text=prise&page=2","page":1,"per_page":24,"total_pages":2262,"total_results":54275}}},"EAN redirect":{"value":{"results":[{"ean":"3250617191227","url":"https://www.rexel.fr/frx/HAGWXF122/p/71742449","name":"Prise de courant gallery 2P+T double pré cablées","brand":"Hager","image_url":"https://api.rexel.fr/media/api/fr/content/71742449/EXTRA_LARGE_WEBP","rexel_ref":"HAGWXF122","product_id":71742449,"description":"La prise de courant double pré cablées 2P+T WXF122 fait partie de la gamme gallery.","manufacturer_ref":"WXF122"}],"pagination":{"next":null,"page":1,"per_page":24,"total_pages":1,"total_results":1}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/digikey/product":{"get":{"summary":"DigiKey Product","description":"Get a DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-digikey-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full DigiKey product detail URL, or relative path.\n\n**Examples:**\n\n```\nhttps://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293\n```\n\n```\n/fr/products/detail/excel-blades/50500/24758728\n```\n\nRelative paths require `region`.","schema":{"type":"string","description":"Full DigiKey product detail URL, or relative path.\n\n**Examples:**\n\n```\nhttps://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293\n```\n\n```\n/fr/products/detail/excel-blades/50500/24758728\n```\n\nRelative paths require `region`."}},{"name":"region","in":"query","required":false,"description":"DigiKey country TLD when `query` is a relative path.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`","schema":{"type":"string","description":"DigiKey country TLD when `query` is a relative path.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"stock":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"region":{"type":"string"},"pricing":{"type":"array","items":{"type":"object","properties":{"packaging":{"type":"string"},"unit_price":{"type":"number"},"break_quantity":{"type":"integer"},"extended_price":{"type":"number"},"digikey_part_number":{"type":"string"}}}},"currency":{"type":"string"},"description":{"type":"string"},"manufacturer":{"type":"string"},"datasheet_url":{"type":"string"},"is_unavailable":{"type":"boolean"},"specifications":{"type":"object","properties":{"Fabricant":{"type":"string"},"Conditionnement":{"type":"string"},"Type d'accessoire":{"type":"string"},"Statut du composant":{"type":"string"}}},"digikey_part_number":{"type":"string"},"detailed_description":{"type":"string"},"manufacturer_part_number":{"type":"string"}}},"examples":{"Phoenix Contact 2981965 (FR)":{"value":{"url":"https://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293","price":110.05,"stock":"49","title":"2981965","images":["https://mm.digikey.com/Volume0/opasdata/d220001/derivates/6/002/833/060/2981965_web%28640x640%29.jpg?hidebanner=true"],"locale":"fr","region":"fr","pricing":[{"packaging":"En vrac","unit_price":110.05,"break_quantity":1,"extended_price":110.05,"digikey_part_number":"277-17389-ND"}],"currency":"EUR","description":"UNIVERSAL SAFETY RELAY","manufacturer":"Phoenix Contact","datasheet_url":"https://mm.digikey.com/Volume0/opasdata/d220001/medias/docus/692/2981965_Ds.pdf","is_unavailable":false,"specifications":{"Fabricant":"Phoenix Contact","Conditionnement":"En vrac","Type d'accessoire":"Relais de sécurité","Statut du composant":"Actif"},"digikey_part_number":"277-17389-ND","detailed_description":"Relais de sécurité","manufacturer_part_number":"2981965"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"DigiKey Product","description":"Get a DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-digikey-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full DigiKey product detail URL, or relative path.\n\n**Examples:**\n\n```\nhttps://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293\n```\n\n```\n/fr/products/detail/excel-blades/50500/24758728\n```\n\nRelative paths require `region`.","schema":{"type":"string","description":"Full DigiKey product detail URL, or relative path.\n\n**Examples:**\n\n```\nhttps://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293\n```\n\n```\n/fr/products/detail/excel-blades/50500/24758728\n```\n\nRelative paths require `region`."}},{"name":"region","in":"query","required":false,"description":"DigiKey country TLD when `query` is a relative path.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`","schema":{"type":"string","description":"DigiKey country TLD when `query` is a relative path.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"stock":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"region":{"type":"string"},"pricing":{"type":"array","items":{"type":"object","properties":{"packaging":{"type":"string"},"unit_price":{"type":"number"},"break_quantity":{"type":"integer"},"extended_price":{"type":"number"},"digikey_part_number":{"type":"string"}}}},"currency":{"type":"string"},"description":{"type":"string"},"manufacturer":{"type":"string"},"datasheet_url":{"type":"string"},"is_unavailable":{"type":"boolean"},"specifications":{"type":"object","properties":{"Fabricant":{"type":"string"},"Conditionnement":{"type":"string"},"Type d'accessoire":{"type":"string"},"Statut du composant":{"type":"string"}}},"digikey_part_number":{"type":"string"},"detailed_description":{"type":"string"},"manufacturer_part_number":{"type":"string"}}},"examples":{"Phoenix Contact 2981965 (FR)":{"value":{"url":"https://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293","price":110.05,"stock":"49","title":"2981965","images":["https://mm.digikey.com/Volume0/opasdata/d220001/derivates/6/002/833/060/2981965_web%28640x640%29.jpg?hidebanner=true"],"locale":"fr","region":"fr","pricing":[{"packaging":"En vrac","unit_price":110.05,"break_quantity":1,"extended_price":110.05,"digikey_part_number":"277-17389-ND"}],"currency":"EUR","description":"UNIVERSAL SAFETY RELAY","manufacturer":"Phoenix Contact","datasheet_url":"https://mm.digikey.com/Volume0/opasdata/d220001/medias/docus/692/2981965_Ds.pdf","is_unavailable":false,"specifications":{"Fabricant":"Phoenix Contact","Conditionnement":"En vrac","Type d'accessoire":"Relais de sécurité","Statut du composant":"Actif"},"digikey_part_number":"277-17389-ND","detailed_description":"Relais de sécurité","manufacturer_part_number":"2981965"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/digikey/search":{"get":{"summary":"DigiKey Search","description":"Search DigiKey country sites by keyword or result/filter URL. Returns category branches or product listings with pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-digikey-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, DigiKey result/filter URL, or relative path.\n\n**Examples:**\n\n```\nphoenix contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/result?keywords=phoenix+contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/filter/marteaux/246\n```\n\n```\n/fr/products/filter/marteaux/246\n```\n\nA full DigiKey URL auto-detects `region`.","schema":{"type":"string","description":"Keyword, DigiKey result/filter URL, or relative path.\n\n**Examples:**\n\n```\nphoenix contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/result?keywords=phoenix+contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/filter/marteaux/246\n```\n\n```\n/fr/products/filter/marteaux/246\n```\n\nA full DigiKey URL auto-detects `region`."}},{"name":"region","in":"query","required":false,"description":"DigiKey country TLD when `query` is not a full URL.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`, `com.au`, `ca`, `jp`\n\nAliases: `uk`/`gb` → `co.uk`, `au` → `com.au`.","schema":{"type":"string","description":"DigiKey country TLD when `query` is not a full URL.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`, `com.au`, `ca`, `jp`\n\nAliases: `uk`/`gb` → `co.uk`, `au` → `com.au`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"type":{"type":"string"},"title":{"type":"string"},"image_url":{"type":"string"},"product_count":{"type":"integer"},"parent_category":{"type":"string"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Keyword phoenix contact (FR categories)":{"value":{"results":[{"id":"370","url":"https://www.digikey.fr/fr/products/filter/embases-fiches-et-prises/370","type":"category","title":"Embases, fiches et prises","image_url":"https://mm.digikey.com/Volume0/opasdata/d220001/derivates/3/010/141/386/1751086_tmb.jpg","product_count":13796,"parent_category":"Blocs de jonction"}],"pagination":{"page":1,"per_page":30,"total_pages":1,"has_next_page":false,"total_results":65793}}},"Filter listing marteaux (products)":{"value":{"results":[{"url":"https://www.digikey.fr/fr/products/detail/excel-blades/55672/24758809","type":"product","price":44.32,"stock":"1000","title":"9\" Swiss Style Mini Hammer","currency":"EUR","product_id":"24758809","stock_label":"Marketplace","manufacturer":"Excel Blades","digikey_part_number":"5795-55672-ND","manufacturer_part_number":"55672"}],"pagination":{"next":2,"page":1,"per_page":25,"total_pages":20,"has_next_page":true,"total_results":491}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"DigiKey Search","description":"Search DigiKey country sites by keyword or result/filter URL. Returns category branches or product listings with pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-digikey-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, DigiKey result/filter URL, or relative path.\n\n**Examples:**\n\n```\nphoenix contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/result?keywords=phoenix+contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/filter/marteaux/246\n```\n\n```\n/fr/products/filter/marteaux/246\n```\n\nA full DigiKey URL auto-detects `region`.","schema":{"type":"string","description":"Keyword, DigiKey result/filter URL, or relative path.\n\n**Examples:**\n\n```\nphoenix contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/result?keywords=phoenix+contact\n```\n\n```\nhttps://www.digikey.fr/fr/products/filter/marteaux/246\n```\n\n```\n/fr/products/filter/marteaux/246\n```\n\nA full DigiKey URL auto-detects `region`."}},{"name":"region","in":"query","required":false,"description":"DigiKey country TLD when `query` is not a full URL.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`, `com.au`, `ca`, `jp`\n\nAliases: `uk`/`gb` → `co.uk`, `au` → `com.au`.","schema":{"type":"string","description":"DigiKey country TLD when `query` is not a full URL.\n\n**Examples:** `fr`, `com`, `de`, `co.uk`, `com.au`, `ca`, `jp`\n\nAliases: `uk`/`gb` → `co.uk`, `au` → `com.au`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"type":{"type":"string"},"title":{"type":"string"},"image_url":{"type":"string"},"product_count":{"type":"integer"},"parent_category":{"type":"string"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Keyword phoenix contact (FR categories)":{"value":{"results":[{"id":"370","url":"https://www.digikey.fr/fr/products/filter/embases-fiches-et-prises/370","type":"category","title":"Embases, fiches et prises","image_url":"https://mm.digikey.com/Volume0/opasdata/d220001/derivates/3/010/141/386/1751086_tmb.jpg","product_count":13796,"parent_category":"Blocs de jonction"}],"pagination":{"page":1,"per_page":30,"total_pages":1,"has_next_page":false,"total_results":65793}}},"Filter listing marteaux (products)":{"value":{"results":[{"url":"https://www.digikey.fr/fr/products/detail/excel-blades/55672/24758809","type":"product","price":44.32,"stock":"1000","title":"9\" Swiss Style Mini Hammer","currency":"EUR","product_id":"24758809","stock_label":"Marketplace","manufacturer":"Excel Blades","digikey_part_number":"5795-55672-ND","manufacturer_part_number":"55672"}],"pagination":{"next":2,"page":1,"per_page":25,"total_pages":20,"has_next_page":true,"total_results":491}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/grainger/search":{"get":{"summary":"Grainger Search","description":"Search Grainger US or Canada by keyword, category URL or SKU. Returns product listings, category branches and suggestions via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-grainger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, full Grainger search/category URL, category path, or SKU.\n\n**Examples:**\n\n```\ncarolina\n```\n\n```\nhttps://www.grainger.com/search?searchQuery=carolina&searchBar=true\n```\n\n```\nhttps://www.grainger.com/category/abrasives\n```\n\n```\ncategory/abrasives\n```\n\n```\n3FRU1\n```\n\nA full Grainger URL auto-detects `region`.","schema":{"type":"string","description":"Keyword, full Grainger search/category URL, category path, or SKU.\n\n**Examples:**\n\n```\ncarolina\n```\n\n```\nhttps://www.grainger.com/search?searchQuery=carolina&searchBar=true\n```\n\n```\nhttps://www.grainger.com/category/abrasives\n```\n\n```\ncategory/abrasives\n```\n\n```\n3FRU1\n```\n\nA full Grainger URL auto-detects `region`."}},{"name":"region","in":"query","required":false,"description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.grainger.com, USD\n- `ca` → www.grainger.ca, CAD\n\n**Example:** `ca`","schema":{"type":"string","description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.grainger.com, USD\n- `ca` → www.grainger.ca, CAD\n\n**Example:** `ca`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"query":{"type":"string"},"region":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}},"total_results":{"type":"integer"}}},"examples":{"Keyword carolina (category branches)":{"value":{"url":"https://www.grainger.com/search?searchQuery=carolina&searchBar=true","query":"carolina","region":"com","categories":[{"url":"https://www.grainger.com/category/safety/footwear-footwear-accessories/safety-toe-work-boots-shoes","title":"Close Match Safety-Toe Work Boots & Shoes"},{"url":"https://www.grainger.com/category/safety/footwear-footwear-accessories/plain-toe-work-boots-shoes","title":"Plain-Toe Work Boots & Shoes"}],"total_results":0}},"SKU 3FRU1 redirected to product":{"value":{"url":"https://www.grainger.com/search?searchQuery=3FRU1&searchBar=true","query":"3FRU1","region":"com","results":[{"sku":"3FRU1","url":"https://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1","price":6.67,"title":"PENTAIR/PENTEK Water Filter Cartridge: 5 micron, Melt Blown, 2 gpm, Polypropylene","currency":"USD"}],"total_results":1}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Grainger Search","description":"Search Grainger US or Canada by keyword, category URL or SKU. Returns product listings, category branches and suggestions via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-grainger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, full Grainger search/category URL, category path, or SKU.\n\n**Examples:**\n\n```\ncarolina\n```\n\n```\nhttps://www.grainger.com/search?searchQuery=carolina&searchBar=true\n```\n\n```\nhttps://www.grainger.com/category/abrasives\n```\n\n```\ncategory/abrasives\n```\n\n```\n3FRU1\n```\n\nA full Grainger URL auto-detects `region`.","schema":{"type":"string","description":"Keyword, full Grainger search/category URL, category path, or SKU.\n\n**Examples:**\n\n```\ncarolina\n```\n\n```\nhttps://www.grainger.com/search?searchQuery=carolina&searchBar=true\n```\n\n```\nhttps://www.grainger.com/category/abrasives\n```\n\n```\ncategory/abrasives\n```\n\n```\n3FRU1\n```\n\nA full Grainger URL auto-detects `region`."}},{"name":"region","in":"query","required":false,"description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.grainger.com, USD\n- `ca` → www.grainger.ca, CAD\n\n**Example:** `ca`","schema":{"type":"string","description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.grainger.com, USD\n- `ca` → www.grainger.ca, CAD\n\n**Example:** `ca`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"query":{"type":"string"},"region":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}},"total_results":{"type":"integer"}}},"examples":{"Keyword carolina (category branches)":{"value":{"url":"https://www.grainger.com/search?searchQuery=carolina&searchBar=true","query":"carolina","region":"com","categories":[{"url":"https://www.grainger.com/category/safety/footwear-footwear-accessories/safety-toe-work-boots-shoes","title":"Close Match Safety-Toe Work Boots & Shoes"},{"url":"https://www.grainger.com/category/safety/footwear-footwear-accessories/plain-toe-work-boots-shoes","title":"Plain-Toe Work Boots & Shoes"}],"total_results":0}},"SKU 3FRU1 redirected to product":{"value":{"url":"https://www.grainger.com/search?searchQuery=3FRU1&searchBar=true","query":"3FRU1","region":"com","results":[{"sku":"3FRU1","url":"https://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1","price":6.67,"title":"PENTAIR/PENTEK Water Filter Cartridge: 5 micron, Melt Blown, 2 gpm, Polypropylene","currency":"USD"}],"total_results":1}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/grainger/product":{"get":{"summary":"Grainger Product","description":"Get a Grainger US or Canada product page: SKU, brand, price, images, description and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-grainger-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"SKU, full Grainger product URL, or relative `/product/...` path.\n\n**Examples:**\n\n```\n3FRU1\n```\n\n```\nhttps://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1\n```\n\n```\n/product/ROCKPORT-WORKS-6-Inch-Work-Boot-Men-s-16V679\n```","schema":{"type":"string","description":"SKU, full Grainger product URL, or relative `/product/...` path.\n\n**Examples:**\n\n```\n3FRU1\n```\n\n```\nhttps://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1\n```\n\n```\n/product/ROCKPORT-WORKS-6-Inch-Work-Boot-Men-s-16V679\n```"}},{"name":"region","in":"query","required":false,"description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:** `com` (USD), `ca` (CAD).","schema":{"type":"string","description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:** `com` (USD), `ca` (CAD)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"model":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"specifications":{"type":"object","properties":{"Brand":{"type":"string"},"Series":{"type":"string"},"Micron Rating":{"type":"string"},"Filter Media Material":{"type":"string"}}}}},"examples":{"Filter cartridge 3FRU1":{"value":{"sku":"3FRU1","url":"https://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1","brand":"PENTAIR/PENTEK","model":"155030-43","price":6.67,"title":"PENTAIR/PENTEK Water Filter Cartridge: 5 micron, Melt Blown, 2 gpm, Polypropylene","images":["https://static.grainger.com/rp/s/is/image/Grainger/3FRU1_AS01"],"region":"com","currency":"USD","product_id":"40161516","description":"Product Description Melt blown filters use porous outer layers...","specifications":{"Brand":"PENTAIR/PENTEK","Series":"Pentek P","Micron Rating":"5 micron","Filter Media Material":"Polypropylene"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Grainger Product","description":"Get a Grainger US or Canada product page: SKU, brand, price, images, description and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-grainger-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"SKU, full Grainger product URL, or relative `/product/...` path.\n\n**Examples:**\n\n```\n3FRU1\n```\n\n```\nhttps://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1\n```\n\n```\n/product/ROCKPORT-WORKS-6-Inch-Work-Boot-Men-s-16V679\n```","schema":{"type":"string","description":"SKU, full Grainger product URL, or relative `/product/...` path.\n\n**Examples:**\n\n```\n3FRU1\n```\n\n```\nhttps://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1\n```\n\n```\n/product/ROCKPORT-WORKS-6-Inch-Work-Boot-Men-s-16V679\n```"}},{"name":"region","in":"query","required":false,"description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:** `com` (USD), `ca` (CAD).","schema":{"type":"string","description":"Grainger country when `query` is not a full URL (default: `com`).\n\n**Supported:** `com` (USD), `ca` (CAD)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"model":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"description":{"type":"string"},"specifications":{"type":"object","properties":{"Brand":{"type":"string"},"Series":{"type":"string"},"Micron Rating":{"type":"string"},"Filter Media Material":{"type":"string"}}}}},"examples":{"Filter cartridge 3FRU1":{"value":{"sku":"3FRU1","url":"https://www.grainger.com/product/PENTAIR-PENTEK-Water-Filter-Cartridge-5-micron-3FRU1","brand":"PENTAIR/PENTEK","model":"155030-43","price":6.67,"title":"PENTAIR/PENTEK Water Filter Cartridge: 5 micron, Melt Blown, 2 gpm, Polypropylene","images":["https://static.grainger.com/rp/s/is/image/Grainger/3FRU1_AS01"],"region":"com","currency":"USD","product_id":"40161516","description":"Product Description Melt blown filters use porous outer layers...","specifications":{"Brand":"PENTAIR/PENTEK","Series":"Pentek P","Micron Rating":"5 micron","Filter Media Material":"Polypropylene"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/maersk/tracking":{"get":{"summary":"Maersk Tracking","description":"Track a Maersk container or BOL: origin, destination, current milestone and full transport-plan events via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-maersk-tracking","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Container / BOL tracking number, or full Maersk tracking URL.\n\n**Examples:**\n\n```\nMMAU1155207\n```\n\n```\nhttps://www.maersk.com/tracking/MMAU1155207\n```\n\nA bare number is resolved to `https://www.maersk.com/tracking/{number}`. Localized URLs (`/fr-fr/tracking/...`) are accepted when passed in full.","schema":{"type":"string","description":"Container / BOL tracking number, or full Maersk tracking URL.\n\n**Examples:**\n\n```\nMMAU1155207\n```\n\n```\nhttps://www.maersk.com/tracking/MMAU1155207\n```\n\nA bare number is resolved to `https://www.maersk.com/tracking/{number}`. Localized URLs (`/fr-fr/tracking/...`) are accepted when passed in full."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"events":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"event":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"facility":{"type":"string"}}},"position":{"type":"integer"},"is_current":{"type":"boolean"}}}},"origin":{"type":"string"},"destination":{"type":"string"},"current_event":{"type":"object","properties":{"date":{"type":"string"},"event":{"type":"string"},"position":{"type":"integer"},"is_current":{"type":"boolean"}}},"tracking_type":{"type":"string"},"tracking_number":{"type":"string"}}},"examples":{"Container MMAU1155207 (Paranagua to Al Khoms)":{"value":{"url":"https://www.maersk.com/tracking/MMAU1155207","events":[{"date":"23 Mar 2026 16:29","event":"Gate out Empty","location":{"city":"Paranagua","facility":"Maersk Depot Paranagua"},"position":1,"is_current":false},{"date":"02 Apr 2026 18:49","event":"Load on MAERSK LOTA / 614N","vessel":"MAERSK LOTA / 614N","position":3,"is_current":false}],"origin":"PARANAGUA","destination":"AL KHOMS","current_event":{"date":"02 Jun 2026 14:00","event":"Empty container return","position":16,"is_current":true},"tracking_type":"Container","tracking_number":"MMAU1155207"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Maersk Tracking","description":"Track a Maersk container or BOL: origin, destination, current milestone and full transport-plan events via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-maersk-tracking","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Container / BOL tracking number, or full Maersk tracking URL.\n\n**Examples:**\n\n```\nMMAU1155207\n```\n\n```\nhttps://www.maersk.com/tracking/MMAU1155207\n```\n\nA bare number is resolved to `https://www.maersk.com/tracking/{number}`. Localized URLs (`/fr-fr/tracking/...`) are accepted when passed in full.","schema":{"type":"string","description":"Container / BOL tracking number, or full Maersk tracking URL.\n\n**Examples:**\n\n```\nMMAU1155207\n```\n\n```\nhttps://www.maersk.com/tracking/MMAU1155207\n```\n\nA bare number is resolved to `https://www.maersk.com/tracking/{number}`. Localized URLs (`/fr-fr/tracking/...`) are accepted when passed in full."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"events":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"event":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"facility":{"type":"string"}}},"position":{"type":"integer"},"is_current":{"type":"boolean"}}}},"origin":{"type":"string"},"destination":{"type":"string"},"current_event":{"type":"object","properties":{"date":{"type":"string"},"event":{"type":"string"},"position":{"type":"integer"},"is_current":{"type":"boolean"}}},"tracking_type":{"type":"string"},"tracking_number":{"type":"string"}}},"examples":{"Container MMAU1155207 (Paranagua to Al Khoms)":{"value":{"url":"https://www.maersk.com/tracking/MMAU1155207","events":[{"date":"23 Mar 2026 16:29","event":"Gate out Empty","location":{"city":"Paranagua","facility":"Maersk Depot Paranagua"},"position":1,"is_current":false},{"date":"02 Apr 2026 18:49","event":"Load on MAERSK LOTA / 614N","vessel":"MAERSK LOTA / 614N","position":3,"is_current":false}],"origin":"PARANAGUA","destination":"AL KHOMS","current_event":{"date":"02 Jun 2026 14:00","event":"Empty container return","position":16,"is_current":true},"tracking_type":"Container","tracking_number":"MMAU1155207"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/vinted/search":{"get":{"summary":"Vinted Search","description":"Search Vinted second-hand listings by keyword or catalog URL across vinted.fr, vinted.com and other domains. Returns results and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-vinted-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword **or** full Vinted catalog URL. Filters from the URL query string are forwarded to the internal Vinted API.\n\n**Examples (keyword):**\n\n    nike\n\n**Example (catalog URL):**\n\n    https://www.vinted.com/catalog?search_text=dresses%20for%20woman\n\n**Notes:**\n- Keyword searches default to `vinted.fr` unless you set `region`.\n- Catalog URLs keep their domain (`vinted.com`, `vinted.de`, etc.).","schema":{"type":"string","description":"Search keyword **or** full Vinted catalog URL. Filters from the URL query string are forwarded to the internal Vinted API.\n\n**Examples (keyword):**\n\n    nike\n\n**Example (catalog URL):**\n\n    https://www.vinted.com/catalog?search_text=dresses%20for%20woman\n\n**Notes:**\n- Keyword searches default to `vinted.fr` unless you set `region`.\n- Catalog URLs keep their domain (`vinted.com`, `vinted.de`, etc.)."}},{"name":"page","in":"query","required":false,"description":"Page number. Default `1`.","schema":{"type":"number","description":"Page number. Default `1`."}},{"name":"per_page","in":"query","required":false,"description":"Results per page. Default `24`.","schema":{"type":"number","description":"Results per page. Default `24`."}},{"name":"order","in":"query","required":false,"description":"Optional sort order.\n\n- `newest_first`\n```\nrelevance\n```\n\n```\nprice_low_to_high\n```\n\n```\nprice_high_to_low\n```","schema":{"type":"string","description":"Optional sort order.\n\n- `newest_first`\n```\nrelevance\n```\n\n```\nprice_low_to_high\n```\n\n```\nprice_high_to_low\n```"}},{"name":"region","in":"query","required":false,"description":"Force the Vinted domain when `query` is a keyword only.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nhttps://www.vinted.fr\n```\n\n```\nhttps://www.vinted.de\n```","schema":{"type":"string","description":"Force the Vinted domain when `query` is a keyword only.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nhttps://www.vinted.fr\n```\n\n```\nhttps://www.vinted.de\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"path":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"login":{"type":"string"},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}},"business":{"type":"boolean"},"profile_url":{"type":"string"}}},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"is_main":{"type":"boolean"}}},"price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"title":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"is_main":{"type":"boolean"},"image_no":{"type":"integer"}}}},"status":{"type":"string"},"item_box":{"type":"object","properties":{"item_id":{"type":"integer"},"first_line":{"type":"string"},"second_line":{"type":"string"}}},"promoted":{"type":"boolean"},"is_visible":{"type":"boolean"},"size_title":{"type":"string"},"brand_title":{"type":"string"},"service_fee":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"is_favourite":{"type":"boolean"},"content_source":{"type":"string"},"favourite_count":{"type":"integer"},"total_item_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Catalog search on vinted.com (dresses)":{"value":{"results":[{"id":9417084957,"url":"https://www.vinted.com/items/9417084957-tempted-black-draped-cowl-neck-short-sleeve-mini-dress","path":"/items/9417084957-tempted-black-draped-cowl-neck-short-sleeve-mini-dress","user":{"id":3167755373,"login":"example-user","photo":{"id":321171847,"url":"https://images1.vinted.net/placeholder/example-user.jpg","width":600,"height":800},"business":false,"profile_url":"https://www.vinted.com/member/example-user"},"photo":{"id":39862469776,"url":"https://images1.vinted.net/t/02_023f8_BqApqrfHRr4eYif4gfmsy9a7/f800/1784247894.jpeg?s=2f0f0b44d41db05b396ceae775aef3c37f8116be","width":600,"height":800,"is_main":true},"price":{"amount":"25.0","currency_code":"USD"},"title":"Tempted Black Draped Cowl-Neck Short Sleeve Mini dress","photos":[{"id":39862469776,"url":"https://images1.vinted.net/t/02_023f8_BqApqrfHRr4eYif4gfmsy9a7/f800/1784247894.jpeg?s=2f0f0b44d41db05b396ceae775aef3c37f8116be","width":600,"height":800,"is_main":true,"image_no":1}],"status":"Very good","item_box":{"item_id":9417084957,"first_line":"tempted","second_line":"S / US 4-6 · Very good"},"promoted":true,"is_visible":true,"size_title":"S / US 4-6","brand_title":"tempted","service_fee":{"amount":"1.95","currency_code":"USD"},"is_favourite":false,"content_source":"search_promoted_items","favourite_count":55,"total_item_price":{"amount":"26.95","currency_code":"USD"}},{"id":9422855356,"url":"https://www.vinted.com/items/9422855356-wild-fable-coral-pink-maxi-dress-with-floral-cups-and-open-back","path":"/items/9422855356-wild-fable-coral-pink-maxi-dress-with-floral-cups-and-open-back","user":{"id":3168044178,"login":"example-user-2","photo":{"id":321347671,"url":"https://images1.vinted.net/placeholder/example-user-2.jpg","width":600,"height":800},"business":false,"profile_url":"https://www.vinted.com/member/example-user-2"},"photo":{"id":39887137204,"url":"https://images1.vinted.net/t/06_00485_DbqyZigqBuvGGQTL4icBDLi5/f800/1784313642.jpeg?s=cf2c907b215da3820cb5abe89e418d934131512c","width":600,"height":800,"is_main":true},"price":{"amount":"12.0","currency_code":"USD"},"title":"Wild Fable coral pink maxi dress with floral cups and open back","photos":[{"id":39887137204,"url":"https://images1.vinted.net/t/06_00485_DbqyZigqBuvGGQTL4icBDLi5/f800/1784313642.jpeg?s=cf2c907b215da3820cb5abe89e418d934131512c","width":600,"height":800,"is_main":true,"image_no":1},{"id":39887137208,"url":"https://images1.vinted.net/t/03_01bd1_h7xRSJBdzL1FQLZ1vmC3Q7XZ/f800/1784313642.jpeg?s=fc2b14c3a747ec275d0c8f9e0ddef236be217ca3","width":600,"height":800,"is_main":false,"image_no":2}],"status":"Very good","item_box":{"item_id":9422855356,"first_line":"Wild Fable","second_line":"S / US 4-6 · Very good"},"promoted":false,"is_visible":true,"size_title":"S / US 4-6","brand_title":"Wild Fable","service_fee":{"amount":"1.3","currency_code":"USD"},"is_favourite":false,"content_source":"search","favourite_count":52,"total_item_price":{"amount":"13.3","currency_code":"USD"}}],"pagination":{"next":2,"page":1,"per_page":24,"total_pages":40,"total_results":960}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Vinted Search","description":"Search Vinted second-hand listings by keyword or catalog URL across vinted.fr, vinted.com and other domains. Returns results and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-vinted-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword **or** full Vinted catalog URL. Filters from the URL query string are forwarded to the internal Vinted API.\n\n**Examples (keyword):**\n\n    nike\n\n**Example (catalog URL):**\n\n    https://www.vinted.com/catalog?search_text=dresses%20for%20woman\n\n**Notes:**\n- Keyword searches default to `vinted.fr` unless you set `region`.\n- Catalog URLs keep their domain (`vinted.com`, `vinted.de`, etc.).","schema":{"type":"string","description":"Search keyword **or** full Vinted catalog URL. Filters from the URL query string are forwarded to the internal Vinted API.\n\n**Examples (keyword):**\n\n    nike\n\n**Example (catalog URL):**\n\n    https://www.vinted.com/catalog?search_text=dresses%20for%20woman\n\n**Notes:**\n- Keyword searches default to `vinted.fr` unless you set `region`.\n- Catalog URLs keep their domain (`vinted.com`, `vinted.de`, etc.)."}},{"name":"page","in":"query","required":false,"description":"Page number. Default `1`.","schema":{"type":"number","description":"Page number. Default `1`."}},{"name":"per_page","in":"query","required":false,"description":"Results per page. Default `24`.","schema":{"type":"number","description":"Results per page. Default `24`."}},{"name":"order","in":"query","required":false,"description":"Optional sort order.\n\n- `newest_first`\n```\nrelevance\n```\n\n```\nprice_low_to_high\n```\n\n```\nprice_high_to_low\n```","schema":{"type":"string","description":"Optional sort order.\n\n- `newest_first`\n```\nrelevance\n```\n\n```\nprice_low_to_high\n```\n\n```\nprice_high_to_low\n```"}},{"name":"region","in":"query","required":false,"description":"Force the Vinted domain when `query` is a keyword only.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nhttps://www.vinted.fr\n```\n\n```\nhttps://www.vinted.de\n```","schema":{"type":"string","description":"Force the Vinted domain when `query` is a keyword only.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nhttps://www.vinted.fr\n```\n\n```\nhttps://www.vinted.de\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"path":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"login":{"type":"string"},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}},"business":{"type":"boolean"},"profile_url":{"type":"string"}}},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"is_main":{"type":"boolean"}}},"price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"title":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"is_main":{"type":"boolean"},"image_no":{"type":"integer"}}}},"status":{"type":"string"},"item_box":{"type":"object","properties":{"item_id":{"type":"integer"},"first_line":{"type":"string"},"second_line":{"type":"string"}}},"promoted":{"type":"boolean"},"is_visible":{"type":"boolean"},"size_title":{"type":"string"},"brand_title":{"type":"string"},"service_fee":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"is_favourite":{"type":"boolean"},"content_source":{"type":"string"},"favourite_count":{"type":"integer"},"total_item_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Catalog search on vinted.com (dresses)":{"value":{"results":[{"id":9417084957,"url":"https://www.vinted.com/items/9417084957-tempted-black-draped-cowl-neck-short-sleeve-mini-dress","path":"/items/9417084957-tempted-black-draped-cowl-neck-short-sleeve-mini-dress","user":{"id":3167755373,"login":"example-user","photo":{"id":321171847,"url":"https://images1.vinted.net/placeholder/example-user.jpg","width":600,"height":800},"business":false,"profile_url":"https://www.vinted.com/member/example-user"},"photo":{"id":39862469776,"url":"https://images1.vinted.net/t/02_023f8_BqApqrfHRr4eYif4gfmsy9a7/f800/1784247894.jpeg?s=2f0f0b44d41db05b396ceae775aef3c37f8116be","width":600,"height":800,"is_main":true},"price":{"amount":"25.0","currency_code":"USD"},"title":"Tempted Black Draped Cowl-Neck Short Sleeve Mini dress","photos":[{"id":39862469776,"url":"https://images1.vinted.net/t/02_023f8_BqApqrfHRr4eYif4gfmsy9a7/f800/1784247894.jpeg?s=2f0f0b44d41db05b396ceae775aef3c37f8116be","width":600,"height":800,"is_main":true,"image_no":1}],"status":"Very good","item_box":{"item_id":9417084957,"first_line":"tempted","second_line":"S / US 4-6 · Very good"},"promoted":true,"is_visible":true,"size_title":"S / US 4-6","brand_title":"tempted","service_fee":{"amount":"1.95","currency_code":"USD"},"is_favourite":false,"content_source":"search_promoted_items","favourite_count":55,"total_item_price":{"amount":"26.95","currency_code":"USD"}},{"id":9422855356,"url":"https://www.vinted.com/items/9422855356-wild-fable-coral-pink-maxi-dress-with-floral-cups-and-open-back","path":"/items/9422855356-wild-fable-coral-pink-maxi-dress-with-floral-cups-and-open-back","user":{"id":3168044178,"login":"example-user-2","photo":{"id":321347671,"url":"https://images1.vinted.net/placeholder/example-user-2.jpg","width":600,"height":800},"business":false,"profile_url":"https://www.vinted.com/member/example-user-2"},"photo":{"id":39887137204,"url":"https://images1.vinted.net/t/06_00485_DbqyZigqBuvGGQTL4icBDLi5/f800/1784313642.jpeg?s=cf2c907b215da3820cb5abe89e418d934131512c","width":600,"height":800,"is_main":true},"price":{"amount":"12.0","currency_code":"USD"},"title":"Wild Fable coral pink maxi dress with floral cups and open back","photos":[{"id":39887137204,"url":"https://images1.vinted.net/t/06_00485_DbqyZigqBuvGGQTL4icBDLi5/f800/1784313642.jpeg?s=cf2c907b215da3820cb5abe89e418d934131512c","width":600,"height":800,"is_main":true,"image_no":1},{"id":39887137208,"url":"https://images1.vinted.net/t/03_01bd1_h7xRSJBdzL1FQLZ1vmC3Q7XZ/f800/1784313642.jpeg?s=fc2b14c3a747ec275d0c8f9e0ddef236be217ca3","width":600,"height":800,"is_main":false,"image_no":2}],"status":"Very good","item_box":{"item_id":9422855356,"first_line":"Wild Fable","second_line":"S / US 4-6 · Very good"},"promoted":false,"is_visible":true,"size_title":"S / US 4-6","brand_title":"Wild Fable","service_fee":{"amount":"1.3","currency_code":"USD"},"is_favourite":false,"content_source":"search","favourite_count":52,"total_item_price":{"amount":"13.3","currency_code":"USD"}}],"pagination":{"next":2,"page":1,"per_page":24,"total_pages":40,"total_results":960}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/vinted/item":{"get":{"summary":"Vinted Item","description":"Fetch a Vinted listing by item URL or numeric ID. Parses the public item page (Next.js payload), returns a normalized snake_case object with photos, attributes, shipping, pricing, and optional seller profile.\n\n**Credit cost:** 1 credit per call","operationId":"get-vinted-item","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Vinted item URL or numeric item ID.\n\n**Examples (URL: recommended):**\n\n    https://www.vinted.com/items/9437210920-purple-prom-dress\n\n**Example (ID only):**\n\n    9437210920\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- With a bare numeric ID, Piloterr tries the main Vinted domains until the item is found.\n- Use `region` to force a domain and skip the multi-domain lookup.","schema":{"type":"string","description":"Vinted item URL or numeric item ID.\n\n**Examples (URL: recommended):**\n\n    https://www.vinted.com/items/9437210920-purple-prom-dress\n\n**Example (ID only):**\n\n    9437210920\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- With a bare numeric ID, Piloterr tries the main Vinted domains until the item is found.\n- Use `region` to force a domain and skip the multi-domain lookup."}},{"name":"region","in":"query","required":false,"description":"Force the Vinted domain when `query` is a bare item ID only.\n\n**Examples:**\n\n```\ncom\n```\n\n```\nhttps://www.vinted.com\n```\n\n```\nhttps://www.vinted.de\n```\n\n**Notes:**\n- Ignored when `query` is a full item URL.\n- Speeds up lookups when you already know the marketplace.","schema":{"type":"string","description":"Force the Vinted domain when `query` is a bare item ID only.\n\n**Examples:**\n\n```\ncom\n```\n\n```\nhttps://www.vinted.com\n```\n\n```\nhttps://www.vinted.de\n```\n\n**Notes:**\n- Ignored when `query` is a full item URL.\n- Speeds up lookups when you already know the marketplace."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"city":{"type":"string"},"login":{"type":"string"},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}},"business":{"type":"boolean"},"item_count":{"type":"integer"},"profile_url":{"type":"string"},"country_code":{"type":"string"},"verification":{"type":"object","properties":{"email":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"}}},"google":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"},"verified_at":{"type":"string"}}}}},"country_title":{"type":"string"},"feedback_count":{"type":"integer"},"feedback_reputation":{"type":"integer"},"positive_feedback_count":{"type":"integer"}}},"color":{"type":"string"},"price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"title":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"is_main":{"type":"boolean"},"full_size_url":{"type":"string"}}}},"status":{"type":"string"},"can_buy":{"type":"boolean"},"plugins":{"type":"object","properties":{"favourite":{"type":"object","properties":{"seller_id":{"type":"integer"},"is_favourite":{"type":"boolean"},"favourite_count":{"type":"integer"}}},"breadcrumbs":{"type":"object","properties":{"brand_id":{"type":"integer"},"catalog_id":{"type":"integer"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}}}},"description":{"type":"object","properties":{"description":{"type":"string"}}},"item_status":{"type":"object","properties":{"is_draft":{"type":"boolean"},"promoted":{"type":"boolean"},"is_closed":{"type":"boolean"},"is_hidden":{"type":"boolean"},"is_reserved":{"type":"boolean"},"transaction_permitted":{"type":"boolean"}}}}},"brand_id":{"type":"integer"},"category":{"type":"string"},"promoted":{"type":"boolean"},"seller_id":{"type":"integer"},"attributes":{"type":"object","properties":{"size":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}},"color":{"type":"string"},"status":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}},"upload_date":{"type":"string"}}},"catalog_id":{"type":"integer"},"size_title":{"type":"string"},"description":{"type":"string"},"instant_buy":{"type":"boolean"},"uploaded_at":{"type":"string"},"is_favourite":{"type":"boolean"},"favourite_count":{"type":"integer"},"pricing_services":{"type":"object","properties":{"services":{"type":"object","properties":{"shipping":{"type":"object","properties":{"type":{"type":"string"},"is_free":{"type":"boolean"},"final_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"original_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}},"buyer_protection":{"type":"object","properties":{"type":{"type":"string"},"is_free":{"type":"boolean"},"final_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"original_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}}}},"total_amount":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"original_asking_amount":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}},"shipping_details":{"type":"object","properties":{"price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"discount":{"nullable":true},"is_pickup_only":{"type":"boolean"},"is_free_shipping":{"type":"boolean"},"are_multiple_shipping_options_available":{"type":"boolean"}}}}},"examples":{"Item on vinted.com (Purple prom dress)":{"value":{"id":9437210920,"url":"https://www.vinted.com/items/9437210920-purple-prom-dress","user":{"id":3163220665,"city":"CHAMBERSBURG, PA","login":"example-user","photo":{"id":317632205,"url":"https://images1.vinted.net/placeholder/example-user.jpg","width":96,"height":96},"business":false,"item_count":10,"profile_url":"https://www.vinted.com/member/example-user","country_code":"US","verification":{"email":{"valid":true,"available":true},"google":{"valid":true,"available":true,"verified_at":"2026-06-17T08:06:05-06:00"}},"country_title":"United States","feedback_count":1,"feedback_reputation":1,"positive_feedback_count":1},"color":"Purple","price":{"amount":"9.0","currency_code":"USD"},"title":"Purple prom dress","photos":[{"id":39947998424,"url":"https://images1.vinted.net/t/03_01b9c_waHhWwt2YUWWt6mHUEY8DPbs/f800/1784471551.webp?s=895a7ec5100a7bc29e98d171869c4c1ab510ac13","width":600,"height":800,"is_main":true,"full_size_url":"https://images1.vinted.net/tc/03_01b9c_waHhWwt2YUWWt6mHUEY8DPbs/1784471551.webp?s=e1d11e587899e731615fee24ed0c6cd41d6ab0fe"}],"status":"New without tags","can_buy":true,"plugins":{"favourite":{"seller_id":3163220665,"is_favourite":false,"favourite_count":0},"breadcrumbs":{"brand_id":1,"catalog_id":1777,"breadcrumbs":[{"url":"/catalog/1904-women","title":"Women"},{"url":"/catalog/4-clothing","title":"Clothing"},{"url":"/catalog/10-dresses","title":"Dresses"},{"url":"/catalog/1774-special-occasion-dresses","title":"Special-occasion dresses"},{"url":"/catalog/1777-prom-dresses","title":"Prom dresses"}]},"description":{"description":"Long purple prom dress, one strap"},"item_status":{"is_draft":false,"promoted":true,"is_closed":false,"is_hidden":false,"is_reserved":false,"transaction_permitted":true}},"brand_id":1,"category":"Women Prom dresses","promoted":true,"seller_id":3163220665,"attributes":{"size":{"id":506,"value":"S / US 4-6"},"color":"Purple","status":{"id":50,"value":"New without tags"},"upload_date":"an hour ago"},"catalog_id":1777,"size_title":"S / US 4-6","description":"Long purple prom dress, one strap","instant_buy":true,"uploaded_at":"an hour ago","is_favourite":false,"favourite_count":0,"pricing_services":{"services":{"shipping":{"type":"shipping","is_free":true,"final_price":{"amount":"0","currency_code":"USD"},"original_price":{"amount":"6.69","currency_code":"USD"}},"buyer_protection":{"type":"buyer_protection","is_free":false,"final_price":{"amount":"1.15","currency_code":"USD"},"original_price":{"amount":"1.15","currency_code":"USD"}}},"total_amount":{"amount":"10.15","currency_code":"USD"},"original_asking_amount":{"amount":"9","currency_code":"USD"}},"shipping_details":{"price":{"amount":"0","currency_code":"USD"},"discount":null,"is_pickup_only":false,"is_free_shipping":true,"are_multiple_shipping_options_available":false}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Vinted Item","description":"Fetch a Vinted listing by item URL or numeric ID. Parses the public item page (Next.js payload), returns a normalized snake_case object with photos, attributes, shipping, pricing, and optional seller profile.\n\n**Credit cost:** 1 credit per call","operationId":"post-vinted-item","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Vinted item URL or numeric item ID.\n\n**Examples (URL: recommended):**\n\n    https://www.vinted.com/items/9437210920-purple-prom-dress\n\n**Example (ID only):**\n\n    9437210920\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- With a bare numeric ID, Piloterr tries the main Vinted domains until the item is found.\n- Use `region` to force a domain and skip the multi-domain lookup.","schema":{"type":"string","description":"Vinted item URL or numeric item ID.\n\n**Examples (URL: recommended):**\n\n    https://www.vinted.com/items/9437210920-purple-prom-dress\n\n**Example (ID only):**\n\n    9437210920\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- With a bare numeric ID, Piloterr tries the main Vinted domains until the item is found.\n- Use `region` to force a domain and skip the multi-domain lookup."}},{"name":"region","in":"query","required":false,"description":"Force the Vinted domain when `query` is a bare item ID only.\n\n**Examples:**\n\n```\ncom\n```\n\n```\nhttps://www.vinted.com\n```\n\n```\nhttps://www.vinted.de\n```\n\n**Notes:**\n- Ignored when `query` is a full item URL.\n- Speeds up lookups when you already know the marketplace.","schema":{"type":"string","description":"Force the Vinted domain when `query` is a bare item ID only.\n\n**Examples:**\n\n```\ncom\n```\n\n```\nhttps://www.vinted.com\n```\n\n```\nhttps://www.vinted.de\n```\n\n**Notes:**\n- Ignored when `query` is a full item URL.\n- Speeds up lookups when you already know the marketplace."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"city":{"type":"string"},"login":{"type":"string"},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}},"business":{"type":"boolean"},"item_count":{"type":"integer"},"profile_url":{"type":"string"},"country_code":{"type":"string"},"verification":{"type":"object","properties":{"email":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"}}},"google":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"},"verified_at":{"type":"string"}}}}},"country_title":{"type":"string"},"feedback_count":{"type":"integer"},"feedback_reputation":{"type":"integer"},"positive_feedback_count":{"type":"integer"}}},"color":{"type":"string"},"price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"title":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"is_main":{"type":"boolean"},"full_size_url":{"type":"string"}}}},"status":{"type":"string"},"can_buy":{"type":"boolean"},"plugins":{"type":"object","properties":{"favourite":{"type":"object","properties":{"seller_id":{"type":"integer"},"is_favourite":{"type":"boolean"},"favourite_count":{"type":"integer"}}},"breadcrumbs":{"type":"object","properties":{"brand_id":{"type":"integer"},"catalog_id":{"type":"integer"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}}}},"description":{"type":"object","properties":{"description":{"type":"string"}}},"item_status":{"type":"object","properties":{"is_draft":{"type":"boolean"},"promoted":{"type":"boolean"},"is_closed":{"type":"boolean"},"is_hidden":{"type":"boolean"},"is_reserved":{"type":"boolean"},"transaction_permitted":{"type":"boolean"}}}}},"brand_id":{"type":"integer"},"category":{"type":"string"},"promoted":{"type":"boolean"},"seller_id":{"type":"integer"},"attributes":{"type":"object","properties":{"size":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}},"color":{"type":"string"},"status":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}},"upload_date":{"type":"string"}}},"catalog_id":{"type":"integer"},"size_title":{"type":"string"},"description":{"type":"string"},"instant_buy":{"type":"boolean"},"uploaded_at":{"type":"string"},"is_favourite":{"type":"boolean"},"favourite_count":{"type":"integer"},"pricing_services":{"type":"object","properties":{"services":{"type":"object","properties":{"shipping":{"type":"object","properties":{"type":{"type":"string"},"is_free":{"type":"boolean"},"final_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"original_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}},"buyer_protection":{"type":"object","properties":{"type":{"type":"string"},"is_free":{"type":"boolean"},"final_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"original_price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}}}},"total_amount":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"original_asking_amount":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}}}},"shipping_details":{"type":"object","properties":{"price":{"type":"object","properties":{"amount":{"type":"string"},"currency_code":{"type":"string"}}},"discount":{"nullable":true},"is_pickup_only":{"type":"boolean"},"is_free_shipping":{"type":"boolean"},"are_multiple_shipping_options_available":{"type":"boolean"}}}}},"examples":{"Item on vinted.com (Purple prom dress)":{"value":{"id":9437210920,"url":"https://www.vinted.com/items/9437210920-purple-prom-dress","user":{"id":3163220665,"city":"CHAMBERSBURG, PA","login":"example-user","photo":{"id":317632205,"url":"https://images1.vinted.net/placeholder/example-user.jpg","width":96,"height":96},"business":false,"item_count":10,"profile_url":"https://www.vinted.com/member/example-user","country_code":"US","verification":{"email":{"valid":true,"available":true},"google":{"valid":true,"available":true,"verified_at":"2026-06-17T08:06:05-06:00"}},"country_title":"United States","feedback_count":1,"feedback_reputation":1,"positive_feedback_count":1},"color":"Purple","price":{"amount":"9.0","currency_code":"USD"},"title":"Purple prom dress","photos":[{"id":39947998424,"url":"https://images1.vinted.net/t/03_01b9c_waHhWwt2YUWWt6mHUEY8DPbs/f800/1784471551.webp?s=895a7ec5100a7bc29e98d171869c4c1ab510ac13","width":600,"height":800,"is_main":true,"full_size_url":"https://images1.vinted.net/tc/03_01b9c_waHhWwt2YUWWt6mHUEY8DPbs/1784471551.webp?s=e1d11e587899e731615fee24ed0c6cd41d6ab0fe"}],"status":"New without tags","can_buy":true,"plugins":{"favourite":{"seller_id":3163220665,"is_favourite":false,"favourite_count":0},"breadcrumbs":{"brand_id":1,"catalog_id":1777,"breadcrumbs":[{"url":"/catalog/1904-women","title":"Women"},{"url":"/catalog/4-clothing","title":"Clothing"},{"url":"/catalog/10-dresses","title":"Dresses"},{"url":"/catalog/1774-special-occasion-dresses","title":"Special-occasion dresses"},{"url":"/catalog/1777-prom-dresses","title":"Prom dresses"}]},"description":{"description":"Long purple prom dress, one strap"},"item_status":{"is_draft":false,"promoted":true,"is_closed":false,"is_hidden":false,"is_reserved":false,"transaction_permitted":true}},"brand_id":1,"category":"Women Prom dresses","promoted":true,"seller_id":3163220665,"attributes":{"size":{"id":506,"value":"S / US 4-6"},"color":"Purple","status":{"id":50,"value":"New without tags"},"upload_date":"an hour ago"},"catalog_id":1777,"size_title":"S / US 4-6","description":"Long purple prom dress, one strap","instant_buy":true,"uploaded_at":"an hour ago","is_favourite":false,"favourite_count":0,"pricing_services":{"services":{"shipping":{"type":"shipping","is_free":true,"final_price":{"amount":"0","currency_code":"USD"},"original_price":{"amount":"6.69","currency_code":"USD"}},"buyer_protection":{"type":"buyer_protection","is_free":false,"final_price":{"amount":"1.15","currency_code":"USD"},"original_price":{"amount":"1.15","currency_code":"USD"}}},"total_amount":{"amount":"10.15","currency_code":"USD"},"original_asking_amount":{"amount":"9","currency_code":"USD"}},"shipping_details":{"price":{"amount":"0","currency_code":"USD"},"discount":null,"is_pickup_only":false,"is_free_shipping":true,"are_multiple_shipping_options_available":false}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/website/antibot":{"get":{"summary":"Website Antibot","description":"Detect which anti-bot protection protects a website before you scrape. Get the vendor, confidence level, and matching clues from a single URL check.\n\n**Credit cost:** 1 credit per call","operationId":"website-antibot","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full URL or domain name to analyze for anti-bot protection. Must be a valid hostname.\n\n**Examples:**\n\n```\nhttps://www.example.com\n```\n\n```\nexample.com\n```\n\n**Notes:**\n- Passive fingerprinting from HTTP headers, cookies, and page content.\n- Challenge pages (403, 503) still count as a successful analysis.","schema":{"type":"string","description":"Full URL or domain name to analyze for anti-bot protection. Must be a valid hostname.\n\n**Examples:**\n\n```\nhttps://www.example.com\n```\n\n```\nexample.com\n```\n\n**Notes:**\n- Passive fingerprinting from HTTP headers, cookies, and page content.\n- Challenge pages (403, 503) still count as a successful analysis."}},{"name":"timeout","in":"query","required":false,"description":"Maximum request timeout in seconds. Defaults to `15`.","schema":{"type":"number","description":"Maximum request timeout in seconds. Defaults to `15`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"vendor":{"type":"string"},"final_url":{"type":"string"},"confidence":{"type":"string"},"detections":{"type":"array","items":{"type":"object","properties":{"vendor":{"type":"string"},"evidence":{"type":"array","items":{"type":"string"}},"confidence":{"type":"string"}}}},"requested_url":{"type":"string"}}},"examples":{"Cloudflare on crunchbase.com":{"value":{"status":200,"vendor":"cloudflare","final_url":"https://www.crunchbase.com/","confidence":"high","detections":[{"vendor":"cloudflare","evidence":["Header cf-ray: a1da70864ed39e6f-CDG","Header cf-cache-status: HIT","Header server: cloudflare","Cookie __cf_bm present (Bot Management)"],"confidence":"high"}],"requested_url":"https://www.crunchbase.com/"}},"DataDome on allegro.pl (403 challenge)":{"value":{"status":403,"vendor":"datadome","final_url":"https://allegro.pl/","confidence":"high","detections":[{"vendor":"datadome","evidence":["Cookie datadome present","Header x-datadome-cid: AHrlqAAAAAMAbMO5pDBn7PQAJac65Q==","Body marker: geo.captcha-delivery.com","Body marker: captcha-delivery.com"],"confidence":"high"}],"requested_url":"https://allegro.pl"}},"Akamai + PerimeterX on walmart.com":{"value":{"status":200,"vendor":"akamai","final_url":"https://www.walmart.com/","confidence":"high","detections":[{"vendor":"akamai","evidence":["Header x-akamai-transformed: 0 - 0 -","Cookie ak_bmsc present","Cookie bm_mi present"],"confidence":"high"},{"vendor":"perimeterx","evidence":["Body marker: window._pxAppId"],"confidence":"high"}],"requested_url":"https://www.walmart.com"}},"No protection detected":{"value":{"status":200,"vendor":"none","final_url":"https://example.org/","confidence":null,"detections":[],"requested_url":"https://example.org"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/website/webunlocker":{"post":{"summary":"Website WebUnlocker (POST)","description":"Send POST requests to whitelisted websites or APIs through WebUnlocker to bypass advanced anti-bot protection and retrieve the upstream response.\n\n**Credit cost:** 3 credits per call","operationId":"post-website-webunlocker","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Target URL (website or API endpoint) to call with POST via WebUnlocker. Must include `http` or `https`. The domain must be on Piloterr's whitelist.\n\n**Example:**\n\n    https://www.seloger-bureaux-commerces.com/api/classifieds/search\n\n**Notes:**\n- Put `query` in the query string and send the upstream JSON payload as the request body (recommended).\n- Alternatively, send `{ \"query\": \"...\", \"json\": { ... } }` in the body.\n- For simple page GET fetches, use the [Website WebUnlocker](https://docs.piloterr.com/website-webunlocker) endpoint instead.","schema":{"type":"string","description":"Target URL (website or API endpoint) to call with POST via WebUnlocker. Must include `http` or `https`. The domain must be on Piloterr's whitelist.\n\n**Example:**\n\n    https://www.seloger-bureaux-commerces.com/api/classifieds/search\n\n**Notes:**\n- Put `query` in the query string and send the upstream JSON payload as the request body (recommended).\n- Alternatively, send `{ \"query\": \"...\", \"json\": { ... } }` in the body.\n- For simple page GET fetches, use the [Website WebUnlocker](https://docs.piloterr.com/website-webunlocker) endpoint instead."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"POST search API via WebUnlocker":{"value":"{\"results\": [{\"id\": \"234275997\", \"title\": \"Boutique\", \"price\": 2862000, \"city\": \"Paris 8ème\", \"url\": \"https://www.seloger-bureaux-commerces.com/annonces/achat/boutique/paris-8eme/234275997\"}], \"pagination\": {\"page\": 1, \"total\": 1145}}"}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"get":{"summary":"Website WebUnlocker","description":"Bypass advanced anti-bot systems (Cloudflare, DataDome, Akamai, PerimeterX) on whitelisted domains. Combines browser rendering and unlock tooling; use after Crawler and Rendering fail.\n\n**Credit cost:** 3 credits per call","operationId":"get-website-webunlocker","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A public website URL to unlock with the WebUnlocker engine. Must include `http://` or `https://`. The target domain must be on Piloterr's approved whitelist.\n\n**Example:**\n\n    https://www.norauto.fr/t/pneu/w-185-h-55-r-14/ete-s/80-l-h-q.html\n\n**Choosing the right engine:**\n- Try [Website Crawler](https://www.piloterr.com/library/website-crawler) and [Website Rendering](https://www.piloterr.com/library/website-rendering) first when possible (lower cost).\n- Use WebUnlocker only for advanced bot protection on approved domains.\n- Contact Piloterr support to request whitelist access before production.\n\nSee [Website Scraping guide](https://www.piloterr.com/blog/website-crawler-vs-rendering-vs-webunlocker) for a full comparison.","schema":{"type":"string","description":"A public website URL to unlock with the WebUnlocker engine. Must include `http://` or `https://`. The target domain must be on Piloterr's approved whitelist.\n\n**Example:**\n\n    https://www.norauto.fr/t/pneu/w-185-h-55-r-14/ete-s/80-l-h-q.html\n\n**Choosing the right engine:**\n- Try [Website Crawler](https://www.piloterr.com/library/website-crawler) and [Website Rendering](https://www.piloterr.com/library/website-rendering) first when possible (lower cost).\n- Use WebUnlocker only for advanced bot protection on approved domains.\n- Contact Piloterr support to request whitelist access before production.\n\nSee [Website Scraping guide](https://www.piloterr.com/blog/website-crawler-vs-rendering-vs-webunlocker) for a full comparison."}},{"name":"allow_redirects","in":"query","required":false,"description":"Controls whether the WebUnlocker engine should follow HTTP redirects.\n\n- `true`: Follow redirects automatically (**default**)\n- `false`: Stop at the first HTTP response without following any redirect\n\n**Notes:**\n- **Set to `false`** when you need to inspect the redirect chain or capture intermediate responses.","schema":{"type":"boolean","default":"true","description":"Controls whether the WebUnlocker engine should follow HTTP redirects.\n\n- `true`: Follow redirects automatically (**default**)\n- `false`: Stop at the first HTTP response without following any redirect\n\n**Notes:**\n- **Set to `false`** when you need to inspect the redirect chain or capture intermediate responses."}},{"name":"return_page_source","in":"query","required":false,"description":"Controls whether the response returns the raw, unprocessed HTML source of the page.\n\n- `false`: Return processed/parsed content (**default**)\n- `true`: Return the exact HTML source as delivered by the web server after bot bypass\n\n**Notes:**\n- Useful when you need the unmodified server response for debugging or precise parsing.","schema":{"type":"boolean","default":"false","description":"Controls whether the response returns the raw, unprocessed HTML source of the page.\n\n- `false`: Return processed/parsed content (**default**)\n- `true`: Return the exact HTML source as delivered by the web server after bot bypass\n\n**Notes:**\n- Useful when you need the unmodified server response for debugging or precise parsing."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"Unlock norauto.fr product page":{"value":"<!DOCTYPE html><html lang=\"fr\"><head><meta charset=\"UTF-8\"><title>Pneus été 185/55 R14 | Norauto</title><meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"></head><body><div id=\"app\"><main class=\"product-listing\"><h1>Pneus 185/55 R14 été</h1><div class=\"product-grid\"><div class=\"product-card\"><span class=\"brand\">Goodyear</span><span class=\"price\">89,90€</span></div></div></main></div></body></html>"}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/indeed/job/salary":{"get":{"summary":"Indeed Job Salary","description":"Indeed Job Salary API. Career salary aggregates by job title slug or URL. Browser rendering returns median, percentiles and top paying cities.\n\n**Credit cost:** 2 credits per call","operationId":"get-indeed-job-salary","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Career salary slug, full `/career/.../salaries` URL or `slug|location` pair.\n\n**Examples:**\n\n```\ningénieur-etudes-et-développement\n```\n\n```\ningénieur-etudes-et-développement|Paris-(75)\n```\n\n```\nhttps://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries\n```","schema":{"type":"string","description":"Career salary slug, full `/career/.../salaries` URL or `slug|location` pair.\n\n**Examples:**\n\n```\ningénieur-etudes-et-développement\n```\n\n```\ningénieur-etudes-et-développement|Paris-(75)\n```\n\n```\nhttps://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"period":{"type":"string"},"salary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"text":{"type":"string"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"country":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"by_period":{"type":"object","properties":{"DAILY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"HOURLY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"YEARLY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"MONTHLY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}}}},"title_slug":{"type":"string"},"location_slug":{"nullable":true},"related_titles":{"nullable":true},"national_salary":{"nullable":true},"top_paying_cities":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"salary":{"nullable":true},"currency":{"type":"string"},"location":{"type":"string"},"location_slug":{"type":"string"}}}},"top_paying_companies":{"type":"array","items":{"type":"object","properties":{"salary":{"type":"object","properties":{"mean":{"type":"number"},"type":{"type":"string"},"count":{"type":"integer"}}},"company_url":{"nullable":true},"company_name":{"type":"string"},"reviews_count":{"type":"integer"}}}}}},"examples":{"Salary aggregates for 'ingénieur-etudes-et-développement' in France":{"value":{"url":"https://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries","title":"Ingénieur Etudes Et Développement (H/F)","period":"YEARLY","salary":{"max":69630.14,"min":31076.39,"mean":48879.51,"text":"46 517 €","type":"YEARLY","median":46517.24,"num_data_points":2269},"country":"FR","currency":"EUR","location":"France","by_period":{"DAILY":{"max":603.35,"min":356.04,"mean":473.4,"type":"DAILY","median":463.48,"num_data_points":108},"HOURLY":{"max":98.98,"min":31.18,"mean":61.49,"type":"HOURLY","median":55.56,"num_data_points":18},"YEARLY":{"max":69630.14,"min":31076.39,"mean":48879.51,"type":"YEARLY","median":46517.24,"num_data_points":2269},"MONTHLY":{"max":3509.6,"min":1795.21,"mean":2552.01,"type":"MONTHLY","median":2454.6,"num_data_points":86}},"title_slug":"ing%C3%A9nieur-etudes-et-d%C3%A9veloppement","location_slug":null,"related_titles":null,"national_salary":null,"top_paying_cities":[{"url":"https://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries/Paris","salary":null,"currency":"EUR","location":"Paris","location_slug":"Paris"},{"url":"https://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries/Bordeaux","salary":null,"currency":"EUR","location":"Bordeaux","location_slug":"Bordeaux"}],"top_paying_companies":[{"salary":{"mean":114.85,"type":"HOURLY","count":3},"company_url":null,"company_name":"Service Civique","reviews_count":12},{"salary":{"mean":422,"type":"DAILY","count":5},"company_url":null,"company_name":"FREELANCE.COM","reviews_count":10}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Indeed Job Salary","description":"Indeed Job Salary API. Career salary aggregates by job title slug or URL. Browser rendering returns median, percentiles and top paying cities.\n\n**Credit cost:** 2 credits per call","operationId":"post-indeed-job-salary","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Career salary slug, full `/career/.../salaries` URL or `slug|location` pair.\n\n**Examples:**\n\n```\ningénieur-etudes-et-développement\n```\n\n```\ningénieur-etudes-et-développement|Paris-(75)\n```\n\n```\nhttps://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries\n```","schema":{"type":"string","description":"Career salary slug, full `/career/.../salaries` URL or `slug|location` pair.\n\n**Examples:**\n\n```\ningénieur-etudes-et-développement\n```\n\n```\ningénieur-etudes-et-développement|Paris-(75)\n```\n\n```\nhttps://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"period":{"type":"string"},"salary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"text":{"type":"string"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"country":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"by_period":{"type":"object","properties":{"DAILY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"HOURLY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"YEARLY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}},"MONTHLY":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"mean":{"type":"number"},"type":{"type":"string"},"median":{"type":"number"},"num_data_points":{"type":"integer"}}}}},"title_slug":{"type":"string"},"location_slug":{"nullable":true},"related_titles":{"nullable":true},"national_salary":{"nullable":true},"top_paying_cities":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"salary":{"nullable":true},"currency":{"type":"string"},"location":{"type":"string"},"location_slug":{"type":"string"}}}},"top_paying_companies":{"type":"array","items":{"type":"object","properties":{"salary":{"type":"object","properties":{"mean":{"type":"number"},"type":{"type":"string"},"count":{"type":"integer"}}},"company_url":{"nullable":true},"company_name":{"type":"string"},"reviews_count":{"type":"integer"}}}}}},"examples":{"Salary aggregates for 'ingénieur-etudes-et-développement' in France":{"value":{"url":"https://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries","title":"Ingénieur Etudes Et Développement (H/F)","period":"YEARLY","salary":{"max":69630.14,"min":31076.39,"mean":48879.51,"text":"46 517 €","type":"YEARLY","median":46517.24,"num_data_points":2269},"country":"FR","currency":"EUR","location":"France","by_period":{"DAILY":{"max":603.35,"min":356.04,"mean":473.4,"type":"DAILY","median":463.48,"num_data_points":108},"HOURLY":{"max":98.98,"min":31.18,"mean":61.49,"type":"HOURLY","median":55.56,"num_data_points":18},"YEARLY":{"max":69630.14,"min":31076.39,"mean":48879.51,"type":"YEARLY","median":46517.24,"num_data_points":2269},"MONTHLY":{"max":3509.6,"min":1795.21,"mean":2552.01,"type":"MONTHLY","median":2454.6,"num_data_points":86}},"title_slug":"ing%C3%A9nieur-etudes-et-d%C3%A9veloppement","location_slug":null,"related_titles":null,"national_salary":null,"top_paying_cities":[{"url":"https://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries/Paris","salary":null,"currency":"EUR","location":"Paris","location_slug":"Paris"},{"url":"https://fr.indeed.com/career/ing%C3%A9nieur-etudes-et-d%C3%A9veloppement/salaries/Bordeaux","salary":null,"currency":"EUR","location":"Bordeaux","location_slug":"Bordeaux"}],"top_paying_companies":[{"salary":{"mean":114.85,"type":"HOURLY","count":3},"company_url":null,"company_name":"Service Civique","reviews_count":12},{"salary":{"mean":422,"type":"DAILY","count":5},"company_url":null,"company_name":"FREELANCE.COM","reviews_count":10}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/picard/product":{"get":{"summary":"Picard Product","description":"Picard Product API. Fetch full frozen food product data from a Picard URL or reference. Returns pricing, images, description, Nutri-Score, Planet-Score, breadcrumb and reviews.\n\n**Credit cost:** 1 credit per call","operationId":"get-picard-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Picard product URL or numeric reference.\n\n**Examples:**\n\n```\n050314\n```\n\n```\nhttps://www.picard.fr/produits/puree-patate-douce-000000000000050314.html\n```","schema":{"type":"string","description":"Picard product URL or numeric reference.\n\n**Examples:**\n\n```\n050314\n```\n\n```\nhttps://www.picard.fr/produits/puree-patate-douce-000000000000050314.html\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"label":{"type":"string"},"price":{"type":"number"},"range":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"origin":{"type":"string"},"rating":{"type":"number"},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"packaging":{"type":"string"},"reference":{"type":"string"},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}}}},"nutriscore":{"type":"string"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"description":{"type":"string"},"planetscore":{"type":"string"},"subcategory":{"type":"string"},"availability":{"type":"string"},"subcategory2":{"type":"string"},"reviews_count":{"type":"integer"},"unit_price_text":{"type":"string"}}},"examples":{"Purée de patate douce (050314) on picard.fr":{"value":{"url":"https://www.picard.fr/produits/puree-patate-douce-000000000000050314.html","gtin":"3270160503148","brand":"Picard","label":"Convient aux végétariens","price":2.6,"range":"Purées","title":"Purée de patate douce","images":["https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sh=200","https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sw=672&sh=392&q=30&frz-v=115"],"origin":"Produit élaboré en France à partir de patate douce cultivée en Espagne et au Portugal","rating":4.7,"category":"Légumes et fruits","currency":"EUR","image_url":"https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sh=200","packaging":"la boîte de 450 g","reference":"050314","breadcrumb":[{"url":"https://www.picard.fr/","name":"Accueil","position":1},{"url":"https://www.picard.fr/rayons","name":"Rayons","position":2},{"url":"https://www.picard.fr/rayons/legumes-et-fruits","name":"Légumes et fruits","position":3},{"url":"https://www.picard.fr/produits/puree-patate-douce-000000000000050314.html","name":"Purée de patate douce","position":6}],"nutriscore":"A","product_id":"000000000000050314","unit_price":5.77,"description":"Redécouvrez un légume oublié avec cette purée de patate douce au petit goût de châtaigne.","planetscore":"C","subcategory":"Légumes cuisinés","availability":"InStock","subcategory2":"Purées","reviews_count":336,"unit_price_text":"Prix au kilo\n5,77 €/kg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Picard Product","description":"Picard Product API. Fetch full frozen food product data from a Picard URL or reference. Returns pricing, images, description, Nutri-Score, Planet-Score, breadcrumb and reviews.\n\n**Credit cost:** 1 credit per call","operationId":"post-picard-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Picard product URL or numeric reference.\n\n**Examples:**\n\n```\n050314\n```\n\n```\nhttps://www.picard.fr/produits/puree-patate-douce-000000000000050314.html\n```","schema":{"type":"string","description":"Picard product URL or numeric reference.\n\n**Examples:**\n\n```\n050314\n```\n\n```\nhttps://www.picard.fr/produits/puree-patate-douce-000000000000050314.html\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"gtin":{"type":"string"},"brand":{"type":"string"},"label":{"type":"string"},"price":{"type":"number"},"range":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"origin":{"type":"string"},"rating":{"type":"number"},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"packaging":{"type":"string"},"reference":{"type":"string"},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}}}},"nutriscore":{"type":"string"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"description":{"type":"string"},"planetscore":{"type":"string"},"subcategory":{"type":"string"},"availability":{"type":"string"},"subcategory2":{"type":"string"},"reviews_count":{"type":"integer"},"unit_price_text":{"type":"string"}}},"examples":{"Purée de patate douce (050314) on picard.fr":{"value":{"url":"https://www.picard.fr/produits/puree-patate-douce-000000000000050314.html","gtin":"3270160503148","brand":"Picard","label":"Convient aux végétariens","price":2.6,"range":"Purées","title":"Purée de patate douce","images":["https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sh=200","https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sw=672&sh=392&q=30&frz-v=115"],"origin":"Produit élaboré en France à partir de patate douce cultivée en Espagne et au Portugal","rating":4.7,"category":"Légumes et fruits","currency":"EUR","image_url":"https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sh=200","packaging":"la boîte de 450 g","reference":"050314","breadcrumb":[{"url":"https://www.picard.fr/","name":"Accueil","position":1},{"url":"https://www.picard.fr/rayons","name":"Rayons","position":2},{"url":"https://www.picard.fr/rayons/legumes-et-fruits","name":"Légumes et fruits","position":3},{"url":"https://www.picard.fr/produits/puree-patate-douce-000000000000050314.html","name":"Purée de patate douce","position":6}],"nutriscore":"A","product_id":"000000000000050314","unit_price":5.77,"description":"Redécouvrez un légume oublié avec cette purée de patate douce au petit goût de châtaigne.","planetscore":"C","subcategory":"Légumes cuisinés","availability":"InStock","subcategory2":"Purées","reviews_count":336,"unit_price_text":"Prix au kilo\n5,77 €/kg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/picard/search":{"get":{"summary":"Picard Search","description":"Picard Search API. Search frozen food listings on picard.fr by keyword or URL. Parses SFCC Search-UpdateGrid HTML; returns prices, Nutri-Score, ratings and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-picard-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Picard search URL.\n\n**Examples:**\n\n```\npatate douce\n```\n\n```\nhttps://www.picard.fr/recherche?q=patate&lang=fr_FR\n```\n\nUse **Picard Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full Picard search URL.\n\n**Examples:**\n\n```\npatate douce\n```\n\n```\nhttps://www.picard.fr/recherche?q=patate&lang=fr_FR\n```\n\nUse **Picard Product** on any result `url` or `product_id` for full PDP data."}},{"name":"page","in":"query","required":false,"description":"1-based page number (24 results per page via SFCC `Search-UpdateGrid`). Default: `1`.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (24 results per page via SFCC `Search-UpdateGrid`). Default: `1`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"packaging":{"type":"string"},"reference":{"type":"string"},"nutriscore":{"type":"string"},"product_id":{"type":"string"},"subcategory":{"type":"string"},"availability":{"type":"string"},"reviews_count":{"nullable":true},"unit_price_text":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"count":{"type":"integer"},"has_next":{"type":"boolean"},"per_page":{"type":"integer"}}}}},"examples":{"Search 'patate douce' on picard.fr (page 1)":{"value":{"results":[{"url":"https://www.picard.fr/produits/inedites-patate-douce-patates-douce-enrobees-000000000000050935.html","price":3.4,"title":"Inédites à la patate douce, patates douce enrobées","rating":4.56,"category":"Légumes et fruits","currency":"EUR","image_url":"https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dw8a619f76/produits/000000000000050935_E.jpg?sw=258&sh=151&q=30","packaging":"le sachet de 500 g","reference":"50935","nutriscore":"C","product_id":"000000000000050935","subcategory":"Féculents","availability":"en stock","reviews_count":null,"unit_price_text":"6,80 €/kg"},{"url":"https://www.picard.fr/produits/puree-patate-douce-000000000000050314.html","price":2.6,"title":"Purée de patate douce","rating":4.7,"category":"Légumes et fruits","currency":"EUR","image_url":"https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sw=258&sh=151&q=30","packaging":"la boîte de 450 g","reference":"50314","nutriscore":"A","product_id":"000000000000050314","subcategory":"Légumes cuisinés","availability":"en stock","reviews_count":null,"unit_price_text":"5,77 €/kg"}],"pagination":{"next":null,"page":1,"count":21,"has_next":false,"per_page":24}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Picard Search","description":"Picard Search API. Search frozen food listings on picard.fr by keyword or URL. Parses SFCC Search-UpdateGrid HTML; returns prices, Nutri-Score, ratings and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-picard-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Picard search URL.\n\n**Examples:**\n\n```\npatate douce\n```\n\n```\nhttps://www.picard.fr/recherche?q=patate&lang=fr_FR\n```\n\nUse **Picard Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full Picard search URL.\n\n**Examples:**\n\n```\npatate douce\n```\n\n```\nhttps://www.picard.fr/recherche?q=patate&lang=fr_FR\n```\n\nUse **Picard Product** on any result `url` or `product_id` for full PDP data."}},{"name":"page","in":"query","required":false,"description":"1-based page number (24 results per page via SFCC `Search-UpdateGrid`). Default: `1`.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (24 results per page via SFCC `Search-UpdateGrid`). Default: `1`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"packaging":{"type":"string"},"reference":{"type":"string"},"nutriscore":{"type":"string"},"product_id":{"type":"string"},"subcategory":{"type":"string"},"availability":{"type":"string"},"reviews_count":{"nullable":true},"unit_price_text":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"count":{"type":"integer"},"has_next":{"type":"boolean"},"per_page":{"type":"integer"}}}}},"examples":{"Search 'patate douce' on picard.fr (page 1)":{"value":{"results":[{"url":"https://www.picard.fr/produits/inedites-patate-douce-patates-douce-enrobees-000000000000050935.html","price":3.4,"title":"Inédites à la patate douce, patates douce enrobées","rating":4.56,"category":"Légumes et fruits","currency":"EUR","image_url":"https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dw8a619f76/produits/000000000000050935_E.jpg?sw=258&sh=151&q=30","packaging":"le sachet de 500 g","reference":"50935","nutriscore":"C","product_id":"000000000000050935","subcategory":"Féculents","availability":"en stock","reviews_count":null,"unit_price_text":"6,80 €/kg"},{"url":"https://www.picard.fr/produits/puree-patate-douce-000000000000050314.html","price":2.6,"title":"Purée de patate douce","rating":4.7,"category":"Légumes et fruits","currency":"EUR","image_url":"https://www.picard.fr/dw/image/v2/AAHV_PRD/on/demandware.static/-/Sites-catalog-picard/default/dwea0e1bd9/produits/legumes/edition/000000000000050314_E1.jpg?sw=258&sh=151&q=30","packaging":"la boîte de 450 g","reference":"50314","nutriscore":"A","product_id":"000000000000050314","subcategory":"Légumes cuisinés","availability":"en stock","reviews_count":null,"unit_price_text":"5,77 €/kg"}],"pagination":{"next":null,"page":1,"count":21,"has_next":false,"per_page":24}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/oscaro/search":{"get":{"summary":"Oscaro Search","description":"Oscaro Search API. Search auto parts by keyword, search URL or category listing on oscaro.com, oscaro.es and oscaro.pt. Returns prices and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-oscaro-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword, search URL, or category listing URL (`*-{id}-g`).\n\n**Examples:**\n\n```\nmoteur ai\n```\n\n```\nhttps://www.oscaro.com/fr/search?q=moteur+ai\n```\n\n```\nhttps://www.oscaro.com/huile-moteur-1862-g\n```\n\nUse **Oscaro Product** on any result `url` for full PDP data.","schema":{"type":"string","description":"Search keyword, search URL, or category listing URL (`*-{id}-g`).\n\n**Examples:**\n\n```\nmoteur ai\n```\n\n```\nhttps://www.oscaro.com/fr/search?q=moteur+ai\n```\n\n```\nhttps://www.oscaro.com/huile-moteur-1862-g\n```\n\nUse **Oscaro Product** on any result `url` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Target shop when `query` is a keyword (default: `com`).\n\n**Examples:** `com`, `fr`, `es`, `pt`\n\nIgnored when `query` is a full Oscaro URL.","schema":{"type":"string","description":"Target shop when `query` is a keyword (default: `com`).\n\n**Examples:** `com`, `fr`, `es`, `pt`\n\nIgnored when `query` is a full Oscaro URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number override for category listing URLs (default: read from URL or `1`). Uses `?page=2` on `*-g` pages.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override for category listing URLs (default: read from URL or `1`). Uses `?page=2` on `*-g` pages."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Search 'moteur ai' on oscaro.com (page 1)":{"value":{"results":[{"url":"https://www.oscaro.com/moteur-electrique-pulseur-dair-habitacle-magneti-marelli-069412247010-13361124-793-p","price":91.79,"title":"Moteur électrique, pulseur d'air habitacle MAGNETI MARELLI - 069412247010","currency":"EUR","image_url":"https://oscaro.media/catalog/images/jpg/normal/95/mt_mte247ax-wr.jpg","product_id":"13361124-793"},{"url":"https://www.oscaro.com/moteur-electrique-pulseur-dair-habitacle-magneti-marelli-069412215010-13485530-793-p","price":47.6,"title":"Moteur électrique, pulseur d'air habitacle MAGNETI MARELLI - 069412215010","currency":"EUR","image_url":"https://oscaro.media/catalog/images/jpg/normal/95/mt_mte215ax_wr.jpg","product_id":"13485530-793"}],"pagination":{"next":null,"page":1,"per_page":50,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Oscaro Search","description":"Oscaro Search API. Search auto parts by keyword, search URL or category listing on oscaro.com, oscaro.es and oscaro.pt. Returns prices and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-oscaro-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword, search URL, or category listing URL (`*-{id}-g`).\n\n**Examples:**\n\n```\nmoteur ai\n```\n\n```\nhttps://www.oscaro.com/fr/search?q=moteur+ai\n```\n\n```\nhttps://www.oscaro.com/huile-moteur-1862-g\n```\n\nUse **Oscaro Product** on any result `url` for full PDP data.","schema":{"type":"string","description":"Search keyword, search URL, or category listing URL (`*-{id}-g`).\n\n**Examples:**\n\n```\nmoteur ai\n```\n\n```\nhttps://www.oscaro.com/fr/search?q=moteur+ai\n```\n\n```\nhttps://www.oscaro.com/huile-moteur-1862-g\n```\n\nUse **Oscaro Product** on any result `url` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Target shop when `query` is a keyword (default: `com`).\n\n**Examples:** `com`, `fr`, `es`, `pt`\n\nIgnored when `query` is a full Oscaro URL.","schema":{"type":"string","description":"Target shop when `query` is a keyword (default: `com`).\n\n**Examples:** `com`, `fr`, `es`, `pt`\n\nIgnored when `query` is a full Oscaro URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number override for category listing URLs (default: read from URL or `1`). Uses `?page=2` on `*-g` pages.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override for category listing URLs (default: read from URL or `1`). Uses `?page=2` on `*-g` pages."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Search 'moteur ai' on oscaro.com (page 1)":{"value":{"results":[{"url":"https://www.oscaro.com/moteur-electrique-pulseur-dair-habitacle-magneti-marelli-069412247010-13361124-793-p","price":91.79,"title":"Moteur électrique, pulseur d'air habitacle MAGNETI MARELLI - 069412247010","currency":"EUR","image_url":"https://oscaro.media/catalog/images/jpg/normal/95/mt_mte247ax-wr.jpg","product_id":"13361124-793"},{"url":"https://www.oscaro.com/moteur-electrique-pulseur-dair-habitacle-magneti-marelli-069412215010-13485530-793-p","price":47.6,"title":"Moteur électrique, pulseur d'air habitacle MAGNETI MARELLI - 069412215010","currency":"EUR","image_url":"https://oscaro.media/catalog/images/jpg/normal/95/mt_mte215ax_wr.jpg","product_id":"13485530-793"}],"pagination":{"next":null,"page":1,"per_page":50,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/oscaro/product":{"get":{"summary":"Oscaro Product","description":"Oscaro Product API. Fetch full auto parts product data from an Oscaro product URL. Returns pricing, brand, reference, images and availability via browser rendering and JSON-LD parsing.\n\n**Credit cost:** 2 credits per call","operationId":"get-oscaro-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Oscaro product page URL (`*-{sku}-p` suffix).\n\n**Examples:**\n\n```\nhttps://www.oscaro.com/huile-moteur-motul-102208-15213891-1862-p\n```\n\n```\nhttps://www.oscaro.es/filtro-de-aceite-purflux-l343d-13644654-7-p\n```\n\nRegion is auto-detected from the URL TLD.","schema":{"type":"string","description":"Oscaro product page URL (`*-{sku}-p` suffix).\n\n**Examples:**\n\n```\nhttps://www.oscaro.com/huile-moteur-motul-102208-15213891-1862-p\n```\n\n```\nhttps://www.oscaro.es/filtro-de-aceite-purflux-l343d-13644654-7-p\n```\n\nRegion is auto-detected from the URL TLD."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"reference":{"type":"string"},"product_id":{"type":"string"}}},"examples":{"MOTUL SPECIFIC 0720 5W-30 (15213891) on oscaro.com":{"value":{"url":"https://www.oscaro.com/huile-moteur-motul-102208-15213891-1862-p","brand":"MOTUL","price":13.28,"title":"MOTUL - SPECIFIC 0720 5W-30  1L - ref. 102208 - Huile moteur","images":["https://oscaro.media/catalog/images/oscjpg/normal/1114/specific 0720 5w30 1l.jpg"],"currency":"EUR","in_stock":true,"image_url":"https://oscaro.media/catalog/images/oscjpg/normal/1114/specific 0720 5w30 1l.jpg","reference":"102208","product_id":"15213891"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Oscaro Product","description":"Oscaro Product API. Fetch full auto parts product data from an Oscaro product URL. Returns pricing, brand, reference, images and availability via browser rendering and JSON-LD parsing.\n\n**Credit cost:** 2 credits per call","operationId":"post-oscaro-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Oscaro product page URL (`*-{sku}-p` suffix).\n\n**Examples:**\n\n```\nhttps://www.oscaro.com/huile-moteur-motul-102208-15213891-1862-p\n```\n\n```\nhttps://www.oscaro.es/filtro-de-aceite-purflux-l343d-13644654-7-p\n```\n\nRegion is auto-detected from the URL TLD.","schema":{"type":"string","description":"Oscaro product page URL (`*-{sku}-p` suffix).\n\n**Examples:**\n\n```\nhttps://www.oscaro.com/huile-moteur-motul-102208-15213891-1862-p\n```\n\n```\nhttps://www.oscaro.es/filtro-de-aceite-purflux-l343d-13644654-7-p\n```\n\nRegion is auto-detected from the URL TLD."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"reference":{"type":"string"},"product_id":{"type":"string"}}},"examples":{"MOTUL SPECIFIC 0720 5W-30 (15213891) on oscaro.com":{"value":{"url":"https://www.oscaro.com/huile-moteur-motul-102208-15213891-1862-p","brand":"MOTUL","price":13.28,"title":"MOTUL - SPECIFIC 0720 5W-30  1L - ref. 102208 - Huile moteur","images":["https://oscaro.media/catalog/images/oscjpg/normal/1114/specific 0720 5w30 1l.jpg"],"currency":"EUR","in_stock":true,"image_url":"https://oscaro.media/catalog/images/oscjpg/normal/1114/specific 0720 5w30 1l.jpg","reference":"102208","product_id":"15213891"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zooplus/product":{"get":{"summary":"Zooplus Product","description":"Read one Zooplus product by id or URL, in the region of that shop. Variants keep their own price and EAN.\n\n**Credit cost:** 1 credit per call","operationId":"get-zooplus-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A product link, a `/shop/.../{id}` path, or the product number.\n\nExamples:\n\n```\n705321\n```\n\n```\nhttps://www.zooplus.fr/shop/chats/croquettes_chat/iams_croquettes_chat/iams_adulte_croquettes_chat/705321\n```\n\nA search link returns 400.","schema":{"type":"string","description":"A product link, a `/shop/.../{id}` path, or the product number.\n\nExamples:\n\n```\n705321\n```\n\n```\nhttps://www.zooplus.fr/shop/chats/croquettes_chat/iams_croquettes_chat/iams_adulte_croquettes_chat/705321\n```\n\nA search link returns 400."}},{"name":"region","in":"query","required":false,"description":"Which country shop when query is a number or a path. `fr` is France (default). `de` is Germany. `uk` is the United Kingdom.\n\nA full link picks the shop itself. A conflicting region returns 400.","schema":{"type":"string","default":"fr","description":"Which country shop when query is a number or a path. `fr` is France (default). `de` is Germany. `uk` is the United Kingdom.\n\nA full link picks the shop itself. A conflicting region returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the product.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the product."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"integer"},"region":{"type":"string"},"reviews":{"type":"array","items":{"type":"object","properties":{"body":{"type":"string"},"date":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"rating":{"type":"integer"},"variant":{"type":"string"}}}},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"sku":{"type":"string"},"unit":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"available":{"type":"boolean"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"description":{"type":"string"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}}},"image_url":{"type":"string"},"price_max":{"type":"number"},"price_min":{"type":"number"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"is_zooplus_choice":{"type":"boolean"},"price_max_display":{"type":"string"},"price_min_display":{"type":"string"},"unit_price_display":{"type":"string"},"selected_variant_id":{"type":"string"}}},"examples":{"IAMS sterilised on zooplus.fr":{"value":{"ean":"8710255150550","url":"https://www.zooplus.fr/shop/chats/croquettes_chat/iams_croquettes_chat/iams_adulte_croquettes_chat/705321","unit":"kg","brand":"IAMS","price":32.99,"title":"IAMS Advanced Nutrition Adult Sterilised poulet pour chat","rating":4,"region":"fr","reviews":[{"body":"Mon chat aime beaucoup c'est croquettes. Bon rapport qualité prix.","date":"2026-10-12","title":"Mon chat aime beaucoup c'est croquettes","author":"Alex Martin","rating":5,"variant":"10 kg"}],"category":"Chat > Croquettes pour chat > IAMS","currency":"EUR","in_stock":true,"variants":[{"ean":"8710255150543","sku":"705321.1","unit":"kg","price":13.49,"currency":"EUR","available":true,"unit_price":4.5,"variant_id":"1","description":"3 kg","price_display":"13,49 €","unit_price_display":"4,50 € / kg"},{"ean":"8710255150550","sku":"705321.2","unit":"kg","price":32.99,"currency":"EUR","available":true,"unit_price":3.3,"variant_id":"2","description":"10 kg","price_display":"32,99 €","unit_price_display":"3,30 € / kg"},{"ean":"8710255150550","sku":"705321.0","unit":"kg","price":64.49,"currency":"EUR","available":true,"unit_price":3.22,"variant_id":"0","description":"2 x 10 kg","price_display":"64,49 €","unit_price_display":"3,22 € / kg"}],"image_url":"https://media.zooplus.com/bilder/9/800/1_8710255150543_1_9.jpg","price_max":64.49,"price_min":13.49,"product_id":"705321","unit_price":3.3,"review_count":164,"price_display":"32,99 €","variant_count":3,"is_zooplus_choice":false,"price_max_display":"64,49 €","price_min_display":"13,49 €","unit_price_display":"3,30 € / kg","selected_variant_id":"2"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zooplus Product","description":"Read one Zooplus product by id or URL, in the region of that shop. Variants keep their own price and EAN.\n\n**Credit cost:** 1 credit per call","operationId":"post-zooplus-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A product link, a `/shop/.../{id}` path, or the product number.\n\nExamples:\n\n```\n705321\n```\n\n```\nhttps://www.zooplus.fr/shop/chats/croquettes_chat/iams_croquettes_chat/iams_adulte_croquettes_chat/705321\n```\n\nA search link returns 400.","schema":{"type":"string","description":"A product link, a `/shop/.../{id}` path, or the product number.\n\nExamples:\n\n```\n705321\n```\n\n```\nhttps://www.zooplus.fr/shop/chats/croquettes_chat/iams_croquettes_chat/iams_adulte_croquettes_chat/705321\n```\n\nA search link returns 400."}},{"name":"region","in":"query","required":false,"description":"Which country shop when query is a number or a path. `fr` is France (default). `de` is Germany. `uk` is the United Kingdom.\n\nA full link picks the shop itself. A conflicting region returns 400.","schema":{"type":"string","default":"fr","description":"Which country shop when query is a number or a path. `fr` is France (default). `de` is Germany. `uk` is the United Kingdom.\n\nA full link picks the shop itself. A conflicting region returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the product.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the product."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"integer"},"region":{"type":"string"},"reviews":{"type":"array","items":{"type":"object","properties":{"body":{"type":"string"},"date":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"rating":{"type":"integer"},"variant":{"type":"string"}}}},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"ean":{"type":"string"},"sku":{"type":"string"},"unit":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"available":{"type":"boolean"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"description":{"type":"string"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}}},"image_url":{"type":"string"},"price_max":{"type":"number"},"price_min":{"type":"number"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"is_zooplus_choice":{"type":"boolean"},"price_max_display":{"type":"string"},"price_min_display":{"type":"string"},"unit_price_display":{"type":"string"},"selected_variant_id":{"type":"string"}}},"examples":{"IAMS sterilised on zooplus.fr":{"value":{"ean":"8710255150550","url":"https://www.zooplus.fr/shop/chats/croquettes_chat/iams_croquettes_chat/iams_adulte_croquettes_chat/705321","unit":"kg","brand":"IAMS","price":32.99,"title":"IAMS Advanced Nutrition Adult Sterilised poulet pour chat","rating":4,"region":"fr","reviews":[{"body":"Mon chat aime beaucoup c'est croquettes. Bon rapport qualité prix.","date":"2026-10-12","title":"Mon chat aime beaucoup c'est croquettes","author":"Alex Martin","rating":5,"variant":"10 kg"}],"category":"Chat > Croquettes pour chat > IAMS","currency":"EUR","in_stock":true,"variants":[{"ean":"8710255150543","sku":"705321.1","unit":"kg","price":13.49,"currency":"EUR","available":true,"unit_price":4.5,"variant_id":"1","description":"3 kg","price_display":"13,49 €","unit_price_display":"4,50 € / kg"},{"ean":"8710255150550","sku":"705321.2","unit":"kg","price":32.99,"currency":"EUR","available":true,"unit_price":3.3,"variant_id":"2","description":"10 kg","price_display":"32,99 €","unit_price_display":"3,30 € / kg"},{"ean":"8710255150550","sku":"705321.0","unit":"kg","price":64.49,"currency":"EUR","available":true,"unit_price":3.22,"variant_id":"0","description":"2 x 10 kg","price_display":"64,49 €","unit_price_display":"3,22 € / kg"}],"image_url":"https://media.zooplus.com/bilder/9/800/1_8710255150543_1_9.jpg","price_max":64.49,"price_min":13.49,"product_id":"705321","unit_price":3.3,"review_count":164,"price_display":"32,99 €","variant_count":3,"is_zooplus_choice":false,"price_max_display":"64,49 €","price_min_display":"13,49 €","unit_price_display":"3,30 € / kg","selected_variant_id":"2"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zooplus/search":{"get":{"summary":"Zooplus Search","description":"Search a Zooplus country shop by keyword. Region defaults to France. Page through food, litter, and accessory cards with local prices.\n\n**Credit cost:** 1 credit per call","operationId":"get-zooplus-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word, or a Zooplus search link.\n\nExamples:\n\n```\ncroquettes\n```\n\n```\nhttps://www.zooplus.fr/search/results?q=croquettes\n```\n\nA product link returns 400.","schema":{"type":"string","description":"What to look for. A word, or a Zooplus search link.\n\nExamples:\n\n```\ncroquettes\n```\n\n```\nhttps://www.zooplus.fr/search/results?q=croquettes\n```\n\nA product link returns 400."}},{"name":"region","in":"query","required":false,"description":"Which country shop. `fr` is France (default, www.zooplus.fr). `de` is Germany (www.zooplus.de). `uk` is the United Kingdom (www.zooplus.co.uk).\n\nA full link picks the shop from its address. If region names a different shop, the call returns 400. `gb` means `uk`.","schema":{"type":"string","default":"fr","description":"Which country shop. `fr` is France (default, www.zooplus.fr). `de` is Germany (www.zooplus.de). `uk` is the United Kingdom (www.zooplus.co.uk).\n\nA full link picks the shop from its address. If region names a different shop, the call returns 400. `gb` means `uk`."}},{"name":"page","in":"query","required":false,"description":"Which page of results, starting at 1. Page 2 uses p=2 and returns different products.","schema":{"type":"number","minimum":1,"description":"Which page of results, starting at 1. Page 2 uses p=2 and returns different products."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the product list.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the product list."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"discount_label":{"type":"string"},"reference_price":{"type":"number"},"unit_price_display":{"type":"string"},"variant_description":{"type":"string"},"reference_price_label":{"type":"string"},"reference_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Eukanuba 12 kg on zooplus.fr":{"value":{"results":[{"sku":"46220.13","url":"https://www.zooplus.fr/shop/chiens/croquettes_chien/eukanuba_special_breed_croquettes_chien/eukanuba_breed_nutrition_croquettes_chien/46220?activeVariant=46220.13","unit":"kg","brand":"Eukanuba","price":42.49,"title":"Eukanuba Adult Breed Care Berger Allemand","region":"fr","currency":"EUR","in_stock":true,"image_url":"https://media.zooplus.com/bilder/7/400/169996_pla_tetragmbhiams_eukanuba_adult_breedspecific_deutscherschaeferhund_12kg_hs_01_7.jpg","product_id":"46220","unit_price":3.54,"variant_id":"13","price_display":"42,49 €","variant_count":4,"discount_label":"Économisez -10%","reference_price":62.99,"unit_price_display":"3,54 €","variant_description":"12 kg","reference_price_label":"Prix conseillé","reference_price_display":"62,99 €"}],"pagination":{"next":"https://www.zooplus.fr/search/results?q=croquettes&p=2","page":1,"per_page":48,"total_pages":183,"total_results":8740}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zooplus Search","description":"Search a Zooplus country shop by keyword. Region defaults to France. Page through food, litter, and accessory cards with local prices.\n\n**Credit cost:** 1 credit per call","operationId":"post-zooplus-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to look for. A word, or a Zooplus search link.\n\nExamples:\n\n```\ncroquettes\n```\n\n```\nhttps://www.zooplus.fr/search/results?q=croquettes\n```\n\nA product link returns 400.","schema":{"type":"string","description":"What to look for. A word, or a Zooplus search link.\n\nExamples:\n\n```\ncroquettes\n```\n\n```\nhttps://www.zooplus.fr/search/results?q=croquettes\n```\n\nA product link returns 400."}},{"name":"region","in":"query","required":false,"description":"Which country shop. `fr` is France (default, www.zooplus.fr). `de` is Germany (www.zooplus.de). `uk` is the United Kingdom (www.zooplus.co.uk).\n\nA full link picks the shop from its address. If region names a different shop, the call returns 400. `gb` means `uk`.","schema":{"type":"string","default":"fr","description":"Which country shop. `fr` is France (default, www.zooplus.fr). `de` is Germany (www.zooplus.de). `uk` is the United Kingdom (www.zooplus.co.uk).\n\nA full link picks the shop from its address. If region names a different shop, the call returns 400. `gb` means `uk`."}},{"name":"page","in":"query","required":false,"description":"Which page of results, starting at 1. Page 2 uses p=2 and returns different products.","schema":{"type":"number","minimum":1,"description":"Which page of results, starting at 1. Page 2 uses p=2 and returns different products."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the raw HTML in result instead of the product list.","schema":{"type":"boolean","description":"Set to true to get the raw HTML in result instead of the product list."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"unit_price":{"type":"number"},"variant_id":{"type":"string"},"price_display":{"type":"string"},"variant_count":{"type":"integer"},"discount_label":{"type":"string"},"reference_price":{"type":"number"},"unit_price_display":{"type":"string"},"variant_description":{"type":"string"},"reference_price_label":{"type":"string"},"reference_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Eukanuba 12 kg on zooplus.fr":{"value":{"results":[{"sku":"46220.13","url":"https://www.zooplus.fr/shop/chiens/croquettes_chien/eukanuba_special_breed_croquettes_chien/eukanuba_breed_nutrition_croquettes_chien/46220?activeVariant=46220.13","unit":"kg","brand":"Eukanuba","price":42.49,"title":"Eukanuba Adult Breed Care Berger Allemand","region":"fr","currency":"EUR","in_stock":true,"image_url":"https://media.zooplus.com/bilder/7/400/169996_pla_tetragmbhiams_eukanuba_adult_breedspecific_deutscherschaeferhund_12kg_hs_01_7.jpg","product_id":"46220","unit_price":3.54,"variant_id":"13","price_display":"42,49 €","variant_count":4,"discount_label":"Économisez -10%","reference_price":62.99,"unit_price_display":"3,54 €","variant_description":"12 kg","reference_price_label":"Prix conseillé","reference_price_display":"62,99 €"}],"pagination":{"next":"https://www.zooplus.fr/search/results?q=croquettes&p=2","page":1,"per_page":48,"total_pages":183,"total_results":8740}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/snapeda/product":{"get":{"summary":"SnapEDA Product","description":"SnapEDA Product API: fetch full part page data from a SnapEDA URL or MPN/manufacturer slug. Returns CAD models, datasheet, RoHS, distributor pricing and availability via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-snapeda-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"SnapEDA part page URL or `MPN/manufacturer` slug.\n\n**Examples:**\n\n```\nCYPD3175-24LQXQ/Cypress Semiconductor\n```\n\n```\nhttps://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/\n```","schema":{"type":"string","description":"SnapEDA part page URL or `MPN/manufacturer` slug.\n\n**Examples:**\n\n```\nCYPD3175-24LQXQ/Cypress Semiconductor\n```\n\n```\nhttps://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"rohs":{"type":"boolean"},"formats":{"type":"array","items":{"type":"string"}},"part_id":{"type":"string"},"pricing":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string"},"currency":{"type":"string"},"quantity":{"type":"integer"},"supplier":{"type":"string"},"price_value":{"type":"integer"}}}},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"cad_models":{"type":"object","properties":{"symbol":{"type":"boolean"},"model_3d":{"type":"boolean"},"footprint":{"type":"boolean"}}},"description":{"type":"string"},"part_number":{"type":"string"},"availability":{"type":"string"},"manufacturer":{"type":"string"},"datasheet_url":{"type":"string"}}},"examples":{"CYPD3175-24LQXQ (Cypress Semiconductor) on snapeda.com":{"value":{"url":"https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part","rohs":true,"formats":["Altium","Eagle","KiCAD","Cadence OrCad/Allegro","PADS","DxDesigner","PCB123","Pulsonix","Proteus"],"part_id":"2776245","pricing":[{"price":"37 x $8.30","currency":"USD","quantity":54954,"supplier":"Featured","price_value":37},{"price":"239 x $1.58 500 x $1.41 1,000 x $1.31 10,000 x $1.17 100,000 x $0.98","currency":"USD","quantity":1470,"supplier":"Verical","price_value":239}],"in_stock":true,"image_url":"https://snapeda.s3.us-east-1.amazonaws.com/partpics/Cypress Semiconductor_CYPD3175-24L-X-_40408.jpg","cad_models":{"symbol":true,"model_3d":true,"footprint":true},"description":"ARM® Cortex®-M0 EZ-PD™ CCG3PA USB Type C Microcontroller IC FLASH (64kB) 24-UFQFN Exposed Pad","part_number":"CYPD3175-24LQXQ","availability":"In Stock","manufacturer":"Cypress Semiconductor","datasheet_url":"https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/datasheet/"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SnapEDA Product","description":"SnapEDA Product API: fetch full part page data from a SnapEDA URL or MPN/manufacturer slug. Returns CAD models, datasheet, RoHS, distributor pricing and availability via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-snapeda-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"SnapEDA part page URL or `MPN/manufacturer` slug.\n\n**Examples:**\n\n```\nCYPD3175-24LQXQ/Cypress Semiconductor\n```\n\n```\nhttps://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/\n```","schema":{"type":"string","description":"SnapEDA part page URL or `MPN/manufacturer` slug.\n\n**Examples:**\n\n```\nCYPD3175-24LQXQ/Cypress Semiconductor\n```\n\n```\nhttps://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"rohs":{"type":"boolean"},"formats":{"type":"array","items":{"type":"string"}},"part_id":{"type":"string"},"pricing":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string"},"currency":{"type":"string"},"quantity":{"type":"integer"},"supplier":{"type":"string"},"price_value":{"type":"integer"}}}},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"cad_models":{"type":"object","properties":{"symbol":{"type":"boolean"},"model_3d":{"type":"boolean"},"footprint":{"type":"boolean"}}},"description":{"type":"string"},"part_number":{"type":"string"},"availability":{"type":"string"},"manufacturer":{"type":"string"},"datasheet_url":{"type":"string"}}},"examples":{"CYPD3175-24LQXQ (Cypress Semiconductor) on snapeda.com":{"value":{"url":"https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part","rohs":true,"formats":["Altium","Eagle","KiCAD","Cadence OrCad/Allegro","PADS","DxDesigner","PCB123","Pulsonix","Proteus"],"part_id":"2776245","pricing":[{"price":"37 x $8.30","currency":"USD","quantity":54954,"supplier":"Featured","price_value":37},{"price":"239 x $1.58 500 x $1.41 1,000 x $1.31 10,000 x $1.17 100,000 x $0.98","currency":"USD","quantity":1470,"supplier":"Verical","price_value":239}],"in_stock":true,"image_url":"https://snapeda.s3.us-east-1.amazonaws.com/partpics/Cypress Semiconductor_CYPD3175-24L-X-_40408.jpg","cad_models":{"symbol":true,"model_3d":true,"footprint":true},"description":"ARM® Cortex®-M0 EZ-PD™ CCG3PA USB Type C Microcontroller IC FLASH (64kB) 24-UFQFN Exposed Pad","part_number":"CYPD3175-24LQXQ","availability":"In Stock","manufacturer":"Cypress Semiconductor","datasheet_url":"https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/datasheet/"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/snapeda/search":{"get":{"summary":"SnapEDA Search","description":"SnapEDA Search API: search electronic parts by keyword or URL on SnapMagic Search (ex-SnapEDA). Returns MPN, manufacturer, pricing, CAD availability and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-snapeda-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full SnapEDA / SnapMagic search URL.\n\n**Examples:**\n\n```\nUSB Type C\n```\n\n```\nhttps://www.snapeda.com/search/?q=Bluetooth+Module\n```\n\nUse **SnapEDA Product** on any result `url` or `part_number`/`manufacturer` for full part data.","schema":{"type":"string","description":"Search keyword or full SnapEDA / SnapMagic search URL.\n\n**Examples:**\n\n```\nUSB Type C\n```\n\n```\nhttps://www.snapeda.com/search/?q=Bluetooth+Module\n```\n\nUse **SnapEDA Product** on any result `url` or `part_number`/`manufacturer` for full part data."}},{"name":"page","in":"query","required":false,"description":"1-based page number override (default: read from URL or `1`). SnapEDA returns 20 results per page.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override (default: read from URL or `1`). SnapEDA returns 20 results per page."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"package":{"type":"string"},"part_id":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"has_symbol":{"type":"boolean"},"description":{"type":"string"},"part_number":{"type":"string"},"availability":{"type":"string"},"manufacturer":{"type":"string"},"has_footprint":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'USB Type C' on snapeda.com (page 1)":{"value":{"results":[{"url":"https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/","price":0.93,"package":"Custom","part_id":"2776245","currency":"USD","image_url":"https://snapeda.s3.amazonaws.com/pinax/images/company_logos/thumbs/Infineon-Logo.svg.png","has_symbol":true,"description":"ARM® Cortex®-M0 EZ-PD™ CCG3PA USB Type C Microcontroller IC FLASH (64kB) 24-UFQFN Exposed Pad","part_number":"CYPD3175-24LQXQ","availability":"In Stock","manufacturer":"Cypress Semiconductor","has_footprint":true},{"url":"https://www.snapeda.com/parts/PI5USB30213AXEAEX/Diodes%20Zetex/view-part/","price":0.89,"package":"Custom","part_id":"12128468","currency":"USD","image_url":"https://snapeda.s3.amazonaws.com/pinax/images/company_logos/thumbs/Zetex.jpg","has_symbol":true,"description":"High Speed Type-C Dual Role Port Controller USB 3.1 T/R 24-Pin X1QFN EP","part_number":"PI5USB30213AXEAEX","availability":"In Stock","manufacturer":"Diodes Zetex","has_footprint":true}],"pagination":{"page":1,"per_page":20,"total_pages":218,"total_results":4349}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SnapEDA Search","description":"SnapEDA Search API: search electronic parts by keyword or URL on SnapMagic Search (ex-SnapEDA). Returns MPN, manufacturer, pricing, CAD availability and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-snapeda-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full SnapEDA / SnapMagic search URL.\n\n**Examples:**\n\n```\nUSB Type C\n```\n\n```\nhttps://www.snapeda.com/search/?q=Bluetooth+Module\n```\n\nUse **SnapEDA Product** on any result `url` or `part_number`/`manufacturer` for full part data.","schema":{"type":"string","description":"Search keyword or full SnapEDA / SnapMagic search URL.\n\n**Examples:**\n\n```\nUSB Type C\n```\n\n```\nhttps://www.snapeda.com/search/?q=Bluetooth+Module\n```\n\nUse **SnapEDA Product** on any result `url` or `part_number`/`manufacturer` for full part data."}},{"name":"page","in":"query","required":false,"description":"1-based page number override (default: read from URL or `1`). SnapEDA returns 20 results per page.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override (default: read from URL or `1`). SnapEDA returns 20 results per page."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"package":{"type":"string"},"part_id":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"has_symbol":{"type":"boolean"},"description":{"type":"string"},"part_number":{"type":"string"},"availability":{"type":"string"},"manufacturer":{"type":"string"},"has_footprint":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'USB Type C' on snapeda.com (page 1)":{"value":{"results":[{"url":"https://www.snapeda.com/parts/CYPD3175-24LQXQ/Cypress%20Semiconductor/view-part/","price":0.93,"package":"Custom","part_id":"2776245","currency":"USD","image_url":"https://snapeda.s3.amazonaws.com/pinax/images/company_logos/thumbs/Infineon-Logo.svg.png","has_symbol":true,"description":"ARM® Cortex®-M0 EZ-PD™ CCG3PA USB Type C Microcontroller IC FLASH (64kB) 24-UFQFN Exposed Pad","part_number":"CYPD3175-24LQXQ","availability":"In Stock","manufacturer":"Cypress Semiconductor","has_footprint":true},{"url":"https://www.snapeda.com/parts/PI5USB30213AXEAEX/Diodes%20Zetex/view-part/","price":0.89,"package":"Custom","part_id":"12128468","currency":"USD","image_url":"https://snapeda.s3.amazonaws.com/pinax/images/company_logos/thumbs/Zetex.jpg","has_symbol":true,"description":"High Speed Type-C Dual Role Port Controller USB 3.1 T/R 24-Pin X1QFN EP","part_number":"PI5USB30213AXEAEX","availability":"In Stock","manufacturer":"Diodes Zetex","has_footprint":true}],"pagination":{"page":1,"per_page":20,"total_pages":218,"total_results":4349}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aldi/search":{"get":{"summary":"Aldi Search","description":"Aldi Search API: list products from an Aldi category page URL or path across FR, DE, NL and Canarias shops. Returns prices, thumbnails and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-aldi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Aldi category page URL or site path.\n\n**Examples:**\n\n```\nproduits/viande-poisson/poisson-crustace.html\n```\n\n```\nhttps://www.aldi.fr/produits/viande-poisson/poisson-crustace.html\n```\n\nUse **Aldi Product** on any result `url` for full PDP data.","schema":{"type":"string","description":"Aldi category page URL or site path.\n\n**Examples:**\n\n```\nproduits/viande-poisson/poisson-crustace.html\n```\n\n```\nhttps://www.aldi.fr/produits/viande-poisson/poisson-crustace.html\n```\n\nUse **Aldi Product** on any result `url` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is a path only (default: `fr`).\n\n**Examples:** `de`, `nl`, `es-can`\n\nIgnored when `query` is a full Aldi URL.","schema":{"type":"string","description":"Target country when `query` is a path only (default: `fr`).\n\n**Examples:** `de`, `nl`, `es-can`\n\nIgnored when `query` is a full Aldi URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number override (default: read from URL or `1`).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override (default: read from URL or `1`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"sales_unit":{"type":"string"},"product_slug":{"type":"string"},"short_description":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Poisson & crustacés category on aldi.fr (page 1)":{"value":{"results":[{"url":"https://www.aldi.fr/fiches-produits/dos-de-cabillaud-9855.html","brand":"GOLDEN SEAFOOD®","price":9.99,"title":"Dos de cabillaud","images":["https://s7g10.scene7.com/is/image/aldinord/9855.main.01.freezer.gp2024","https://s7g10.scene7.com/is/image/aldinord/Label_peche_durable_msc"],"category":"Viandes et poissons > Poissons et crustacés","currency":"EUR","image_url":"https://s7g10.scene7.com/is/image/aldinord/9855.main.01.freezer.gp2024","product_id":"9855","sales_unit":"540G","product_slug":"dos-de-cabillaud-9855","short_description":"Régalez-vous avec notre délicieux dos de cabillaud…"}],"pagination":{"next":null,"page":1,"per_page":46,"total_pages":1,"total_results":46}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Aldi Search","description":"Aldi Search API: list products from an Aldi category page URL or path across FR, DE, NL and Canarias shops. Returns prices, thumbnails and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-aldi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Aldi category page URL or site path.\n\n**Examples:**\n\n```\nproduits/viande-poisson/poisson-crustace.html\n```\n\n```\nhttps://www.aldi.fr/produits/viande-poisson/poisson-crustace.html\n```\n\nUse **Aldi Product** on any result `url` for full PDP data.","schema":{"type":"string","description":"Aldi category page URL or site path.\n\n**Examples:**\n\n```\nproduits/viande-poisson/poisson-crustace.html\n```\n\n```\nhttps://www.aldi.fr/produits/viande-poisson/poisson-crustace.html\n```\n\nUse **Aldi Product** on any result `url` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is a path only (default: `fr`).\n\n**Examples:** `de`, `nl`, `es-can`\n\nIgnored when `query` is a full Aldi URL.","schema":{"type":"string","description":"Target country when `query` is a path only (default: `fr`).\n\n**Examples:** `de`, `nl`, `es-can`\n\nIgnored when `query` is a full Aldi URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number override (default: read from URL or `1`).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override (default: read from URL or `1`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"sales_unit":{"type":"string"},"product_slug":{"type":"string"},"short_description":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Poisson & crustacés category on aldi.fr (page 1)":{"value":{"results":[{"url":"https://www.aldi.fr/fiches-produits/dos-de-cabillaud-9855.html","brand":"GOLDEN SEAFOOD®","price":9.99,"title":"Dos de cabillaud","images":["https://s7g10.scene7.com/is/image/aldinord/9855.main.01.freezer.gp2024","https://s7g10.scene7.com/is/image/aldinord/Label_peche_durable_msc"],"category":"Viandes et poissons > Poissons et crustacés","currency":"EUR","image_url":"https://s7g10.scene7.com/is/image/aldinord/9855.main.01.freezer.gp2024","product_id":"9855","sales_unit":"540G","product_slug":"dos-de-cabillaud-9855","short_description":"Régalez-vous avec notre délicieux dos de cabillaud…"}],"pagination":{"next":null,"page":1,"per_page":46,"total_pages":1,"total_results":46}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aldi/product":{"get":{"summary":"Aldi Product","description":"Aldi Product API: fetch full product page data from an Aldi URL or path slug. Returns pricing, images, description, category and cooling flags.\n\n**Credit cost:** 1 credit per call","operationId":"get-aldi-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Aldi product page URL or site path slug.\n\n**Examples:**\n\n```\nfiches-produits/filets-danchois-marines-6806.html\n```\n\n```\nhttps://www.aldi.fr/fiches-produits/filets-danchois-marines-6806.html\n```\n\nNumeric product id alone is not supported: use URL or slug path.","schema":{"type":"string","description":"Aldi product page URL or site path slug.\n\n**Examples:**\n\n```\nfiches-produits/filets-danchois-marines-6806.html\n```\n\n```\nhttps://www.aldi.fr/fiches-produits/filets-danchois-marines-6806.html\n```\n\nNumeric product id alone is not supported: use URL or slug path."}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is a path only (default: `fr`). Ignored for full product URLs.","schema":{"type":"string","description":"Target country when `query` is a path only (default: `fr`). Ignored for full product URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"is_cooling":{"type":"boolean"},"product_id":{"type":"string"},"sales_unit":{"type":"string"},"description":{"type":"string"},"product_slug":{"type":"string"},"short_description":{"type":"string"}}},"examples":{"Filets d'anchois marinés (6806) on aldi.fr":{"value":{"url":"https://www.aldi.fr/fiches-produits/filets-danchois-marines-6806.html","brand":"GOLDEN SEAFOOD®","price":1.99,"title":"FILETS D'ANCHOIS MARINÉS","images":["https://s7g10.scene7.com/is/image/aldinord/6806.main.1.fr_fr.All.anchois","https://s7g10.scene7.com/is/image/aldinord/6806_FILETS_ANCHOIS_MARINES_AIL"],"category":"73-poisson","currency":"EUR","image_url":"https://s7g10.scene7.com/is/image/aldinord/6806.main.1.fr_fr.All.anchois","is_cooling":true,"product_id":"6806","sales_unit":"100 g","description":"Pêche durable selon le référentiel MSC.","product_slug":"filets-danchois-marines-6806","short_description":"Au choix : Nature, ail et persil ou à la provençale."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Aldi Product","description":"Aldi Product API: fetch full product page data from an Aldi URL or path slug. Returns pricing, images, description, category and cooling flags.\n\n**Credit cost:** 1 credit per call","operationId":"post-aldi-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Aldi product page URL or site path slug.\n\n**Examples:**\n\n```\nfiches-produits/filets-danchois-marines-6806.html\n```\n\n```\nhttps://www.aldi.fr/fiches-produits/filets-danchois-marines-6806.html\n```\n\nNumeric product id alone is not supported: use URL or slug path.","schema":{"type":"string","description":"Aldi product page URL or site path slug.\n\n**Examples:**\n\n```\nfiches-produits/filets-danchois-marines-6806.html\n```\n\n```\nhttps://www.aldi.fr/fiches-produits/filets-danchois-marines-6806.html\n```\n\nNumeric product id alone is not supported: use URL or slug path."}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is a path only (default: `fr`). Ignored for full product URLs.","schema":{"type":"string","description":"Target country when `query` is a path only (default: `fr`). Ignored for full product URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"is_cooling":{"type":"boolean"},"product_id":{"type":"string"},"sales_unit":{"type":"string"},"description":{"type":"string"},"product_slug":{"type":"string"},"short_description":{"type":"string"}}},"examples":{"Filets d'anchois marinés (6806) on aldi.fr":{"value":{"url":"https://www.aldi.fr/fiches-produits/filets-danchois-marines-6806.html","brand":"GOLDEN SEAFOOD®","price":1.99,"title":"FILETS D'ANCHOIS MARINÉS","images":["https://s7g10.scene7.com/is/image/aldinord/6806.main.1.fr_fr.All.anchois","https://s7g10.scene7.com/is/image/aldinord/6806_FILETS_ANCHOIS_MARINES_AIL"],"category":"73-poisson","currency":"EUR","image_url":"https://s7g10.scene7.com/is/image/aldinord/6806.main.1.fr_fr.All.anchois","is_cooling":true,"product_id":"6806","sales_unit":"100 g","description":"Pêche durable selon le référentiel MSC.","product_slug":"filets-danchois-marines-6806","short_description":"Au choix : Nature, ail et persil ou à la provençale."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/reverb/search":{"get":{"summary":"Reverb Search","description":"Reverb Search API: search music gear listings by keyword, query string or marketplace URL on Reverb. Returns prices, thumbnails and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-reverb-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword, query string, or full Reverb marketplace URL.\n\n**Examples:**\n\n```\nguitar\n```\n\n```\nquery=guitar&product_type=electric-guitars\n```\n\n```\nhttps://reverb.com/marketplace?query=guitar&product_type=electric-guitars\n```\n\nUse **Reverb Product** on any result `url` or `listing_id` for full listing data.","schema":{"type":"string","description":"Search keyword, query string, or full Reverb marketplace URL.\n\n**Examples:**\n\n```\nguitar\n```\n\n```\nquery=guitar&product_type=electric-guitars\n```\n\n```\nhttps://reverb.com/marketplace?query=guitar&product_type=electric-guitars\n```\n\nUse **Reverb Product** on any result `url` or `listing_id` for full listing data."}},{"name":"page","in":"query","required":false,"description":"1-based page number override (default: read from URL or `1`).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override (default: read from URL or `1`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"image_url":{"type":"string"},"listing_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Search 'guitar' on reverb.com (page 1)":{"value":{"results":[{"url":"https://reverb.com/fr/item/92086927-fanta-studio-guitar-2023-bege-heavy-duty-engine-metal","price":847.45,"title":"Fanta Studio Guitar 2023 - Bege Heavy Duty Engine Metal","image_url":"https://rvb-img.reverb.com/i/s--rmpkcW0d--/quality=medium-low,height=400,width=400,fit=cover,gravity=bottom/eashywrraatgvpugyof8.jpg","listing_id":"92086927"},{"url":"https://reverb.com/fr/item/96872671-1988-gibson-sg-custom-antique-ivory-nitro-vintage-usa-guitar-w-original-chainsaw-case","price":4150,"title":"1988 Gibson SG Custom Antique Ivory Nitro Vintage USA Guitar w/ Original Chainsaw Case","image_url":"https://rvb-img.reverb.com/i/s--uy4zcAiS--/quality=medium-low,height=400,width=400,fit=cover,gravity=bottom/7b197daf-4157-4dbc-87eb-20de0c382571.jpg","listing_id":"96872671"}],"pagination":{"next":"https://reverb.com/marketplace?query=guitar&product_type=electric-guitars&page=2","page":1,"per_page":56,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Reverb Search","description":"Reverb Search API: search music gear listings by keyword, query string or marketplace URL on Reverb. Returns prices, thumbnails and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-reverb-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword, query string, or full Reverb marketplace URL.\n\n**Examples:**\n\n```\nguitar\n```\n\n```\nquery=guitar&product_type=electric-guitars\n```\n\n```\nhttps://reverb.com/marketplace?query=guitar&product_type=electric-guitars\n```\n\nUse **Reverb Product** on any result `url` or `listing_id` for full listing data.","schema":{"type":"string","description":"Search keyword, query string, or full Reverb marketplace URL.\n\n**Examples:**\n\n```\nguitar\n```\n\n```\nquery=guitar&product_type=electric-guitars\n```\n\n```\nhttps://reverb.com/marketplace?query=guitar&product_type=electric-guitars\n```\n\nUse **Reverb Product** on any result `url` or `listing_id` for full listing data."}},{"name":"page","in":"query","required":false,"description":"1-based page number override (default: read from URL or `1`).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override (default: read from URL or `1`)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"image_url":{"type":"string"},"listing_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Search 'guitar' on reverb.com (page 1)":{"value":{"results":[{"url":"https://reverb.com/fr/item/92086927-fanta-studio-guitar-2023-bege-heavy-duty-engine-metal","price":847.45,"title":"Fanta Studio Guitar 2023 - Bege Heavy Duty Engine Metal","image_url":"https://rvb-img.reverb.com/i/s--rmpkcW0d--/quality=medium-low,height=400,width=400,fit=cover,gravity=bottom/eashywrraatgvpugyof8.jpg","listing_id":"92086927"},{"url":"https://reverb.com/fr/item/96872671-1988-gibson-sg-custom-antique-ivory-nitro-vintage-usa-guitar-w-original-chainsaw-case","price":4150,"title":"1988 Gibson SG Custom Antique Ivory Nitro Vintage USA Guitar w/ Original Chainsaw Case","image_url":"https://rvb-img.reverb.com/i/s--uy4zcAiS--/quality=medium-low,height=400,width=400,fit=cover,gravity=bottom/7b197daf-4157-4dbc-87eb-20de0c382571.jpg","listing_id":"96872671"}],"pagination":{"next":"https://reverb.com/marketplace?query=guitar&product_type=electric-guitars&page=2","page":1,"per_page":56,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/reverb/product":{"get":{"summary":"Reverb Product","description":"Reverb Product API: fetch full listing data from a Reverb URL or listing id. Returns pricing, specs, images, description and shop info via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-reverb-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Reverb listing URL or numeric listing id.\n\n**Examples:**\n\n```\n96933467\n```\n\n```\nhttps://reverb.com/fr/item/96933467-aria-pro-ii-xx-deluxe-1983-matsumoku-noir\n```\n\nThe `bk` tracking parameter is stripped automatically.","schema":{"type":"string","description":"Reverb listing URL or numeric listing id.\n\n**Examples:**\n\n```\n96933467\n```\n\n```\nhttps://reverb.com/fr/item/96933467-aria-pro-ii-xx-deluxe-1983-matsumoku-noir\n```\n\nThe `bk` tracking parameter is stripped automatically."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"make":{"type":"string"},"shop":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"shop_id":{"type":"string"},"location":{"type":"string"},"feedback_percentage":{"type":"integer"}}},"year":{"type":"integer"},"model":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"finish":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"inventory":{"type":"integer"},"listing_id":{"type":"string"},"description":{"type":"string"},"listing_type":{"type":"string"},"price_display":{"type":"string"},"offers_enabled":{"type":"boolean"}}},"examples":{"Aria Pro II XX Deluxe (96933467) on reverb.com":{"value":{"url":"https://reverb.com/fr/item/96933467-aria-pro-ii-xx-deluxe-1983-matsumoku-noir","make":"Aria","shop":{"name":"etienne Vintage Shop","slug":"etiennes-shop-59","shop_id":"4508650","location":"HARFLEUR, France","feedback_percentage":100},"year":1983,"model":"XX Deluxe","price":580,"state":"live","title":"Aria Pro II XX Deluxe 1983(Matsumoku) - Noir","finish":"Noir","images":["https://rvb-img.reverb.com/i/s--4w_SZaeX--/quality=medium-low,height=800,width=800,fit=contain/ef1fd9bd-45f5-43fe-a27a-2cfb776430aa.jpeg"],"category":"Guitares électriques","currency":"EUR","condition":"Correct","image_url":"https://rvb-img.reverb.com/i/s--4w_SZaeX--/quality=medium-low,height=800,width=800,fit=contain/ef1fd9bd-45f5-43fe-a27a-2cfb776430aa.jpeg","inventory":0,"listing_id":"96933467","description":"<p><b><strong>Aria Pro II XX Deluxe 1983(Matsumoku) - Noir</strong></b></p>","listing_type":"MAKE_AN_OFFER","price_display":"€580","offers_enabled":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Reverb Product","description":"Reverb Product API: fetch full listing data from a Reverb URL or listing id. Returns pricing, specs, images, description and shop info via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-reverb-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Reverb listing URL or numeric listing id.\n\n**Examples:**\n\n```\n96933467\n```\n\n```\nhttps://reverb.com/fr/item/96933467-aria-pro-ii-xx-deluxe-1983-matsumoku-noir\n```\n\nThe `bk` tracking parameter is stripped automatically.","schema":{"type":"string","description":"Reverb listing URL or numeric listing id.\n\n**Examples:**\n\n```\n96933467\n```\n\n```\nhttps://reverb.com/fr/item/96933467-aria-pro-ii-xx-deluxe-1983-matsumoku-noir\n```\n\nThe `bk` tracking parameter is stripped automatically."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"make":{"type":"string"},"shop":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"shop_id":{"type":"string"},"location":{"type":"string"},"feedback_percentage":{"type":"integer"}}},"year":{"type":"integer"},"model":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"finish":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"inventory":{"type":"integer"},"listing_id":{"type":"string"},"description":{"type":"string"},"listing_type":{"type":"string"},"price_display":{"type":"string"},"offers_enabled":{"type":"boolean"}}},"examples":{"Aria Pro II XX Deluxe (96933467) on reverb.com":{"value":{"url":"https://reverb.com/fr/item/96933467-aria-pro-ii-xx-deluxe-1983-matsumoku-noir","make":"Aria","shop":{"name":"etienne Vintage Shop","slug":"etiennes-shop-59","shop_id":"4508650","location":"HARFLEUR, France","feedback_percentage":100},"year":1983,"model":"XX Deluxe","price":580,"state":"live","title":"Aria Pro II XX Deluxe 1983(Matsumoku) - Noir","finish":"Noir","images":["https://rvb-img.reverb.com/i/s--4w_SZaeX--/quality=medium-low,height=800,width=800,fit=contain/ef1fd9bd-45f5-43fe-a27a-2cfb776430aa.jpeg"],"category":"Guitares électriques","currency":"EUR","condition":"Correct","image_url":"https://rvb-img.reverb.com/i/s--4w_SZaeX--/quality=medium-low,height=800,width=800,fit=contain/ef1fd9bd-45f5-43fe-a27a-2cfb776430aa.jpeg","inventory":0,"listing_id":"96933467","description":"<p><b><strong>Aria Pro II XX Deluxe 1983(Matsumoku) - Noir</strong></b></p>","listing_type":"MAKE_AN_OFFER","price_display":"€580","offers_enabled":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/lidl/product":{"get":{"summary":"Lidl Product","description":"Lidl Product API: fetch full product page data from a Lidl URL or ERP id. Returns pricing, images, description, availability and category via Nuxt SSR parsing.\n\n**Credit cost:** 1 credit per call","operationId":"get-lidl-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Lidl product URL or ERP id.\n\n**Examples:**\n\n```\n100397447\n```\n\n```\np100397447\n```\n\n```\nhttps://www.lidl.fr/p/parkside-perceuse-a-percussion-psbm-750-b3-10-nm-750-w/p100397447\n```","schema":{"type":"string","description":"Lidl product URL or ERP id.\n\n**Examples:**\n\n```\n100397447\n```\n\n```\np100397447\n```\n\n```\nhttps://www.lidl.fr/p/parkside-perceuse-a-percussion-psbm-750-b3-10-nm-750-w/p100397447\n```"}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is an ERP id only (default: `fr`). Ignored for full product URLs.","schema":{"type":"string","description":"Target country when `query` is an ERP id only (default: `fr`). Ignored for full product URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"rating":{"type":"number"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"availability_text":{"type":"string"},"discount_percentage":{"type":"integer"}}},"examples":{"Perceuse PSBM 750 B3 (100397447) on lidl.fr":{"value":{"url":"https://www.lidl.fr/p/parkside-perceuse-a-percussion-psbm-750-b3-10-nm-750-w/p100397447","brand":"PARKSIDE®","price":17.99,"title":"PARKSIDE® Perceuse à percussion PSBM 750 B3, 10 Nm, 750 W","images":["https://www.lidl.fr/assets/gcp8943e01124db4b4b8be1424510edcc10.jpg"],"locale":"fr-fr","rating":4.2,"category":"Assortiment/Bricoler/Atelier/.../Perceuses à percussion","currency":"EUR","in_stock":true,"image_url":"https://www.lidl.fr/assets/gcp8943e01124db4b4b8be1424510edcc10.jpg","old_price":31.99,"product_id":"100397447","description":"<h3>PARKSIDE® Perceuse à percussion PSBM 750 B3, 10 Nm, 750 W</h3>","availability":"in_stock","review_count":145,"availability_text":"Disponible à la livraison","discount_percentage":43}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Lidl Product","description":"Lidl Product API: fetch full product page data from a Lidl URL or ERP id. Returns pricing, images, description, availability and category via Nuxt SSR parsing.\n\n**Credit cost:** 1 credit per call","operationId":"post-lidl-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Lidl product URL or ERP id.\n\n**Examples:**\n\n```\n100397447\n```\n\n```\np100397447\n```\n\n```\nhttps://www.lidl.fr/p/parkside-perceuse-a-percussion-psbm-750-b3-10-nm-750-w/p100397447\n```","schema":{"type":"string","description":"Lidl product URL or ERP id.\n\n**Examples:**\n\n```\n100397447\n```\n\n```\np100397447\n```\n\n```\nhttps://www.lidl.fr/p/parkside-perceuse-a-percussion-psbm-750-b3-10-nm-750-w/p100397447\n```"}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is an ERP id only (default: `fr`). Ignored for full product URLs.","schema":{"type":"string","description":"Target country when `query` is an ERP id only (default: `fr`). Ignored for full product URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"rating":{"type":"number"},"category":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"},"availability_text":{"type":"string"},"discount_percentage":{"type":"integer"}}},"examples":{"Perceuse PSBM 750 B3 (100397447) on lidl.fr":{"value":{"url":"https://www.lidl.fr/p/parkside-perceuse-a-percussion-psbm-750-b3-10-nm-750-w/p100397447","brand":"PARKSIDE®","price":17.99,"title":"PARKSIDE® Perceuse à percussion PSBM 750 B3, 10 Nm, 750 W","images":["https://www.lidl.fr/assets/gcp8943e01124db4b4b8be1424510edcc10.jpg"],"locale":"fr-fr","rating":4.2,"category":"Assortiment/Bricoler/Atelier/.../Perceuses à percussion","currency":"EUR","in_stock":true,"image_url":"https://www.lidl.fr/assets/gcp8943e01124db4b4b8be1424510edcc10.jpg","old_price":31.99,"product_id":"100397447","description":"<h3>PARKSIDE® Perceuse à percussion PSBM 750 B3, 10 Nm, 750 W</h3>","availability":"in_stock","review_count":145,"availability_text":"Disponible à la livraison","discount_percentage":43}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/action/search":{"get":{"summary":"Action Search","description":"Action Search API: search product listings by keyword or URL on Action.com across European locales. Returns prices, images, locale, currency and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-action-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Action.com search URL.\n\n**Examples:**\n\n```\nmeuble\n```\n\n```\nhttps://www.action.com/fr-fr/search/?q=meuble\n```\n\n```\nhttps://www.action.com/pt-pt/search/?q=cabide\n```\n\nUse **Action Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full Action.com search URL.\n\n**Examples:**\n\n```\nmeuble\n```\n\n```\nhttps://www.action.com/fr-fr/search/?q=meuble\n```\n\n```\nhttps://www.action.com/pt-pt/search/?q=cabide\n```\n\nUse **Action Product** on any result `url` or `product_id` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`.\n\nFor multilingual countries use full locale (`fr-be`, `nl-be`, `fr-ch`, `de-ch`, `it-ch`).","schema":{"type":"string","description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`.\n\nFor multilingual countries use full locale (`fr-be`, `nl-be`, `fr-ch`, `de-ch`, `it-ch`)."}},{"name":"page","in":"query","required":false,"description":"1-based page number (default: 1).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (default: 1)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"locale":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'meuble' on action.com fr-fr (page 1)":{"value":{"results":[{"url":"https://www.action.com/fr-fr/p/3220594/meuble-d-entree/","price":32.95,"title":"Meuble d'entrée","locale":"fr-fr","currency":"EUR","image_url":"https://asset.action.com/image/upload/3220594_8718964261123-110_01_l7lvqj","product_id":"3220594"},{"url":"https://www.action.com/fr-fr/p/3216159/etagere/","price":39.95,"title":"Étagère","locale":"fr-fr","currency":"EUR","image_url":"https://asset.action.com/image/upload/3216159_8718964237609-110_01_lbhy6y","product_id":"3216159"},{"url":"https://www.action.com/fr-fr/p/3220583/etagere/","price":29.95,"title":"Étagère","locale":"fr-fr","currency":"EUR","image_url":"https://asset.action.com/image/upload/3220583_8718964261420-110_01_uoqzby","product_id":"3220583"}],"pagination":{"next":"https://www.action.com/fr-fr/search/?q=meuble&page=2#product-grid","page":1,"per_page":24,"total_pages":8,"total_results":185}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Action Search","description":"Action Search API: search product listings by keyword or URL on Action.com across European locales. Returns prices, images, locale, currency and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-action-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Action.com search URL.\n\n**Examples:**\n\n```\nmeuble\n```\n\n```\nhttps://www.action.com/fr-fr/search/?q=meuble\n```\n\n```\nhttps://www.action.com/pt-pt/search/?q=cabide\n```\n\nUse **Action Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full Action.com search URL.\n\n**Examples:**\n\n```\nmeuble\n```\n\n```\nhttps://www.action.com/fr-fr/search/?q=meuble\n```\n\n```\nhttps://www.action.com/pt-pt/search/?q=cabide\n```\n\nUse **Action Product** on any result `url` or `product_id` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`.\n\nFor multilingual countries use full locale (`fr-be`, `nl-be`, `fr-ch`, `de-ch`, `it-ch`).","schema":{"type":"string","description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`.\n\nFor multilingual countries use full locale (`fr-be`, `nl-be`, `fr-ch`, `de-ch`, `it-ch`)."}},{"name":"page","in":"query","required":false,"description":"1-based page number (default: 1).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (default: 1)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"locale":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'meuble' on action.com fr-fr (page 1)":{"value":{"results":[{"url":"https://www.action.com/fr-fr/p/3220594/meuble-d-entree/","price":32.95,"title":"Meuble d'entrée","locale":"fr-fr","currency":"EUR","image_url":"https://asset.action.com/image/upload/3220594_8718964261123-110_01_l7lvqj","product_id":"3220594"},{"url":"https://www.action.com/fr-fr/p/3216159/etagere/","price":39.95,"title":"Étagère","locale":"fr-fr","currency":"EUR","image_url":"https://asset.action.com/image/upload/3216159_8718964237609-110_01_lbhy6y","product_id":"3216159"},{"url":"https://www.action.com/fr-fr/p/3220583/etagere/","price":29.95,"title":"Étagère","locale":"fr-fr","currency":"EUR","image_url":"https://asset.action.com/image/upload/3220583_8718964261420-110_01_uoqzby","product_id":"3220583"}],"pagination":{"next":"https://www.action.com/fr-fr/search/?q=meuble&page=2#product-grid","page":1,"per_page":24,"total_pages":8,"total_results":185}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/action/product":{"get":{"summary":"Action Product","description":"Action Product API: fetch full product page data from a product ID or URL on Action.com. Returns pricing, specs, images, breadcrumbs and availability via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-action-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Action product ID or full product URL.\n\n**Examples:**\n\n```\n3216159\n```\n\n```\nhttps://www.action.com/fr-fr/p/3216159/etagere/\n```\n\n```\nhttps://www.action.com/pt-pt/p/2535685/cabides-de-veludo/\n```","schema":{"type":"string","description":"Action product ID or full product URL.\n\n**Examples:**\n\n```\n3216159\n```\n\n```\nhttps://www.action.com/fr-fr/p/3216159/etagere/\n```\n\n```\nhttps://www.action.com/pt-pt/p/2535685/cabides-de-veludo/\n```"}},{"name":"region","in":"query","required":false,"description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`.","schema":{"type":"string","description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"availability":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Étagère (3216159) on action.com fr-fr":{"value":{"url":"https://www.action.com/fr-fr/p/3216159/etagere/","price":39.95,"title":"Étagère","images":["https://asset.action.com/image/upload/3216159_8718964237609-110_01_lbhy6y","https://asset.action.com/image/upload/3216159_8718964237593-110_01_eglur0","https://asset.action.com/image/upload/3216159_8718964237609-111_01_sofmt6"],"locale":"fr-fr","currency":"EUR","in_stock":true,"image_url":"https://asset.action.com/image/upload/3216159_8718964237609-110_01_lbhy6y","product_id":"3216159","breadcrumbs":["Habitat","Meubles","Étagère"],"description":"Donnez un coup de jeune à votre salon avec cette étagère moderne. Les rayons ouverts sont parfaits pour vos plus belles décorations et plantes, tandis que le compartiment inférieur avec portes vous permet de ranger le tout de manière ordonnée.","availability":"in_stock","specifications":[{"key":"Couleur","value":"Beige, Brun, Noir, Blanc"},{"key":"Matériau","value":"Iron, Bois mdf, Melamine"},{"key":"Numéro de l'article","value":"3216159"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Action Product","description":"Action Product API: fetch full product page data from a product ID or URL on Action.com. Returns pricing, specs, images, breadcrumbs and availability via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-action-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Action product ID or full product URL.\n\n**Examples:**\n\n```\n3216159\n```\n\n```\nhttps://www.action.com/fr-fr/p/3216159/etagere/\n```\n\n```\nhttps://www.action.com/pt-pt/p/2535685/cabides-de-veludo/\n```","schema":{"type":"string","description":"Action product ID or full product URL.\n\n**Examples:**\n\n```\n3216159\n```\n\n```\nhttps://www.action.com/fr-fr/p/3216159/etagere/\n```\n\n```\nhttps://www.action.com/pt-pt/p/2535685/cabides-de-veludo/\n```"}},{"name":"region","in":"query","required":false,"description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`.","schema":{"type":"string","description":"Locale (`fr-fr`, `de-de`, `pt-pt`, …) or country code (`fr`, `de`, `pt`). Default: `fr-fr`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"image_url":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"availability":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Étagère (3216159) on action.com fr-fr":{"value":{"url":"https://www.action.com/fr-fr/p/3216159/etagere/","price":39.95,"title":"Étagère","images":["https://asset.action.com/image/upload/3216159_8718964237609-110_01_lbhy6y","https://asset.action.com/image/upload/3216159_8718964237593-110_01_eglur0","https://asset.action.com/image/upload/3216159_8718964237609-111_01_sofmt6"],"locale":"fr-fr","currency":"EUR","in_stock":true,"image_url":"https://asset.action.com/image/upload/3216159_8718964237609-110_01_lbhy6y","product_id":"3216159","breadcrumbs":["Habitat","Meubles","Étagère"],"description":"Donnez un coup de jeune à votre salon avec cette étagère moderne. Les rayons ouverts sont parfaits pour vos plus belles décorations et plantes, tandis que le compartiment inférieur avec portes vous permet de ranger le tout de manière ordonnée.","availability":"in_stock","specifications":[{"key":"Couleur","value":"Beige, Brun, Noir, Blanc"},{"key":"Matériau","value":"Iron, Bois mdf, Melamine"},{"key":"Numéro de l'article","value":"3216159"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/upwork/services":{"get":{"summary":"Upwork Services","description":"Upwork Services API: browse Project Catalog listings by category slug or URL. Returns prices, product IDs and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-upwork-services","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Upwork Project Catalog category slug or full services URL.\n\n**Examples:**\n\n```\nmobile-apps\n```\n\n```\nhttps://www.upwork.com/services/mobile-apps\n```\n\nReturns `{ category, name, results[], pagination }`.\n\nUse **Upwork Services Info** for full product details from any `listing_url`.","schema":{"type":"string","description":"Upwork Project Catalog category slug or full services URL.\n\n**Examples:**\n\n```\nmobile-apps\n```\n\n```\nhttps://www.upwork.com/services/mobile-apps\n```\n\nReturns `{ category, name, results[], pagination }`.\n\nUse **Upwork Services Info** for full product details from any `listing_url`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"rating":{"nullable":true},"currency":{"type":"string"},"image_url":{"type":"string"},"price_from":{"type":"integer"},"product_id":{"type":"string"},"listing_url":{"type":"string"}}}},"category":{"type":"string"},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Mobile Apps category (page 1)":{"value":{"name":"Mobile Apps","results":[{"title":"Mobile App Development | Android Apps | iOS Apps | Flutter Application DevMobile App Development | Android Apps | iOS Apps | Flutter Application Dev","rating":null,"currency":"USD","image_url":"https://res.cloudinary.com/upwork-cloud/image/upload/c_scale,w_400/v1765222199/catalog/1403673770703212544/lxul06rynupzvk1jkz8s.jpg","price_from":399,"product_id":"1403673770703212544","listing_url":"https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544"},{"title":"Mobile App Developer, Android, iOS App Development in Flutter, App DesignerMobile App Developer, Android, iOS App Development in Flutter, App Designer","rating":null,"currency":"USD","image_url":"https://res.cloudinary.com/upwork-cloud/image/upload/c_scale,w_400/v1750666442/catalog/1784861153261067753/p9oduz9tvcfgpomnqqow.jpg","price_from":499,"product_id":"1784861153261067753","listing_url":"https://www.upwork.com/services/product/development-it-android-ios-mobile-app-development-using-flutter-expert-ai-app-developer-1784861153261067753"}],"category":"mobile-apps","pagination":{"next":null,"page":1,"per_page":24,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Upwork Services","description":"Upwork Services API: browse Project Catalog listings by category slug or URL. Returns prices, product IDs and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-upwork-services","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Upwork Project Catalog category slug or full services URL.\n\n**Examples:**\n\n```\nmobile-apps\n```\n\n```\nhttps://www.upwork.com/services/mobile-apps\n```\n\nReturns `{ category, name, results[], pagination }`.\n\nUse **Upwork Services Info** for full product details from any `listing_url`.","schema":{"type":"string","description":"Upwork Project Catalog category slug or full services URL.\n\n**Examples:**\n\n```\nmobile-apps\n```\n\n```\nhttps://www.upwork.com/services/mobile-apps\n```\n\nReturns `{ category, name, results[], pagination }`.\n\nUse **Upwork Services Info** for full product details from any `listing_url`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"rating":{"nullable":true},"currency":{"type":"string"},"image_url":{"type":"string"},"price_from":{"type":"integer"},"product_id":{"type":"string"},"listing_url":{"type":"string"}}}},"category":{"type":"string"},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Mobile Apps category (page 1)":{"value":{"name":"Mobile Apps","results":[{"title":"Mobile App Development | Android Apps | iOS Apps | Flutter Application DevMobile App Development | Android Apps | iOS Apps | Flutter Application Dev","rating":null,"currency":"USD","image_url":"https://res.cloudinary.com/upwork-cloud/image/upload/c_scale,w_400/v1765222199/catalog/1403673770703212544/lxul06rynupzvk1jkz8s.jpg","price_from":399,"product_id":"1403673770703212544","listing_url":"https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544"},{"title":"Mobile App Developer, Android, iOS App Development in Flutter, App DesignerMobile App Developer, Android, iOS App Development in Flutter, App Designer","rating":null,"currency":"USD","image_url":"https://res.cloudinary.com/upwork-cloud/image/upload/c_scale,w_400/v1750666442/catalog/1784861153261067753/p9oduz9tvcfgpomnqqow.jpg","price_from":499,"product_id":"1784861153261067753","listing_url":"https://www.upwork.com/services/product/development-it-android-ios-mobile-app-development-using-flutter-expert-ai-app-developer-1784861153261067753"}],"category":"mobile-apps","pagination":{"next":null,"page":1,"per_page":24,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/upwork/services/info":{"get":{"summary":"Upwork Services Info","description":"Upwork Services Info API: fetch Project Catalog product details from a product URL. Returns packages, pricing, seller, media and breadcrumbs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-upwork-services-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Upwork Project Catalog product URL.\n\n**Example:**\n\n    https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544\n\nReturns a flat product object with description, pricing tiers, packages, seller info, and media.\n\nDiscover listings with **Upwork Services**, then pass any `listing_url` here.","schema":{"type":"string","description":"Full Upwork Project Catalog product URL.\n\n**Example:**\n\n    https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544\n\nReturns a flat product object with description, pricing tiers, packages, seller info, and media.\n\nDiscover listings with **Upwork Services**, then pass any `listing_url` here."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"seller":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}},"pricing":{"type":"object","properties":{"currency":{"type":"string"},"price_max":{"type":"integer"},"price_min":{"type":"integer"}}},"packages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"delivery_days":{"type":"integer"}}}},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Mobile Apps catalog product on upwork.com":{"value":{"url":"https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544","name":"You will get Mobile App Development | Android Apps | iOS Apps | Flutter Application Dev","media":["https://www.upwork.com/profile-portraits/c1vxfieoLCtKwfBvgMJOsjDJ0V5yef3ZDUIb_LI85bAA7wkPjr-AyXZ3QyfHCzOZqZ","https://www.upwork.com/profile-portraits/c1vxfieoLCtKwfBvgMJOsjDJ0V5yef3ZDUIb_LI85bAA6jLFePDbCqtoc1d4MPZG-3"],"rating":4.95,"seller":{"url":"https://www.upwork.com/freelancers/example-user","name":"Alex Martin"},"pricing":{"currency":"USD","price_max":2999,"price_min":399},"packages":[{"name":"Starter","price":399,"currency":"USD","delivery_days":7},{"name":"Standard","price":1299,"currency":"USD","delivery_days":25},{"name":"Advanced","price":2999,"currency":"USD","delivery_days":50}],"product_id":"1403673770703212544","breadcrumbs":["Project Catalog","Development & IT","Development","Mobile Apps","Custom Mobile Apps"],"description":"Building a successful mobile app requires strong engineering, smooth interface design, and reliable performance. I create high-quality Android and iOS applications that feel modern, work fast, and scale efficiently. Whether you need a cross-platform Flutter build or a refined native app, every project is developed with clean architecture, secure data handling, and intuitive user flows.\n\nMy focus i...","review_count":1096}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Upwork Services Info","description":"Upwork Services Info API: fetch Project Catalog product details from a product URL. Returns packages, pricing, seller, media and breadcrumbs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-upwork-services-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Upwork Project Catalog product URL.\n\n**Example:**\n\n    https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544\n\nReturns a flat product object with description, pricing tiers, packages, seller info, and media.\n\nDiscover listings with **Upwork Services**, then pass any `listing_url` here.","schema":{"type":"string","description":"Full Upwork Project Catalog product URL.\n\n**Example:**\n\n    https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544\n\nReturns a flat product object with description, pricing tiers, packages, seller info, and media.\n\nDiscover listings with **Upwork Services**, then pass any `listing_url` here."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"seller":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}},"pricing":{"type":"object","properties":{"currency":{"type":"string"},"price_max":{"type":"integer"},"price_min":{"type":"integer"}}},"packages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"delivery_days":{"type":"integer"}}}},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Mobile Apps catalog product on upwork.com":{"value":{"url":"https://www.upwork.com/services/product/development-it-mobile-app-developer-android-ios-flutter-application-hybrid-apps-1403673770703212544","name":"You will get Mobile App Development | Android Apps | iOS Apps | Flutter Application Dev","media":["https://www.upwork.com/profile-portraits/c1vxfieoLCtKwfBvgMJOsjDJ0V5yef3ZDUIb_LI85bAA7wkPjr-AyXZ3QyfHCzOZqZ","https://www.upwork.com/profile-portraits/c1vxfieoLCtKwfBvgMJOsjDJ0V5yef3ZDUIb_LI85bAA6jLFePDbCqtoc1d4MPZG-3"],"rating":4.95,"seller":{"url":"https://www.upwork.com/freelancers/example-user","name":"Alex Martin"},"pricing":{"currency":"USD","price_max":2999,"price_min":399},"packages":[{"name":"Starter","price":399,"currency":"USD","delivery_days":7},{"name":"Standard","price":1299,"currency":"USD","delivery_days":25},{"name":"Advanced","price":2999,"currency":"USD","delivery_days":50}],"product_id":"1403673770703212544","breadcrumbs":["Project Catalog","Development & IT","Development","Mobile Apps","Custom Mobile Apps"],"description":"Building a successful mobile app requires strong engineering, smooth interface design, and reliable performance. I create high-quality Android and iOS applications that feel modern, work fast, and scale efficiently. Whether you need a cross-platform Flutter build or a refined native app, every project is developed with clean architecture, secure data handling, and intuitive user flows.\n\nMy focus i...","review_count":1096}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/upwork/jobs":{"get":{"summary":"Upwork Jobs","description":"Upwork Jobs API: search freelance job listings by skill slug or URL. Returns budgets, skills, experience level and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-upwork-jobs","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Upwork skill slug or full freelance-jobs URL.\n\n**Examples:**\n\n```\napi-development\n```\n\n```\nhttps://www.upwork.com/freelance-jobs/api-development/\n```\n\nReturns `{ skill, title, results[], pagination }`.\n\nUse **Upwork Freelancer** to enrich a candidate profile from a freelancer URL.","schema":{"type":"string","description":"Upwork skill slug or full freelance-jobs URL.\n\n**Examples:**\n\n```\napi-development\n```\n\n```\nhttps://www.upwork.com/freelance-jobs/api-development/\n```\n\nReturns `{ skill, title, results[], pagination }`.\n\nUse **Upwork Freelancer** to enrich a candidate profile from a freelancer URL."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"string"},"title":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"job_id":{"type":"string"},"skills":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"duration":{"type":"string"},"job_type":{"type":"string"},"posted_at":{"type":"string"},"budget_max":{"nullable":true},"budget_min":{"type":"integer"},"posted_ago":{"type":"string"},"description":{"type":"string"},"listing_url":{"type":"string"},"hours_per_week":{"nullable":true},"experience_level":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"API development jobs (page 1)":{"value":{"skill":"api-development","title":"Find the Best API Developer Jobs","results":[{"title":"Full-stack Shopify + Make.com + Gemini AI Automation Setup","job_id":"022071658395247542131","skills":["HTML","HTML5","CSS","Shopify"],"currency":"USD","duration":"1 to 3 months","job_type":"fixed","posted_at":"2026-06-29T18:13:45+0000","budget_max":null,"budget_min":800,"posted_ago":"14 hours ago","description":"Dear Expert,\nBelow you can find a description of my project where your expertise would be needed.\nProject Overview: I am looking for a full-stack automation expert/agency to build a completely turnkey...","listing_url":"https://www.upwork.com/freelance-jobs/apply/Full-stack-Shopify-Make-com-Gemini-Automation-Setup_~022071658395247542131/","hours_per_week":null,"experience_level":"Expert"},{"title":"Looking for an AI Agent Developer for Social Media Automation","job_id":"022071659921584263119","skills":["Lead Generation","Artificial Intelligence","Python"],"currency":"USD","duration":"1 to 3 months","job_type":"fixed","posted_at":"2026-06-29T18:19:49+0000","budget_max":null,"budget_min":13000,"posted_ago":"13 hours ago","description":"I am looking to build an AI agent that can manage and handle social media profiles across platforms like Facebook, Instagram, LinkedIn, and TikTok.\nThe goal is to create an AI-powered system that can ...","listing_url":"https://www.upwork.com/freelance-jobs/apply/Looking-for-Agent-Developer-for-Social-Media-Automation_~022071659921584263119/","hours_per_week":null,"experience_level":"Expert"}],"pagination":{"next":null,"page":1,"per_page":30,"total_pages":206,"total_results":6156}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Upwork Jobs","description":"Upwork Jobs API: search freelance job listings by skill slug or URL. Returns budgets, skills, experience level and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-upwork-jobs","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Upwork skill slug or full freelance-jobs URL.\n\n**Examples:**\n\n```\napi-development\n```\n\n```\nhttps://www.upwork.com/freelance-jobs/api-development/\n```\n\nReturns `{ skill, title, results[], pagination }`.\n\nUse **Upwork Freelancer** to enrich a candidate profile from a freelancer URL.","schema":{"type":"string","description":"Upwork skill slug or full freelance-jobs URL.\n\n**Examples:**\n\n```\napi-development\n```\n\n```\nhttps://www.upwork.com/freelance-jobs/api-development/\n```\n\nReturns `{ skill, title, results[], pagination }`.\n\nUse **Upwork Freelancer** to enrich a candidate profile from a freelancer URL."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"string"},"title":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"job_id":{"type":"string"},"skills":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"duration":{"type":"string"},"job_type":{"type":"string"},"posted_at":{"type":"string"},"budget_max":{"nullable":true},"budget_min":{"type":"integer"},"posted_ago":{"type":"string"},"description":{"type":"string"},"listing_url":{"type":"string"},"hours_per_week":{"nullable":true},"experience_level":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"API development jobs (page 1)":{"value":{"skill":"api-development","title":"Find the Best API Developer Jobs","results":[{"title":"Full-stack Shopify + Make.com + Gemini AI Automation Setup","job_id":"022071658395247542131","skills":["HTML","HTML5","CSS","Shopify"],"currency":"USD","duration":"1 to 3 months","job_type":"fixed","posted_at":"2026-06-29T18:13:45+0000","budget_max":null,"budget_min":800,"posted_ago":"14 hours ago","description":"Dear Expert,\nBelow you can find a description of my project where your expertise would be needed.\nProject Overview: I am looking for a full-stack automation expert/agency to build a completely turnkey...","listing_url":"https://www.upwork.com/freelance-jobs/apply/Full-stack-Shopify-Make-com-Gemini-Automation-Setup_~022071658395247542131/","hours_per_week":null,"experience_level":"Expert"},{"title":"Looking for an AI Agent Developer for Social Media Automation","job_id":"022071659921584263119","skills":["Lead Generation","Artificial Intelligence","Python"],"currency":"USD","duration":"1 to 3 months","job_type":"fixed","posted_at":"2026-06-29T18:19:49+0000","budget_max":null,"budget_min":13000,"posted_ago":"13 hours ago","description":"I am looking to build an AI agent that can manage and handle social media profiles across platforms like Facebook, Instagram, LinkedIn, and TikTok.\nThe goal is to create an AI-powered system that can ...","listing_url":"https://www.upwork.com/freelance-jobs/apply/Looking-for-Agent-Developer-for-Social-Media-Automation_~022071659921584263119/","hours_per_week":null,"experience_level":"Expert"}],"pagination":{"next":null,"page":1,"per_page":30,"total_pages":206,"total_results":6156}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/upwork/freelancer":{"get":{"summary":"Upwork Freelancer","description":"Upwork Freelancer API: fetch public freelancer profile data from a profile ID, username or URL. Returns bio, hourly rate, skills, ratings and agency info via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-upwork-freelancer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Upwork freelancer profile ID, username, or full profile URL.\n\n**Examples:**\n\n```\n~0161ad91037ca6144b\n```\n\n```\nhttps://www.upwork.com/freelancers/example-user\n```\n\n```\nhttps://www.upwork.com/freelancers/adnans2\n```\n\nReturns a flat profile object with bio, hourly rate, skills, ratings, and agency info.\n\nPair with **Upwork Jobs** for role discovery or **Upwork Services Info** seller URLs.","schema":{"type":"string","description":"Upwork freelancer profile ID, username, or full profile URL.\n\n**Examples:**\n\n```\n~0161ad91037ca6144b\n```\n\n```\nhttps://www.upwork.com/freelancers/example-user\n```\n\n```\nhttps://www.upwork.com/freelancers/adnans2\n```\n\nReturns a flat profile object with bio, hourly rate, skills, ratings, and agency info.\n\nPair with **Upwork Jobs** for role discovery or **Upwork Services Info** seller URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"skills":{"type":"array","items":{"type":"string"}},"user_id":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"username":{"nullable":true},"verified":{"type":"boolean"},"is_agency":{"type":"boolean"},"profile_id":{"type":"string"},"agency_name":{"type":"string"},"description":{"type":"string"},"hourly_rate":{"type":"integer"},"total_hours":{"type":"integer"},"review_count":{"type":"integer"},"job_success_score":{"type":"integer"},"profile_image_url":{"type":"string"}}},"examples":{"Freelancer example-user":{"value":{"url":"https://www.upwork.com/freelancers/example-user","name":"Alex Martin","title":"Your technology partner in Mobile & web app development","rating":4.9,"skills":["Website","HTML","CSS","JavaScript","HTML5","CSS 3","Microsoft SharePoint Administration","Microsoft Office SharePoint Server"],"user_id":"000000000000000000","currency":"USD","location":"Rajkot , India","username":null,"verified":true,"is_agency":true,"profile_id":"example-user","agency_name":"AllianceTek Inc","description":"View Alex Martin profile on Upwork, the world’s work marketplace. Viraj has completed 55 jobs on Upwork. Check out the complete profile and discover more professionals with the skills you need.","hourly_rate":32,"total_hours":12029,"review_count":38,"job_success_score":100,"profile_image_url":"https://www.upwork.com/placeholder/example-user.jpg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Upwork Freelancer","description":"Upwork Freelancer API: fetch public freelancer profile data from a profile ID, username or URL. Returns bio, hourly rate, skills, ratings and agency info via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-upwork-freelancer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Upwork freelancer profile ID, username, or full profile URL.\n\n**Examples:**\n\n```\n~0161ad91037ca6144b\n```\n\n```\nhttps://www.upwork.com/freelancers/example-user\n```\n\n```\nhttps://www.upwork.com/freelancers/adnans2\n```\n\nReturns a flat profile object with bio, hourly rate, skills, ratings, and agency info.\n\nPair with **Upwork Jobs** for role discovery or **Upwork Services Info** seller URLs.","schema":{"type":"string","description":"Upwork freelancer profile ID, username, or full profile URL.\n\n**Examples:**\n\n```\n~0161ad91037ca6144b\n```\n\n```\nhttps://www.upwork.com/freelancers/example-user\n```\n\n```\nhttps://www.upwork.com/freelancers/adnans2\n```\n\nReturns a flat profile object with bio, hourly rate, skills, ratings, and agency info.\n\nPair with **Upwork Jobs** for role discovery or **Upwork Services Info** seller URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"skills":{"type":"array","items":{"type":"string"}},"user_id":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"username":{"nullable":true},"verified":{"type":"boolean"},"is_agency":{"type":"boolean"},"profile_id":{"type":"string"},"agency_name":{"type":"string"},"description":{"type":"string"},"hourly_rate":{"type":"integer"},"total_hours":{"type":"integer"},"review_count":{"type":"integer"},"job_success_score":{"type":"integer"},"profile_image_url":{"type":"string"}}},"examples":{"Freelancer example-user":{"value":{"url":"https://www.upwork.com/freelancers/example-user","name":"Alex Martin","title":"Your technology partner in Mobile & web app development","rating":4.9,"skills":["Website","HTML","CSS","JavaScript","HTML5","CSS 3","Microsoft SharePoint Administration","Microsoft Office SharePoint Server"],"user_id":"000000000000000000","currency":"USD","location":"Rajkot , India","username":null,"verified":true,"is_agency":true,"profile_id":"example-user","agency_name":"AllianceTek Inc","description":"View Alex Martin profile on Upwork, the world’s work marketplace. Viraj has completed 55 jobs on Upwork. Check out the complete profile and discover more professionals with the skills you need.","hourly_rate":32,"total_hours":12029,"review_count":38,"job_success_score":100,"profile_image_url":"https://www.upwork.com/placeholder/example-user.jpg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/x/profile/info":{"get":{"summary":"X Profile Info (twitter)","description":"X Profile Info API: fetch public X/Twitter profile data (bio, followers, verification, avatars) from a username or URL via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-x-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"X profile to look up. Accepts a username, @handle, or profile URL.\n\n**Examples:**\n\n```\nelonmusk\n```\n\n```\n@example-user\n```\n\n```\nhttps://x.com/example-user\n```\n\n**Notes:**\n- Legacy `twitter.com` URLs are supported.\n- **Rejected (400):** search URLs, status/tweet URLs, invalid handles.\n- X Search is not supported by this API.","schema":{"type":"string","description":"X profile to look up. Accepts a username, @handle, or profile URL.\n\n**Examples:**\n\n```\nelonmusk\n```\n\n```\n@example-user\n```\n\n```\nhttps://x.com/example-user\n```\n\n**Notes:**\n- Legacy `twitter.com` URLs are supported.\n- **Rejected (400):** search URLs, status/tweet URLs, invalid handles.\n- X Search is not supported by this API."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"user_id":{"type":"string"},"location":{"nullable":true},"username":{"type":"string"},"verified":{"type":"boolean"},"created_at":{"type":"string"},"description":{"type":"string"},"tweet_count":{"type":"integer"},"followers_count":{"type":"integer"},"following_count":{"type":"integer"},"profile_image_url":{"type":"string"},"profile_banner_url":{"type":"string"},"profile_image_url_normal":{"type":"string"}}},"examples":{"Profile @example-user on x.com":{"value":{"url":"https://x.com/example-user","name":"Alex Martin","user_id":"00000000","location":null,"username":"example-user","verified":true,"created_at":"2009-06-02T20:12:29.000Z","description":"Example profile.","tweet_count":104989,"followers_count":240609640,"following_count":1366,"profile_image_url":"https://pbs.twimg.com/placeholder/example-user.jpg","profile_banner_url":"https://pbs.twimg.com/placeholder/example-user.jpg","profile_image_url_normal":"https://pbs.twimg.com/placeholder/example-user.jpg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"X Profile Info (twitter)","description":"X Profile Info API: fetch public X/Twitter profile data (bio, followers, verification, avatars) from a username or URL via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-x-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"X profile to look up. Accepts a username, @handle, or profile URL.\n\n**Examples:**\n\n```\nelonmusk\n```\n\n```\n@example-user\n```\n\n```\nhttps://x.com/example-user\n```\n\n**Notes:**\n- Legacy `twitter.com` URLs are supported.\n- **Rejected (400):** search URLs, status/tweet URLs, invalid handles.\n- X Search is not supported by this API.","schema":{"type":"string","description":"X profile to look up. Accepts a username, @handle, or profile URL.\n\n**Examples:**\n\n```\nelonmusk\n```\n\n```\n@example-user\n```\n\n```\nhttps://x.com/example-user\n```\n\n**Notes:**\n- Legacy `twitter.com` URLs are supported.\n- **Rejected (400):** search URLs, status/tweet URLs, invalid handles.\n- X Search is not supported by this API."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"user_id":{"type":"string"},"location":{"nullable":true},"username":{"type":"string"},"verified":{"type":"boolean"},"created_at":{"type":"string"},"description":{"type":"string"},"tweet_count":{"type":"integer"},"followers_count":{"type":"integer"},"following_count":{"type":"integer"},"profile_image_url":{"type":"string"},"profile_banner_url":{"type":"string"},"profile_image_url_normal":{"type":"string"}}},"examples":{"Profile @example-user on x.com":{"value":{"url":"https://x.com/example-user","name":"Alex Martin","user_id":"00000000","location":null,"username":"example-user","verified":true,"created_at":"2009-06-02T20:12:29.000Z","description":"Example profile.","tweet_count":104989,"followers_count":240609640,"following_count":1366,"profile_image_url":"https://pbs.twimg.com/placeholder/example-user.jpg","profile_banner_url":"https://pbs.twimg.com/placeholder/example-user.jpg","profile_image_url_normal":"https://pbs.twimg.com/placeholder/example-user.jpg"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/x/post/info":{"get":{"summary":"X Post Info (twitter)","description":"X Post Info API: fetch public tweet data (text, likes, retweets, views, media) from a status URL or tweet ID via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-x-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"X tweet to retrieve. Accepts a full status URL or numeric tweet ID.\n\n**Examples:**\n\n```\nhttps://x.com/example-user/status/0000000000000000001\n```\n\n```\n2070215849970119090\n```\n\n**Notes:**\n- Legacy `twitter.com` status URLs are supported.\n- `created_at` and `name` may be null when not shown on the rendered page.","schema":{"type":"string","description":"X tweet to retrieve. Accepts a full status URL or numeric tweet ID.\n\n**Examples:**\n\n```\nhttps://x.com/example-user/status/0000000000000000001\n```\n\n```\n2070215849970119090\n```\n\n**Notes:**\n- Legacy `twitter.com` status URLs are supported.\n- `created_at` and `name` may be null when not shown on the rendered page."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"nullable":true},"text":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"tweet_id":{"type":"string"},"username":{"type":"string"},"verified":{"type":"boolean"},"created_at":{"nullable":true},"like_count":{"type":"integer"},"view_count":{"type":"integer"},"reply_count":{"type":"integer"},"retweet_count":{"type":"integer"}}},"examples":{"Post by @example-user on x.com":{"value":{"url":"https://x.com/example-user/status/0000000000000000001","name":null,"text":"Grok Imagine Video has become the clear leader in @vercel AI Gateway, now amounting to ~50% of videos generated by developers 🤯 vercel.com/ai-gateway/lea…","media":["https://pbs.twimg.com/media/HLrgznVbwAAG4y8.png"],"tweet_id":"0000000000000000001","username":"example-user","verified":true,"created_at":null,"like_count":2517,"view_count":232,"reply_count":279,"retweet_count":791}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"X Post Info (twitter)","description":"X Post Info API: fetch public tweet data (text, likes, retweets, views, media) from a status URL or tweet ID via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-x-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"X tweet to retrieve. Accepts a full status URL or numeric tweet ID.\n\n**Examples:**\n\n```\nhttps://x.com/example-user/status/0000000000000000001\n```\n\n```\n2070215849970119090\n```\n\n**Notes:**\n- Legacy `twitter.com` status URLs are supported.\n- `created_at` and `name` may be null when not shown on the rendered page.","schema":{"type":"string","description":"X tweet to retrieve. Accepts a full status URL or numeric tweet ID.\n\n**Examples:**\n\n```\nhttps://x.com/example-user/status/0000000000000000001\n```\n\n```\n2070215849970119090\n```\n\n**Notes:**\n- Legacy `twitter.com` status URLs are supported.\n- `created_at` and `name` may be null when not shown on the rendered page."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"nullable":true},"text":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"tweet_id":{"type":"string"},"username":{"type":"string"},"verified":{"type":"boolean"},"created_at":{"nullable":true},"like_count":{"type":"integer"},"view_count":{"type":"integer"},"reply_count":{"type":"integer"},"retweet_count":{"type":"integer"}}},"examples":{"Post by @example-user on x.com":{"value":{"url":"https://x.com/example-user/status/0000000000000000001","name":null,"text":"Grok Imagine Video has become the clear leader in @vercel AI Gateway, now amounting to ~50% of videos generated by developers 🤯 vercel.com/ai-gateway/lea…","media":["https://pbs.twimg.com/media/HLrgznVbwAAG4y8.png"],"tweet_id":"0000000000000000001","username":"example-user","verified":true,"created_at":null,"like_count":2517,"view_count":232,"reply_count":279,"retweet_count":791}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/pointp/search":{"get":{"summary":"Point.P Search","description":"Point.P Search API: search by keyword or URL and get building-material listings with prices, brands, ratings, units, and pagination as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-pointp-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Point.P search results URL.\n\n**Example (keyword):**\n\n    colle\n\nResolves to `https://www.pointp.fr/search?q=colle`.\n\n**Example (search URL):**\n\n    https://www.pointp.fr/search?q=colle\n\n**Example (page 2):**\n\n    https://www.pointp.fr/search/page-2?q=colle\n\n**Accepted URL patterns:** `/search`, `/search/page-{n}` with param `q`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from pointp.fr.\n- Use `page` to override the page number, or paginate via `pagination.next`.\n- Use each result `listing_url` with **Point.P Product** for full PDP data.","schema":{"type":"string","description":"Search keyword or full Point.P search results URL.\n\n**Example (keyword):**\n\n    colle\n\nResolves to `https://www.pointp.fr/search?q=colle`.\n\n**Example (search URL):**\n\n    https://www.pointp.fr/search?q=colle\n\n**Example (page 2):**\n\n    https://www.pointp.fr/search/page-2?q=colle\n\n**Accepted URL patterns:** `/search`, `/search/page-{n}` with param `q`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from pointp.fr.\n- Use `page` to override the page number, or paginate via `pagination.next`.\n- Use each result `listing_url` with **Point.P Product** for full PDP data."}},{"name":"page","in":"query","required":false,"description":"1-based page number for pagination. Overrides the page inferred from the URL. Defaults to `1` when omitted.\n\n**Example:** `2`","schema":{"type":"number","description":"1-based page number for pagination. Overrides the page inferred from the URL. Defaults to `1` when omitted.\n\n**Example:** `2`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"reference":{"type":"string"},"product_id":{"type":"string"},"listing_url":{"type":"string"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'colle' on pointp.fr (page 1)":{"value":{"results":[{"unit":"Sac-sachet","brand":"ULTIBAT","price":37.82,"title":"Colle Flex polyvalente - C2S1 ET/G - gris - sac de 25 kg","rating":5,"currency":"EUR","image_url":"https://www.pointp.fr/asset/29/81/AST2272981-M.jpg","reference":"7147449","product_id":"A7147449","listing_url":"https://www.pointp.fr/p/decoration-interieure/mortier-colle-flex-polyvalent-ultibat-c2s1-et-g-25kg-gris-A7147449","review_count":3},{"unit":"Sac-sachet","brand":"WEBER","price":41.74,"title":"Colle pour carrelage webercol flex enaé - gris - sac de 25 kg","rating":5,"currency":"EUR","image_url":"https://www.pointp.fr/asset/46/89/AST17024689-M.jpg","reference":"3596886","product_id":"A3596886","listing_url":"https://www.pointp.fr/p/decoration-interieure/mortier-colle-deformable-non-irritant-pour-carrelage-weber-col-A3596886","review_count":1},{"unit":"Pièce","brand":"WEBER","price":29.24,"title":"Mortier-colle webercol grès pour tous carreaux - blanc - sac de 25 kg","rating":5,"currency":"EUR","image_url":"https://www.pointp.fr/asset/44/78/AST17024478-M.jpg","reference":"3900577","product_id":"A3900577","listing_url":"https://www.pointp.fr/p/decoration-interieure/mortier-colle-a-adherence-amelioree-pour-carrelage-c2-weber-col-A3900577","review_count":1}],"pagination":{"next":"https://www.pointp.fr/search/page-2?q=colle","page":1,"per_page":24,"total_pages":49,"total_results":1165}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Point.P Search","description":"Point.P Search API: search by keyword or URL and get building-material listings with prices, brands, ratings, units, and pagination as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-pointp-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Point.P search results URL.\n\n**Example (keyword):**\n\n    colle\n\nResolves to `https://www.pointp.fr/search?q=colle`.\n\n**Example (search URL):**\n\n    https://www.pointp.fr/search?q=colle\n\n**Example (page 2):**\n\n    https://www.pointp.fr/search/page-2?q=colle\n\n**Accepted URL patterns:** `/search`, `/search/page-{n}` with param `q`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from pointp.fr.\n- Use `page` to override the page number, or paginate via `pagination.next`.\n- Use each result `listing_url` with **Point.P Product** for full PDP data.","schema":{"type":"string","description":"Search keyword or full Point.P search results URL.\n\n**Example (keyword):**\n\n    colle\n\nResolves to `https://www.pointp.fr/search?q=colle`.\n\n**Example (search URL):**\n\n    https://www.pointp.fr/search?q=colle\n\n**Example (page 2):**\n\n    https://www.pointp.fr/search/page-2?q=colle\n\n**Accepted URL patterns:** `/search`, `/search/page-{n}` with param `q`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from pointp.fr.\n- Use `page` to override the page number, or paginate via `pagination.next`.\n- Use each result `listing_url` with **Point.P Product** for full PDP data."}},{"name":"page","in":"query","required":false,"description":"1-based page number for pagination. Overrides the page inferred from the URL. Defaults to `1` when omitted.\n\n**Example:** `2`","schema":{"type":"number","description":"1-based page number for pagination. Overrides the page inferred from the URL. Defaults to `1` when omitted.\n\n**Example:** `2`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"unit":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"reference":{"type":"string"},"product_id":{"type":"string"},"listing_url":{"type":"string"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'colle' on pointp.fr (page 1)":{"value":{"results":[{"unit":"Sac-sachet","brand":"ULTIBAT","price":37.82,"title":"Colle Flex polyvalente - C2S1 ET/G - gris - sac de 25 kg","rating":5,"currency":"EUR","image_url":"https://www.pointp.fr/asset/29/81/AST2272981-M.jpg","reference":"7147449","product_id":"A7147449","listing_url":"https://www.pointp.fr/p/decoration-interieure/mortier-colle-flex-polyvalent-ultibat-c2s1-et-g-25kg-gris-A7147449","review_count":3},{"unit":"Sac-sachet","brand":"WEBER","price":41.74,"title":"Colle pour carrelage webercol flex enaé - gris - sac de 25 kg","rating":5,"currency":"EUR","image_url":"https://www.pointp.fr/asset/46/89/AST17024689-M.jpg","reference":"3596886","product_id":"A3596886","listing_url":"https://www.pointp.fr/p/decoration-interieure/mortier-colle-deformable-non-irritant-pour-carrelage-weber-col-A3596886","review_count":1},{"unit":"Pièce","brand":"WEBER","price":29.24,"title":"Mortier-colle webercol grès pour tous carreaux - blanc - sac de 25 kg","rating":5,"currency":"EUR","image_url":"https://www.pointp.fr/asset/44/78/AST17024478-M.jpg","reference":"3900577","product_id":"A3900577","listing_url":"https://www.pointp.fr/p/decoration-interieure/mortier-colle-a-adherence-amelioree-pour-carrelage-c2-weber-col-A3900577","review_count":1}],"pagination":{"next":"https://www.pointp.fr/search/page-2?q=colle","page":1,"per_page":24,"total_pages":49,"total_results":1165}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/pointp/product":{"get":{"summary":"Point.P Product","description":"Point.P Product API: scrape live `/p/` product pages from a full URL. Get title, images, EAN, pricing, specifications, and breadcrumbs as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-pointp-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Point.P product page URL (`/p/...-A{id}`).\n\n**Example:**\n\n    https://www.pointp.fr/p/platre-isolation-ite/laine-de-verre-a-souffler-thermo-loft-knauf-insulation-sac-16-A3334230\n\n**Notes:**\n- Pass the full product URL (not just the ID).\n- Slug must end with `-A{id}` (e.g. `A3334230`).\n- Domain must be `pointp.fr`.\n- **Rejected (400):** URLs without `/p/`, slugs without `-A{id}`, non-Point.P domains.\n- Use **Point.P Search** to discover `listing_url` values first.","schema":{"type":"string","description":"Full Point.P product page URL (`/p/...-A{id}`).\n\n**Example:**\n\n    https://www.pointp.fr/p/platre-isolation-ite/laine-de-verre-a-souffler-thermo-loft-knauf-insulation-sac-16-A3334230\n\n**Notes:**\n- Pass the full product URL (not just the ID).\n- Slug must end with `-A{id}` (e.g. `A3334230`).\n- Domain must be `pointp.fr`.\n- **Rejected (400):** URLs without `/p/`, slugs without `-A{id}`, non-Point.P domains.\n- Use **Point.P Search** to discover `listing_url` values first."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"link":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"pricing":{"type":"object","properties":{"unit":{"type":"string"},"price":{"type":"number"},"price_currency":{"type":"string"}}},"reference":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Thermo Loft insulation product on pointp.fr":{"value":{"ean":"5413031003370","link":"https://www.pointp.fr/p/platre-isolation-ite/laine-de-verre-a-souffler-thermo-loft-knauf-insulation-sac-16-A3334230","name":"Laine de verre à souffler Thermo Loft - sac de 16,6 kg","brand":"KNAUF INSULATION","media":["https://www.pointp.fr/asset/40/21/AST18564021-L.jpg","https://www.pointp.fr/asset/40/21/AST18564021-M.jpg","https://www.pointp.fr/asset/40/23/AST18564023-M.jpg"],"pricing":{"unit":"Sac-sachet","price":59.9,"price_currency":"EUR"},"reference":"1463175","product_id":"A3334230","breadcrumbs":["Point.P","Plâtre, isolation, plafonds","Isolation des toitures","Isolation des combles"],"description":"La laine de verre à souffler Thermo Loft de Knauf Insulation est conçue spécifiquement pour l'isolation thermique haute performance des combles perdus difficilement accessibles. Elle s'utilise en neuf comme en rénovation...","specifications":[{"name":"Matière","value":"Laine de verre"},{"name":"Type de produit","value":"Laine de verre"},{"name":"Gamme","value":"THERMO LOFT"},{"name":"Conditionnement du produit","value":"Sac de 16,6 kg"},{"name":"Pièce /ouvrage de destination","value":"Combles perdus"},{"name":"Zone d'utilisation","value":"Plafond"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Point.P Product","description":"Point.P Product API: scrape live `/p/` product pages from a full URL. Get title, images, EAN, pricing, specifications, and breadcrumbs as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-pointp-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Point.P product page URL (`/p/...-A{id}`).\n\n**Example:**\n\n    https://www.pointp.fr/p/platre-isolation-ite/laine-de-verre-a-souffler-thermo-loft-knauf-insulation-sac-16-A3334230\n\n**Notes:**\n- Pass the full product URL (not just the ID).\n- Slug must end with `-A{id}` (e.g. `A3334230`).\n- Domain must be `pointp.fr`.\n- **Rejected (400):** URLs without `/p/`, slugs without `-A{id}`, non-Point.P domains.\n- Use **Point.P Search** to discover `listing_url` values first.","schema":{"type":"string","description":"Full Point.P product page URL (`/p/...-A{id}`).\n\n**Example:**\n\n    https://www.pointp.fr/p/platre-isolation-ite/laine-de-verre-a-souffler-thermo-loft-knauf-insulation-sac-16-A3334230\n\n**Notes:**\n- Pass the full product URL (not just the ID).\n- Slug must end with `-A{id}` (e.g. `A3334230`).\n- Domain must be `pointp.fr`.\n- **Rejected (400):** URLs without `/p/`, slugs without `-A{id}`, non-Point.P domains.\n- Use **Point.P Search** to discover `listing_url` values first."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"link":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"pricing":{"type":"object","properties":{"unit":{"type":"string"},"price":{"type":"number"},"price_currency":{"type":"string"}}},"reference":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Thermo Loft insulation product on pointp.fr":{"value":{"ean":"5413031003370","link":"https://www.pointp.fr/p/platre-isolation-ite/laine-de-verre-a-souffler-thermo-loft-knauf-insulation-sac-16-A3334230","name":"Laine de verre à souffler Thermo Loft - sac de 16,6 kg","brand":"KNAUF INSULATION","media":["https://www.pointp.fr/asset/40/21/AST18564021-L.jpg","https://www.pointp.fr/asset/40/21/AST18564021-M.jpg","https://www.pointp.fr/asset/40/23/AST18564023-M.jpg"],"pricing":{"unit":"Sac-sachet","price":59.9,"price_currency":"EUR"},"reference":"1463175","product_id":"A3334230","breadcrumbs":["Point.P","Plâtre, isolation, plafonds","Isolation des toitures","Isolation des combles"],"description":"La laine de verre à souffler Thermo Loft de Knauf Insulation est conçue spécifiquement pour l'isolation thermique haute performance des combles perdus difficilement accessibles. Elle s'utilise en neuf comme en rénovation...","specifications":[{"name":"Matière","value":"Laine de verre"},{"name":"Type de produit","value":"Laine de verre"},{"name":"Gamme","value":"THERMO LOFT"},{"name":"Conditionnement du produit","value":"Sac de 16,6 kg"},{"name":"Pièce /ouvrage de destination","value":"Combles perdus"},{"name":"Zone d'utilisation","value":"Plafond"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/walmart/suggest":{"get":{"summary":"Walmart Suggest","description":"Get Walmart.com search autocomplete suggestions for a keyword via browser rendering, with optional US ZIP code localization.\n\n**Credit cost:** 2 credits per call","operationId":"get-walmart-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword for Walmart autocomplete suggestions.\n\n**Example:**\n\n    apples\n\n**Notes:**\n- Partial keywords return related query suggestions (e.g. `apples` → `applesauce`, `apple juice`).\n- Mirrors the Walmart.com search typeahead behavior.\n- Walmart typeahead is loaded via JavaScript; this endpoint uses browser rendering.","schema":{"type":"string","description":"Search keyword for Walmart autocomplete suggestions.\n\n**Example:**\n\n    apples\n\n**Notes:**\n- Partial keywords return related query suggestions (e.g. `apples` → `applesauce`, `apple juice`).\n- Mirrors the Walmart.com search typeahead behavior.\n- Walmart typeahead is loaded via JavaScript; this endpoint uses browser rendering."}},{"name":"zipcode","in":"query","required":false,"description":"Optional US ZIP code to localize Walmart store and inventory context for suggestions.\n\n**Example:**\n\n    95829\n\n**Notes:**\n- 5-digit US ZIP code format.\n- Omit to use Walmart's default location context.\n- When provided, affects localized availability context on walmart.com.","schema":{"type":"string","description":"Optional US ZIP code to localize Walmart store and inventory context for suggestions.\n\n**Example:**\n\n    95829\n\n**Notes:**\n- 5-digit US ZIP code format.\n- Omit to use Walmart's default location context.\n- When provided, affects localized availability context on walmart.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"image_url":{"type":"string"},"analytics_fm":{"type":"integer"},"display_name":{"type":"string"}}}}}},"examples":{"Suggest for 'apples' near ZIP 95829":{"value":{"results":[{"url":"query=apples&typeahead=apples","type":"QUERY","image_url":"https://i5.walmartimages.com/asr/bcfd9451-a73b-411f-84e3-1d866f833ae8.3e996f05a24facfa2ac526d6c631401d.jpeg","analytics_fm":5,"display_name":"apples"},{"url":"query=applesauce&typeahead=apples","type":"QUERY","image_url":"https://i5.walmartimages.com/asr/d71c007b-3ae2-433f-9ca2-41906af71500.bff31e2bb8bdfddd3bd46ae00f50135d.jpeg","analytics_fm":5,"display_name":"applesauce"},{"url":"query=apple%20juice&typeahead=apples","type":"QUERY","image_url":"https://i5.walmartimages.com/asr/34a4bc66-9cdb-404c-8665-b6435742ed45.3402c97169db76e6c3784d67cc1ad581.jpeg","analytics_fm":5,"display_name":"apple juice"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Walmart Suggest","description":"Get Walmart.com search autocomplete suggestions for a keyword via browser rendering, with optional US ZIP code localization.\n\n**Credit cost:** 2 credits per call","operationId":"post-walmart-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword for Walmart autocomplete suggestions.\n\n**Example:**\n\n    apples\n\n**Notes:**\n- Partial keywords return related query suggestions (e.g. `apples` → `applesauce`, `apple juice`).\n- Mirrors the Walmart.com search typeahead behavior.\n- Walmart typeahead is loaded via JavaScript; this endpoint uses browser rendering.","schema":{"type":"string","description":"Search keyword for Walmart autocomplete suggestions.\n\n**Example:**\n\n    apples\n\n**Notes:**\n- Partial keywords return related query suggestions (e.g. `apples` → `applesauce`, `apple juice`).\n- Mirrors the Walmart.com search typeahead behavior.\n- Walmart typeahead is loaded via JavaScript; this endpoint uses browser rendering."}},{"name":"zipcode","in":"query","required":false,"description":"Optional US ZIP code to localize Walmart store and inventory context for suggestions.\n\n**Example:**\n\n    95829\n\n**Notes:**\n- 5-digit US ZIP code format.\n- Omit to use Walmart's default location context.\n- When provided, affects localized availability context on walmart.com.","schema":{"type":"string","description":"Optional US ZIP code to localize Walmart store and inventory context for suggestions.\n\n**Example:**\n\n    95829\n\n**Notes:**\n- 5-digit US ZIP code format.\n- Omit to use Walmart's default location context.\n- When provided, affects localized availability context on walmart.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"image_url":{"type":"string"},"analytics_fm":{"type":"integer"},"display_name":{"type":"string"}}}}}},"examples":{"Suggest for 'apples' near ZIP 95829":{"value":{"results":[{"url":"query=apples&typeahead=apples","type":"QUERY","image_url":"https://i5.walmartimages.com/asr/bcfd9451-a73b-411f-84e3-1d866f833ae8.3e996f05a24facfa2ac526d6c631401d.jpeg","analytics_fm":5,"display_name":"apples"},{"url":"query=applesauce&typeahead=apples","type":"QUERY","image_url":"https://i5.walmartimages.com/asr/d71c007b-3ae2-433f-9ca2-41906af71500.bff31e2bb8bdfddd3bd46ae00f50135d.jpeg","analytics_fm":5,"display_name":"applesauce"},{"url":"query=apple%20juice&typeahead=apples","type":"QUERY","image_url":"https://i5.walmartimages.com/asr/34a4bc66-9cdb-404c-8665-b6435742ed45.3402c97169db76e6c3784d67cc1ad581.jpeg","analytics_fm":5,"display_name":"apple juice"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/walmart/search":{"get":{"summary":"Walmart Search","description":"Scrape Walmart.com search result pages from a full URL and retrieve product cards with pricing, ratings, availability, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-walmart-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Walmart search results URL.\n\n**Example (keyword search):**\n\n    https://www.walmart.com/search?q=apples\n\n**Example (page 2):**\n\n    https://www.walmart.com/search?q=apples&page=2\n\n**Notes:**\n- Copy the full URL from walmart.com after running a search.\n- Supports keyword queries (`q=`), pagination (`page=`), and facet filters.\n- Walmart search pages are JavaScript SPAs; this endpoint uses browser rendering.\n- Pass each result `url` to the Walmart Product endpoint for full PDP data.","schema":{"type":"string","description":"Full Walmart search results URL.\n\n**Example (keyword search):**\n\n    https://www.walmart.com/search?q=apples\n\n**Example (page 2):**\n\n    https://www.walmart.com/search?q=apples&page=2\n\n**Notes:**\n- Copy the full URL from walmart.com after running a search.\n- Supports keyword queries (`q=`), pagination (`page=`), and facet filters.\n- Walmart search pages are JavaScript SPAs; this endpoint uses browser rendering.\n- Pass each result `url` to the Walmart Product endpoint for full PDP data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"brand":{"nullable":true},"image":{"type":"string"},"price":{"type":"number"},"price_info":{"type":"object","properties":{"unit_price":{"type":"string"},"line_price_display":{"type":"string"}}},"us_item_id":{"type":"string"},"seller_name":{"type":"string"},"canonical_url":{"type":"string"},"average_rating":{"type":"number"},"fulfillment_type":{"type":"string"},"is_sponsored_flag":{"type":"boolean"},"number_of_reviews":{"type":"integer"},"availability_status_v2":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}}}}},"pagination":{"type":"object","properties":{"next":{"type":"boolean"},"page":{"type":"integer"},"total":{"type":"integer"},"max_page":{"type":"integer"}}}}},"examples":{"Search 'apples' on walmart.com":{"value":{"results":[{"id":"40KH71FS6S1U","url":"https://www.walmart.com/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096?classType=REGULAR","name":"Fresh Rockit, Crisp Sweet Miniature Apples, 3lb Tub","type":"REGULAR","brand":null,"image":"https://i5.walmartimages.com/seo/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub_de6d6d44-507a-43e4-9bd9-d86286473870.4d6dbcb5c200885859982510d4314077.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF","price":8.97,"price_info":{"unit_price":"$2.99/lb","line_price_display":"$8.97"},"us_item_id":"309762096","seller_name":"Walmart.com","canonical_url":"/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096?classType=REGULAR","average_rating":4.4,"fulfillment_type":"STORE","is_sponsored_flag":true,"number_of_reviews":2034,"availability_status_v2":{"value":"IN_STOCK","display":"In stock"}},{"id":"2GZTW48YO9IV","url":"https://www.walmart.com/ip/Fresh-Envy-Apples-3-lb-Bag/978115165?classType=REGULAR","name":"Fresh Envy™ Apples, 3 lb Bag","type":"REGULAR","brand":null,"image":"https://i5.walmartimages.com/seo/Fresh-Envy-Apples-3-lb-Bag_d988dbde-f74a-4fde-a66f-b96569f9133b.87d9427485c1e5d8b3feaf0c0fde5834.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF","price":5.37,"price_info":{"unit_price":"$1.79/lb","line_price_display":"$5.37"},"us_item_id":"978115165","seller_name":"Walmart.com","canonical_url":"/ip/Fresh-Envy-Apples-3-lb-Bag/978115165?classType=REGULAR","average_rating":4.2,"fulfillment_type":"STORE","is_sponsored_flag":true,"number_of_reviews":1172,"availability_status_v2":{"value":"IN_STOCK","display":"In stock"}}],"pagination":{"next":true,"page":1,"total":92,"max_page":5}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Walmart Search","description":"Scrape Walmart.com search result pages from a full URL and retrieve product cards with pricing, ratings, availability, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-walmart-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Walmart search results URL.\n\n**Example (keyword search):**\n\n    https://www.walmart.com/search?q=apples\n\n**Example (page 2):**\n\n    https://www.walmart.com/search?q=apples&page=2\n\n**Notes:**\n- Copy the full URL from walmart.com after running a search.\n- Supports keyword queries (`q=`), pagination (`page=`), and facet filters.\n- Walmart search pages are JavaScript SPAs; this endpoint uses browser rendering.\n- Pass each result `url` to the Walmart Product endpoint for full PDP data.","schema":{"type":"string","description":"Full Walmart search results URL.\n\n**Example (keyword search):**\n\n    https://www.walmart.com/search?q=apples\n\n**Example (page 2):**\n\n    https://www.walmart.com/search?q=apples&page=2\n\n**Notes:**\n- Copy the full URL from walmart.com after running a search.\n- Supports keyword queries (`q=`), pagination (`page=`), and facet filters.\n- Walmart search pages are JavaScript SPAs; this endpoint uses browser rendering.\n- Pass each result `url` to the Walmart Product endpoint for full PDP data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"brand":{"nullable":true},"image":{"type":"string"},"price":{"type":"number"},"price_info":{"type":"object","properties":{"unit_price":{"type":"string"},"line_price_display":{"type":"string"}}},"us_item_id":{"type":"string"},"seller_name":{"type":"string"},"canonical_url":{"type":"string"},"average_rating":{"type":"number"},"fulfillment_type":{"type":"string"},"is_sponsored_flag":{"type":"boolean"},"number_of_reviews":{"type":"integer"},"availability_status_v2":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}}}}},"pagination":{"type":"object","properties":{"next":{"type":"boolean"},"page":{"type":"integer"},"total":{"type":"integer"},"max_page":{"type":"integer"}}}}},"examples":{"Search 'apples' on walmart.com":{"value":{"results":[{"id":"40KH71FS6S1U","url":"https://www.walmart.com/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096?classType=REGULAR","name":"Fresh Rockit, Crisp Sweet Miniature Apples, 3lb Tub","type":"REGULAR","brand":null,"image":"https://i5.walmartimages.com/seo/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub_de6d6d44-507a-43e4-9bd9-d86286473870.4d6dbcb5c200885859982510d4314077.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF","price":8.97,"price_info":{"unit_price":"$2.99/lb","line_price_display":"$8.97"},"us_item_id":"309762096","seller_name":"Walmart.com","canonical_url":"/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096?classType=REGULAR","average_rating":4.4,"fulfillment_type":"STORE","is_sponsored_flag":true,"number_of_reviews":2034,"availability_status_v2":{"value":"IN_STOCK","display":"In stock"}},{"id":"2GZTW48YO9IV","url":"https://www.walmart.com/ip/Fresh-Envy-Apples-3-lb-Bag/978115165?classType=REGULAR","name":"Fresh Envy™ Apples, 3 lb Bag","type":"REGULAR","brand":null,"image":"https://i5.walmartimages.com/seo/Fresh-Envy-Apples-3-lb-Bag_d988dbde-f74a-4fde-a66f-b96569f9133b.87d9427485c1e5d8b3feaf0c0fde5834.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF","price":5.37,"price_info":{"unit_price":"$1.79/lb","line_price_display":"$5.37"},"us_item_id":"978115165","seller_name":"Walmart.com","canonical_url":"/ip/Fresh-Envy-Apples-3-lb-Bag/978115165?classType=REGULAR","average_rating":4.2,"fulfillment_type":"STORE","is_sponsored_flag":true,"number_of_reviews":1172,"availability_status_v2":{"value":"IN_STOCK","display":"In stock"}}],"pagination":{"next":true,"page":1,"total":92,"max_page":5}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/thefork/restaurant":{"get":{"summary":"TheFork Restaurant","description":"Extract a full TheFork restaurant profile from a restaurant page URL, including ratings, tags, photo gallery, opening hours, and AI review summaries via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-thefork-restaurant","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full TheFork restaurant page URL.\n\n**Example:**\n\n    https://www.thefork.fr/restaurant/salamboo-amilkar-r10892#date=2026-06-13&rankedBy=SEARCH_ENGINE\n\n**Notes:**\n- Only `/restaurant/{slug}-r{id}` URLs on TheFork domains are accepted.\n- Hash parameters (`#date=...`) are optional and preserved when relevant.\n- Restaurant pages are JavaScript SPAs; this endpoint uses website rendering to extract ratings, tags, photos, hours, and AI review summaries.\n- Copy the restaurant URL from search results or from thefork.fr.","schema":{"type":"string","description":"Full TheFork restaurant page URL.\n\n**Example:**\n\n    https://www.thefork.fr/restaurant/salamboo-amilkar-r10892#date=2026-06-13&rankedBy=SEARCH_ENGINE\n\n**Notes:**\n- Only `/restaurant/{slug}-r{id}` URLs on TheFork domains are accepted.\n- Hash parameters (`#date=...`) are optional and preserved when relevant.\n- Restaurant pages are JavaScript SPAs; this endpoint uses website rendering to extract ratings, tags, photos, hours, and AI review summaries.\n- Copy the restaurant URL from search results or from thefork.fr."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"category":{"type":"object","properties":{"id":{"type":"string"}}},"is_published":{"type":"boolean"}}}},"uuid":{"type":"string"},"image":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"object","properties":{"street":{"type":"string"},"country":{"type":"string"},"locality":{"type":"string"},"zip_code":{"type":"string"}}},"cuisine":{"type":"string"},"ratings":{"type":"object","properties":{"thefork":{"type":"object","properties":{"rating":{"type":"number"},"reviews_count":{"type":"integer"}}},"tripadvisor":{"type":"object","properties":{"rating":{"type":"number"},"reviews_count":{"type":"integer"}}}}},"currency":{"type":"string"},"avg_price":{"type":"integer"},"description":{"nullable":true},"geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"is_bookable":{"type":"boolean"},"reviews_summary":{"type":"string"},"opening_time_information":{"type":"object","properties":{"opening_hours":{"type":"object","properties":{"fri":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"mon":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"sat":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"sun":{"type":"array","items":{}},"thu":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"tue":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"wed":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}}}}}}}},"examples":{"Lookup Le Petit Casa, Strasbourg":{"value":{"id":668497,"url":"https://www.thefork.fr/restaurant/le-petit-casa-r668497","name":"Le Petit Casa","slug":"le-petit-casa","tags":[{"id":"1829","name":"Bas-Rhin (67)","category":{"id":"21"},"is_published":true},{"id":"5779","name":"Carte Cadeau","category":{"id":"11"},"is_published":true},{"id":"5777","name":"Déjeuner","category":{"id":"11"},"is_published":true},{"id":"1","name":"En famille","category":{"id":"11"},"is_published":true},{"id":"1460","name":"Enfants bienvenus !","category":{"id":"11"},"is_published":true},{"id":"2","name":"Entre amis","category":{"id":"11"},"is_published":true},{"id":"381","name":"Traditionnel","category":{"id":"11"},"is_published":true},{"id":"644","name":"Trip Advisor","category":{"id":"14"},"is_published":true},{"id":"335","name":"Halal","category":{"id":"8"},"is_published":true},{"id":"470","name":"Options végétariennes","category":{"id":"8"},"is_published":true},{"id":"2372","name":"Petit Prix","category":{"id":"9"},"is_published":true},{"id":"312","name":"Carte Bleue","category":{"id":"5"},"is_published":true},{"id":"314","name":"Carte Mastercard","category":{"id":"5"},"is_published":true},{"id":"315","name":"Carte Visa","category":{"id":"5"},"is_published":true},{"id":"4367","name":"TheFork PAY","category":{"id":"5"},"is_published":true},{"id":"317","name":"Titres et chèques pour les restaurants","category":{"id":"5"},"is_published":true},{"id":"2699","name":"UnionPay","category":{"id":"5"},"is_published":true},{"id":"660","name":"Couscous","category":{"id":"6"},"is_published":true},{"id":"513","name":"Viande et grillades","category":{"id":"6"},"is_published":true},{"id":"1109","name":"Place de Haguenau","category":{"id":"4"},"is_published":true},{"id":"1742","name":"Alsace","category":{"id":"20"},"is_published":true},{"id":"5859","name":"France","category":{"id":"20"},"is_published":true},{"id":"3461","name":"Grand Est","category":{"id":"20"},"is_published":true},{"id":"346","name":"Accès personnes à mobilité réduite","category":{"id":"10"},"is_published":true},{"id":"359","name":"Anglais parlé","category":{"id":"10"},"is_published":true},{"id":"360","name":"Français parlé","category":{"id":"10"},"is_published":true},{"id":"466","name":"Marocain","category":{"id":"12"},"is_published":true},{"id":"460","name":"Oriental","category":{"id":"12"},"is_published":true}],"uuid":"265f611d-cb85-4ae4-a779-e963df820a4b","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/b9c443c8-06c8-4d56-8e87-419c66f7eeee.jpg","images":["https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/b9c443c8-06c8-4d56-8e87-419c66f7eeee.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/e69b12cc-a28a-4d17-b6ff-1a32c51c94ce.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/fe8d67df-8d21-481d-ac76-87111a1c3f2f.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/5ec87fc3-01ef-4021-8cfd-97a35f14e5d7.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/e370aa25-b074-41b8-a8e7-1f643f85af64.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/635a90be-2eb1-4592-8841-75f839ed8d8b.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/9ae02f81-bc2a-42e7-a3b1-a64714e42771.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/30c1c7f4-b466-4728-b777-6f59c8edc606.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/ff8bfd1f-a0f2-40c1-a623-61f13b28399a.jpg"],"address":{"street":"24 Rue Thiergarten","country":"France","locality":"Strasbourg","zip_code":"67000"},"cuisine":"Marocain","ratings":{"thefork":{"rating":9.8,"reviews_count":1030},"tripadvisor":{"rating":4.8,"reviews_count":53}},"currency":"EUR","avg_price":35,"description":null,"geolocation":{"latitude":48.5853087,"longitude":7.7378558},"is_bookable":true,"reviews_summary":"Le Petit Casa enchante par son ambiance chaleureuse et dépaysante, évoquant un véritable voyage au Maroc. Les clients apprécient les plats marocains raffinés, notamment le couscous aux saveurs équilibrées et les tajines exquis. Le service est irréprochable, avec un accueil chaleureux et des conseils avisés. Une expérience inoubliable à découvrir sans hésitation, avec un excellent rapport qualité-prix.","opening_time_information":{"opening_hours":{"fri":[{"end":870,"start":720},{"end":1350,"start":1140}],"mon":[{"end":870,"start":720},{"end":1350,"start":1140}],"sat":[{"end":870,"start":720},{"end":1350,"start":1140}],"sun":[],"thu":[{"end":870,"start":720},{"end":1350,"start":1140}],"tue":[{"end":870,"start":720},{"end":1350,"start":1140}],"wed":[{"end":870,"start":720},{"end":1350,"start":1140}]}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TheFork Restaurant","description":"Extract a full TheFork restaurant profile from a restaurant page URL, including ratings, tags, photo gallery, opening hours, and AI review summaries via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-thefork-restaurant","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full TheFork restaurant page URL.\n\n**Example:**\n\n    https://www.thefork.fr/restaurant/salamboo-amilkar-r10892#date=2026-06-13&rankedBy=SEARCH_ENGINE\n\n**Notes:**\n- Only `/restaurant/{slug}-r{id}` URLs on TheFork domains are accepted.\n- Hash parameters (`#date=...`) are optional and preserved when relevant.\n- Restaurant pages are JavaScript SPAs; this endpoint uses website rendering to extract ratings, tags, photos, hours, and AI review summaries.\n- Copy the restaurant URL from search results or from thefork.fr.","schema":{"type":"string","description":"Full TheFork restaurant page URL.\n\n**Example:**\n\n    https://www.thefork.fr/restaurant/salamboo-amilkar-r10892#date=2026-06-13&rankedBy=SEARCH_ENGINE\n\n**Notes:**\n- Only `/restaurant/{slug}-r{id}` URLs on TheFork domains are accepted.\n- Hash parameters (`#date=...`) are optional and preserved when relevant.\n- Restaurant pages are JavaScript SPAs; this endpoint uses website rendering to extract ratings, tags, photos, hours, and AI review summaries.\n- Copy the restaurant URL from search results or from thefork.fr."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"category":{"type":"object","properties":{"id":{"type":"string"}}},"is_published":{"type":"boolean"}}}},"uuid":{"type":"string"},"image":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"object","properties":{"street":{"type":"string"},"country":{"type":"string"},"locality":{"type":"string"},"zip_code":{"type":"string"}}},"cuisine":{"type":"string"},"ratings":{"type":"object","properties":{"thefork":{"type":"object","properties":{"rating":{"type":"number"},"reviews_count":{"type":"integer"}}},"tripadvisor":{"type":"object","properties":{"rating":{"type":"number"},"reviews_count":{"type":"integer"}}}}},"currency":{"type":"string"},"avg_price":{"type":"integer"},"description":{"nullable":true},"geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"is_bookable":{"type":"boolean"},"reviews_summary":{"type":"string"},"opening_time_information":{"type":"object","properties":{"opening_hours":{"type":"object","properties":{"fri":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"mon":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"sat":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"sun":{"type":"array","items":{}},"thu":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"tue":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}},"wed":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"}}}}}}}}}},"examples":{"Lookup Le Petit Casa, Strasbourg":{"value":{"id":668497,"url":"https://www.thefork.fr/restaurant/le-petit-casa-r668497","name":"Le Petit Casa","slug":"le-petit-casa","tags":[{"id":"1829","name":"Bas-Rhin (67)","category":{"id":"21"},"is_published":true},{"id":"5779","name":"Carte Cadeau","category":{"id":"11"},"is_published":true},{"id":"5777","name":"Déjeuner","category":{"id":"11"},"is_published":true},{"id":"1","name":"En famille","category":{"id":"11"},"is_published":true},{"id":"1460","name":"Enfants bienvenus !","category":{"id":"11"},"is_published":true},{"id":"2","name":"Entre amis","category":{"id":"11"},"is_published":true},{"id":"381","name":"Traditionnel","category":{"id":"11"},"is_published":true},{"id":"644","name":"Trip Advisor","category":{"id":"14"},"is_published":true},{"id":"335","name":"Halal","category":{"id":"8"},"is_published":true},{"id":"470","name":"Options végétariennes","category":{"id":"8"},"is_published":true},{"id":"2372","name":"Petit Prix","category":{"id":"9"},"is_published":true},{"id":"312","name":"Carte Bleue","category":{"id":"5"},"is_published":true},{"id":"314","name":"Carte Mastercard","category":{"id":"5"},"is_published":true},{"id":"315","name":"Carte Visa","category":{"id":"5"},"is_published":true},{"id":"4367","name":"TheFork PAY","category":{"id":"5"},"is_published":true},{"id":"317","name":"Titres et chèques pour les restaurants","category":{"id":"5"},"is_published":true},{"id":"2699","name":"UnionPay","category":{"id":"5"},"is_published":true},{"id":"660","name":"Couscous","category":{"id":"6"},"is_published":true},{"id":"513","name":"Viande et grillades","category":{"id":"6"},"is_published":true},{"id":"1109","name":"Place de Haguenau","category":{"id":"4"},"is_published":true},{"id":"1742","name":"Alsace","category":{"id":"20"},"is_published":true},{"id":"5859","name":"France","category":{"id":"20"},"is_published":true},{"id":"3461","name":"Grand Est","category":{"id":"20"},"is_published":true},{"id":"346","name":"Accès personnes à mobilité réduite","category":{"id":"10"},"is_published":true},{"id":"359","name":"Anglais parlé","category":{"id":"10"},"is_published":true},{"id":"360","name":"Français parlé","category":{"id":"10"},"is_published":true},{"id":"466","name":"Marocain","category":{"id":"12"},"is_published":true},{"id":"460","name":"Oriental","category":{"id":"12"},"is_published":true}],"uuid":"265f611d-cb85-4ae4-a779-e963df820a4b","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/b9c443c8-06c8-4d56-8e87-419c66f7eeee.jpg","images":["https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/b9c443c8-06c8-4d56-8e87-419c66f7eeee.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/e69b12cc-a28a-4d17-b6ff-1a32c51c94ce.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/fe8d67df-8d21-481d-ac76-87111a1c3f2f.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/5ec87fc3-01ef-4021-8cfd-97a35f14e5d7.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/e370aa25-b074-41b8-a8e7-1f643f85af64.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/635a90be-2eb1-4592-8841-75f839ed8d8b.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/9ae02f81-bc2a-42e7-a3b1-a64714e42771.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/30c1c7f4-b466-4728-b777-6f59c8edc606.jpg","https://cdn.thefork.com/tf-lab/image/upload/restaurant/265f611d-cb85-4ae4-a779-e963df820a4b/ff8bfd1f-a0f2-40c1-a623-61f13b28399a.jpg"],"address":{"street":"24 Rue Thiergarten","country":"France","locality":"Strasbourg","zip_code":"67000"},"cuisine":"Marocain","ratings":{"thefork":{"rating":9.8,"reviews_count":1030},"tripadvisor":{"rating":4.8,"reviews_count":53}},"currency":"EUR","avg_price":35,"description":null,"geolocation":{"latitude":48.5853087,"longitude":7.7378558},"is_bookable":true,"reviews_summary":"Le Petit Casa enchante par son ambiance chaleureuse et dépaysante, évoquant un véritable voyage au Maroc. Les clients apprécient les plats marocains raffinés, notamment le couscous aux saveurs équilibrées et les tajines exquis. Le service est irréprochable, avec un accueil chaleureux et des conseils avisés. Une expérience inoubliable à découvrir sans hésitation, avec un excellent rapport qualité-prix.","opening_time_information":{"opening_hours":{"fri":[{"end":870,"start":720},{"end":1350,"start":1140}],"mon":[{"end":870,"start":720},{"end":1350,"start":1140}],"sat":[{"end":870,"start":720},{"end":1350,"start":1140}],"sun":[],"thu":[{"end":870,"start":720},{"end":1350,"start":1140}],"tue":[{"end":870,"start":720},{"end":1350,"start":1140}],"wed":[{"end":870,"start":720},{"end":1350,"start":1140}]}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/thefork/search":{"get":{"summary":"TheFork Search","description":"Search TheFork restaurants from a full search or city URL and retrieve ratings, cuisine, prices, availability, review summaries, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-thefork-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full TheFork search or city listing URL.\n\n**Example 1 (search with date, time, and party size):**\n\n    https://www.thefork.fr/search?cityId=529135&date=2026-06-13&hour=660&partySize=8&timezone=Europe%2FParis\n\n**Example 2 (city restaurant listing):**\n\n    https://www.thefork.fr/restaurants/strasbourg-c529135\n\n**Notes:**\n- Accepts `thefork.fr`, `thefork.com`, and other TheFork country domains.\n- Copy the full URL from TheFork, including filters (`cityId`, `date`, `hour`, `partySize`, cuisine tags, etc.).\n- Pagination uses the `#list25` anchor in `pagination.next_url` (page 2 = `#list25`, page 3 = `#list50`, etc.).\n- TheFork search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the TheFork Restaurant endpoint for full profile data.","schema":{"type":"string","description":"Full TheFork search or city listing URL.\n\n**Example 1 (search with date, time, and party size):**\n\n    https://www.thefork.fr/search?cityId=529135&date=2026-06-13&hour=660&partySize=8&timezone=Europe%2FParis\n\n**Example 2 (city restaurant listing):**\n\n    https://www.thefork.fr/restaurants/strasbourg-c529135\n\n**Notes:**\n- Accepts `thefork.fr`, `thefork.com`, and other TheFork country domains.\n- Copy the full URL from TheFork, including filters (`cityId`, `date`, `hour`, `partySize`, cuisine tags, etc.).\n- Pagination uses the `#list25` anchor in `pagination.next_url` (page 2 = `#list25`, page 3 = `#list50`, etc.).\n- TheFork search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the TheFork Restaurant endpoint for full profile data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"uuid":{"type":"string"},"image":{"type":"string"},"rating":{"type":"number"},"address":{"type":"string"},"cuisine":{"type":"string"},"currency":{"type":"string"},"avg_price":{"type":"integer"},"timeslots":{"type":"array","items":{}},"geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"__typename":{"type":"string"}}},"is_bookable":{"type":"boolean"},"reviews_count":{"type":"integer"},"review_snippets":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"__typename":{"type":"string"},"highlights":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"},"__typename":{"type":"string"}}}},"review_snippet_uuid":{"type":"string"}}}},"reviews_summary":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search restaurants in Strasbourg for 8 guests on 2026-06-13":{"value":{"results":[{"id":423365,"url":"https://www.thefork.fr/restaurant/le-vintage-r423365","name":"Le Vintage","slug":"le-vintage","uuid":"a55fe916-811b-43be-9b14-4babd77b0df9","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/a55fe916-811b-43be-9b14-4babd77b0df9/54b4e261-50d9-4bbb-a690-08a38059391c.jpg","rating":9.5,"address":"15 Rue des Serruriers, 67000, Strasbourg, France","cuisine":"Alsacien","currency":"EUR","avg_price":32,"timeslots":[],"geolocation":{"latitude":48.5803126,"longitude":7.7464058,"__typename":"Coordinate"},"is_bookable":true,"reviews_count":571,"review_snippets":[{"text":"très beau cadre vintage, très belle musique, très bon repas, accueil parfait, nous recommandons à 100%","__typename":"SearchReviewSnippet","highlights":[{"end":59,"start":45,"__typename":"SearchReviewSnippetHighlight"},{"end":76,"start":61,"__typename":"SearchReviewSnippetHighlight"}],"review_snippet_uuid":"a114b6d4-f50f-4d74-9935-c5a6ed7f895f"}],"reviews_summary":"Le Vintage charme par son ambiance rétro et intimiste, avec une décoration vintage de très bon goût, agrémentée de photos d’actrices mythiques. Les clients apprécient particulièrement les tartes flambées croustillantes et bien garnies, ainsi que le jarret grillé. Le service est impeccable et chaleureux, avec un personnel attentionné. Une adresse recommandée à Strasbourg pour une expérience culinaire authentique."},{"id":832121,"url":"https://www.thefork.fr/restaurant/restaurant-et-cafe-aygui-r832121","name":"RESTAURANT ET CAFÉ AYGUI","slug":"restaurant-et-cafe-aygui","uuid":"d34ce798-5ed7-4a0f-b014-eb2dbdd24476","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/d34ce798-5ed7-4a0f-b014-eb2dbdd24476/d524634e-094b-447f-bdc8-c2865bf506e3.png","rating":9.3,"address":"5 Rue du Faubourg-de-Saverne, 67000, Strasbourg, France","cuisine":"Arménien","currency":"EUR","avg_price":18,"timeslots":[],"geolocation":{"latitude":48.584737,"longitude":7.740534999999999,"__typename":"Coordinate"},"is_bookable":true,"reviews_count":202,"review_snippets":[{"text":"Tout était parfait, mon amie a pris plaisir à découvrir la cuisine du Caucase.","__typename":"SearchReviewSnippet","highlights":[{"end":18,"start":11,"__typename":"SearchReviewSnippetHighlight"},{"end":77,"start":59,"__typename":"SearchReviewSnippetHighlight"}],"review_snippet_uuid":"90058560-2c7f-4d07-8de4-91a5ab4a0c87"}],"reviews_summary":"RESTAURANT ET CAFÉ AYGUI offre une belle découverte culinaire avec une cuisine caucasienne savoureuse et généreuse, notamment les délicieux raviolis arméniens et l'excellent baklava. Le cadre est chaleureux et agréable, bien que l'éclairage puisse être amélioré. Le service est accueillant et attentionné, malgré quelques retards. Une adresse recommandée pour explorer des mets authentiques."},{"id":10892,"url":"https://www.thefork.fr/restaurant/salamboo-amilkar-r10892","name":"Salamboo Amilkar","slug":"salamboo-amilkar","uuid":"b553d2bc-f24b-4f3d-bc40-e415dfc927cd","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/b553d2bc-f24b-4f3d-bc40-e415dfc927cd/f2041a2c-126f-4e38-9238-36f54d2a9077.jpg","rating":9.4,"address":"2, rue de la Croix, 67000, Strasbourg, France","cuisine":"Tunisien","currency":"EUR","avg_price":31,"timeslots":[],"geolocation":{"latitude":48.582227484,"longitude":7.754749775,"__typename":"Coordinate"},"is_bookable":true,"reviews_count":1614,"review_snippets":[{"text":"Endroit magnifique et couscous excellent, service impeccable, toujours avec le sourire, c'est une belle adresse","__typename":"SearchReviewSnippet","highlights":[{"end":18,"start":8,"__typename":"SearchReviewSnippetHighlight"},{"end":30,"start":22,"__typename":"SearchReviewSnippetHighlight"}],"review_snippet_uuid":"b31707a7-ba97-4121-8424-1a223fbe490e"}],"reviews_summary":"Salamboo Amilkar séduit par son cadre raffiné et son ambiance chaleureuse, idéale pour s'évader le temps d'un repas. Les plats tunisiens, notamment le couscous, sont une explosion de saveurs et généreusement servis. Le personnel, toujours accueillant et souriant, assure un service impeccable. Une adresse à découvrir et à revisiter pour des moments inoubliables."}],"pagination":{"next":2,"current":1,"next_url":"https://www.thefork.fr/search?cityId=529135&date=2026-06-13&hour=660&partySize=8&timezone=Europe%2FParis#list25","per_page":25,"total_count":185,"total_pages":8,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"TheFork Search","description":"Search TheFork restaurants from a full search or city URL and retrieve ratings, cuisine, prices, availability, review summaries, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-thefork-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full TheFork search or city listing URL.\n\n**Example 1 (search with date, time, and party size):**\n\n    https://www.thefork.fr/search?cityId=529135&date=2026-06-13&hour=660&partySize=8&timezone=Europe%2FParis\n\n**Example 2 (city restaurant listing):**\n\n    https://www.thefork.fr/restaurants/strasbourg-c529135\n\n**Notes:**\n- Accepts `thefork.fr`, `thefork.com`, and other TheFork country domains.\n- Copy the full URL from TheFork, including filters (`cityId`, `date`, `hour`, `partySize`, cuisine tags, etc.).\n- Pagination uses the `#list25` anchor in `pagination.next_url` (page 2 = `#list25`, page 3 = `#list50`, etc.).\n- TheFork search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the TheFork Restaurant endpoint for full profile data.","schema":{"type":"string","description":"Full TheFork search or city listing URL.\n\n**Example 1 (search with date, time, and party size):**\n\n    https://www.thefork.fr/search?cityId=529135&date=2026-06-13&hour=660&partySize=8&timezone=Europe%2FParis\n\n**Example 2 (city restaurant listing):**\n\n    https://www.thefork.fr/restaurants/strasbourg-c529135\n\n**Notes:**\n- Accepts `thefork.fr`, `thefork.com`, and other TheFork country domains.\n- Copy the full URL from TheFork, including filters (`cityId`, `date`, `hour`, `partySize`, cuisine tags, etc.).\n- Pagination uses the `#list25` anchor in `pagination.next_url` (page 2 = `#list25`, page 3 = `#list50`, etc.).\n- TheFork search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the TheFork Restaurant endpoint for full profile data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"uuid":{"type":"string"},"image":{"type":"string"},"rating":{"type":"number"},"address":{"type":"string"},"cuisine":{"type":"string"},"currency":{"type":"string"},"avg_price":{"type":"integer"},"timeslots":{"type":"array","items":{}},"geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"__typename":{"type":"string"}}},"is_bookable":{"type":"boolean"},"reviews_count":{"type":"integer"},"review_snippets":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"__typename":{"type":"string"},"highlights":{"type":"array","items":{"type":"object","properties":{"end":{"type":"integer"},"start":{"type":"integer"},"__typename":{"type":"string"}}}},"review_snippet_uuid":{"type":"string"}}}},"reviews_summary":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search restaurants in Strasbourg for 8 guests on 2026-06-13":{"value":{"results":[{"id":423365,"url":"https://www.thefork.fr/restaurant/le-vintage-r423365","name":"Le Vintage","slug":"le-vintage","uuid":"a55fe916-811b-43be-9b14-4babd77b0df9","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/a55fe916-811b-43be-9b14-4babd77b0df9/54b4e261-50d9-4bbb-a690-08a38059391c.jpg","rating":9.5,"address":"15 Rue des Serruriers, 67000, Strasbourg, France","cuisine":"Alsacien","currency":"EUR","avg_price":32,"timeslots":[],"geolocation":{"latitude":48.5803126,"longitude":7.7464058,"__typename":"Coordinate"},"is_bookable":true,"reviews_count":571,"review_snippets":[{"text":"très beau cadre vintage, très belle musique, très bon repas, accueil parfait, nous recommandons à 100%","__typename":"SearchReviewSnippet","highlights":[{"end":59,"start":45,"__typename":"SearchReviewSnippetHighlight"},{"end":76,"start":61,"__typename":"SearchReviewSnippetHighlight"}],"review_snippet_uuid":"a114b6d4-f50f-4d74-9935-c5a6ed7f895f"}],"reviews_summary":"Le Vintage charme par son ambiance rétro et intimiste, avec une décoration vintage de très bon goût, agrémentée de photos d’actrices mythiques. Les clients apprécient particulièrement les tartes flambées croustillantes et bien garnies, ainsi que le jarret grillé. Le service est impeccable et chaleureux, avec un personnel attentionné. Une adresse recommandée à Strasbourg pour une expérience culinaire authentique."},{"id":832121,"url":"https://www.thefork.fr/restaurant/restaurant-et-cafe-aygui-r832121","name":"RESTAURANT ET CAFÉ AYGUI","slug":"restaurant-et-cafe-aygui","uuid":"d34ce798-5ed7-4a0f-b014-eb2dbdd24476","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/d34ce798-5ed7-4a0f-b014-eb2dbdd24476/d524634e-094b-447f-bdc8-c2865bf506e3.png","rating":9.3,"address":"5 Rue du Faubourg-de-Saverne, 67000, Strasbourg, France","cuisine":"Arménien","currency":"EUR","avg_price":18,"timeslots":[],"geolocation":{"latitude":48.584737,"longitude":7.740534999999999,"__typename":"Coordinate"},"is_bookable":true,"reviews_count":202,"review_snippets":[{"text":"Tout était parfait, mon amie a pris plaisir à découvrir la cuisine du Caucase.","__typename":"SearchReviewSnippet","highlights":[{"end":18,"start":11,"__typename":"SearchReviewSnippetHighlight"},{"end":77,"start":59,"__typename":"SearchReviewSnippetHighlight"}],"review_snippet_uuid":"90058560-2c7f-4d07-8de4-91a5ab4a0c87"}],"reviews_summary":"RESTAURANT ET CAFÉ AYGUI offre une belle découverte culinaire avec une cuisine caucasienne savoureuse et généreuse, notamment les délicieux raviolis arméniens et l'excellent baklava. Le cadre est chaleureux et agréable, bien que l'éclairage puisse être amélioré. Le service est accueillant et attentionné, malgré quelques retards. Une adresse recommandée pour explorer des mets authentiques."},{"id":10892,"url":"https://www.thefork.fr/restaurant/salamboo-amilkar-r10892","name":"Salamboo Amilkar","slug":"salamboo-amilkar","uuid":"b553d2bc-f24b-4f3d-bc40-e415dfc927cd","image":"https://cdn.thefork.com/tf-lab/image/upload/restaurant/b553d2bc-f24b-4f3d-bc40-e415dfc927cd/f2041a2c-126f-4e38-9238-36f54d2a9077.jpg","rating":9.4,"address":"2, rue de la Croix, 67000, Strasbourg, France","cuisine":"Tunisien","currency":"EUR","avg_price":31,"timeslots":[],"geolocation":{"latitude":48.582227484,"longitude":7.754749775,"__typename":"Coordinate"},"is_bookable":true,"reviews_count":1614,"review_snippets":[{"text":"Endroit magnifique et couscous excellent, service impeccable, toujours avec le sourire, c'est une belle adresse","__typename":"SearchReviewSnippet","highlights":[{"end":18,"start":8,"__typename":"SearchReviewSnippetHighlight"},{"end":30,"start":22,"__typename":"SearchReviewSnippetHighlight"}],"review_snippet_uuid":"b31707a7-ba97-4121-8424-1a223fbe490e"}],"reviews_summary":"Salamboo Amilkar séduit par son cadre raffiné et son ambiance chaleureuse, idéale pour s'évader le temps d'un repas. Les plats tunisiens, notamment le couscous, sont une explosion de saveurs et généreusement servis. Le personnel, toujours accueillant et souriant, assure un service impeccable. Une adresse à découvrir et à revisiter pour des moments inoubliables."}],"pagination":{"next":2,"current":1,"next_url":"https://www.thefork.fr/search?cityId=529135&date=2026-06-13&hour=660&partySize=8&timezone=Europe%2FParis#list25","per_page":25,"total_count":185,"total_pages":8,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/yelp/reviews":{"get":{"summary":"Yelp Reviews","description":"Fetch paginated Yelp reviews for a business with rating, text, author profile, reactions, and attached photos or videos.\n\n**Credit cost:** 2 credits per call","operationId":"get-yelp-reviews","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Yelp business ID / encid.\n\n**Example:**\n\n    cX5dOMkwZ5rqWbeIJpw_Ig\n\nUse `biz_id` from **Yelp Search** or `business_id` from **Yelp Business**.","schema":{"type":"string","description":"Yelp business ID / encid.\n\n**Example:**\n\n    cX5dOMkwZ5rqWbeIJpw_Ig\n\nUse `biz_id` from **Yelp Search** or `business_id` from **Yelp Business**."}},{"name":"page","in":"query","required":false,"description":"Page number. Each page returns up to 10 reviews. Default: `1`.","schema":{"type":"number","default":"1","description":"Page number. Each page returns up to 10 reviews. Default: `1`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"text":{"type":"object","properties":{"full":{"type":"string"},"language":{"type":"string"}}},"encid":{"type":"string"},"author":{"type":"object","properties":{"encid":{"type":"string"},"display_name":{"type":"string"},"friend_count":{"type":"integer"},"review_count":{"type":"integer"},"display_location":{"type":"string"},"business_photo_count":{"type":"integer"}}},"rating":{"type":"integer"},"business":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"encid":{"type":"string"}}},"feedback":{"type":"object","properties":{"cool_count":{"nullable":true},"funny_count":{"nullable":true},"useful_count":{"nullable":true}}},"created_at":{"nullable":true},"business_photos":{"type":"array","items":{}},"business_videos":{"type":"array","items":{}},"available_reactions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"display_text":{"type":"string"},"reaction_type":{"type":"string"}}}}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"business_id":{"type":"string"}}},"examples":{"Reviews for Novela (page 1)":{"value":{"url":"https://www.yelp.com/biz_photos/cX5dOMkwZ5rqWbeIJpw_Ig","results":[{"text":{"full":"Superb cocktails and friendly service \nDecor are modern and sleek \nCrabcakes and Turkish chicken legs are delicious","language":"en"},"encid":"ftgDNwNVnb3xwx8XRP9n9Q","author":{"encid":"fFv3wzMIZDgIruoiVOFEGQ","display_name":"Alex Martin","friend_count":1,"review_count":6,"display_location":"San Francisco, CA","business_photo_count":0},"rating":5,"business":{"name":"Novela","alias":"novela-san-francisco-2","encid":"cX5dOMkwZ5rqWbeIJpw_Ig"},"feedback":{"cool_count":null,"funny_count":null,"useful_count":null},"created_at":null,"business_photos":[],"business_videos":[],"available_reactions":[{"count":0,"display_text":"Helpful","reaction_type":"HELPFUL"},{"count":0,"display_text":"Thanks","reaction_type":"THANKS"},{"count":1,"display_text":"Love this","reaction_type":"LOVE_THIS"},{"count":0,"display_text":"Oh no","reaction_type":"OH_NO"}]},{"text":{"full":"The vibe is amazing. We walked in without a reservation and were seated right away even though they were busy. The host was great and services were amazing.\n\nI ordered the chicken and rice and was okay. The rice tasted undercooked and the chicken could have used more seasoning to really bring out its flavor.","language":"en"},"encid":"iZUQegcOX-GIKLacrlBJ2g","author":{"encid":"P0RUkwZySXJMHmH-njJVkw","display_name":"Jordan Lee","friend_count":1,"review_count":9,"display_location":"Alum Rock, San Jose, CA","business_photo_count":4},"rating":4,"business":{"name":"Novela","alias":"novela-san-francisco-2","encid":"cX5dOMkwZ5rqWbeIJpw_Ig"},"feedback":{"cool_count":null,"funny_count":null,"useful_count":null},"created_at":null,"business_photos":[{"encid":"OkoVt1WskgotDf6A2NM_gQ","caption":null,"photo_url":"https://s3-media0.fl.yelpcdn.com/bphoto/OkoVt1WskgotDf6A2NM_gQ/348s.jpg","helpful_count":null}],"business_videos":[{"encid":"txtNP6zT6_BnGSdUnlOBzQ","caption":null,"video_url":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/high.mp4","__typename":"BusinessVideo","time_created":{"__typename":"DateTime","utc_date_time":"2026-04-12T22:07:02Z"},"thumbnail_url":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=720&time=0","uploading_user":{"encid":"P0RUkwZySXJMHmH-njJVkw","__typename":"User","display_name":"Jordan Lee","profile_photo":{"encid":"tFsfT564Fo5sv7F-FFowPQ","photo_url":{"url1x":"https://s3-media0.fl.yelpcdn.com/photo/tFsfT564Fo5sv7F-FFowPQ/xss.jpg","url2x":"https://s3-media0.fl.yelpcdn.com/photo/tFsfT564Fo5sv7F-FFowPQ/ss.jpg","__typename":"UserPhotoUrl"},"__typename":"UserProfilePhoto"},"is_logged_in_user":null},"video_business":{"name":"Novela","alias":"novela-san-francisco-2","encid":"cX5dOMkwZ5rqWbeIJpw_Ig","location":{"encid":"cX5dOMkwZ5rqWbeIJpw_Ig","address":{"city":"San Francisco","__typename":"BusinessAddress","region_code":"CA"},"__typename":"BusinessLocation"},"__typename":"Business","categories":[{"encid":"FIW3O50FJ6hyqdvrHxTa0g","title":"Cocktail Bars","__typename":"BusinessCategory"},{"encid":"1F6C8Q_3pre02ukRakGs3Q","title":"Lounges","__typename":"BusinessCategory"},{"encid":"9vS4P2Z_kJiWpTLB0O6cYw","title":"Venues & Event Spaces","__typename":"BusinessCategory"}],"primary_photo":{"encid":"J8uN_Ux35IHZ0S2q5_2buQ","photo_url":{"url1x":"https://s3-media0.fl.yelpcdn.com/bphoto/J8uN_Ux35IHZ0S2q5_2buQ/xs.jpg","url2x":"https://s3-media0.fl.yelpcdn.com/bphoto/J8uN_Ux35IHZ0S2q5_2buQ/s.jpg","__typename":"BusinessPhotoUrl"},"__typename":"BusinessPhoto"}},"video_publication":{"__typename":"VideoPublication","rendition_set":[{"src":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/high.mp4","duration":6000,"__typename":"VideoRendition","rendition_id":"progressive_video_high"},{"src":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/medium.mp4","duration":6000,"__typename":"VideoRendition","rendition_id":"progressive_video_medium"},{"src":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/low.mp4","duration":6000,"__typename":"VideoRendition","rendition_id":"progressive_video_low"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=1080&time=0","duration":null,"__typename":"VideoRendition","rendition_id":"poster_high"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=720&time=0","duration":null,"__typename":"VideoRendition","rendition_id":"poster_medium"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=480&time=0","duration":null,"__typename":"VideoRendition","rendition_id":"poster_low"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?fit_mode=crop&width=720&height=720","duration":null,"__typename":"VideoRendition","rendition_id":"square_thumbnail_720"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?fit_mode=crop&width=480&height=480","duration":null,"__typename":"VideoRendition","rendition_id":"square_thumbnail_480"}],"publication_id":"532b1916-23c9-5469-b16c-d929939797fb"},"available_reactions_container":{"__typename":"AvailableContentReactionsContainer","container_format":{"axis":"HORIZONTAL","alignment":"LEADING","__typename":"ContentReactionsContainerFormat"},"available_reactions":[{"count":0,"__typename":"AvailableContentReaction","show_count":true,"asset_format":{"__typename":"ContentReactionAssetFormat","text_layout":"OUTSIDE_BUTTON_RIGHT","corner_radius":"CIRCULAR","disabled_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackLight","border_color":"coreGrayscaleGrayRegular","ripple_color":"coreGrayscaleGrayLightWithAlpha10","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"24x24_like_v2"},"background_color":"coreGrayscaleWhite"},"selected_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackRegular","border_color":"coreGrayscaleWhite","ripple_color":"coreGrayscaleGrayLightWithAlpha50","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"24x24_like_filled_v2"},"background_color":"coreGrayscaleWhite"},"collapsed_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackRegular","border_color":"coreGrayscaleWhite","ripple_color":"coreGrayscaleGrayLightWithAlpha50","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"16x16_like_filled_v2"},"background_color":"coreGrayscaleWhite"},"unselected_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackLight","border_color":"coreGrayscaleWhite","ripple_color":"coreGrayscaleGrayLightWithAlpha50","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"24x24_like_v2"},"background_color":"coreGrayscaleWhite"},"asset_content_type":"IMAGE"},"display_text":"likes","toggle_state":"UNSELECTED","reaction_type":"BIZ_VIDEO_LIKE","show_as_tooltip":false,"show_zero_count":false,"invert_text_order":true,"display_text_single_count":"like"}],"is_mutually_exclusive":false}}],"available_reactions":[{"count":1,"display_text":"Helpful","reaction_type":"HELPFUL"},{"count":1,"display_text":"Thanks","reaction_type":"THANKS"},{"count":1,"display_text":"Love this","reaction_type":"LOVE_THIS"},{"count":0,"display_text":"Oh no","reaction_type":"OH_NO"}]}],"pagination":{"next":2,"current":1,"other_pages":[],"total_pages":155,"has_next_page":true,"total_results":1545},"business_id":"cX5dOMkwZ5rqWbeIJpw_Ig"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Yelp Reviews","description":"Fetch paginated Yelp reviews for a business with rating, text, author profile, reactions, and attached photos or videos.\n\n**Credit cost:** 2 credits per call","operationId":"post-yelp-reviews","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Yelp business ID / encid.\n\n**Example:**\n\n    cX5dOMkwZ5rqWbeIJpw_Ig\n\nUse `biz_id` from **Yelp Search** or `business_id` from **Yelp Business**.","schema":{"type":"string","description":"Yelp business ID / encid.\n\n**Example:**\n\n    cX5dOMkwZ5rqWbeIJpw_Ig\n\nUse `biz_id` from **Yelp Search** or `business_id` from **Yelp Business**."}},{"name":"page","in":"query","required":false,"description":"Page number. Each page returns up to 10 reviews. Default: `1`.","schema":{"type":"number","default":"1","description":"Page number. Each page returns up to 10 reviews. Default: `1`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"text":{"type":"object","properties":{"full":{"type":"string"},"language":{"type":"string"}}},"encid":{"type":"string"},"author":{"type":"object","properties":{"encid":{"type":"string"},"display_name":{"type":"string"},"friend_count":{"type":"integer"},"review_count":{"type":"integer"},"display_location":{"type":"string"},"business_photo_count":{"type":"integer"}}},"rating":{"type":"integer"},"business":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"encid":{"type":"string"}}},"feedback":{"type":"object","properties":{"cool_count":{"nullable":true},"funny_count":{"nullable":true},"useful_count":{"nullable":true}}},"created_at":{"nullable":true},"business_photos":{"type":"array","items":{}},"business_videos":{"type":"array","items":{}},"available_reactions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"display_text":{"type":"string"},"reaction_type":{"type":"string"}}}}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"business_id":{"type":"string"}}},"examples":{"Reviews for Novela (page 1)":{"value":{"url":"https://www.yelp.com/biz_photos/cX5dOMkwZ5rqWbeIJpw_Ig","results":[{"text":{"full":"Superb cocktails and friendly service \nDecor are modern and sleek \nCrabcakes and Turkish chicken legs are delicious","language":"en"},"encid":"ftgDNwNVnb3xwx8XRP9n9Q","author":{"encid":"fFv3wzMIZDgIruoiVOFEGQ","display_name":"Alex Martin","friend_count":1,"review_count":6,"display_location":"San Francisco, CA","business_photo_count":0},"rating":5,"business":{"name":"Novela","alias":"novela-san-francisco-2","encid":"cX5dOMkwZ5rqWbeIJpw_Ig"},"feedback":{"cool_count":null,"funny_count":null,"useful_count":null},"created_at":null,"business_photos":[],"business_videos":[],"available_reactions":[{"count":0,"display_text":"Helpful","reaction_type":"HELPFUL"},{"count":0,"display_text":"Thanks","reaction_type":"THANKS"},{"count":1,"display_text":"Love this","reaction_type":"LOVE_THIS"},{"count":0,"display_text":"Oh no","reaction_type":"OH_NO"}]},{"text":{"full":"The vibe is amazing. We walked in without a reservation and were seated right away even though they were busy. The host was great and services were amazing.\n\nI ordered the chicken and rice and was okay. The rice tasted undercooked and the chicken could have used more seasoning to really bring out its flavor.","language":"en"},"encid":"iZUQegcOX-GIKLacrlBJ2g","author":{"encid":"P0RUkwZySXJMHmH-njJVkw","display_name":"Jordan Lee","friend_count":1,"review_count":9,"display_location":"Alum Rock, San Jose, CA","business_photo_count":4},"rating":4,"business":{"name":"Novela","alias":"novela-san-francisco-2","encid":"cX5dOMkwZ5rqWbeIJpw_Ig"},"feedback":{"cool_count":null,"funny_count":null,"useful_count":null},"created_at":null,"business_photos":[{"encid":"OkoVt1WskgotDf6A2NM_gQ","caption":null,"photo_url":"https://s3-media0.fl.yelpcdn.com/bphoto/OkoVt1WskgotDf6A2NM_gQ/348s.jpg","helpful_count":null}],"business_videos":[{"encid":"txtNP6zT6_BnGSdUnlOBzQ","caption":null,"video_url":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/high.mp4","__typename":"BusinessVideo","time_created":{"__typename":"DateTime","utc_date_time":"2026-04-12T22:07:02Z"},"thumbnail_url":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=720&time=0","uploading_user":{"encid":"P0RUkwZySXJMHmH-njJVkw","__typename":"User","display_name":"Jordan Lee","profile_photo":{"encid":"tFsfT564Fo5sv7F-FFowPQ","photo_url":{"url1x":"https://s3-media0.fl.yelpcdn.com/photo/tFsfT564Fo5sv7F-FFowPQ/xss.jpg","url2x":"https://s3-media0.fl.yelpcdn.com/photo/tFsfT564Fo5sv7F-FFowPQ/ss.jpg","__typename":"UserPhotoUrl"},"__typename":"UserProfilePhoto"},"is_logged_in_user":null},"video_business":{"name":"Novela","alias":"novela-san-francisco-2","encid":"cX5dOMkwZ5rqWbeIJpw_Ig","location":{"encid":"cX5dOMkwZ5rqWbeIJpw_Ig","address":{"city":"San Francisco","__typename":"BusinessAddress","region_code":"CA"},"__typename":"BusinessLocation"},"__typename":"Business","categories":[{"encid":"FIW3O50FJ6hyqdvrHxTa0g","title":"Cocktail Bars","__typename":"BusinessCategory"},{"encid":"1F6C8Q_3pre02ukRakGs3Q","title":"Lounges","__typename":"BusinessCategory"},{"encid":"9vS4P2Z_kJiWpTLB0O6cYw","title":"Venues & Event Spaces","__typename":"BusinessCategory"}],"primary_photo":{"encid":"J8uN_Ux35IHZ0S2q5_2buQ","photo_url":{"url1x":"https://s3-media0.fl.yelpcdn.com/bphoto/J8uN_Ux35IHZ0S2q5_2buQ/xs.jpg","url2x":"https://s3-media0.fl.yelpcdn.com/bphoto/J8uN_Ux35IHZ0S2q5_2buQ/s.jpg","__typename":"BusinessPhotoUrl"},"__typename":"BusinessPhoto"}},"video_publication":{"__typename":"VideoPublication","rendition_set":[{"src":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/high.mp4","duration":6000,"__typename":"VideoRendition","rendition_id":"progressive_video_high"},{"src":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/medium.mp4","duration":6000,"__typename":"VideoRendition","rendition_id":"progressive_video_medium"},{"src":"https://stream.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/low.mp4","duration":6000,"__typename":"VideoRendition","rendition_id":"progressive_video_low"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=1080&time=0","duration":null,"__typename":"VideoRendition","rendition_id":"poster_high"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=720&time=0","duration":null,"__typename":"VideoRendition","rendition_id":"poster_medium"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?height=480&time=0","duration":null,"__typename":"VideoRendition","rendition_id":"poster_low"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?fit_mode=crop&width=720&height=720","duration":null,"__typename":"VideoRendition","rendition_id":"square_thumbnail_720"},{"src":"https://image.mux.com/3F01tjxp00gNsdqVNhaet8gktQvcHRv2ftAUPaH600NuEY/thumbnail.jpg?fit_mode=crop&width=480&height=480","duration":null,"__typename":"VideoRendition","rendition_id":"square_thumbnail_480"}],"publication_id":"532b1916-23c9-5469-b16c-d929939797fb"},"available_reactions_container":{"__typename":"AvailableContentReactionsContainer","container_format":{"axis":"HORIZONTAL","alignment":"LEADING","__typename":"ContentReactionsContainerFormat"},"available_reactions":[{"count":0,"__typename":"AvailableContentReaction","show_count":true,"asset_format":{"__typename":"ContentReactionAssetFormat","text_layout":"OUTSIDE_BUTTON_RIGHT","corner_radius":"CIRCULAR","disabled_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackLight","border_color":"coreGrayscaleGrayRegular","ripple_color":"coreGrayscaleGrayLightWithAlpha10","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"24x24_like_v2"},"background_color":"coreGrayscaleWhite"},"selected_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackRegular","border_color":"coreGrayscaleWhite","ripple_color":"coreGrayscaleGrayLightWithAlpha50","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"24x24_like_filled_v2"},"background_color":"coreGrayscaleWhite"},"collapsed_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackRegular","border_color":"coreGrayscaleWhite","ripple_color":"coreGrayscaleGrayLightWithAlpha50","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"16x16_like_filled_v2"},"background_color":"coreGrayscaleWhite"},"unselected_format":{"__typename":"ContentReactionStateAssetFormat","text_color":"coreGrayscaleBlackLight","border_color":"coreGrayscaleWhite","ripple_color":"coreGrayscaleGrayLightWithAlpha50","asset_locator":{"__typename":"ContentReactionBundledAssetLocator","asset_name":"24x24_like_v2"},"background_color":"coreGrayscaleWhite"},"asset_content_type":"IMAGE"},"display_text":"likes","toggle_state":"UNSELECTED","reaction_type":"BIZ_VIDEO_LIKE","show_as_tooltip":false,"show_zero_count":false,"invert_text_order":true,"display_text_single_count":"like"}],"is_mutually_exclusive":false}}],"available_reactions":[{"count":1,"display_text":"Helpful","reaction_type":"HELPFUL"},{"count":1,"display_text":"Thanks","reaction_type":"THANKS"},{"count":1,"display_text":"Love this","reaction_type":"LOVE_THIS"},{"count":0,"display_text":"Oh no","reaction_type":"OH_NO"}]}],"pagination":{"next":2,"current":1,"other_pages":[],"total_pages":155,"has_next_page":true,"total_results":1545},"business_id":"cX5dOMkwZ5rqWbeIJpw_Ig"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/yelp/business":{"get":{"summary":"Yelp Business","description":"Fetch a Yelp business profile from a full business URL with phone, address, website, logo, hours, and claim status.\n\n**Credit cost:** 2 credits per call","operationId":"get-yelp-business","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yelp business URL.\n\n**Example:**\n\n    https://www.yelp.com/biz/novela-san-francisco-2\n\nUse an organic `/biz/` link from **Yelp Search** results.","schema":{"type":"string","description":"Full Yelp business URL.\n\n**Example:**\n\n    https://www.yelp.com/biz/novela-san-francisco-2\n\nUse an organic `/biz/` link from **Yelp Search** results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"},"website":{"type":"string"},"open_hours":{"type":"object","properties":{"fri":{"type":"string"},"mon":{"type":"string"},"sat":{"type":"string"},"sun":{"type":"string"},"thu":{"type":"string"},"tue":{"type":"string"},"wed":{"type":"string"}}},"business_id":{"type":"string"},"claim_status":{"type":"string"}}},"examples":{"Lookup Novela, San Francisco":{"value":{"url":"https://www.yelp.com/biz/novela-san-francisco-2?osq=bars+open&rr=4","logo":"https://s3-media0.fl.yelpcdn.com/businessregularlogo/dkB_F32_r_PfLpQLAuNsFA/ms.jpg","name":"Novela","phone":"(415) 896-6500","address":"662 Mission St San Francisco, CA 94105","website":"novelasf.com","open_hours":{"fri":"4:00 PM - 2:00 AM (Next day)","mon":"4:00 PM - 12:00 AM (Next day)","sat":"5:00 PM - 2:00 AM (Next day)","sun":"Closed","thu":"4:00 PM - 2:00 AM (Next day)","tue":"4:00 PM - 1:00 AM (Next day)","wed":"4:00 PM - 1:00 AM (Next day)"},"business_id":"cX5dOMkwZ5rqWbeIJpw_Ig","claim_status":"claimed"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Yelp Business","description":"Fetch a Yelp business profile from a full business URL with phone, address, website, logo, hours, and claim status.\n\n**Credit cost:** 2 credits per call","operationId":"post-yelp-business","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yelp business URL.\n\n**Example:**\n\n    https://www.yelp.com/biz/novela-san-francisco-2\n\nUse an organic `/biz/` link from **Yelp Search** results.","schema":{"type":"string","description":"Full Yelp business URL.\n\n**Example:**\n\n    https://www.yelp.com/biz/novela-san-francisco-2\n\nUse an organic `/biz/` link from **Yelp Search** results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"},"website":{"type":"string"},"open_hours":{"type":"object","properties":{"fri":{"type":"string"},"mon":{"type":"string"},"sat":{"type":"string"},"sun":{"type":"string"},"thu":{"type":"string"},"tue":{"type":"string"},"wed":{"type":"string"}}},"business_id":{"type":"string"},"claim_status":{"type":"string"}}},"examples":{"Lookup Novela, San Francisco":{"value":{"url":"https://www.yelp.com/biz/novela-san-francisco-2?osq=bars+open&rr=4","logo":"https://s3-media0.fl.yelpcdn.com/businessregularlogo/dkB_F32_r_PfLpQLAuNsFA/ms.jpg","name":"Novela","phone":"(415) 896-6500","address":"662 Mission St San Francisco, CA 94105","website":"novelasf.com","open_hours":{"fri":"4:00 PM - 2:00 AM (Next day)","mon":"4:00 PM - 12:00 AM (Next day)","sat":"5:00 PM - 2:00 AM (Next day)","sun":"Closed","thu":"4:00 PM - 2:00 AM (Next day)","tue":"4:00 PM - 1:00 AM (Next day)","wed":"4:00 PM - 1:00 AM (Next day)"},"business_id":"cX5dOMkwZ5rqWbeIJpw_Ig","claim_status":"claimed"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/cdiscount/search":{"get":{"summary":"Cdiscount Search","description":"Extract product listings from Cdiscount search results or category pages for market intelligence and competitive analysis.\n\n**Credit cost:** 2 credits per call","operationId":"get-cdiscount-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Cdiscount search results page URL. Use any URL from a search or category browse on cdiscount.com.\n\n**Example:**\n\n    https://www.cdiscount.com/search/10/laptop.html\n\n**Notes:**\n- You can use keyword search URLs (e.g. `/search/10/{keyword}.html`) or category browse URLs (e.g. `/informatique/ordinateurs-pc-portables/...`)\n- Pagination and filter parameters present in the URL are respected.","schema":{"type":"string","description":"Cdiscount search results page URL. Use any URL from a search or category browse on cdiscount.com.\n\n**Example:**\n\n    https://www.cdiscount.com/search/10/laptop.html\n\n**Notes:**\n- You can use keyword search URLs (e.g. `/search/10/{keyword}.html`) or category browse URLs (e.g. `/informatique/ordinateurs-pc-portables/...`)\n- Pagination and filter parameters present in the URL are respected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"is_new":{"type":"boolean"},"rating":{"type":"integer"},"seller":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"is_cdav":{"type":"boolean"},"brand_id":{"type":"integer"},"currency":{"type":"string"},"offer_id":{"type":"integer"},"condition":{"type":"string"},"category_id":{"type":"integer"},"is_sponsored":{"type":"boolean"},"min_quantity":{"type":"integer"},"category_path":{"type":"string"},"department_id":{"type":"integer"},"free_shipping":{"type":"boolean"},"reviews_count":{"type":"integer"},"original_price":{"type":"number"},"new_offer_quantity":{"type":"integer"},"new_offer_min_price":{"type":"integer"},"used_offer_quantity":{"type":"integer"},"used_offer_min_price":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for laptops":{"value":{"results":[{"id":"aaaph06865","url":"https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html","image":"https://www.cdiscount.com/pdt2/8/6/5/1/300x300/aaaph06865/rw/acemagic-pc-portables-gaming.jpg","price":429.99,"title":"ACEMAGIC PC Portables Gaming - 15.6\" FHD, AMD Ryzen 7 5700U, 16Go RAM, 512Go SSD","images":["https://www.cdiscount.com/pdt2/8/6/5/1/300x300/aaaph06865/rw/acemagic-pc-portables-gaming.jpg","https://www.cdiscount.com/pdt2/8/6/5/1/140x140/aaaph06865/rw/acemagic-pc-portables-gaming.jpg"],"is_new":true,"rating":4,"seller":{"id":405259,"name":"BOOMING"},"is_cdav":true,"brand_id":221204,"currency":"EUR","offer_id":4258700481,"condition":"Neuf","category_id":1000004592,"is_sponsored":false,"min_quantity":1,"category_path":"0K/0K07/0K0701/0K070101","department_id":1070992,"free_shipping":true,"reviews_count":2,"original_price":499.9,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0},{"id":"aaaaq86960","url":"https://www.cdiscount.com/informatique/ordinateurs-pc-portables/ordinateur-portable-laptop-hp/f-1070992-aaaaq86960.html","image":"https://www.cdiscount.com/pdt2/9/6/0/1/300x300/aaaaq86960/rw/ordinateur-portable-laptop-hp.jpg","price":759.99,"title":"ORDINATEUR PORTABLE LAPTOP HP 15-EH3001SF RAM 16 Go SSD 512 Go - ARGENT NATUREL","images":["https://www.cdiscount.com/pdt2/9/6/0/1/300x300/aaaaq86960/rw/ordinateur-portable-laptop-hp.jpg","https://www.cdiscount.com/pdt2/9/6/0/1/140x140/aaaaq86960/rw/ordinateur-portable-laptop-hp.jpg"],"is_new":true,"seller":{"id":80174,"name":"MegaMarket"},"is_cdav":true,"brand_id":766,"currency":"EUR","offer_id":4213440156,"condition":"Neuf","category_id":1000004592,"is_sponsored":false,"min_quantity":1,"category_path":"0K/0K07/0K0701/0K070101","department_id":1070992,"free_shipping":true,"original_price":999.99,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0}],"pagination":{"next":2,"current":1,"other_pages":[2],"total_pages":2,"has_next_page":true}}},"Search for Microsoft Office":{"value":{"results":[{"id":"aabld38423","tag":"sw","url":"https://www.cdiscount.com/informatique/logiciels-informatique/office-365-----version-2025--/f-10707-aabld38423.html?idOffre=4303503538","image":"https://www.cdiscount.com/pdt2/4/2/3/1/300x300/aabld38423/rw/office-365-----version-2025--.jpg","price":4.9,"title":"MICROSOFT 365 - PACK OFFICE Version 2026","images":["https://www.cdiscount.com/pdt2/4/2/3/1/300x300/aabld38423/rw/office-365-----version-2025--.jpg","https://www.cdiscount.com/pdt2/4/2/3/1/140x140/aabld38423/rw/office-365-----version-2025--.jpg"],"is_new":true,"rating":2.3,"seller":{"id":370417,"name":"Logiciel Direct"},"is_cdav":true,"brand_id":3980,"currency":"EUR","offer_id":4303503538,"condition":"Neuf","category_id":1000004213,"is_sponsored":true,"min_quantity":1,"category_path":"0K/0K08/0K0806/0K080601","department_id":10707,"free_shipping":true,"reviews_count":3,"original_price":null,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0},{"id":"aacua55338","url":"https://www.cdiscount.com/informatique/logiciels-informatique/windows-11-famille--pack/f-10707-aacua55338.html","image":"https://www.cdiscount.com/pdt2/3/3/8/1/300x300/aacua55338/rw/windows-11-famille--pack.jpg","price":4.9,"title":"WINDOWS 11 FAMILLE + PACK OFFICE Version 2026","images":["https://www.cdiscount.com/pdt2/3/3/8/1/300x300/aacua55338/rw/windows-11-famille--pack.jpg","https://www.cdiscount.com/pdt2/3/3/8/1/140x140/aacua55338/rw/windows-11-famille--pack.jpg"],"is_new":true,"seller":{"id":132273,"name":"Fast Software"},"is_cdav":true,"brand_id":3980,"currency":"EUR","offer_id":4310321497,"condition":"Neuf","category_id":1000004213,"is_sponsored":false,"min_quantity":1,"category_path":"0K/0K08/0K0806/0K080601","department_id":10707,"free_shipping":true,"original_price":null,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0}],"pagination":{"next":3,"current":2,"other_pages":[1,3,4,5,6],"total_pages":6,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Cdiscount Search","description":"Extract product listings from Cdiscount search results or category pages for market intelligence and competitive analysis.\n\n**Credit cost:** 2 credits per call","operationId":"post-cdiscount-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Cdiscount search results page URL. Use any URL from a search or category browse on cdiscount.com.\n\n**Example:**\n\n    https://www.cdiscount.com/search/10/laptop.html\n\n**Notes:**\n- You can use keyword search URLs (e.g. `/search/10/{keyword}.html`) or category browse URLs (e.g. `/informatique/ordinateurs-pc-portables/...`)\n- Pagination and filter parameters present in the URL are respected.","schema":{"type":"string","description":"Cdiscount search results page URL. Use any URL from a search or category browse on cdiscount.com.\n\n**Example:**\n\n    https://www.cdiscount.com/search/10/laptop.html\n\n**Notes:**\n- You can use keyword search URLs (e.g. `/search/10/{keyword}.html`) or category browse URLs (e.g. `/informatique/ordinateurs-pc-portables/...`)\n- Pagination and filter parameters present in the URL are respected."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"is_new":{"type":"boolean"},"rating":{"type":"integer"},"seller":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"is_cdav":{"type":"boolean"},"brand_id":{"type":"integer"},"currency":{"type":"string"},"offer_id":{"type":"integer"},"condition":{"type":"string"},"category_id":{"type":"integer"},"is_sponsored":{"type":"boolean"},"min_quantity":{"type":"integer"},"category_path":{"type":"string"},"department_id":{"type":"integer"},"free_shipping":{"type":"boolean"},"reviews_count":{"type":"integer"},"original_price":{"type":"number"},"new_offer_quantity":{"type":"integer"},"new_offer_min_price":{"type":"integer"},"used_offer_quantity":{"type":"integer"},"used_offer_min_price":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for laptops":{"value":{"results":[{"id":"aaaph06865","url":"https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html","image":"https://www.cdiscount.com/pdt2/8/6/5/1/300x300/aaaph06865/rw/acemagic-pc-portables-gaming.jpg","price":429.99,"title":"ACEMAGIC PC Portables Gaming - 15.6\" FHD, AMD Ryzen 7 5700U, 16Go RAM, 512Go SSD","images":["https://www.cdiscount.com/pdt2/8/6/5/1/300x300/aaaph06865/rw/acemagic-pc-portables-gaming.jpg","https://www.cdiscount.com/pdt2/8/6/5/1/140x140/aaaph06865/rw/acemagic-pc-portables-gaming.jpg"],"is_new":true,"rating":4,"seller":{"id":405259,"name":"BOOMING"},"is_cdav":true,"brand_id":221204,"currency":"EUR","offer_id":4258700481,"condition":"Neuf","category_id":1000004592,"is_sponsored":false,"min_quantity":1,"category_path":"0K/0K07/0K0701/0K070101","department_id":1070992,"free_shipping":true,"reviews_count":2,"original_price":499.9,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0},{"id":"aaaaq86960","url":"https://www.cdiscount.com/informatique/ordinateurs-pc-portables/ordinateur-portable-laptop-hp/f-1070992-aaaaq86960.html","image":"https://www.cdiscount.com/pdt2/9/6/0/1/300x300/aaaaq86960/rw/ordinateur-portable-laptop-hp.jpg","price":759.99,"title":"ORDINATEUR PORTABLE LAPTOP HP 15-EH3001SF RAM 16 Go SSD 512 Go - ARGENT NATUREL","images":["https://www.cdiscount.com/pdt2/9/6/0/1/300x300/aaaaq86960/rw/ordinateur-portable-laptop-hp.jpg","https://www.cdiscount.com/pdt2/9/6/0/1/140x140/aaaaq86960/rw/ordinateur-portable-laptop-hp.jpg"],"is_new":true,"seller":{"id":80174,"name":"MegaMarket"},"is_cdav":true,"brand_id":766,"currency":"EUR","offer_id":4213440156,"condition":"Neuf","category_id":1000004592,"is_sponsored":false,"min_quantity":1,"category_path":"0K/0K07/0K0701/0K070101","department_id":1070992,"free_shipping":true,"original_price":999.99,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0}],"pagination":{"next":2,"current":1,"other_pages":[2],"total_pages":2,"has_next_page":true}}},"Search for Microsoft Office":{"value":{"results":[{"id":"aabld38423","tag":"sw","url":"https://www.cdiscount.com/informatique/logiciels-informatique/office-365-----version-2025--/f-10707-aabld38423.html?idOffre=4303503538","image":"https://www.cdiscount.com/pdt2/4/2/3/1/300x300/aabld38423/rw/office-365-----version-2025--.jpg","price":4.9,"title":"MICROSOFT 365 - PACK OFFICE Version 2026","images":["https://www.cdiscount.com/pdt2/4/2/3/1/300x300/aabld38423/rw/office-365-----version-2025--.jpg","https://www.cdiscount.com/pdt2/4/2/3/1/140x140/aabld38423/rw/office-365-----version-2025--.jpg"],"is_new":true,"rating":2.3,"seller":{"id":370417,"name":"Logiciel Direct"},"is_cdav":true,"brand_id":3980,"currency":"EUR","offer_id":4303503538,"condition":"Neuf","category_id":1000004213,"is_sponsored":true,"min_quantity":1,"category_path":"0K/0K08/0K0806/0K080601","department_id":10707,"free_shipping":true,"reviews_count":3,"original_price":null,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0},{"id":"aacua55338","url":"https://www.cdiscount.com/informatique/logiciels-informatique/windows-11-famille--pack/f-10707-aacua55338.html","image":"https://www.cdiscount.com/pdt2/3/3/8/1/300x300/aacua55338/rw/windows-11-famille--pack.jpg","price":4.9,"title":"WINDOWS 11 FAMILLE + PACK OFFICE Version 2026","images":["https://www.cdiscount.com/pdt2/3/3/8/1/300x300/aacua55338/rw/windows-11-famille--pack.jpg","https://www.cdiscount.com/pdt2/3/3/8/1/140x140/aacua55338/rw/windows-11-famille--pack.jpg"],"is_new":true,"seller":{"id":132273,"name":"Fast Software"},"is_cdav":true,"brand_id":3980,"currency":"EUR","offer_id":4310321497,"condition":"Neuf","category_id":1000004213,"is_sponsored":false,"min_quantity":1,"category_path":"0K/0K08/0K0806/0K080601","department_id":10707,"free_shipping":true,"original_price":null,"new_offer_quantity":0,"new_offer_min_price":0,"used_offer_quantity":0,"used_offer_min_price":0}],"pagination":{"next":3,"current":2,"other_pages":[1,3,4,5,6],"total_pages":6,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/leroymerlin/search":{"get":{"summary":"Leroy Merlin Search","description":"Live Leroy Merlin search across France and Romania: title, URL, price, currency, brand, seller, rating and pagination.\n\n**Credit cost:** 3 credits per call","operationId":"get-leroymerlin-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword, SKU/EAN, or full Leroy Merlin search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nbormasina\n```\n\n```\nhttps://www.leroymerlin.ro/search?q=drill\n```\n\nWhen `query` is a full URL, `region` is detected from the domain and can be omitted.","schema":{"type":"string","description":"Search keyword, SKU/EAN, or full Leroy Merlin search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nbormasina\n```\n\n```\nhttps://www.leroymerlin.ro/search?q=drill\n```\n\nWhen `query` is a full URL, `region` is detected from the domain and can be omitted."}},{"name":"region","in":"query","required":false,"description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```","schema":{"type":"string","description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```"}},{"name":"page","in":"query","required":false,"description":"1-based page number for pagination. Defaults to `1` when omitted. Use the `pagination.total_pages` returned by a previous call to iterate.\n\n**Example:** `2`","schema":{"type":"number","description":"1-based page number for pagination. Defaults to `1` when omitted. Use the `pagination.total_pages` returned by a previous call to iterate.\n\n**Example:** `2`"}},{"name":"store_id","in":"query","required":false,"description":"Optional store id for local prices and availability. Must exist for the active region (`FR` stores with `region=fr`, `RO` stores with `region=ro`). Returns `400` when unknown.\n\n**Example:** `110`","schema":{"type":"string","description":"Optional store id for local prices and availability. Must exist for the active region (`FR` stores with `region=fr`, `RO` stores with `region=ro`). Returns `400` when unknown.\n\n**Example:** `110`"}},{"name":"return_page_source","in":"query","required":false,"description":"When set to `true`, returns the raw HTML of the page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`","schema":{"type":"boolean","default":"false","description":"When set to `true`, returns the raw HTML of the page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"region":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"seller":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"currency":{"type":"string"},"position":{"type":"integer"},"is_sponsored":{"type":"boolean"},"price_excl_tax":{"type":"number"},"total_offer_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"has_next":{"type":"boolean"},"total_pages":{"type":"integer"},"current_page":{"type":"integer"},"has_previous":{"type":"boolean"}}}}},"examples":{"Search 'colle pvc' (page 1)":{"value":{"total":21,"region":"fr","results":[{"sku":"67806074","url":"https://www.leroymerlin.fr/produits/colle-assemblage-gel-604202-axton-250ml-250-g-transparent-67806074.html","brand":"AXTON","price":6.99,"title":"Colle d'assemblage gel 604202 AXTON, 250ml, 250 g transparent","rating":4.5,"seller":{"name":"Leroy Merlin","type":"1P"},"currency":"EUR","position":1,"is_sponsored":false,"price_excl_tax":5.83,"total_offer_count":1},{"sku":"67805850","url":"https://www.leroymerlin.fr/produits/colle-en-tube-pvc-axton-60-ml-67805850.html","brand":"AXTON","price":3.59,"title":"Colle en tube PVC AXTON, 60 ml","rating":4.4,"seller":{"name":"Leroy Merlin","type":"1P"},"currency":"EUR","position":2,"is_sponsored":false,"marketing_tag":"RESPONSIBLE","price_excl_tax":2.99,"total_offer_count":1},{"sku":"82345671","url":"https://www.leroymerlin.fr/produits/colle-neoprene-multi-usages-sader-250-ml-82345671.html","brand":"SADER","price":8.49,"title":"Colle néoprène multi-usages SADER, 250 ml","rating":4.3,"seller":{"name":"Bricomarket","type":"3P"},"currency":"EUR","discount":3.5,"position":9,"is_sponsored":false,"discount_rate":29,"initial_price":11.99,"price_excl_tax":7.08,"total_offer_count":4}],"pagination":{"has_next":true,"total_pages":41,"current_page":1,"has_previous":false}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Leroy Merlin Search","description":"Live Leroy Merlin search across France and Romania: title, URL, price, currency, brand, seller, rating and pagination.\n\n**Credit cost:** 3 credits per call","operationId":"post-leroymerlin-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword, SKU/EAN, or full Leroy Merlin search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nbormasina\n```\n\n```\nhttps://www.leroymerlin.ro/search?q=drill\n```\n\nWhen `query` is a full URL, `region` is detected from the domain and can be omitted.","schema":{"type":"string","description":"Search keyword, SKU/EAN, or full Leroy Merlin search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nbormasina\n```\n\n```\nhttps://www.leroymerlin.ro/search?q=drill\n```\n\nWhen `query` is a full URL, `region` is detected from the domain and can be omitted."}},{"name":"region","in":"query","required":false,"description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```","schema":{"type":"string","description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```"}},{"name":"page","in":"query","required":false,"description":"1-based page number for pagination. Defaults to `1` when omitted. Use the `pagination.total_pages` returned by a previous call to iterate.\n\n**Example:** `2`","schema":{"type":"number","description":"1-based page number for pagination. Defaults to `1` when omitted. Use the `pagination.total_pages` returned by a previous call to iterate.\n\n**Example:** `2`"}},{"name":"store_id","in":"query","required":false,"description":"Optional store id for local prices and availability. Must exist for the active region (`FR` stores with `region=fr`, `RO` stores with `region=ro`). Returns `400` when unknown.\n\n**Example:** `110`","schema":{"type":"string","description":"Optional store id for local prices and availability. Must exist for the active region (`FR` stores with `region=fr`, `RO` stores with `region=ro`). Returns `400` when unknown.\n\n**Example:** `110`"}},{"name":"return_page_source","in":"query","required":false,"description":"When set to `true`, returns the raw HTML of the page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`","schema":{"type":"boolean","default":"false","description":"When set to `true`, returns the raw HTML of the page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"region":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"seller":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"currency":{"type":"string"},"position":{"type":"integer"},"is_sponsored":{"type":"boolean"},"price_excl_tax":{"type":"number"},"total_offer_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"has_next":{"type":"boolean"},"total_pages":{"type":"integer"},"current_page":{"type":"integer"},"has_previous":{"type":"boolean"}}}}},"examples":{"Search 'colle pvc' (page 1)":{"value":{"total":21,"region":"fr","results":[{"sku":"67806074","url":"https://www.leroymerlin.fr/produits/colle-assemblage-gel-604202-axton-250ml-250-g-transparent-67806074.html","brand":"AXTON","price":6.99,"title":"Colle d'assemblage gel 604202 AXTON, 250ml, 250 g transparent","rating":4.5,"seller":{"name":"Leroy Merlin","type":"1P"},"currency":"EUR","position":1,"is_sponsored":false,"price_excl_tax":5.83,"total_offer_count":1},{"sku":"67805850","url":"https://www.leroymerlin.fr/produits/colle-en-tube-pvc-axton-60-ml-67805850.html","brand":"AXTON","price":3.59,"title":"Colle en tube PVC AXTON, 60 ml","rating":4.4,"seller":{"name":"Leroy Merlin","type":"1P"},"currency":"EUR","position":2,"is_sponsored":false,"marketing_tag":"RESPONSIBLE","price_excl_tax":2.99,"total_offer_count":1},{"sku":"82345671","url":"https://www.leroymerlin.fr/produits/colle-neoprene-multi-usages-sader-250-ml-82345671.html","brand":"SADER","price":8.49,"title":"Colle néoprène multi-usages SADER, 250 ml","rating":4.3,"seller":{"name":"Bricomarket","type":"3P"},"currency":"EUR","discount":3.5,"position":9,"is_sponsored":false,"discount_rate":29,"initial_price":11.99,"price_excl_tax":7.08,"total_offer_count":4}],"pagination":{"has_next":true,"total_pages":41,"current_page":1,"has_previous":false}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/leroymerlin/product":{"get":{"summary":"Leroy Merlin Product","description":"Live Leroy Merlin product detail for France and Romania from a URL or identifier: offers, currency, images, features and store context.\n\n**Credit cost:** 3 credits per call","operationId":"get-leroymerlin-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Leroy Merlin product URL, or an identifier (SKU / EAN / text).\n\n**Examples:**\n\n```\nhttps://www.leroymerlin.fr/produits/bobine-soudure-63378273.html\n```\n\n```\nhttps://www.leroymerlin.ro/produits/scara-aluminiu-12345678.html\n```\n\n```\n63378273\n```\n\nWhen `query` is not a URL, Piloterr searches and follows the redirect to the product page when the match is clear enough. When `query` is a full URL, `region` is detected from the domain.","schema":{"type":"string","description":"Full Leroy Merlin product URL, or an identifier (SKU / EAN / text).\n\n**Examples:**\n\n```\nhttps://www.leroymerlin.fr/produits/bobine-soudure-63378273.html\n```\n\n```\nhttps://www.leroymerlin.ro/produits/scara-aluminiu-12345678.html\n```\n\n```\n63378273\n```\n\nWhen `query` is not a URL, Piloterr searches and follows the redirect to the product page when the match is clear enough. When `query` is a full URL, `region` is detected from the domain."}},{"name":"region","in":"query","required":false,"description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```","schema":{"type":"string","description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```"}},{"name":"store_id","in":"query","required":false,"description":"Optional store id for local offer context (prices, stock, deliveries). Must exist for the active region. Returns `400` when unknown.\n\nThe response `store` block is present only when this parameter is set.\n\n**Example:** `110`","schema":{"type":"string","description":"Optional store id for local offer context (prices, stock, deliveries). Must exist for the active region. Returns `400` when unknown.\n\nThe response `store` block is present only when this parameter is set.\n\n**Example:** `110`"}},{"name":"return_page_source","in":"query","required":false,"description":"When set to `true`, returns the raw HTML of the product page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`","schema":{"type":"boolean","default":"false","description":"When set to `true`, returns the raw HTML of the product page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"store":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"features":{"type":"object","properties":{"Forme":{"type":"string"},"Aspect":{"type":"string"},"Couleur":{"type":"string"},"Largeur (en cm)":{"type":"string"},"Longueur (en cm)":{"type":"string"},"Epaisseur (en mm)":{"type":"string"},"Pays de fabrication":{"type":"string"},"Destination du carrelage":{"type":"string"},"Contenance de la boîte (en m²)":{"type":"string"},"Nombre de carreaux dans la boîte":{"type":"string"}}},"best_offer":{"type":"object","properties":{"price":{"type":"number"},"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"currency":{"type":"string"},"available":{"type":"boolean"},"deliveries":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string"},"type":{"type":"string"},"price":{"type":"number"},"stock":{"type":"integer"},"stock_status":{"type":"string"}}}},"offer_type":{"type":"string"},"price_excl_tax":{"type":"number"}}},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}}}},"description":{"type":"string"},"marketing_tag":{"type":"string"},"reviews_count":{"type":"integer"},"total_offer_count":{"type":"integer"},"sellers_composition":{"type":"string"}}},"examples":{"Product by URL (Zellige tile, store=110)":{"value":{"sku":"82311569","url":"https://www.leroymerlin.fr/produits/carrelage-mur-interieur-effet-zellige-blanc-casse-zellie-l-10-x-l-10-cm-x-ep-10-82311569.html","store":{"id":"110","slug":"balma-toulouse"},"title":"Carrelage mur intérieur effet zellige blanc cassé Zellie l.10 x L.10 cm x Ep.10","images":["https://media.adeo.com/media/1102654/media.jpg","https://media.adeo.com/media/1034533/media.jpg","https://media.adeo.com/media/1742409/media.jpg","https://media.adeo.com/media/3210749/media.jpg"],"rating":4.37,"region":"fr","features":{"Forme":"Carré","Aspect":"Brillant","Couleur":"Blanc cassé","Largeur (en cm)":"10","Longueur (en cm)":"10","Epaisseur (en mm)":"10","Pays de fabrication":"Italie","Destination du carrelage":"Mur intérieur","Contenance de la boîte (en m²)":"0.54","Nombre de carreaux dans la boîte":"54"},"best_offer":{"price":21.54,"seller":{"id":"12136181","name":"Leroy Merlin","type":"1P"},"currency":"EUR","available":true,"deliveries":[{"time":"3 OPENING_DAY","type":"relayDelivery","price":1.9,"stock":2823,"stock_status":"ONSITE"},{"time":"5 OPENING_DAY","type":"homeDelivery","price":4.9,"stock":2823,"stock_status":"ONSITE"}],"offer_type":"NEW","price_excl_tax":17.95},"breadcrumb":[{"url":"https://www.leroymerlin.fr/","name":"Accueil","position":1},{"url":"https://www.leroymerlin.fr/produits/","name":"Produits","position":2},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/","name":"Revêtement sol, mur et peinture","position":3},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/carrelage/","name":"Carrelage sol et mur","position":4},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/carrelage/carrelage-mural/","name":"Carrelage mural et faïence","position":5},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/carrelage/carrelage-mural/zellige/","name":"Zellige","position":6},{"url":"https://www.leroymerlin.fr/produits/carrelage-mur-interieur-effet-zellige-blanc-casse-zellie-l-10-x-l-10-cm-x-ep-10-82311569.html","name":"Carrelage mur intérieur effet zellige blanc cassé Zellie l.10 x L.10 cm x Ep.10","position":7}],"description":"Pour avoir un résultat aussi authentique que les zelliges du Maroc, nous vous conseillons de les poser sans croisillon. C'est l'effet irrégulier du produit, tant dans l'aspect des carreaux que dans la pose, qui apporte le charme esthétique de cette série. Ce produit vous permet de bénéficier de la simplicité du carrelage : il est facile d'entretien car non poreux.","marketing_tag":"RESPONSIBLE_SECONDARY","reviews_count":282,"total_offer_count":1,"sellers_composition":"1P_only"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Leroy Merlin Product","description":"Live Leroy Merlin product detail for France and Romania from a URL or identifier: offers, currency, images, features and store context.\n\n**Credit cost:** 3 credits per call","operationId":"post-leroymerlin-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Leroy Merlin product URL, or an identifier (SKU / EAN / text).\n\n**Examples:**\n\n```\nhttps://www.leroymerlin.fr/produits/bobine-soudure-63378273.html\n```\n\n```\nhttps://www.leroymerlin.ro/produits/scara-aluminiu-12345678.html\n```\n\n```\n63378273\n```\n\nWhen `query` is not a URL, Piloterr searches and follows the redirect to the product page when the match is clear enough. When `query` is a full URL, `region` is detected from the domain.","schema":{"type":"string","description":"Full Leroy Merlin product URL, or an identifier (SKU / EAN / text).\n\n**Examples:**\n\n```\nhttps://www.leroymerlin.fr/produits/bobine-soudure-63378273.html\n```\n\n```\nhttps://www.leroymerlin.ro/produits/scara-aluminiu-12345678.html\n```\n\n```\n63378273\n```\n\nWhen `query` is not a URL, Piloterr searches and follows the redirect to the product page when the match is clear enough. When `query` is a full URL, `region` is detected from the domain."}},{"name":"region","in":"query","required":false,"description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```","schema":{"type":"string","description":"Leroy Merlin country when `query` is a keyword or identifier (default: `fr`). Ignored when `query` is a full Leroy Merlin URL (country is detected from the domain).\n\n**Supported regions:**\n- `fr` (aliases: `france`, `fr-fr`) → www.leroymerlin.fr, currency `EUR`\n- `ro` (aliases: `romania`, `roumanie`, `ro-ro`) → www.leroymerlin.ro, currency `RON`\n\n**Examples:**\n\n```\nfr\n```\n\n```\nro\n```\n\n```\nromania\n```"}},{"name":"store_id","in":"query","required":false,"description":"Optional store id for local offer context (prices, stock, deliveries). Must exist for the active region. Returns `400` when unknown.\n\nThe response `store` block is present only when this parameter is set.\n\n**Example:** `110`","schema":{"type":"string","description":"Optional store id for local offer context (prices, stock, deliveries). Must exist for the active region. Returns `400` when unknown.\n\nThe response `store` block is present only when this parameter is set.\n\n**Example:** `110`"}},{"name":"return_page_source","in":"query","required":false,"description":"When set to `true`, returns the raw HTML of the product page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`","schema":{"type":"boolean","default":"false","description":"When set to `true`, returns the raw HTML of the product page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is `{\"return\": \"<html>...\"}`. Defaults to `false`.\n\n**Example:** `true`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"store":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"features":{"type":"object","properties":{"Forme":{"type":"string"},"Aspect":{"type":"string"},"Couleur":{"type":"string"},"Largeur (en cm)":{"type":"string"},"Longueur (en cm)":{"type":"string"},"Epaisseur (en mm)":{"type":"string"},"Pays de fabrication":{"type":"string"},"Destination du carrelage":{"type":"string"},"Contenance de la boîte (en m²)":{"type":"string"},"Nombre de carreaux dans la boîte":{"type":"string"}}},"best_offer":{"type":"object","properties":{"price":{"type":"number"},"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"currency":{"type":"string"},"available":{"type":"boolean"},"deliveries":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string"},"type":{"type":"string"},"price":{"type":"number"},"stock":{"type":"integer"},"stock_status":{"type":"string"}}}},"offer_type":{"type":"string"},"price_excl_tax":{"type":"number"}}},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}}}},"description":{"type":"string"},"marketing_tag":{"type":"string"},"reviews_count":{"type":"integer"},"total_offer_count":{"type":"integer"},"sellers_composition":{"type":"string"}}},"examples":{"Product by URL (Zellige tile, store=110)":{"value":{"sku":"82311569","url":"https://www.leroymerlin.fr/produits/carrelage-mur-interieur-effet-zellige-blanc-casse-zellie-l-10-x-l-10-cm-x-ep-10-82311569.html","store":{"id":"110","slug":"balma-toulouse"},"title":"Carrelage mur intérieur effet zellige blanc cassé Zellie l.10 x L.10 cm x Ep.10","images":["https://media.adeo.com/media/1102654/media.jpg","https://media.adeo.com/media/1034533/media.jpg","https://media.adeo.com/media/1742409/media.jpg","https://media.adeo.com/media/3210749/media.jpg"],"rating":4.37,"region":"fr","features":{"Forme":"Carré","Aspect":"Brillant","Couleur":"Blanc cassé","Largeur (en cm)":"10","Longueur (en cm)":"10","Epaisseur (en mm)":"10","Pays de fabrication":"Italie","Destination du carrelage":"Mur intérieur","Contenance de la boîte (en m²)":"0.54","Nombre de carreaux dans la boîte":"54"},"best_offer":{"price":21.54,"seller":{"id":"12136181","name":"Leroy Merlin","type":"1P"},"currency":"EUR","available":true,"deliveries":[{"time":"3 OPENING_DAY","type":"relayDelivery","price":1.9,"stock":2823,"stock_status":"ONSITE"},{"time":"5 OPENING_DAY","type":"homeDelivery","price":4.9,"stock":2823,"stock_status":"ONSITE"}],"offer_type":"NEW","price_excl_tax":17.95},"breadcrumb":[{"url":"https://www.leroymerlin.fr/","name":"Accueil","position":1},{"url":"https://www.leroymerlin.fr/produits/","name":"Produits","position":2},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/","name":"Revêtement sol, mur et peinture","position":3},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/carrelage/","name":"Carrelage sol et mur","position":4},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/carrelage/carrelage-mural/","name":"Carrelage mural et faïence","position":5},{"url":"https://www.leroymerlin.fr/produits/revetement-sol-et-mur/carrelage/carrelage-mural/zellige/","name":"Zellige","position":6},{"url":"https://www.leroymerlin.fr/produits/carrelage-mur-interieur-effet-zellige-blanc-casse-zellie-l-10-x-l-10-cm-x-ep-10-82311569.html","name":"Carrelage mur intérieur effet zellige blanc cassé Zellie l.10 x L.10 cm x Ep.10","position":7}],"description":"Pour avoir un résultat aussi authentique que les zelliges du Maroc, nous vous conseillons de les poser sans croisillon. C'est l'effet irrégulier du produit, tant dans l'aspect des carreaux que dans la pose, qui apporte le charme esthétique de cette série. Ce produit vous permet de bénéficier de la simplicité du carrelage : il est facile d'entretien car non poreux.","marketing_tag":"RESPONSIBLE_SECONDARY","reviews_count":282,"total_offer_count":1,"sellers_composition":"1P_only"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/mrbricolage/suggest":{"get":{"summary":"Mr.Bricolage Suggest","description":"Live Mr.Bricolage product suggestions for a search keyword or EAN, including title, URL, image, price and currency.\n\n**Credit cost:** 3 credits per call","operationId":"get-mrbricolage-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or EAN used to query the Mr.Bricolage live suggest endpoint. Accepts product names, partial titles or numeric identifiers such as EAN barcodes.\n\n**Examples:**\n\n```\nmarteau\n```\n\n```\n3283988157233\n```","schema":{"type":"string","description":"Search keyword or EAN used to query the Mr.Bricolage live suggest endpoint. Accepts product names, partial titles or numeric identifiers such as EAN barcodes.\n\n**Examples:**\n\n```\nmarteau\n```\n\n```\n3283988157233\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"}}}}}},"examples":{"Suggest 'marteau'":{"value":{"total":5,"results":[{"url":"https://www.mr-bricolage.fr/marteau-perforateur-rh800-800-w.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/6/3603745041702_b1_ad04.jpg","price":92.9,"title":"Marteau perforateur rh800 800 w","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/coffret-marteau-burineur-4-burins-pour-compresseur-michelin.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/8/0/8020119077245_b1_b661.jpg","price":37.9,"title":"Coffret marteau burineur 4 burins pour compresseur - MICHELIN","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/marteau-burineur-1500w-5-5-joules-v2-inventiv.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/6/3603745041764_b1_1d3c.jpg","price":92.9,"title":"Marteau burineur 1500W 5.5 joules V2 - INVENTIV","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/combine-marteau-brosse.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/1/3154020044166_a1_da7a.jpg","price":5.3,"title":"Combiné marteau brosse","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/marteau-a-piquer.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/1/3154020044159_b1_9145.jpg","price":9.1,"title":"Marteau à piquer","currency":"EUR"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Mr.Bricolage Suggest","description":"Live Mr.Bricolage product suggestions for a search keyword or EAN, including title, URL, image, price and currency.\n\n**Credit cost:** 3 credits per call","operationId":"post-mrbricolage-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or EAN used to query the Mr.Bricolage live suggest endpoint. Accepts product names, partial titles or numeric identifiers such as EAN barcodes.\n\n**Examples:**\n\n```\nmarteau\n```\n\n```\n3283988157233\n```","schema":{"type":"string","description":"Search keyword or EAN used to query the Mr.Bricolage live suggest endpoint. Accepts product names, partial titles or numeric identifiers such as EAN barcodes.\n\n**Examples:**\n\n```\nmarteau\n```\n\n```\n3283988157233\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"}}}}}},"examples":{"Suggest 'marteau'":{"value":{"total":5,"results":[{"url":"https://www.mr-bricolage.fr/marteau-perforateur-rh800-800-w.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/6/3603745041702_b1_ad04.jpg","price":92.9,"title":"Marteau perforateur rh800 800 w","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/coffret-marteau-burineur-4-burins-pour-compresseur-michelin.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/8/0/8020119077245_b1_b661.jpg","price":37.9,"title":"Coffret marteau burineur 4 burins pour compresseur - MICHELIN","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/marteau-burineur-1500w-5-5-joules-v2-inventiv.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/6/3603745041764_b1_1d3c.jpg","price":92.9,"title":"Marteau burineur 1500W 5.5 joules V2 - INVENTIV","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/combine-marteau-brosse.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/1/3154020044166_a1_da7a.jpg","price":5.3,"title":"Combiné marteau brosse","currency":"EUR"},{"url":"https://www.mr-bricolage.fr/marteau-a-piquer.html","type":"product","image":"https://media.mr-bricolage.fr/media/catalog/product/cache/3a46d67a25d94f618cdcf20d0c3383a5/3/1/3154020044159_b1_9145.jpg","price":9.1,"title":"Marteau à piquer","currency":"EUR"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fotocasa/search":{"get":{"summary":"Fotocasa Property Search","description":"Search Fotocasa listings by city or search URL. Returns prices, rooms, area, coordinates, and agency data via browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-fotocasa-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City name or full Fotocasa search URL.\n\n**Examples:**\n\n```\nmadrid\n```\n\n```\nbarcelona\n```\n\n```\nhttps://www.fotocasa.es/es/comprar/viviendas/madrid-capital/todas-las-zonas/l\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/viviendas/barcelona-capital/todas-las-zonas/l/2\n```","schema":{"type":"string","description":"City name or full Fotocasa search URL.\n\n**Examples:**\n\n```\nmadrid\n```\n\n```\nbarcelona\n```\n\n```\nhttps://www.fotocasa.es/es/comprar/viviendas/madrid-capital/todas-las-zonas/l\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/viviendas/barcelona-capital/todas-las-zonas/l/2\n```"}},{"name":"operation","in":"query","required":false,"description":"Used when `query` is a city name (ignored for full URLs).\n\n- `buy` / `comprar`: for sale (default)\n- `rent` / `alquiler`: for rent","schema":{"type":"string","default":"buy","description":"Used when `query` is a city name (ignored for full URLs).\n\n- `buy` / `comprar`: for sale (default)\n- `rent` / `alquiler`: for rent"}},{"name":"page","in":"query","required":false,"description":"Page number (1-based). Default: `1`. Page 2 maps to `/l/2`.","schema":{"type":"number","default":"1","description":"Page number (1-based). Default: `1`. Page 2 maps to `/l/2`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"location":{"type":"string"},"operation":{"type":"string"},"total_pages":{"type":"integer"},"current_page":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"listings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"floor":{"nullable":true},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"area_m2":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"operation":{"type":"string"},"price_drop":{"nullable":true},"agency_name":{"type":"string"},"neighborhood":{"type":"string"},"price_per_m2":{"type":"integer"},"published_at":{"type":"string"},"property_type":{"type":"string"},"thumbnail_url":{"type":"string"},"property_subtype":{"type":"string"}}}}}},"examples":{"Buy homes in Madrid":{"value":{"meta":{"location":"Madrid","operation":"sale","total_pages":375,"current_page":1,"has_next_page":true,"total_results":11222},"listings":[{"id":"189717534","url":"https://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/189717534/d","city":"Madrid","floor":null,"price":990000,"rooms":3,"title":"Barrio de Salamanca","address":"Barrio de Salamanca","area_m2":99,"currency":"EUR","latitude":40.43689191820105,"bathrooms":2,"longitude":-3.677214968590556,"operation":"sale","price_drop":null,"agency_name":"Dils Lucas Fox","neighborhood":"Barrio de Salamanca","price_per_m2":10000,"published_at":"2026-05-19T04:07:34.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/18ce6fc9-f80b-415f-b538-a150d35c7073?rule=original","property_subtype":"apartment"},{"id":"189625641","url":"https://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-trastero-ascensor-amueblado/189625641/d","city":"Madrid","floor":12,"price":1620000,"rooms":3,"title":"Alcalá, Barrio de Salamanca","address":"Alcalá, Barrio de Salamanca","area_m2":130,"currency":"EUR","latitude":40.42785333292837,"bathrooms":2,"longitude":-3.672679393562349,"operation":"sale","price_drop":null,"agency_name":"ESPÍGUL IMMOBILIARIA","neighborhood":"Barrio de Salamanca","price_per_m2":12462,"published_at":"2026-05-08T15:08:35.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/f8a5ccd4-ccf2-4012-9584-ba97c261b3ff?rule=original","property_subtype":"penthouse"}]}},"Rent homes in Barcelona":{"value":{"meta":{"location":"Barcelona","operation":"rent","total_pages":111,"current_page":1,"has_next_page":true,"total_results":3319},"listings":[{"id":"190623509","url":"https://www.fotocasa.es/es/alquiler/vivienda/barcelona-capital/aire-acondicionado-calefaccion-amueblado-television-se-aceptan-mascotas-internet/190623509/d","city":"Barcelona","floor":null,"price":1486,"rooms":2,"title":"N/A, Eixample","address":"N/A, Eixample","area_m2":69,"currency":"EUR","latitude":41.38040172808665,"bathrooms":null,"longitude":2.15092820467445,"operation":"rent","price_drop":null,"agency_name":"HOUSINGANYWHERE","neighborhood":"Eixample","price_per_m2":22,"published_at":"2026-09-01T01:03:28.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/9f7f7ed2-621f-43ce-8ce8-6c5ef9c07d4d?rule=original","property_subtype":"apartment"},{"id":"190623503","url":"https://www.fotocasa.es/es/alquiler/vivienda/barcelona-capital/aire-acondicionado-calefaccion-amueblado-television/190623503/d","city":"Barcelona","floor":null,"price":1100,"rooms":null,"title":"N/A, Sants - Montjuïc","address":"N/A, Sants - Montjuïc","area_m2":40,"currency":"EUR","latitude":41.37519937568134,"bathrooms":null,"longitude":2.133587230323095,"operation":"rent","price_drop":null,"agency_name":"HOUSINGANYWHERE","neighborhood":"Sants - Montjuïc","price_per_m2":28,"published_at":"2026-09-01T01:02:20.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/55f8785f-12a8-4975-945e-24a12783bfa7?rule=original","property_subtype":"apartment"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fotocasa Property Search","description":"Search Fotocasa listings by city or search URL. Returns prices, rooms, area, coordinates, and agency data via browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-fotocasa-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City name or full Fotocasa search URL.\n\n**Examples:**\n\n```\nmadrid\n```\n\n```\nbarcelona\n```\n\n```\nhttps://www.fotocasa.es/es/comprar/viviendas/madrid-capital/todas-las-zonas/l\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/viviendas/barcelona-capital/todas-las-zonas/l/2\n```","schema":{"type":"string","description":"City name or full Fotocasa search URL.\n\n**Examples:**\n\n```\nmadrid\n```\n\n```\nbarcelona\n```\n\n```\nhttps://www.fotocasa.es/es/comprar/viviendas/madrid-capital/todas-las-zonas/l\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/viviendas/barcelona-capital/todas-las-zonas/l/2\n```"}},{"name":"operation","in":"query","required":false,"description":"Used when `query` is a city name (ignored for full URLs).\n\n- `buy` / `comprar`: for sale (default)\n- `rent` / `alquiler`: for rent","schema":{"type":"string","default":"buy","description":"Used when `query` is a city name (ignored for full URLs).\n\n- `buy` / `comprar`: for sale (default)\n- `rent` / `alquiler`: for rent"}},{"name":"page","in":"query","required":false,"description":"Page number (1-based). Default: `1`. Page 2 maps to `/l/2`.","schema":{"type":"number","default":"1","description":"Page number (1-based). Default: `1`. Page 2 maps to `/l/2`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"location":{"type":"string"},"operation":{"type":"string"},"total_pages":{"type":"integer"},"current_page":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"listings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"floor":{"nullable":true},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"area_m2":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"operation":{"type":"string"},"price_drop":{"nullable":true},"agency_name":{"type":"string"},"neighborhood":{"type":"string"},"price_per_m2":{"type":"integer"},"published_at":{"type":"string"},"property_type":{"type":"string"},"thumbnail_url":{"type":"string"},"property_subtype":{"type":"string"}}}}}},"examples":{"Buy homes in Madrid":{"value":{"meta":{"location":"Madrid","operation":"sale","total_pages":375,"current_page":1,"has_next_page":true,"total_results":11222},"listings":[{"id":"189717534","url":"https://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/189717534/d","city":"Madrid","floor":null,"price":990000,"rooms":3,"title":"Barrio de Salamanca","address":"Barrio de Salamanca","area_m2":99,"currency":"EUR","latitude":40.43689191820105,"bathrooms":2,"longitude":-3.677214968590556,"operation":"sale","price_drop":null,"agency_name":"Dils Lucas Fox","neighborhood":"Barrio de Salamanca","price_per_m2":10000,"published_at":"2026-05-19T04:07:34.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/18ce6fc9-f80b-415f-b538-a150d35c7073?rule=original","property_subtype":"apartment"},{"id":"189625641","url":"https://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-trastero-ascensor-amueblado/189625641/d","city":"Madrid","floor":12,"price":1620000,"rooms":3,"title":"Alcalá, Barrio de Salamanca","address":"Alcalá, Barrio de Salamanca","area_m2":130,"currency":"EUR","latitude":40.42785333292837,"bathrooms":2,"longitude":-3.672679393562349,"operation":"sale","price_drop":null,"agency_name":"ESPÍGUL IMMOBILIARIA","neighborhood":"Barrio de Salamanca","price_per_m2":12462,"published_at":"2026-05-08T15:08:35.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/f8a5ccd4-ccf2-4012-9584-ba97c261b3ff?rule=original","property_subtype":"penthouse"}]}},"Rent homes in Barcelona":{"value":{"meta":{"location":"Barcelona","operation":"rent","total_pages":111,"current_page":1,"has_next_page":true,"total_results":3319},"listings":[{"id":"190623509","url":"https://www.fotocasa.es/es/alquiler/vivienda/barcelona-capital/aire-acondicionado-calefaccion-amueblado-television-se-aceptan-mascotas-internet/190623509/d","city":"Barcelona","floor":null,"price":1486,"rooms":2,"title":"N/A, Eixample","address":"N/A, Eixample","area_m2":69,"currency":"EUR","latitude":41.38040172808665,"bathrooms":null,"longitude":2.15092820467445,"operation":"rent","price_drop":null,"agency_name":"HOUSINGANYWHERE","neighborhood":"Eixample","price_per_m2":22,"published_at":"2026-09-01T01:03:28.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/9f7f7ed2-621f-43ce-8ce8-6c5ef9c07d4d?rule=original","property_subtype":"apartment"},{"id":"190623503","url":"https://www.fotocasa.es/es/alquiler/vivienda/barcelona-capital/aire-acondicionado-calefaccion-amueblado-television/190623503/d","city":"Barcelona","floor":null,"price":1100,"rooms":null,"title":"N/A, Sants - Montjuïc","address":"N/A, Sants - Montjuïc","area_m2":40,"currency":"EUR","latitude":41.37519937568134,"bathrooms":null,"longitude":2.133587230323095,"operation":"rent","price_drop":null,"agency_name":"HOUSINGANYWHERE","neighborhood":"Sants - Montjuïc","price_per_m2":28,"published_at":"2026-09-01T01:02:20.000Z","property_type":"home","thumbnail_url":"https://static.fotocasa.es/images/ads/55f8785f-12a8-4975-945e-24a12783bfa7?rule=original","property_subtype":"apartment"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fotocasa/ad":{"get":{"summary":"Fotocasa Property Ad","description":"Get a full Fotocasa listing by URL: price, features, coordinates, energy certificate, images, and agency (browser rendering, 2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-fotocasa-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Fotocasa ad URL (`/comprar/` or `/alquiler/`, ending with `/d`).\n\n**Examples:**\n\n```\nhttps://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-ascensor-amueblado/190589697/d\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/190625587/d\n```","schema":{"type":"string","description":"Full Fotocasa ad URL (`/comprar/` or `/alquiler/`, ending with `/d`).\n\n**Examples:**\n\n```\nhttps://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-ascensor-amueblado/190589697/d\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/190625587/d\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"media":{"type":"object","properties":{"images":{"type":"array","items":{"type":"string"}},"thumbnail_url":{"type":"string"}}},"price":{"type":"object","properties":{"amount":{"type":"integer"},"currency":{"type":"string"},"price_drop":{"nullable":true},"price_per_m2":{"type":"integer"}}},"title":{"type":"string"},"agency":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"},"phone":{"type":"string"}}},"status":{"type":"string"},"features":{"type":"object","properties":{"floor":{"type":"string"},"rooms":{"type":"integer"},"extras":{"type":"array","items":{"type":"string"}},"area_m2":{"type":"integer"},"bathrooms":{"type":"integer"},"furnished":{"type":"boolean"},"has_heating":{"type":"boolean"},"has_parking":{"type":"boolean"},"has_terrace":{"type":"boolean"},"orientation":{"type":"string"},"has_elevator":{"type":"boolean"},"energy_certificate":{"type":"string"},"has_air_conditioning":{"type":"boolean"}}},"location":{"type":"object","properties":{"city":{"type":"string"},"address":{"type":"string"},"district":{"type":"string"},"latitude":{"type":"number"},"province":{"type":"string"},"longitude":{"type":"number"},"postal_code":{"type":"string"},"neighborhood":{"type":"string"}}},"operation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"property_type":{"type":"string"},"energy_certificate":{"type":"object","properties":{"emissions":{"type":"string"},"efficiency":{"type":"string"},"emissions_value":{"type":"integer"},"efficiency_value":{"type":"integer"}}}}},"examples":{"Apartment for sale in Simancas, Madrid":{"value":{"id":"190589697","url":"https://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-ascensor-amueblado/190589697/d","media":{"images":["https://static.fotocasa.es/images/ads/0fe8c038-bcae-4028-aa77-840986d1562d?rule=original","https://static.fotocasa.es/images/ads/c41d1c6c-a6b8-4c66-8957-6986220698a8?rule=original","https://static.fotocasa.es/images/ads/4f18df17-d595-4622-b0e9-b9f911cf4741?rule=original","https://static.fotocasa.es/images/ads/3086bd1e-6ceb-415e-86cf-1766f7f9a5cd?rule=original","https://static.fotocasa.es/images/ads/73448974-39a0-4bb4-9b26-3e14c6e8d039?rule=original"],"thumbnail_url":"https://static.fotocasa.es/images/ads/0fe8c038-bcae-4028-aa77-840986d1562d?rule=original"},"price":{"amount":244000,"currency":"EUR","price_drop":null,"price_per_m2":4692},"title":"Apartamento en venta en Calle de Zabalza, Simancas, Madrid Capital","agency":{"url":"https://www.fotocasa.es/es/inmobiliaria--vohome-julián-camarillo---simancas/comprar/viviendas/espana/todas-las-zonas/l","name":"VO HOME JULIAN CAMARILLO - SIMANCAS","type":"professional","alias":"VOhome Julián Camarillo - Simancas","phone":"+33 1 99 00 00 00"},"status":"active","features":{"floor":"4ª planta","rooms":2,"extras":["Aire acondicionado","Calefacción","Terraza","Ascensor","Amueblado","Balcón","Alarma","Puerta Blindada"],"area_m2":52,"bathrooms":1,"furnished":true,"has_heating":true,"has_parking":false,"has_terrace":true,"orientation":"Noreste","has_elevator":true,"energy_certificate":"F","has_air_conditioning":true},"location":{"city":"Madrid","address":"Calle de Zabalza","district":"San Blas","latitude":40.42925376395859,"province":"Madrid","longitude":-3.624235493745569,"postal_code":"28037","neighborhood":"Simancas"},"operation":"sale","reference":"145","description":"VOhome Propiedades Simancas vende piso ubicado en Calle Zabalza en el barrio de Simancas.\r\n\r\nEsta acogedora vivienda se distribuye a través de un práctico pasillo de entrada que da acceso a un amplio y muy luminoso salón-comedor, perfecto para disfrutar de la luz natural durante todo el día. Cuenta con una cocina independiente totalmente equipada, dos dormitorios confortables y un baño completo co…","published_at":"2026-08-28T14:03:58.087","property_type":"apartment","energy_certificate":{"emissions":"E","efficiency":"F","emissions_value":61,"efficiency_value":328}}},"Apartment for rent in Acacias, Madrid":{"value":{"id":"190625587","url":"https://www.fotocasa.es/es/alquiler/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/190625587/d","media":{"images":["https://static.fotocasa.es/images/ads/7318d552-58ef-4ff8-acdb-3541a62a443a?rule=original","https://static.fotocasa.es/images/ads/811e0fb3-4e0a-46c9-9abc-697c84e3f18a?rule=original","https://static.fotocasa.es/images/ads/e27a8330-d50a-413f-a1ef-cd44c6af6746?rule=original","https://static.fotocasa.es/images/ads/6d126c44-11ab-4018-a56c-d80b29d99830?rule=original","https://static.fotocasa.es/images/ads/7f24a05c-a928-4120-a9c6-c5b40f0f33ca?rule=original"],"thumbnail_url":"https://static.fotocasa.es/images/ads/7318d552-58ef-4ff8-acdb-3541a62a443a?rule=original"},"price":{"amount":1900,"currency":"EUR","price_drop":null,"price_per_m2":20},"title":"Piso de alquiler en De Santa María de la Cabeza, Acacias, Madrid Capital","agency":{"url":"https://www.fotocasa.es/es/inmobiliaria-valtier/alquiler/viviendas/espana/todas-las-zonas/l","name":"Valtier","type":"professional","alias":"Valtier","phone":"+33 1 99 00 00 01"},"status":"active","features":{"floor":"1ª planta","rooms":3,"extras":["Aire acondicionado","Armarios","Ascensor","Amueblado","Cocina Equipada"],"area_m2":95,"bathrooms":2,"furnished":true,"has_heating":false,"has_parking":false,"has_terrace":false,"orientation":"Norte","has_elevator":true,"energy_certificate":"G","has_air_conditioning":true},"location":{"city":"Madrid","address":"DE SANTA MARÍA DE LA CABEZA","district":"Arganzuela","latitude":40.40091057525719,"province":"Madrid","longitude":-3.70034418322445,"postal_code":"28005","neighborhood":"Acacias"},"operation":"rent","reference":"6211","description":"En VALTIER Real Estate presentamos esta cómoda vivienda en alquiler de temporada situada en el Paseo de Santa María de la Cabeza 66 B, en el barrio de Acacias, una ubicación consolidada y perfectamente comunicada de Madrid.\n\n\nLa propiedad ofrece una distribución funcional y resulta especialmente adecuada para quienes buscan una vivienda para compartir durante una estancia temporal en la capital.\n\n…","published_at":"2026-09-01T09:03:03.340","property_type":"apartment","energy_certificate":{"emissions":"G","efficiency":"G","emissions_value":999,"efficiency_value":999}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fotocasa Property Ad","description":"Get a full Fotocasa listing by URL: price, features, coordinates, energy certificate, images, and agency (browser rendering, 2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-fotocasa-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Fotocasa ad URL (`/comprar/` or `/alquiler/`, ending with `/d`).\n\n**Examples:**\n\n```\nhttps://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-ascensor-amueblado/190589697/d\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/190625587/d\n```","schema":{"type":"string","description":"Full Fotocasa ad URL (`/comprar/` or `/alquiler/`, ending with `/d`).\n\n**Examples:**\n\n```\nhttps://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-ascensor-amueblado/190589697/d\n```\n\n```\nhttps://www.fotocasa.es/es/alquiler/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/190625587/d\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"media":{"type":"object","properties":{"images":{"type":"array","items":{"type":"string"}},"thumbnail_url":{"type":"string"}}},"price":{"type":"object","properties":{"amount":{"type":"integer"},"currency":{"type":"string"},"price_drop":{"nullable":true},"price_per_m2":{"type":"integer"}}},"title":{"type":"string"},"agency":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"},"phone":{"type":"string"}}},"status":{"type":"string"},"features":{"type":"object","properties":{"floor":{"type":"string"},"rooms":{"type":"integer"},"extras":{"type":"array","items":{"type":"string"}},"area_m2":{"type":"integer"},"bathrooms":{"type":"integer"},"furnished":{"type":"boolean"},"has_heating":{"type":"boolean"},"has_parking":{"type":"boolean"},"has_terrace":{"type":"boolean"},"orientation":{"type":"string"},"has_elevator":{"type":"boolean"},"energy_certificate":{"type":"string"},"has_air_conditioning":{"type":"boolean"}}},"location":{"type":"object","properties":{"city":{"type":"string"},"address":{"type":"string"},"district":{"type":"string"},"latitude":{"type":"number"},"province":{"type":"string"},"longitude":{"type":"number"},"postal_code":{"type":"string"},"neighborhood":{"type":"string"}}},"operation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"property_type":{"type":"string"},"energy_certificate":{"type":"object","properties":{"emissions":{"type":"string"},"efficiency":{"type":"string"},"emissions_value":{"type":"integer"},"efficiency_value":{"type":"integer"}}}}},"examples":{"Apartment for sale in Simancas, Madrid":{"value":{"id":"190589697","url":"https://www.fotocasa.es/es/comprar/vivienda/madrid-capital/aire-acondicionado-calefaccion-terraza-ascensor-amueblado/190589697/d","media":{"images":["https://static.fotocasa.es/images/ads/0fe8c038-bcae-4028-aa77-840986d1562d?rule=original","https://static.fotocasa.es/images/ads/c41d1c6c-a6b8-4c66-8957-6986220698a8?rule=original","https://static.fotocasa.es/images/ads/4f18df17-d595-4622-b0e9-b9f911cf4741?rule=original","https://static.fotocasa.es/images/ads/3086bd1e-6ceb-415e-86cf-1766f7f9a5cd?rule=original","https://static.fotocasa.es/images/ads/73448974-39a0-4bb4-9b26-3e14c6e8d039?rule=original"],"thumbnail_url":"https://static.fotocasa.es/images/ads/0fe8c038-bcae-4028-aa77-840986d1562d?rule=original"},"price":{"amount":244000,"currency":"EUR","price_drop":null,"price_per_m2":4692},"title":"Apartamento en venta en Calle de Zabalza, Simancas, Madrid Capital","agency":{"url":"https://www.fotocasa.es/es/inmobiliaria--vohome-julián-camarillo---simancas/comprar/viviendas/espana/todas-las-zonas/l","name":"VO HOME JULIAN CAMARILLO - SIMANCAS","type":"professional","alias":"VOhome Julián Camarillo - Simancas","phone":"+33 1 99 00 00 00"},"status":"active","features":{"floor":"4ª planta","rooms":2,"extras":["Aire acondicionado","Calefacción","Terraza","Ascensor","Amueblado","Balcón","Alarma","Puerta Blindada"],"area_m2":52,"bathrooms":1,"furnished":true,"has_heating":true,"has_parking":false,"has_terrace":true,"orientation":"Noreste","has_elevator":true,"energy_certificate":"F","has_air_conditioning":true},"location":{"city":"Madrid","address":"Calle de Zabalza","district":"San Blas","latitude":40.42925376395859,"province":"Madrid","longitude":-3.624235493745569,"postal_code":"28037","neighborhood":"Simancas"},"operation":"sale","reference":"145","description":"VOhome Propiedades Simancas vende piso ubicado en Calle Zabalza en el barrio de Simancas.\r\n\r\nEsta acogedora vivienda se distribuye a través de un práctico pasillo de entrada que da acceso a un amplio y muy luminoso salón-comedor, perfecto para disfrutar de la luz natural durante todo el día. Cuenta con una cocina independiente totalmente equipada, dos dormitorios confortables y un baño completo co…","published_at":"2026-08-28T14:03:58.087","property_type":"apartment","energy_certificate":{"emissions":"E","efficiency":"F","emissions_value":61,"efficiency_value":328}}},"Apartment for rent in Acacias, Madrid":{"value":{"id":"190625587","url":"https://www.fotocasa.es/es/alquiler/vivienda/madrid-capital/aire-acondicionado-ascensor-amueblado/190625587/d","media":{"images":["https://static.fotocasa.es/images/ads/7318d552-58ef-4ff8-acdb-3541a62a443a?rule=original","https://static.fotocasa.es/images/ads/811e0fb3-4e0a-46c9-9abc-697c84e3f18a?rule=original","https://static.fotocasa.es/images/ads/e27a8330-d50a-413f-a1ef-cd44c6af6746?rule=original","https://static.fotocasa.es/images/ads/6d126c44-11ab-4018-a56c-d80b29d99830?rule=original","https://static.fotocasa.es/images/ads/7f24a05c-a928-4120-a9c6-c5b40f0f33ca?rule=original"],"thumbnail_url":"https://static.fotocasa.es/images/ads/7318d552-58ef-4ff8-acdb-3541a62a443a?rule=original"},"price":{"amount":1900,"currency":"EUR","price_drop":null,"price_per_m2":20},"title":"Piso de alquiler en De Santa María de la Cabeza, Acacias, Madrid Capital","agency":{"url":"https://www.fotocasa.es/es/inmobiliaria-valtier/alquiler/viviendas/espana/todas-las-zonas/l","name":"Valtier","type":"professional","alias":"Valtier","phone":"+33 1 99 00 00 01"},"status":"active","features":{"floor":"1ª planta","rooms":3,"extras":["Aire acondicionado","Armarios","Ascensor","Amueblado","Cocina Equipada"],"area_m2":95,"bathrooms":2,"furnished":true,"has_heating":false,"has_parking":false,"has_terrace":false,"orientation":"Norte","has_elevator":true,"energy_certificate":"G","has_air_conditioning":true},"location":{"city":"Madrid","address":"DE SANTA MARÍA DE LA CABEZA","district":"Arganzuela","latitude":40.40091057525719,"province":"Madrid","longitude":-3.70034418322445,"postal_code":"28005","neighborhood":"Acacias"},"operation":"rent","reference":"6211","description":"En VALTIER Real Estate presentamos esta cómoda vivienda en alquiler de temporada situada en el Paseo de Santa María de la Cabeza 66 B, en el barrio de Acacias, una ubicación consolidada y perfectamente comunicada de Madrid.\n\n\nLa propiedad ofrece una distribución funcional y resulta especialmente adecuada para quienes buscan una vivienda para compartir durante una estancia temporal en la capital.\n\n…","published_at":"2026-09-01T09:03:03.340","property_type":"apartment","energy_certificate":{"emissions":"G","efficiency":"G","emissions_value":999,"efficiency_value":999}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/lamudi/search":{"get":{"summary":"Lamudi Search","description":"Search Lamudi Philippines and Indonesia listings. Pass a search URL in `query`, or use `location` and filters. Prices, area, rooms, tags, and pagination via browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-lamudi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Full Lamudi search URL. Used first when set. Location and path filters are ignored.\n\nPut `?page=2` in the URL to paginate.\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/\n\n**Example 2 (page 2):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/?page=2\n\n**Example 3 (Indonesia):**\n\n    https://www.lamudi.co.id/jual/rumah/jakarta-pusat/menteng/","schema":{"type":"string","description":"Full Lamudi search URL. Used first when set. Location and path filters are ignored.\n\nPut `?page=2` in the URL to paginate.\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/\n\n**Example 2 (page 2):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/?page=2\n\n**Example 3 (Indonesia):**\n\n    https://www.lamudi.co.id/jual/rumah/jakarta-pusat/menteng/"}},{"name":"location","in":"query","required":false,"description":"City or district. Used when `query` is empty. Builds a Philippines URL (`lamudi.com.ph`). For Indonesia, pass a search URL in `query`.\n\n**Example 1:**\n\n    Makati, Metro Manila\n\n**Example 2:**\n\n    Cebu City, Cebu","schema":{"type":"string","description":"City or district. Used when `query` is empty. Builds a Philippines URL (`lamudi.com.ph`). For Indonesia, pass a search URL in `query`.\n\n**Example 1:**\n\n    Makati, Metro Manila\n\n**Example 2:**\n\n    Cebu City, Cebu"}},{"name":"operation","in":"query","required":false,"description":"Transaction type. Used when `query` is empty.\n\n- `sale`: for sale (default)\n- `rent`: for rent","schema":{"type":"string","default":"sale","description":"Transaction type. Used when `query` is empty.\n\n- `sale`: for sale (default)\n- `rent`: for rent"}},{"name":"property_type","in":"query","required":false,"description":"Property type. Used when `query` is empty. Maps to Lamudi slugs (`condominium` → `/condo/`, `land` → `/lot/`).\n\n- `condominium`\n- `house`\n- `apartment`\n- `land`\n- `commercial`\n- `warehouse`","schema":{"type":"string","description":"Property type. Used when `query` is empty. Maps to Lamudi slugs (`condominium` → `/condo/`, `land` → `/lot/`).\n\n- `condominium`\n- `house`\n- `apartment`\n- `land`\n- `commercial`\n- `warehouse`"}},{"name":"min_price","in":"query","required":false,"description":"Minimum asking price in PHP or IDR.\n\n**Example:**\n\n    3000000","schema":{"type":"number","description":"Minimum asking price in PHP or IDR.\n\n**Example:**\n\n    3000000"}},{"name":"max_price","in":"query","required":false,"description":"Maximum asking price in PHP or IDR.\n\n**Example:**\n\n    15000000","schema":{"type":"number","description":"Maximum asking price in PHP or IDR.\n\n**Example:**\n\n    15000000"}},{"name":"min_bedrooms","in":"query","required":false,"description":"Minimum bedroom count.\n\n**Example:**\n\n    2","schema":{"type":"number","description":"Minimum bedroom count.\n\n**Example:**\n\n    2"}},{"name":"max_bedrooms","in":"query","required":false,"description":"Maximum bedroom count.\n\n**Example:**\n\n    4","schema":{"type":"number","description":"Maximum bedroom count.\n\n**Example:**\n\n    4"}},{"name":"min_bathrooms","in":"query","required":false,"description":"Minimum bathroom count.\n\n**Example:**\n\n    1","schema":{"type":"number","description":"Minimum bathroom count.\n\n**Example:**\n\n    1"}},{"name":"min_area","in":"query","required":false,"description":"Minimum area in m².\n\n**Example:**\n\n    40","schema":{"type":"number","description":"Minimum area in m².\n\n**Example:**\n\n    40"}},{"name":"max_area","in":"query","required":false,"description":"Maximum area in m².\n\n**Example:**\n\n    300","schema":{"type":"number","description":"Maximum area in m².\n\n**Example:**\n\n    300"}},{"name":"sort","in":"query","required":false,"description":"Sort order.\n\n- `relevance`: most relevant (default)\n- `price_asc`\n- `price_desc`\n- `date`","schema":{"type":"string","default":"relevance","description":"Sort order.\n\n- `relevance`: most relevant (default)\n- `price_asc`\n- `price_desc`\n- `date`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"price":{"type":"integer"},"title":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"neighborhood":{"type":"string"}}},"bathrooms":{"type":"integer"},"operation":{"type":"string"},"thumbnail":{"type":"string"},"lot_area_m2":{"nullable":true},"published_at":{"nullable":true},"floor_area_m2":{"type":"integer"},"property_type":{"type":"string"},"publisher_name":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}},"total_results":{"type":"integer"},"results_per_page":{"type":"integer"}}},"examples":{"Search condominiums for sale in Makati, Philippines":{"value":{"results":[{"id":"41032-73-86961cab0c33-7596-4cacf18a-9188-49f0","url":"https://www.lamudi.com.ph/property/41032-73-86961cab0c33-7596-4cacf18a-9188-49f0","tags":["Featured","New Development","Fully verified"],"price":4282813,"title":"Condo For Sale in San Antonio","bedrooms":1,"currency":"PHP","location":{"city":"Makati","region":"Metro Manila","neighborhood":"Malugay Street"},"bathrooms":1,"operation":"sale","thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJpbmdlc3Rlci80Y2FjZjE0MS03NTRkLTQ5YTctOTEzZi04Njk2MWNhYjBiZWEvaG9tZS0xLmpwZyIsImJyYW5kIjoibGFtdWRpIiwiZWRpdHMiOnsicm90YXRlIjpudWxsLCJyZXNpemUiOnsid2lkdGgiOjMyMCwiaGVpZ2h0IjoyNDAsImZpdCI6ImNvdmVyIn19fQ==","lot_area_m2":null,"published_at":null,"floor_area_m2":27,"property_type":"condominium","publisher_name":null},{"id":"41032-73-fd54c1228caf-1fa8-1991388-8ea8-7691","url":"https://www.lamudi.com.ph/property/41032-73-fd54c1228caf-1fa8-1991388-8ea8-7691","tags":["Featured","New Development","Fully verified"],"price":6216923,"title":"Studio For Sale in San Antonio","bedrooms":1,"currency":"PHP","location":{"city":"Makati","region":"Metro Manila","neighborhood":"Malugay Street"},"bathrooms":1,"operation":"sale","thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1wcm9qZWN0cy1hZG1pbi1pbWFnZXMiLCJrZXkiOiI1YTZhMjdjYi0zYTc3LTQ2ZmQtYWY4Ni01NjE1ZjQ1ZmFmOTgvNWE2YTI3Y2ItM2E3Ny00NmZkLWFmODYtNTYxNWY0NWZhZjk4XzEuMC1QSC0xMDIzNjQwLVBKLTE3NDU2LTEyMTc2MDc5NzY2MGU0ZjgyNTQ0YTJkLTEtMTIwMC04MDAuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6MzIwLCJoZWlnaHQiOjI0MCwiZml0IjoiY292ZXIifX19","lot_area_m2":null,"published_at":null,"floor_area_m2":22,"property_type":"condominium","publisher_name":null}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8],"total_pages":282,"has_next_page":true},"total_results":8435,"results_per_page":30}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Lamudi Search","description":"Search Lamudi Philippines and Indonesia listings. Pass a search URL in `query`, or use `location` and filters. Prices, area, rooms, tags, and pagination via browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-lamudi-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Full Lamudi search URL. Used first when set. Location and path filters are ignored.\n\nPut `?page=2` in the URL to paginate.\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/\n\n**Example 2 (page 2):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/?page=2\n\n**Example 3 (Indonesia):**\n\n    https://www.lamudi.co.id/jual/rumah/jakarta-pusat/menteng/","schema":{"type":"string","description":"Full Lamudi search URL. Used first when set. Location and path filters are ignored.\n\nPut `?page=2` in the URL to paginate.\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/\n\n**Example 2 (page 2):**\n\n    https://www.lamudi.com.ph/buy/metro-manila/makati/condo/?page=2\n\n**Example 3 (Indonesia):**\n\n    https://www.lamudi.co.id/jual/rumah/jakarta-pusat/menteng/"}},{"name":"location","in":"query","required":false,"description":"City or district. Used when `query` is empty. Builds a Philippines URL (`lamudi.com.ph`). For Indonesia, pass a search URL in `query`.\n\n**Example 1:**\n\n    Makati, Metro Manila\n\n**Example 2:**\n\n    Cebu City, Cebu","schema":{"type":"string","description":"City or district. Used when `query` is empty. Builds a Philippines URL (`lamudi.com.ph`). For Indonesia, pass a search URL in `query`.\n\n**Example 1:**\n\n    Makati, Metro Manila\n\n**Example 2:**\n\n    Cebu City, Cebu"}},{"name":"operation","in":"query","required":false,"description":"Transaction type. Used when `query` is empty.\n\n- `sale`: for sale (default)\n- `rent`: for rent","schema":{"type":"string","default":"sale","description":"Transaction type. Used when `query` is empty.\n\n- `sale`: for sale (default)\n- `rent`: for rent"}},{"name":"property_type","in":"query","required":false,"description":"Property type. Used when `query` is empty. Maps to Lamudi slugs (`condominium` → `/condo/`, `land` → `/lot/`).\n\n- `condominium`\n- `house`\n- `apartment`\n- `land`\n- `commercial`\n- `warehouse`","schema":{"type":"string","description":"Property type. Used when `query` is empty. Maps to Lamudi slugs (`condominium` → `/condo/`, `land` → `/lot/`).\n\n- `condominium`\n- `house`\n- `apartment`\n- `land`\n- `commercial`\n- `warehouse`"}},{"name":"min_price","in":"query","required":false,"description":"Minimum asking price in PHP or IDR.\n\n**Example:**\n\n    3000000","schema":{"type":"number","description":"Minimum asking price in PHP or IDR.\n\n**Example:**\n\n    3000000"}},{"name":"max_price","in":"query","required":false,"description":"Maximum asking price in PHP or IDR.\n\n**Example:**\n\n    15000000","schema":{"type":"number","description":"Maximum asking price in PHP or IDR.\n\n**Example:**\n\n    15000000"}},{"name":"min_bedrooms","in":"query","required":false,"description":"Minimum bedroom count.\n\n**Example:**\n\n    2","schema":{"type":"number","description":"Minimum bedroom count.\n\n**Example:**\n\n    2"}},{"name":"max_bedrooms","in":"query","required":false,"description":"Maximum bedroom count.\n\n**Example:**\n\n    4","schema":{"type":"number","description":"Maximum bedroom count.\n\n**Example:**\n\n    4"}},{"name":"min_bathrooms","in":"query","required":false,"description":"Minimum bathroom count.\n\n**Example:**\n\n    1","schema":{"type":"number","description":"Minimum bathroom count.\n\n**Example:**\n\n    1"}},{"name":"min_area","in":"query","required":false,"description":"Minimum area in m².\n\n**Example:**\n\n    40","schema":{"type":"number","description":"Minimum area in m².\n\n**Example:**\n\n    40"}},{"name":"max_area","in":"query","required":false,"description":"Maximum area in m².\n\n**Example:**\n\n    300","schema":{"type":"number","description":"Maximum area in m².\n\n**Example:**\n\n    300"}},{"name":"sort","in":"query","required":false,"description":"Sort order.\n\n- `relevance`: most relevant (default)\n- `price_asc`\n- `price_desc`\n- `date`","schema":{"type":"string","default":"relevance","description":"Sort order.\n\n- `relevance`: most relevant (default)\n- `price_asc`\n- `price_desc`\n- `date`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"price":{"type":"integer"},"title":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"neighborhood":{"type":"string"}}},"bathrooms":{"type":"integer"},"operation":{"type":"string"},"thumbnail":{"type":"string"},"lot_area_m2":{"nullable":true},"published_at":{"nullable":true},"floor_area_m2":{"type":"integer"},"property_type":{"type":"string"},"publisher_name":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}},"total_results":{"type":"integer"},"results_per_page":{"type":"integer"}}},"examples":{"Search condominiums for sale in Makati, Philippines":{"value":{"results":[{"id":"41032-73-86961cab0c33-7596-4cacf18a-9188-49f0","url":"https://www.lamudi.com.ph/property/41032-73-86961cab0c33-7596-4cacf18a-9188-49f0","tags":["Featured","New Development","Fully verified"],"price":4282813,"title":"Condo For Sale in San Antonio","bedrooms":1,"currency":"PHP","location":{"city":"Makati","region":"Metro Manila","neighborhood":"Malugay Street"},"bathrooms":1,"operation":"sale","thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJpbmdlc3Rlci80Y2FjZjE0MS03NTRkLTQ5YTctOTEzZi04Njk2MWNhYjBiZWEvaG9tZS0xLmpwZyIsImJyYW5kIjoibGFtdWRpIiwiZWRpdHMiOnsicm90YXRlIjpudWxsLCJyZXNpemUiOnsid2lkdGgiOjMyMCwiaGVpZ2h0IjoyNDAsImZpdCI6ImNvdmVyIn19fQ==","lot_area_m2":null,"published_at":null,"floor_area_m2":27,"property_type":"condominium","publisher_name":null},{"id":"41032-73-fd54c1228caf-1fa8-1991388-8ea8-7691","url":"https://www.lamudi.com.ph/property/41032-73-fd54c1228caf-1fa8-1991388-8ea8-7691","tags":["Featured","New Development","Fully verified"],"price":6216923,"title":"Studio For Sale in San Antonio","bedrooms":1,"currency":"PHP","location":{"city":"Makati","region":"Metro Manila","neighborhood":"Malugay Street"},"bathrooms":1,"operation":"sale","thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1wcm9qZWN0cy1hZG1pbi1pbWFnZXMiLCJrZXkiOiI1YTZhMjdjYi0zYTc3LTQ2ZmQtYWY4Ni01NjE1ZjQ1ZmFmOTgvNWE2YTI3Y2ItM2E3Ny00NmZkLWFmODYtNTYxNWY0NWZhZjk4XzEuMC1QSC0xMDIzNjQwLVBKLTE3NDU2LTEyMTc2MDc5NzY2MGU0ZjgyNTQ0YTJkLTEtMTIwMC04MDAuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6MzIwLCJoZWlnaHQiOjI0MCwiZml0IjoiY292ZXIifX19","lot_area_m2":null,"published_at":null,"floor_area_m2":22,"property_type":"condominium","publisher_name":null}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8],"total_pages":282,"has_next_page":true},"total_results":8435,"results_per_page":30}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/lamudi/ad":{"get":{"summary":"Lamudi Ad","description":"Get a full Lamudi listing by URL: price, area, amenities, coordinates, images, and agent (browser rendering, 2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-lamudi-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Lamudi listing URL. Accepts `lamudi.com.ph` (`/property/`) and `lamudi.co.id` (`/properti/`).\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/property/41032-73-626c638217d1-1d2a-1985488-907f-7802\n\n**Example 2 (Indonesia):**\n\n    https://www.lamudi.co.id/properti/41032-73-c337a9a63ceb-7484-19aca2f-9ba9-74d8","schema":{"type":"string","description":"Full Lamudi listing URL. Accepts `lamudi.com.ph` (`/property/`) and `lamudi.co.id` (`/properti/`).\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/property/41032-73-626c638217d1-1d2a-1985488-907f-7802\n\n**Example 2 (Indonesia):**\n\n    https://www.lamudi.co.id/properti/41032-73-c337a9a63ceb-7484-19aca2f-9ba9-74d8"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"object","properties":{"lot_m2":{"type":"integer"},"floor_m2":{"type":"integer"}}},"tags":{"type":"array","items":{"type":"string"}},"price":{"type":"object","properties":{"amount":{"type":"integer"},"currency":{"type":"string"},"price_per_m2":{"type":"integer"},"monthly_estimate":{"nullable":true}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"country":{"type":"string"},"features":{"type":"object","properties":{"parking":{"nullable":true},"bedrooms":{"type":"integer"},"bathrooms":{"nullable":true},"furnishing":{"nullable":true},"year_built":{"nullable":true},"floor_level":{"nullable":true}}},"location":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"full_address":{"type":"string"},"neighborhood":{"type":"string"}}},"amenities":{"type":"array","items":{"type":"string"}},"operation":{"type":"string"},"publisher":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"phone":{"nullable":true},"logo_url":{"type":"string"},"verified":{"type":"boolean"}}},"thumbnail":{"type":"string"},"video_url":{"nullable":true},"updated_at":{"nullable":true},"description":{"type":"string"},"published_at":{"type":"string"},"property_type":{"type":"string"},"virtual_tour_url":{"nullable":true}}},"examples":{"Villa for sale in Malay, Aklan":{"value":{"id":"41032-73-626c638217d1-1d2a-1985488-907f-7802","url":"https://www.lamudi.com.ph/property/41032-73-626c638217d1-1d2a-1985488-907f-7802","area":{"lot_m2":250,"floor_m2":100},"tags":["Fully verified","Featured"],"price":{"amount":27650000,"currency":"PHP","price_per_m2":276500,"monthly_estimate":null},"title":"Boracay Newcoast Resort Village Villas","images":["https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYWIyLTcwYjUtOGRlNi02OGJmMzZmZjcyNzQuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYmEwLTcyZjYtYjY0OC01MjVjNmM0MjQ5YjQuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYzI3LTczZTUtOGI2YS1jMjA5MTc2MTY5YTkuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYzZjLTcyNmMtOTE5ZC03YjJkMTBiZmIwOTEuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19"],"status":"active","country":"ph","features":{"parking":null,"bedrooms":2,"bathrooms":null,"furnishing":null,"year_built":null,"floor_level":null},"location":{"city":"Malay","region":"Aklan","latitude":11.9367774,"longitude":121.9502983,"full_address":"Boracay Island, Malay, Lalawigan ng Aklan, Pilipinas","neighborhood":"Boracay Island"},"amenities":["Fully furnished"],"operation":"sale","publisher":{"name":"Alessandra Victoria Guingao","type":"agent","phone":null,"logo_url":"https://images.proppit.com/publisher/79dfa7ea-beae-11eb-ade2-42010a940008/logo.jpeg","verified":true},"thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYWIyLTcwYjUtOGRlNi02OGJmMzZmZjcyNzQuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","video_url":null,"updated_at":null,"description":"Own a Luxury Villa in Boracay!\n\nMegaworld is now taking LOIs for the Boracay Newcoast Resort Village \n\nVillas – only 23 units available!\n\n250–310 sqm lots\n\n100 sqm, 2-bedroom, fully furnished villas\n\n15 mins from White Beach\n\nPrices start at ₱27.65M\n\nSubmit your LOI now for priority selection & launch pricing.\n\nMessage us today – slots are limited!","published_at":"2025-07-29T00:00:00.000Z","property_type":"house","virtual_tour_url":null}},"Condo for rent in Taguig":{"value":{"id":"41032-73-53013fa735a4-e59d-19dbd5a-ade9-72b9","url":"https://www.lamudi.com.ph/property/41032-73-53013fa735a4-e59d-19dbd5a-ade9-72b9","area":{"lot_m2":null,"floor_m2":22},"tags":["Fully verified","Featured"],"price":{"amount":38000,"currency":"PHP","price_per_m2":1727,"monthly_estimate":null},"title":"Fully-Furnished 1 Bedroom Unit with Balcony for Rent in  Unit B040154 Tower 4 Grace Residences Taguig City","images":["https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NWI3LTcyN2UtYjUzYi04NmE3ZmI5ODUwMDQucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NmJlLTczZTMtYjU2Yy01NjgyNDE2NjZlMDcucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NzE4LTczNTEtODZkZi03YjliZWI0N2E5ZDEucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NzZhLTcxMDItODFjMC05M2RiMGExMzAwMzAucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19"],"status":"active","country":"ph","features":{"parking":null,"bedrooms":1,"bathrooms":1,"furnishing":null,"year_built":null,"floor_level":null},"location":{"city":"Taguig","region":"Metro Manila","latitude":14.5302322,"longitude":121.06140427,"full_address":"Cayetano Avenue, Bambang, Taguig City, Metro Manila, National Capital Region, PHL","neighborhood":"Cayetano Avenue"},"amenities":["24 hours security","Air conditioning","Alarm","Balcony","Cctv","Playground","Concierge","Electricity","Lift","Fire alarm","Fire exits","Garden","Gym","Security","Swimming pool","Water","Fully furnished","New Development","Services","Healthcare","Shopping"],"operation":"rent","publisher":{"name":"SMDC Good Stays","type":"agent","phone":null,"logo_url":"https://images.proppit.com/publisher/05fafd09-672a-498d-a4d4-ea64469f7836/logo.jpeg","verified":true},"thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NWI3LTcyN2UtYjUzYi04NmE3ZmI5ODUwMDQucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","video_url":null,"updated_at":null,"description":"Project: Grace Residences \n\nTower: 4\nUnit Type: 1-bedroom with Balcony\n\nMonthly Rate: PHP 38,000 (negotiable) \n\nAddress: Cayetano Blvd. (formerly Levi. B. Mariano Ave.), Brgy. Ususan, Taguig City, Metro Manila \n\nGrace Residences – Units for Rent in Taguig 1 Bedroom available! Fully furnished units with modern interiors in a peaceful, gated community. Enjoy resort-style amenities, 24/7 security, and easy access to BGC, Makati, and C5. Move-in ready – contact us now!","published_at":"2026-04-24T00:00:00.000Z","property_type":"condominium","virtual_tour_url":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Lamudi Ad","description":"Get a full Lamudi listing by URL: price, area, amenities, coordinates, images, and agent (browser rendering, 2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-lamudi-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Lamudi listing URL. Accepts `lamudi.com.ph` (`/property/`) and `lamudi.co.id` (`/properti/`).\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/property/41032-73-626c638217d1-1d2a-1985488-907f-7802\n\n**Example 2 (Indonesia):**\n\n    https://www.lamudi.co.id/properti/41032-73-c337a9a63ceb-7484-19aca2f-9ba9-74d8","schema":{"type":"string","description":"Full Lamudi listing URL. Accepts `lamudi.com.ph` (`/property/`) and `lamudi.co.id` (`/properti/`).\n\n**Example 1 (Philippines):**\n\n    https://www.lamudi.com.ph/property/41032-73-626c638217d1-1d2a-1985488-907f-7802\n\n**Example 2 (Indonesia):**\n\n    https://www.lamudi.co.id/properti/41032-73-c337a9a63ceb-7484-19aca2f-9ba9-74d8"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"object","properties":{"lot_m2":{"type":"integer"},"floor_m2":{"type":"integer"}}},"tags":{"type":"array","items":{"type":"string"}},"price":{"type":"object","properties":{"amount":{"type":"integer"},"currency":{"type":"string"},"price_per_m2":{"type":"integer"},"monthly_estimate":{"nullable":true}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"country":{"type":"string"},"features":{"type":"object","properties":{"parking":{"nullable":true},"bedrooms":{"type":"integer"},"bathrooms":{"nullable":true},"furnishing":{"nullable":true},"year_built":{"nullable":true},"floor_level":{"nullable":true}}},"location":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"full_address":{"type":"string"},"neighborhood":{"type":"string"}}},"amenities":{"type":"array","items":{"type":"string"}},"operation":{"type":"string"},"publisher":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"phone":{"nullable":true},"logo_url":{"type":"string"},"verified":{"type":"boolean"}}},"thumbnail":{"type":"string"},"video_url":{"nullable":true},"updated_at":{"nullable":true},"description":{"type":"string"},"published_at":{"type":"string"},"property_type":{"type":"string"},"virtual_tour_url":{"nullable":true}}},"examples":{"Villa for sale in Malay, Aklan":{"value":{"id":"41032-73-626c638217d1-1d2a-1985488-907f-7802","url":"https://www.lamudi.com.ph/property/41032-73-626c638217d1-1d2a-1985488-907f-7802","area":{"lot_m2":250,"floor_m2":100},"tags":["Fully verified","Featured"],"price":{"amount":27650000,"currency":"PHP","price_per_m2":276500,"monthly_estimate":null},"title":"Boracay Newcoast Resort Village Villas","images":["https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYWIyLTcwYjUtOGRlNi02OGJmMzZmZjcyNzQuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYmEwLTcyZjYtYjY0OC01MjVjNmM0MjQ5YjQuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYzI3LTczZTUtOGI2YS1jMjA5MTc2MTY5YTkuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYzZjLTcyNmMtOTE5ZC03YjJkMTBiZmIwOTEuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19"],"status":"active","country":"ph","features":{"parking":null,"bedrooms":2,"bathrooms":null,"furnishing":null,"year_built":null,"floor_level":null},"location":{"city":"Malay","region":"Aklan","latitude":11.9367774,"longitude":121.9502983,"full_address":"Boracay Island, Malay, Lalawigan ng Aklan, Pilipinas","neighborhood":"Boracay Island"},"amenities":["Fully furnished"],"operation":"sale","publisher":{"name":"Alessandra Victoria Guingao","type":"agent","phone":null,"logo_url":"https://images.proppit.com/publisher/79dfa7ea-beae-11eb-ade2-42010a940008/logo.jpeg","verified":true},"thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOTg1NDNmLTFjZTEtNzdiOS05MDM2LTYyNmM2MzgyMTc4OC8wMTk4NTQ0MC1lYWIyLTcwYjUtOGRlNi02OGJmMzZmZjcyNzQuanBnIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","video_url":null,"updated_at":null,"description":"Own a Luxury Villa in Boracay!\n\nMegaworld is now taking LOIs for the Boracay Newcoast Resort Village \n\nVillas – only 23 units available!\n\n250–310 sqm lots\n\n100 sqm, 2-bedroom, fully furnished villas\n\n15 mins from White Beach\n\nPrices start at ₱27.65M\n\nSubmit your LOI now for priority selection & launch pricing.\n\nMessage us today – slots are limited!","published_at":"2025-07-29T00:00:00.000Z","property_type":"house","virtual_tour_url":null}},"Condo for rent in Taguig":{"value":{"id":"41032-73-53013fa735a4-e59d-19dbd5a-ade9-72b9","url":"https://www.lamudi.com.ph/property/41032-73-53013fa735a4-e59d-19dbd5a-ade9-72b9","area":{"lot_m2":null,"floor_m2":22},"tags":["Fully verified","Featured"],"price":{"amount":38000,"currency":"PHP","price_per_m2":1727,"monthly_estimate":null},"title":"Fully-Furnished 1 Bedroom Unit with Balcony for Rent in  Unit B040154 Tower 4 Grace Residences Taguig City","images":["https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NWI3LTcyN2UtYjUzYi04NmE3ZmI5ODUwMDQucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NmJlLTczZTMtYjU2Yy01NjgyNDE2NjZlMDcucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NzE4LTczNTEtODZkZi03YjliZWI0N2E5ZDEucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NzZhLTcxMDItODFjMC05M2RiMGExMzAwMzAucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19"],"status":"active","country":"ph","features":{"parking":null,"bedrooms":1,"bathrooms":1,"furnishing":null,"year_built":null,"floor_level":null},"location":{"city":"Taguig","region":"Metro Manila","latitude":14.5302322,"longitude":121.06140427,"full_address":"Cayetano Avenue, Bambang, Taguig City, Metro Manila, National Capital Region, PHL","neighborhood":"Cayetano Avenue"},"amenities":["24 hours security","Air conditioning","Alarm","Balcony","Cctv","Playground","Concierge","Electricity","Lift","Fire alarm","Fire exits","Garden","Gym","Security","Swimming pool","Water","Fully furnished","New Development","Services","Healthcare","Shopping"],"operation":"rent","publisher":{"name":"SMDC Good Stays","type":"agent","phone":null,"logo_url":"https://images.proppit.com/publisher/05fafd09-672a-498d-a4d4-ea64469f7836/logo.jpeg","verified":true},"thumbnail":"https://img.lamudi.com/eyJidWNrZXQiOiJwcmQtbGlmdWxsY29ubmVjdC1iYWNrZW5kLWIyYi1pbWFnZXMiLCJrZXkiOiJwcm9wZXJ0aWVzLzAxOWRiZDExLWU1NTQtNzI3MC1hZGEwLTUzMDEzZmE3MzU1Yi8wMTlkYmQxOC00NWI3LTcyN2UtYjUzYi04NmE3ZmI5ODUwMDQucG5nIiwiYnJhbmQiOiJsYW11ZGkiLCJlZGl0cyI6eyJyb3RhdGUiOm51bGwsInJlc2l6ZSI6eyJ3aWR0aCI6OTAwLCJoZWlnaHQiOjY1MCwiZml0IjoiY292ZXIifX19","video_url":null,"updated_at":null,"description":"Project: Grace Residences \n\nTower: 4\nUnit Type: 1-bedroom with Balcony\n\nMonthly Rate: PHP 38,000 (negotiable) \n\nAddress: Cayetano Blvd. (formerly Levi. B. Mariano Ave.), Brgy. Ususan, Taguig City, Metro Manila \n\nGrace Residences – Units for Rent in Taguig 1 Bedroom available! Fully furnished units with modern interiors in a peaceful, gated community. Enjoy resort-style amenities, 24/7 security, and easy access to BGC, Makati, and C5. Move-in ready – contact us now!","published_at":"2026-04-24T00:00:00.000Z","property_type":"condominium","virtual_tour_url":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/centris/search":{"get":{"summary":"Centris Search","description":"Search Centris listings by city or by a full results URL. Use the English or French path. Page through properties for sale.\n\n**Credit cost:** 1 credit per call","operationId":"get-centris-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Place name or a full Centris results URL.\n\nA place is slugified. English builds /en/properties~for-sale~{slug}. French builds /fr/propriete~a-vendre~{slug}. A full URL keeps its path and its filters.\n\n**Examples:**\n\n```\nmontreal\n```\n\n```\nhttps://www.centris.ca/en/properties~for-sale~montreal\n```\n\n```\nhttps://www.centris.ca/fr/propriete~a-vendre~montreal\n```","schema":{"type":"string","description":"Place name or a full Centris results URL.\n\nA place is slugified. English builds /en/properties~for-sale~{slug}. French builds /fr/propriete~a-vendre~{slug}. A full URL keeps its path and its filters.\n\n**Examples:**\n\n```\nmontreal\n```\n\n```\nhttps://www.centris.ca/en/properties~for-sale~montreal\n```\n\n```\nhttps://www.centris.ca/fr/propriete~a-vendre~montreal\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Default is 1.\n\nPage 2 of Montreal returns different listing ids from page 1. When this stays at 1, a page value already present in a results URL is kept.\n\n**Example:**\n\n```\n2\n```","schema":{"type":"number","default":"1","description":"Page number, starting at 1. Default is 1.\n\nPage 2 of Montreal returns different listing ids from page 1. When this stays at 1, a page value already present in a results URL is kept.\n\n**Example:**\n\n```\n2\n```"}},{"name":"language","in":"query","required":false,"description":"Results language when query is a place name. Default is en.\n\nen uses the English for-sale path. fr uses the French path. A full Centris URL keeps the language already in its path.\n\n**Example:**\n\n```\nfr\n```","schema":{"type":"string","default":"en","description":"Results language when query is a place name. Default is en.\n\nen uses the English for-sale path. fr uses the French path. A full Centris URL keeps the language already in its path.\n\n**Example:**\n\n```\nfr\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"photo_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Condo for sale in Montreal, Le Sud-Ouest":{"value":{"results":[{"id":"17796540","url":"https://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540","city":"Montréal (Le Sud-Ouest)","image":"https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CC4DDDDDDDDDD2&t=pi&w=320&h=240&sm=c","price":568000,"title":"Condo for sale in Montréal (Le Sud-Ouest), Montréal (Island), 2365, Rue Saint-Patrick, apt. 207, 17796540 - Centris.ca","address":"2365, Rue Saint-Patrick, apt. 207","bedrooms":1,"category":"Condo for sale","currency":"CAD","language":"en","latitude":45.482041,"bathrooms":1,"longitude":-73.569347,"photo_count":33,"price_display":"$568,000"}],"pagination":{"next":"https://www.centris.ca/en/properties~for-sale~montreal?page=2","page":1,"per_page":20,"total_pages":250,"total_results":9912}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Centris Search","description":"Search Centris listings by city or by a full results URL. Use the English or French path. Page through properties for sale.\n\n**Credit cost:** 1 credit per call","operationId":"post-centris-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Place name or a full Centris results URL.\n\nA place is slugified. English builds /en/properties~for-sale~{slug}. French builds /fr/propriete~a-vendre~{slug}. A full URL keeps its path and its filters.\n\n**Examples:**\n\n```\nmontreal\n```\n\n```\nhttps://www.centris.ca/en/properties~for-sale~montreal\n```\n\n```\nhttps://www.centris.ca/fr/propriete~a-vendre~montreal\n```","schema":{"type":"string","description":"Place name or a full Centris results URL.\n\nA place is slugified. English builds /en/properties~for-sale~{slug}. French builds /fr/propriete~a-vendre~{slug}. A full URL keeps its path and its filters.\n\n**Examples:**\n\n```\nmontreal\n```\n\n```\nhttps://www.centris.ca/en/properties~for-sale~montreal\n```\n\n```\nhttps://www.centris.ca/fr/propriete~a-vendre~montreal\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Default is 1.\n\nPage 2 of Montreal returns different listing ids from page 1. When this stays at 1, a page value already present in a results URL is kept.\n\n**Example:**\n\n```\n2\n```","schema":{"type":"number","default":"1","description":"Page number, starting at 1. Default is 1.\n\nPage 2 of Montreal returns different listing ids from page 1. When this stays at 1, a page value already present in a results URL is kept.\n\n**Example:**\n\n```\n2\n```"}},{"name":"language","in":"query","required":false,"description":"Results language when query is a place name. Default is en.\n\nen uses the English for-sale path. fr uses the French path. A full Centris URL keeps the language already in its path.\n\n**Example:**\n\n```\nfr\n```","schema":{"type":"string","default":"en","description":"Results language when query is a place name. Default is en.\n\nen uses the English for-sale path. fr uses the French path. A full Centris URL keeps the language already in its path.\n\n**Example:**\n\n```\nfr\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"language":{"type":"string"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"photo_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Condo for sale in Montreal, Le Sud-Ouest":{"value":{"results":[{"id":"17796540","url":"https://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540","city":"Montréal (Le Sud-Ouest)","image":"https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CC4DDDDDDDDDD2&t=pi&w=320&h=240&sm=c","price":568000,"title":"Condo for sale in Montréal (Le Sud-Ouest), Montréal (Island), 2365, Rue Saint-Patrick, apt. 207, 17796540 - Centris.ca","address":"2365, Rue Saint-Patrick, apt. 207","bedrooms":1,"category":"Condo for sale","currency":"CAD","language":"en","latitude":45.482041,"bathrooms":1,"longitude":-73.569347,"photo_count":33,"price_display":"$568,000"}],"pagination":{"next":"https://www.centris.ca/en/properties~for-sale~montreal?page=2","page":1,"per_page":20,"total_pages":250,"total_results":9912}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/argenprop/search":{"get":{"summary":"Argenprop Search","description":"Search Argenprop by neighbourhood or city. Set operation to venta or alquiler, and property_type such as departamentos or casas. Page with pagina.\n\n**Credit cost:** 1 credit per call","operationId":"get-argenprop-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The place to search, or a full Argenprop results page.\n\nA short place name is enough. Palermo is a neighborhood in Buenos Aires. The placeholder is palermo. With the other fields left as they are, that search is apartments for sale.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo\n```\n\nYou can paste the results page itself. This URL is the same apartments-for-sale list, and the path is kept.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=https://www.argenprop.com/departamentos/venta/palermo\n```\n\nA single listing page, the kind that ends with -- and a number, belongs on [Argenprop Property](https://www.piloterr.com/library/argenprop-property).\n","schema":{"type":"string","description":"The place to search, or a full Argenprop results page.\n\nA short place name is enough. Palermo is a neighborhood in Buenos Aires. The placeholder is palermo. With the other fields left as they are, that search is apartments for sale.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo\n```\n\nYou can paste the results page itself. This URL is the same apartments-for-sale list, and the path is kept.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=https://www.argenprop.com/departamentos/venta/palermo\n```\n\nA single listing page, the kind that ends with -- and a number, belongs on [Argenprop Property](https://www.piloterr.com/library/argenprop-property).\n"}},{"name":"page","in":"query","required":false,"description":"Which page of the list to open. The first page is 1. The placeholder is 2.\n\nPage 2 of apartments for sale in Palermo asks Argenprop for ?pagina-2. Those listing ids differ from page 1.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo&page=2\n```\n\nWhen this stays at 1 and the results URL already contains pagina-N, that page number is kept.\n","schema":{"type":"number","default":"1","description":"Which page of the list to open. The first page is 1. The placeholder is 2.\n\nPage 2 of apartments for sale in Palermo asks Argenprop for ?pagina-2. Those listing ids differ from page 1.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo&page=2\n```\n\nWhen this stays at 1 and the results URL already contains pagina-N, that page number is kept.\n"}},{"name":"operation","in":"query","required":false,"description":"Sale or rent, when query is a place name. The placeholder is venta, which means for sale. alquiler is a long-term rental. alquiler-temporal is a short stay. sale, buy, and rent are accepted as aliases.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the operation already written in its path.\n","schema":{"type":"string","default":"venta","description":"Sale or rent, when query is a place name. The placeholder is venta, which means for sale. alquiler is a long-term rental. alquiler-temporal is a short stay. sale, buy, and rent are accepted as aliases.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the operation already written in its path.\n"}},{"name":"property_type","in":"query","required":false,"description":"The kind of home, when query is a place name. The placeholder is departamentos, which means apartments. Also accepted: casas (houses), ph, terrenos, locales, oficinas, and quintas. casa and house map to casas.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the type already written in its path.\n","schema":{"type":"string","default":"departamentos","description":"The kind of home, when query is a place name. The placeholder is departamentos, which means apartments. Also accepted: casas (houses), ph, terrenos, locales, oficinas, and quintas. casa and house map to casas.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the type already written in its path.\n"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"toilets":{"nullable":true},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"expenses":{"nullable":true},"age_label":{"type":"string"},"age_years":{"type":"integer"},"bathrooms":{"type":"integer"},"condition":{"nullable":true},"operation":{"type":"string"},"agent_name":{"type":"string"},"disposition":{"nullable":true},"photo_count":{"type":"integer"},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"covered_area_m2":{"type":"integer"},"expenses_display":{"nullable":true},"expenses_currency":{"nullable":true},"semi_covered_area_m2":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apartments for sale in Palermo":{"value":{"results":[{"id":"20724993","url":"https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993","image":"https://www.argenprop.com/static-content/39942702/4792c440-1cec-4120-a78c-953e933e9303_u_small.jpg","price":2400000,"rooms":5,"title":"Torre bellini! piso alto! balcón c/espec vista panorámica! t/a nuevo! full amenities! 2 coch! único!","address":"Jerónimo Salguero 2700, Palermo Chico","toilets":null,"bedrooms":3,"currency":"USD","expenses":null,"age_label":"17 años","age_years":17,"bathrooms":4,"condition":null,"operation":"venta","agent_name":"LOPEZ CASTROMIL PROPIEDADES","disposition":null,"photo_count":46,"neighborhood":"Palermo Chico","price_display":"USD 2.400.000","property_type":"departamento","covered_area_m2":275,"expenses_display":null,"expenses_currency":null,"semi_covered_area_m2":null}],"pagination":{"next":"https://www.argenprop.com/departamentos/venta/palermo?pagina-2","page":1,"per_page":20,"total_pages":577,"total_results":11536}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Argenprop Search","description":"Search Argenprop by neighbourhood or city. Set operation to venta or alquiler, and property_type such as departamentos or casas. Page with pagina.\n\n**Credit cost:** 1 credit per call","operationId":"post-argenprop-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The place to search, or a full Argenprop results page.\n\nA short place name is enough. Palermo is a neighborhood in Buenos Aires. The placeholder is palermo. With the other fields left as they are, that search is apartments for sale.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo\n```\n\nYou can paste the results page itself. This URL is the same apartments-for-sale list, and the path is kept.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=https://www.argenprop.com/departamentos/venta/palermo\n```\n\nA single listing page, the kind that ends with -- and a number, belongs on [Argenprop Property](https://www.piloterr.com/library/argenprop-property).\n","schema":{"type":"string","description":"The place to search, or a full Argenprop results page.\n\nA short place name is enough. Palermo is a neighborhood in Buenos Aires. The placeholder is palermo. With the other fields left as they are, that search is apartments for sale.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo\n```\n\nYou can paste the results page itself. This URL is the same apartments-for-sale list, and the path is kept.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=https://www.argenprop.com/departamentos/venta/palermo\n```\n\nA single listing page, the kind that ends with -- and a number, belongs on [Argenprop Property](https://www.piloterr.com/library/argenprop-property).\n"}},{"name":"page","in":"query","required":false,"description":"Which page of the list to open. The first page is 1. The placeholder is 2.\n\nPage 2 of apartments for sale in Palermo asks Argenprop for ?pagina-2. Those listing ids differ from page 1.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo&page=2\n```\n\nWhen this stays at 1 and the results URL already contains pagina-N, that page number is kept.\n","schema":{"type":"number","default":"1","description":"Which page of the list to open. The first page is 1. The placeholder is 2.\n\nPage 2 of apartments for sale in Palermo asks Argenprop for ?pagina-2. Those listing ids differ from page 1.\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=palermo&page=2\n```\n\nWhen this stays at 1 and the results URL already contains pagina-N, that page number is kept.\n"}},{"name":"operation","in":"query","required":false,"description":"Sale or rent, when query is a place name. The placeholder is venta, which means for sale. alquiler is a long-term rental. alquiler-temporal is a short stay. sale, buy, and rent are accepted as aliases.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the operation already written in its path.\n","schema":{"type":"string","default":"venta","description":"Sale or rent, when query is a place name. The placeholder is venta, which means for sale. alquiler is a long-term rental. alquiler-temporal is a short stay. sale, buy, and rent are accepted as aliases.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the operation already written in its path.\n"}},{"name":"property_type","in":"query","required":false,"description":"The kind of home, when query is a place name. The placeholder is departamentos, which means apartments. Also accepted: casas (houses), ph, terrenos, locales, oficinas, and quintas. casa and house map to casas.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the type already written in its path.\n","schema":{"type":"string","default":"departamentos","description":"The kind of home, when query is a place name. The placeholder is departamentos, which means apartments. Also accepted: casas (houses), ph, terrenos, locales, oficinas, and quintas. casa and house map to casas.\n\nHouses for rent in Rosario:\n\n```\nGET https://api.piloterr.com/v2/argenprop/search?query=rosario&operation=alquiler&property_type=casas\n```\n\nA full results URL keeps the type already written in its path.\n"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"toilets":{"nullable":true},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"expenses":{"nullable":true},"age_label":{"type":"string"},"age_years":{"type":"integer"},"bathrooms":{"type":"integer"},"condition":{"nullable":true},"operation":{"type":"string"},"agent_name":{"type":"string"},"disposition":{"nullable":true},"photo_count":{"type":"integer"},"neighborhood":{"type":"string"},"price_display":{"type":"string"},"property_type":{"type":"string"},"covered_area_m2":{"type":"integer"},"expenses_display":{"nullable":true},"expenses_currency":{"nullable":true},"semi_covered_area_m2":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apartments for sale in Palermo":{"value":{"results":[{"id":"20724993","url":"https://www.argenprop.com/departamento-en-venta-en-palermo-chico-5-ambientes--20724993","image":"https://www.argenprop.com/static-content/39942702/4792c440-1cec-4120-a78c-953e933e9303_u_small.jpg","price":2400000,"rooms":5,"title":"Torre bellini! piso alto! balcón c/espec vista panorámica! t/a nuevo! full amenities! 2 coch! único!","address":"Jerónimo Salguero 2700, Palermo Chico","toilets":null,"bedrooms":3,"currency":"USD","expenses":null,"age_label":"17 años","age_years":17,"bathrooms":4,"condition":null,"operation":"venta","agent_name":"LOPEZ CASTROMIL PROPIEDADES","disposition":null,"photo_count":46,"neighborhood":"Palermo Chico","price_display":"USD 2.400.000","property_type":"departamento","covered_area_m2":275,"expenses_display":null,"expenses_currency":null,"semi_covered_area_m2":null}],"pagination":{"next":"https://www.argenprop.com/departamentos/venta/palermo?pagina-2","page":1,"per_page":20,"total_pages":577,"total_results":11536}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zonaprop/search":{"get":{"summary":"ZonaProp Search","description":"Search ZonaProp for apartments or houses in an Argentine city. Page with pagina. A few featured ads can repeat. Development projects priced 'from' are left out.\n\n**Credit cost:** 2 credits per call","operationId":"get-zonaprop-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Place or a ZonaProp search URL.\n\n**Example:**\n\n```\ncapital federal\n```\n\nAlso palermo or CABA. A full search URL keeps its path. A property URL returns 400.","schema":{"type":"string","description":"Place or a ZonaProp search URL.\n\n**Example:**\n\n```\ncapital federal\n```\n\nAlso palermo or CABA. A full search URL keeps its path. A property URL returns 400."}},{"name":"operation","in":"query","required":false,"description":"Sale or rent when query is a place.\n\n**Example:**\n\n```\nventa\n```\n\nUse alquiler for rent. Aliases: sale, buy, rent. Default venta. A search URL keeps its own path.","schema":{"type":"string","description":"Sale or rent when query is a place.\n\n**Example:**\n\n```\nventa\n```\n\nUse alquiler for rent. Aliases: sale, buy, rent. Default venta. A search URL keeps its own path."}},{"name":"property_type","in":"query","required":false,"description":"Kind of property. Default departamentos.\n\n**Example:**\n\n```\ndepartamentos\n```\n\nAlso casas, ph, terrenos, locales, oficinas, cocheras.","schema":{"type":"string","description":"Kind of property. Default departamentos.\n\n**Example:**\n\n```\ndepartamentos\n```\n\nAlso casas, ph, terrenos, locales, oficinas, cocheras."}},{"name":"page","in":"query","required":false,"description":"Page from 1. ZonaProp writes this into the path as -pagina-N.html.\n\n**Example:**\n\n```\n2\n```\n\n2 requests departamentos-venta-capital-federal-pagina-2.html when query is capital federal. A few Super destacado ids can appear on the next page. Most ids change.","schema":{"type":"number","description":"Page from 1. ZonaProp writes this into the path as -pagina-N.html.\n\n**Example:**\n\n```\n2\n```\n\n2 requests departamentos-venta-capital-federal-pagina-2.html when query is capital federal. A few Super destacado ids can appear on the next page. Most ids change."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"bathrooms":{"type":"integer"},"operation":{"type":"string"},"area_display":{"type":"string"},"neighborhood":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Capital Federal venta, Av. Estado de Israel 4620":{"value":{"results":[{"id":"59096735","url":"https://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html","area":53,"city":"Capital Federal","image":"https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/360x266/2052496641.jpg?isFirstImage=true","price":149773,"rooms":2,"title":"Venta Departamento 2 Ambientes Villa Crespo - Financiación","address":"Av. Estado de Israel 4620","bedrooms":1,"currency":"USD","bathrooms":1,"operation":"venta","area_display":"53 m² tot.","neighborhood":"Villa Crespo","price_display":"USD 149.773"}],"pagination":{"next":"https://www.zonaprop.com.ar/departamentos-venta-capital-federal-pagina-2.html","page":1,"per_page":30,"total_pages":2462,"total_results":73847}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ZonaProp Search","description":"Search ZonaProp for apartments or houses in an Argentine city. Page with pagina. A few featured ads can repeat. Development projects priced 'from' are left out.\n\n**Credit cost:** 2 credits per call","operationId":"post-zonaprop-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Place or a ZonaProp search URL.\n\n**Example:**\n\n```\ncapital federal\n```\n\nAlso palermo or CABA. A full search URL keeps its path. A property URL returns 400.","schema":{"type":"string","description":"Place or a ZonaProp search URL.\n\n**Example:**\n\n```\ncapital federal\n```\n\nAlso palermo or CABA. A full search URL keeps its path. A property URL returns 400."}},{"name":"operation","in":"query","required":false,"description":"Sale or rent when query is a place.\n\n**Example:**\n\n```\nventa\n```\n\nUse alquiler for rent. Aliases: sale, buy, rent. Default venta. A search URL keeps its own path.","schema":{"type":"string","description":"Sale or rent when query is a place.\n\n**Example:**\n\n```\nventa\n```\n\nUse alquiler for rent. Aliases: sale, buy, rent. Default venta. A search URL keeps its own path."}},{"name":"property_type","in":"query","required":false,"description":"Kind of property. Default departamentos.\n\n**Example:**\n\n```\ndepartamentos\n```\n\nAlso casas, ph, terrenos, locales, oficinas, cocheras.","schema":{"type":"string","description":"Kind of property. Default departamentos.\n\n**Example:**\n\n```\ndepartamentos\n```\n\nAlso casas, ph, terrenos, locales, oficinas, cocheras."}},{"name":"page","in":"query","required":false,"description":"Page from 1. ZonaProp writes this into the path as -pagina-N.html.\n\n**Example:**\n\n```\n2\n```\n\n2 requests departamentos-venta-capital-federal-pagina-2.html when query is capital federal. A few Super destacado ids can appear on the next page. Most ids change.","schema":{"type":"number","description":"Page from 1. ZonaProp writes this into the path as -pagina-N.html.\n\n**Example:**\n\n```\n2\n```\n\n2 requests departamentos-venta-capital-federal-pagina-2.html when query is capital federal. A few Super destacado ids can appear on the next page. Most ids change."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"area":{"type":"integer"},"city":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"rooms":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"bathrooms":{"type":"integer"},"operation":{"type":"string"},"area_display":{"type":"string"},"neighborhood":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Capital Federal venta, Av. Estado de Israel 4620":{"value":{"results":[{"id":"59096735","url":"https://www.zonaprop.com.ar/propiedades/clasificado/veclapin-venta-departamento-2-ambientes-villa-crespo-59096735.html","area":53,"city":"Capital Federal","image":"https://imgar.zonapropcdn.com/avisos/1/00/59/09/67/35/360x266/2052496641.jpg?isFirstImage=true","price":149773,"rooms":2,"title":"Venta Departamento 2 Ambientes Villa Crespo - Financiación","address":"Av. Estado de Israel 4620","bedrooms":1,"currency":"USD","bathrooms":1,"operation":"venta","area_display":"53 m² tot.","neighborhood":"Villa Crespo","price_display":"USD 149.773"}],"pagination":{"next":"https://www.zonaprop.com.ar/departamentos-venta-capital-federal-pagina-2.html","page":1,"per_page":30,"total_pages":2462,"total_results":73847}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/olx/product":{"get":{"summary":"OLX Product","description":"Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name.\n\n**Credit cost:** 1 credit per call","operationId":"get-olx-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full URL of the OLX listing page to retrieve. Must be a valid olx.com.br listing URL.\n**Example 1:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html\n```\n**Example 2:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/autos-e-pecas/carros-vans-e-utilitarios/honda-civic-2020-exl-IDK8pQz.html\n```\n","schema":{"type":"string","description":"Full URL of the OLX listing page to retrieve. Must be a valid olx.com.br listing URL.\n**Example 1:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html\n```\n**Example 2:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/autos-e-pecas/carros-vans-e-utilitarios/honda-civic-2020-exl-IDK8pQz.html\n```\n"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"views":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"total_ads":{"type":"integer"},"profile_url":{"type":"string"},"member_since":{"type":"string"}}},"status":{"type":"string"},"payment":{"type":"object","properties":{"installments":{"type":"object","properties":{"amount":{"type":"number"},"quantity":{"type":"integer"}}},"free_shipping":{"type":"boolean"},"online_payment":{"type":"boolean"}}},"category":{"type":"string"},"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"city":{"type":"string"},"state":{"type":"string"},"neighborhood":{"type":"string"}}},"condition":{"type":"string"},"thumbnail":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"updated_at":{"type":"string"},"category_id":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"original_price":{"type":"integer"}}},"examples":{"Fetch listing by URL":{"value":{"id":"902901124","url":"https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html","price":3200,"title":"iPhone 14 128GB Como Novo","views":847,"images":["https://img.olx.com.br/images/902901124_1.jpg","https://img.olx.com.br/images/902901124_2.jpg","https://img.olx.com.br/images/902901124_3.jpg"],"seller":{"id":"48273910","name":"Alex Martin","type":"particular","total_ads":4,"profile_url":"https://www.olx.com.br/example-user/48273910","member_since":"2021-03-15T00:00:00.000Z"},"status":"active","payment":{"installments":{"amount":1066.67,"quantity":3},"free_shipping":false,"online_payment":true},"category":"Celulares e Smartphones","location":{"lat":-23.5629,"lng":-46.6861,"city":"São Paulo","state":"SP","neighborhood":"Pinheiros"},"condition":"usado","thumbnail":"https://img.olx.com.br/images/902901124_1_thumb.jpg","attributes":[{"label":"Marca","value":"Apple"},{"label":"Modelo","value":"iPhone 14"},{"label":"Memória interna","value":"128 GB"},{"label":"Cor","value":"Preto"}],"updated_at":"2026-04-30T09:10:00.000Z","category_id":"3486","description":"Vendo iPhone 14 128GB na cor preta, em ótimo estado de conservação. Sem arranhões, bateria com 89% de saúde. Acompanha caixa original, carregador e capinha. Aceito cartão no débito ou PIX. Não faço troca.","published_at":"2026-04-29T14:35:00.000Z","original_price":3800}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"OLX Product","description":"Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name.\n\n**Credit cost:** 1 credit per call","operationId":"post-olx-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full URL of the OLX listing page to retrieve. Must be a valid olx.com.br listing URL.\n**Example 1:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html\n```\n**Example 2:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/autos-e-pecas/carros-vans-e-utilitarios/honda-civic-2020-exl-IDK8pQz.html\n```\n","schema":{"type":"string","description":"Full URL of the OLX listing page to retrieve. Must be a valid olx.com.br listing URL.\n**Example 1:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html\n```\n**Example 2:**\n\n```\nGET https://api.piloterr.com/v2/olx/product?query=https://www.olx.com.br/autos-e-pecas/carros-vans-e-utilitarios/honda-civic-2020-exl-IDK8pQz.html\n```\n"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"views":{"type":"integer"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"total_ads":{"type":"integer"},"profile_url":{"type":"string"},"member_since":{"type":"string"}}},"status":{"type":"string"},"payment":{"type":"object","properties":{"installments":{"type":"object","properties":{"amount":{"type":"number"},"quantity":{"type":"integer"}}},"free_shipping":{"type":"boolean"},"online_payment":{"type":"boolean"}}},"category":{"type":"string"},"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"city":{"type":"string"},"state":{"type":"string"},"neighborhood":{"type":"string"}}},"condition":{"type":"string"},"thumbnail":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"updated_at":{"type":"string"},"category_id":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"original_price":{"type":"integer"}}},"examples":{"Fetch listing by URL":{"value":{"id":"902901124","url":"https://www.olx.com.br/eletronicos-e-celulares/celulares-e-smartphones/iphone-14-128gb-como-novo-IDJ4mBb.html","price":3200,"title":"iPhone 14 128GB Como Novo","views":847,"images":["https://img.olx.com.br/images/902901124_1.jpg","https://img.olx.com.br/images/902901124_2.jpg","https://img.olx.com.br/images/902901124_3.jpg"],"seller":{"id":"48273910","name":"Alex Martin","type":"particular","total_ads":4,"profile_url":"https://www.olx.com.br/example-user/48273910","member_since":"2021-03-15T00:00:00.000Z"},"status":"active","payment":{"installments":{"amount":1066.67,"quantity":3},"free_shipping":false,"online_payment":true},"category":"Celulares e Smartphones","location":{"lat":-23.5629,"lng":-46.6861,"city":"São Paulo","state":"SP","neighborhood":"Pinheiros"},"condition":"usado","thumbnail":"https://img.olx.com.br/images/902901124_1_thumb.jpg","attributes":[{"label":"Marca","value":"Apple"},{"label":"Modelo","value":"iPhone 14"},{"label":"Memória interna","value":"128 GB"},{"label":"Cor","value":"Preto"}],"updated_at":"2026-04-30T09:10:00.000Z","category_id":"3486","description":"Vendo iPhone 14 128GB na cor preta, em ótimo estado de conservação. Sem arranhões, bateria com 89% de saúde. Acompanha caixa original, carregador e capinha. Aceito cartão no débito ou PIX. Não faço troca.","published_at":"2026-04-29T14:35:00.000Z","original_price":3800}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zapimoveis/ad":{"get":{"summary":"Zap Imóveis Ad","description":"Get a full Zap Imóveis listing by URL: price, IPTU, features, coordinates, images, and publisher (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-zapimoveis-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zap Imóveis listing URL. Accepts `/imovel/` and `/lancamentos/`.\n\n**Example 1 (sale):**\n\n    https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/\n\n**Example 2 (rent):**\n\n    https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/\n\n**Example 3 (development):**\n\n    https://www.zapimoveis.com.br/lancamentos/joya-jardins-id-2856335837/","schema":{"type":"string","description":"Full Zap Imóveis listing URL. Accepts `/imovel/` and `/lancamentos/`.\n\n**Example 1 (sale):**\n\n    https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/\n\n**Example 2 (rent):**\n\n    https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/\n\n**Example 3 (development):**\n\n    https://www.zapimoveis.com.br/lancamentos/joya-jardins-id-2856335837/"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"object","properties":{"iptu":{"type":"integer"},"amount":{"type":"integer"},"currency":{"type":"string"},"price_max":{"nullable":true},"condominium":{"type":"integer"},"price_per_m2":{"type":"integer"},"price_period":{"nullable":true}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"features":{"type":"object","properties":{"floor":{"type":"integer"},"suites":{"type":"integer"},"area_m2":{"type":"integer"},"area_max":{"nullable":true},"bedrooms":{"type":"integer"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"integer"},"parking_spaces":{"type":"integer"},"building_floors":{"type":"integer"}}},"location":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_code":{"type":"string"},"approximate":{"type":"boolean"},"full_address":{"type":"string"},"neighborhood":{"type":"string"}}},"operation":{"type":"string"},"publisher":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"tier":{"type":"string"},"phones":{"type":"array","items":{"type":"string"}},"license":{"type":"string"},"logo_url":{"type":"string"},"verified":{"type":"boolean"},"whatsapp":{"type":"string"}}},"reference":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"property_type":{"type":"string"},"thumbnail_url":{"type":"string"},"virtual_tour_url":{"nullable":true}}},"examples":{"Apartment for sale in Jardim Paulista, São Paulo":{"value":{"id":"2912096343","url":"https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/","price":{"iptu":800,"amount":2500000,"currency":"BRL","price_max":null,"condominium":3300,"price_per_m2":14706,"price_period":null},"title":"Apartamento para comprar com 170 m², 3 quartos, 3 banheiros, 2 vagas","images":["https://resizedimgs.zapimoveis.com.br/img/vr-listing/ab361b6c58c7374a2d3ddb8893e24c4f/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297","https://resizedimgs.zapimoveis.com.br/img/vr-listing/606ad8b94d41ff11d250bbf21f42fac1/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/85c5f47f8f5b869e649898a0f27b06da/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/ffb439a066985fc4af7393f5af14d7a8/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/068b9d25ca605784e2913bb62ec4e713/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false"],"status":"active","features":{"floor":9,"suites":1,"area_m2":170,"area_max":null,"bedrooms":3,"amenities":["reception","furnished","safety_circuit","service_area","internet_access","elevator","intercom","kitchen","cable_tv","laundry","pets_allowed","garden"],"bathrooms":3,"parking_spaces":2,"building_floors":10},"location":{"city":"São Paulo","state":"São Paulo","street":"Alameda Joaquim Eugênio de Lima","latitude":-23.571,"longitude":-46.656,"state_code":"SP","approximate":true,"full_address":"Alameda Joaquim Eugênio de Lima - Jardim Paulista, São Paulo - SP","neighborhood":"Jardim Paulista"},"operation":"sale","publisher":{"id":"f6645d26-414f-98df-22b0-338e40a3d71f","url":"https://www.zapimoveis.com.br/imobiliaria/661812/","name":"Paulo Roberto Leardi","tier":"diamond","phones":["1132847000","11973516994"],"license":"13057-F-SP","logo_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/7ee8941c3572b44acc3d9a9ea4ce29e9/paulo-roberto-leardi.webp?action=fit-in&dimension=72x72","verified":false,"whatsapp":"11973516994"},"reference":"667523","updated_at":"2026-10-01T11:33:22.061Z","description":"Apartamento à venda no nobre e sofisticado bairro do Jardim Paulista entre a alameda Lorena e rua Guarará, parte plana, próximo ao lindo e exuberante Parque do Ibirapuera e ao diversificado comércio da região, como ao Shopping Jardim Pamplona Shopping, Pão de Açucar, Swift entre outras lojas. \nUm (1) por andar, tendo todas as faces, é um imóvel com muito sol e muita ventilação.\nAmplo com living para três (3) bons e c…","published_at":"2021-06-04T20:57:05Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/ab361b6c58c7374a2d3ddb8893e24c4f/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297","virtual_tour_url":null}},"Apartment for rent in Gávea, Rio de Janeiro":{"value":{"id":"2908582541","url":"https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/","price":{"iptu":598,"amount":10800,"currency":"BRL","price_max":null,"condominium":1765,"price_per_m2":152,"price_period":"monthly"},"title":"Apartamento para alugar com 71 m², 2 quartos, 2 banheiros, 1 vaga","images":["https://resizedimgs.zapimoveis.com.br/img/vr-listing/fe13b29d87b1a8911fd4d65545218846/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297","https://resizedimgs.zapimoveis.com.br/img/vr-listing/76157749ccb0c5a6eb29b82fbb3d7581/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/c335810a5a55b94b31da253592614ef7/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/7629572174a98e9d2d9c37ed203fc855/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/6daab2ccb1993f8e576d4c35f6679c55/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false"],"status":"active","features":{"floor":0,"suites":1,"area_m2":71,"area_max":null,"bedrooms":2,"amenities":["concierge_24h","garage","balcony","kitchen_cabinets","air_conditioning","indoor_soccer","party_hall","laundry","internet_access","childrens_pool","sports_court","full_cabling","gym","recreation_area","pool"],"bathrooms":2,"parking_spaces":1,"building_floors":null},"location":{"city":"Rio de Janeiro","state":"Rio de Janeiro","street":"Rua Marquês de São Vicente","latitude":-22.978,"longitude":-43.233,"state_code":"RJ","approximate":true,"full_address":"Rua Marquês de São Vicente - Gávea, Rio de Janeiro - RJ","neighborhood":"Gávea"},"operation":"rent","publisher":{"id":"7ffd17dc-f1f5-90b3-5d37-77ca93fbcb5b","url":"https://www.zapimoveis.com.br/imobiliaria/746625/","name":"Stella Maris Real Estate","tier":"diamond","phones":["21992515265"],"license":"8474-J-RJ","logo_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/450ffaf3418085cf59dcc3df631face3/stella-maris-real-estate.webp?action=fit-in&dimension=72x72","verified":true,"whatsapp":"21992515265"},"reference":"AP-GA-080-L","updated_at":"2026-09-12T09:15:27.638Z","description":"Parque Sustentável da Gávea, Apartamento novo, primeira locação, todo planejado e climatizado com varanda, 2 quartos e 1 vaga para locação em excelente localização.\n\nCom 71 m2, o imóvel é super bem dividido em: ampla sala para 2 ambientes climatizada e com acesso direto à uma varanda com bancada de apoio, 2 quartos com armários e ar condicionado sendo 1 suíte, banheiro social completo, cozinha planejada com muitos ar…","published_at":"2021-12-02T12:49:25Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/fe13b29d87b1a8911fd4d65545218846/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297","virtual_tour_url":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zap Imóveis Ad","description":"Get a full Zap Imóveis listing by URL: price, IPTU, features, coordinates, images, and publisher (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-zapimoveis-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zap Imóveis listing URL. Accepts `/imovel/` and `/lancamentos/`.\n\n**Example 1 (sale):**\n\n    https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/\n\n**Example 2 (rent):**\n\n    https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/\n\n**Example 3 (development):**\n\n    https://www.zapimoveis.com.br/lancamentos/joya-jardins-id-2856335837/","schema":{"type":"string","description":"Full Zap Imóveis listing URL. Accepts `/imovel/` and `/lancamentos/`.\n\n**Example 1 (sale):**\n\n    https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/\n\n**Example 2 (rent):**\n\n    https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/\n\n**Example 3 (development):**\n\n    https://www.zapimoveis.com.br/lancamentos/joya-jardins-id-2856335837/"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"price":{"type":"object","properties":{"iptu":{"type":"integer"},"amount":{"type":"integer"},"currency":{"type":"string"},"price_max":{"nullable":true},"condominium":{"type":"integer"},"price_per_m2":{"type":"integer"},"price_period":{"nullable":true}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"features":{"type":"object","properties":{"floor":{"type":"integer"},"suites":{"type":"integer"},"area_m2":{"type":"integer"},"area_max":{"nullable":true},"bedrooms":{"type":"integer"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"integer"},"parking_spaces":{"type":"integer"},"building_floors":{"type":"integer"}}},"location":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_code":{"type":"string"},"approximate":{"type":"boolean"},"full_address":{"type":"string"},"neighborhood":{"type":"string"}}},"operation":{"type":"string"},"publisher":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"tier":{"type":"string"},"phones":{"type":"array","items":{"type":"string"}},"license":{"type":"string"},"logo_url":{"type":"string"},"verified":{"type":"boolean"},"whatsapp":{"type":"string"}}},"reference":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"published_at":{"type":"string"},"property_type":{"type":"string"},"thumbnail_url":{"type":"string"},"virtual_tour_url":{"nullable":true}}},"examples":{"Apartment for sale in Jardim Paulista, São Paulo":{"value":{"id":"2912096343","url":"https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/","price":{"iptu":800,"amount":2500000,"currency":"BRL","price_max":null,"condominium":3300,"price_per_m2":14706,"price_period":null},"title":"Apartamento para comprar com 170 m², 3 quartos, 3 banheiros, 2 vagas","images":["https://resizedimgs.zapimoveis.com.br/img/vr-listing/ab361b6c58c7374a2d3ddb8893e24c4f/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297","https://resizedimgs.zapimoveis.com.br/img/vr-listing/606ad8b94d41ff11d250bbf21f42fac1/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/85c5f47f8f5b869e649898a0f27b06da/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/ffb439a066985fc4af7393f5af14d7a8/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/068b9d25ca605784e2913bb62ec4e713/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false"],"status":"active","features":{"floor":9,"suites":1,"area_m2":170,"area_max":null,"bedrooms":3,"amenities":["reception","furnished","safety_circuit","service_area","internet_access","elevator","intercom","kitchen","cable_tv","laundry","pets_allowed","garden"],"bathrooms":3,"parking_spaces":2,"building_floors":10},"location":{"city":"São Paulo","state":"São Paulo","street":"Alameda Joaquim Eugênio de Lima","latitude":-23.571,"longitude":-46.656,"state_code":"SP","approximate":true,"full_address":"Alameda Joaquim Eugênio de Lima - Jardim Paulista, São Paulo - SP","neighborhood":"Jardim Paulista"},"operation":"sale","publisher":{"id":"f6645d26-414f-98df-22b0-338e40a3d71f","url":"https://www.zapimoveis.com.br/imobiliaria/661812/","name":"Paulo Roberto Leardi","tier":"diamond","phones":["1132847000","11973516994"],"license":"13057-F-SP","logo_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/7ee8941c3572b44acc3d9a9ea4ce29e9/paulo-roberto-leardi.webp?action=fit-in&dimension=72x72","verified":false,"whatsapp":"11973516994"},"reference":"667523","updated_at":"2026-10-01T11:33:22.061Z","description":"Apartamento à venda no nobre e sofisticado bairro do Jardim Paulista entre a alameda Lorena e rua Guarará, parte plana, próximo ao lindo e exuberante Parque do Ibirapuera e ao diversificado comércio da região, como ao Shopping Jardim Pamplona Shopping, Pão de Açucar, Swift entre outras lojas. \nUm (1) por andar, tendo todas as faces, é um imóvel com muito sol e muita ventilação.\nAmplo com living para três (3) bons e c…","published_at":"2021-06-04T20:57:05Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/ab361b6c58c7374a2d3ddb8893e24c4f/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297","virtual_tour_url":null}},"Apartment for rent in Gávea, Rio de Janeiro":{"value":{"id":"2908582541","url":"https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/","price":{"iptu":598,"amount":10800,"currency":"BRL","price_max":null,"condominium":1765,"price_per_m2":152,"price_period":"monthly"},"title":"Apartamento para alugar com 71 m², 2 quartos, 2 banheiros, 1 vaga","images":["https://resizedimgs.zapimoveis.com.br/img/vr-listing/fe13b29d87b1a8911fd4d65545218846/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297","https://resizedimgs.zapimoveis.com.br/img/vr-listing/76157749ccb0c5a6eb29b82fbb3d7581/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/c335810a5a55b94b31da253592614ef7/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/7629572174a98e9d2d9c37ed203fc855/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false","https://resizedimgs.zapimoveis.com.br/img/vr-listing/6daab2ccb1993f8e576d4c35f6679c55/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297&seo=false"],"status":"active","features":{"floor":0,"suites":1,"area_m2":71,"area_max":null,"bedrooms":2,"amenities":["concierge_24h","garage","balcony","kitchen_cabinets","air_conditioning","indoor_soccer","party_hall","laundry","internet_access","childrens_pool","sports_court","full_cabling","gym","recreation_area","pool"],"bathrooms":2,"parking_spaces":1,"building_floors":null},"location":{"city":"Rio de Janeiro","state":"Rio de Janeiro","street":"Rua Marquês de São Vicente","latitude":-22.978,"longitude":-43.233,"state_code":"RJ","approximate":true,"full_address":"Rua Marquês de São Vicente - Gávea, Rio de Janeiro - RJ","neighborhood":"Gávea"},"operation":"rent","publisher":{"id":"7ffd17dc-f1f5-90b3-5d37-77ca93fbcb5b","url":"https://www.zapimoveis.com.br/imobiliaria/746625/","name":"Stella Maris Real Estate","tier":"diamond","phones":["21992515265"],"license":"8474-J-RJ","logo_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/450ffaf3418085cf59dcc3df631face3/stella-maris-real-estate.webp?action=fit-in&dimension=72x72","verified":true,"whatsapp":"21992515265"},"reference":"AP-GA-080-L","updated_at":"2026-09-12T09:15:27.638Z","description":"Parque Sustentável da Gávea, Apartamento novo, primeira locação, todo planejado e climatizado com varanda, 2 quartos e 1 vaga para locação em excelente localização.\n\nCom 71 m2, o imóvel é super bem dividido em: ampla sala para 2 ambientes climatizada e com acesso direto à uma varanda com bancada de apoio, 2 quartos com armários e ar condicionado sendo 1 suíte, banheiro social completo, cozinha planejada com muitos ar…","published_at":"2021-12-02T12:49:25Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/fe13b29d87b1a8911fd4d65545218846/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297","virtual_tour_url":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zapimoveis/search":{"get":{"summary":"Zap Imóveis Search","description":"Search Zap Imóveis listings by city or search URL. Returns prices, IPTU, condominium fees, rooms, and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"get-zapimoveis-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City, `City, UF`, neighborhood, or full Zap Imóveis search URL.\n\n**Example 1 (city):**\n\n    São Paulo\n\n**Example 2 (city and state):**\n\n    Rio de Janeiro, RJ\n\n**Example 3 (search URL):**\n\n    https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/\n\n**Example 4 (page 2):**\n\n    https://www.zapimoveis.com.br/venda/casas/mg+belo-horizonte/?pagina=2","schema":{"type":"string","description":"City, `City, UF`, neighborhood, or full Zap Imóveis search URL.\n\n**Example 1 (city):**\n\n    São Paulo\n\n**Example 2 (city and state):**\n\n    Rio de Janeiro, RJ\n\n**Example 3 (search URL):**\n\n    https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/\n\n**Example 4 (page 2):**\n\n    https://www.zapimoveis.com.br/venda/casas/mg+belo-horizonte/?pagina=2"}},{"name":"operation","in":"query","required":false,"description":"Transaction type. Used when `query` is a city. Ignored as a path builder when `query` is a full URL.\n\n- `sale`: for sale (default)\n- `rent`: for rent\n\nAliases `venda`, `aluguel`, `buy`, and `rental` are accepted. The response uses `sale` or `rent`.","schema":{"type":"string","default":"sale","description":"Transaction type. Used when `query` is a city. Ignored as a path builder when `query` is a full URL.\n\n- `sale`: for sale (default)\n- `rent`: for rent\n\nAliases `venda`, `aluguel`, `buy`, and `rental` are accepted. The response uses `sale` or `rent`."}},{"name":"property_type","in":"query","required":false,"description":"Property type. Used when `query` is a city.\n\n- `apartment`\n- `house`\n- `penthouse` (`cobertura`)\n- `land`\n- `studio` (`kitnet`)\n- `condo`\n- `flat`\n- `loft`\n- `commercial` / `office`\n- `warehouse`\n- `store`\n- `farm`\n- `building`\n- `sobrado`\n\nEmpty means all types (`imoveis`).","schema":{"type":"string","description":"Property type. Used when `query` is a city.\n\n- `apartment`\n- `house`\n- `penthouse` (`cobertura`)\n- `land`\n- `studio` (`kitnet`)\n- `condo`\n- `flat`\n- `loft`\n- `commercial` / `office`\n- `warehouse`\n- `store`\n- `farm`\n- `building`\n- `sobrado`\n\nEmpty means all types (`imoveis`)."}},{"name":"page","in":"query","required":false,"description":"Page number (1-based). Default: `1`. Values above 1 set `pagina` on the URL.","schema":{"type":"number","default":"1","description":"Page number (1-based). Default: `1`. Values above 1 set `pagina` on the URL."}},{"name":"min_price","in":"query","required":false,"description":"Minimum asking price in BRL.\n\n**Example:**\n\n    500000","schema":{"type":"number","description":"Minimum asking price in BRL.\n\n**Example:**\n\n    500000"}},{"name":"max_price","in":"query","required":false,"description":"Maximum asking price in BRL.\n\n**Example:**\n\n    2000000","schema":{"type":"number","description":"Maximum asking price in BRL.\n\n**Example:**\n\n    2000000"}},{"name":"min_area","in":"query","required":false,"description":"Minimum area in m².\n\n**Example:**\n\n    70","schema":{"type":"number","description":"Minimum area in m².\n\n**Example:**\n\n    70"}},{"name":"max_area","in":"query","required":false,"description":"Maximum area in m².\n\n**Example:**\n\n    150","schema":{"type":"number","description":"Maximum area in m².\n\n**Example:**\n\n    150"}},{"name":"min_bedrooms","in":"query","required":false,"description":"Minimum bedroom count.\n\n**Example:**\n\n    3","schema":{"type":"number","description":"Minimum bedroom count.\n\n**Example:**\n\n    3"}},{"name":"min_bathrooms","in":"query","required":false,"description":"Minimum bathroom count.\n\n**Example:**\n\n    2","schema":{"type":"number","description":"Minimum bathroom count.\n\n**Example:**\n\n    2"}},{"name":"min_parking","in":"query","required":false,"description":"Minimum parking spaces.\n\n**Example:**\n\n    1","schema":{"type":"number","description":"Minimum parking spaces.\n\n**Example:**\n\n    1"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"iptu":{"type":"integer"},"floor":{"type":"integer"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"suites":{"type":"integer"},"address":{"type":"string"},"area_m2":{"type":"integer"},"area_max":{"nullable":true},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"operation":{"type":"string"},"price_max":{"nullable":true},"state_code":{"type":"string"},"condominium":{"type":"integer"},"neighborhood":{"type":"string"},"price_per_m2":{"type":"integer"},"price_period":{"nullable":true},"published_at":{"type":"string"},"property_type":{"type":"string"},"thumbnail_url":{"type":"string"},"parking_spaces":{"type":"integer"},"publisher_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apartments for sale in São Paulo":{"value":{"results":[{"id":"2912096343","url":"https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/","city":"São Paulo","iptu":800,"floor":9,"price":2500000,"state":"São Paulo","title":"Apartamento para comprar com 170 m², 3 quartos, 3 banheiros, 2 vagas","suites":1,"address":"Alameda Joaquim Eugênio de Lima","area_m2":170,"area_max":null,"bedrooms":3,"currency":"BRL","latitude":-23.571,"bathrooms":3,"longitude":-46.656,"operation":"sale","price_max":null,"state_code":"SP","condominium":3300,"neighborhood":"Jardim Paulista","price_per_m2":14706,"price_period":null,"published_at":"2021-06-04T20:57:05Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/ab361b6c58c7374a2d3ddb8893e24c4f/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297","parking_spaces":2,"publisher_name":"Paulo Roberto Leardi"},{"id":"2856335837","url":"https://www.zapimoveis.com.br/lancamentos/joya-jardins-id-2856335837/","city":"São Paulo","iptu":null,"floor":0,"price":1707192,"state":"São Paulo","title":"Apartamento para comprar com 57 - 153 m², 1 quarto, 1 banheiro, 1 vaga","suites":1,"address":"Rua da Consolação","area_m2":57,"area_max":153,"bedrooms":1,"currency":"BRL","latitude":-23.558224,"bathrooms":1,"longitude":-46.665412,"operation":"sale","price_max":4740872,"state_code":"SP","condominium":null,"neighborhood":"Cerqueira César","price_per_m2":29951,"price_period":null,"published_at":"2025-03-12T11:42:11Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/dab3db62b3c764fd96d0457e7fcd4431/joya-jardins-no-cerqueira-cesar-sao-paulo.webp?action=fit-in&dimension=614x297","parking_spaces":1,"publisher_name":"Bom Negocio Atividades De Internet Ltda"}],"pagination":{"next":"https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/?pagina=2","page":1,"per_page":30,"total_pages":14528,"total_results":435826}}},"Apartments for rent in Rio de Janeiro":{"value":{"results":[{"id":"2908582541","url":"https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/","city":"Rio de Janeiro","iptu":598,"floor":0,"price":10800,"state":"Rio de Janeiro","title":"Apartamento para alugar com 71 m², 2 quartos, 2 banheiros, 1 vaga","suites":1,"address":"Rua Marquês de São Vicente","area_m2":71,"area_max":null,"bedrooms":2,"currency":"BRL","latitude":-22.978,"bathrooms":2,"longitude":-43.233,"operation":"rent","price_max":null,"state_code":"RJ","condominium":1765,"neighborhood":"Gávea","price_per_m2":152,"price_period":"monthly","published_at":"2021-12-02T12:49:25Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/fe13b29d87b1a8911fd4d65545218846/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297","parking_spaces":1,"publisher_name":"Stella Maris Real Estate"},{"id":"2887904208","url":"https://www.zapimoveis.com.br/imovel/aluguel-apartamento-4-quartos-com-piscina-barra-da-tijuca-zona-oeste-rio-de-janeiro-rj-226m2-id-2887904208/","city":"Rio de Janeiro","iptu":907,"floor":0,"price":12000,"state":"Rio de Janeiro","title":"Apartamento para alugar com 226 m², 4 quartos, 4 banheiros, 2 vagas","suites":4,"address":"Rua Coronel Aviador Antônio Arthur Braga","area_m2":226,"area_max":null,"bedrooms":4,"currency":"BRL","latitude":-23.004,"bathrooms":4,"longitude":-43.366,"operation":"rent","price_max":null,"state_code":"RJ","condominium":3900,"neighborhood":"Barra da Tijuca","price_per_m2":53,"price_period":"monthly","published_at":"2018-03-27T15:37:39Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/a2ad722d269d08f6537ebb271bdbc248/apartamento-com-4-quartos-para-alugar-226m-no-barra-da-tijuca-rio-de-janeiro.webp?action=fit-in&dimension=614x297","parking_spaces":2,"publisher_name":"Jtavares Administradora Ipanema"}],"pagination":{"next":"https://www.zapimoveis.com.br/aluguel/apartamentos/rj+rio-de-janeiro/?pagina=2","page":1,"per_page":30,"total_pages":290,"total_results":8681}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zap Imóveis Search","description":"Search Zap Imóveis listings by city or search URL. Returns prices, IPTU, condominium fees, rooms, and pagination (1 credit).\n\n**Credit cost:** 1 credit per call","operationId":"post-zapimoveis-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"City, `City, UF`, neighborhood, or full Zap Imóveis search URL.\n\n**Example 1 (city):**\n\n    São Paulo\n\n**Example 2 (city and state):**\n\n    Rio de Janeiro, RJ\n\n**Example 3 (search URL):**\n\n    https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/\n\n**Example 4 (page 2):**\n\n    https://www.zapimoveis.com.br/venda/casas/mg+belo-horizonte/?pagina=2","schema":{"type":"string","description":"City, `City, UF`, neighborhood, or full Zap Imóveis search URL.\n\n**Example 1 (city):**\n\n    São Paulo\n\n**Example 2 (city and state):**\n\n    Rio de Janeiro, RJ\n\n**Example 3 (search URL):**\n\n    https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/\n\n**Example 4 (page 2):**\n\n    https://www.zapimoveis.com.br/venda/casas/mg+belo-horizonte/?pagina=2"}},{"name":"operation","in":"query","required":false,"description":"Transaction type. Used when `query` is a city. Ignored as a path builder when `query` is a full URL.\n\n- `sale`: for sale (default)\n- `rent`: for rent\n\nAliases `venda`, `aluguel`, `buy`, and `rental` are accepted. The response uses `sale` or `rent`.","schema":{"type":"string","default":"sale","description":"Transaction type. Used when `query` is a city. Ignored as a path builder when `query` is a full URL.\n\n- `sale`: for sale (default)\n- `rent`: for rent\n\nAliases `venda`, `aluguel`, `buy`, and `rental` are accepted. The response uses `sale` or `rent`."}},{"name":"property_type","in":"query","required":false,"description":"Property type. Used when `query` is a city.\n\n- `apartment`\n- `house`\n- `penthouse` (`cobertura`)\n- `land`\n- `studio` (`kitnet`)\n- `condo`\n- `flat`\n- `loft`\n- `commercial` / `office`\n- `warehouse`\n- `store`\n- `farm`\n- `building`\n- `sobrado`\n\nEmpty means all types (`imoveis`).","schema":{"type":"string","description":"Property type. Used when `query` is a city.\n\n- `apartment`\n- `house`\n- `penthouse` (`cobertura`)\n- `land`\n- `studio` (`kitnet`)\n- `condo`\n- `flat`\n- `loft`\n- `commercial` / `office`\n- `warehouse`\n- `store`\n- `farm`\n- `building`\n- `sobrado`\n\nEmpty means all types (`imoveis`)."}},{"name":"page","in":"query","required":false,"description":"Page number (1-based). Default: `1`. Values above 1 set `pagina` on the URL.","schema":{"type":"number","default":"1","description":"Page number (1-based). Default: `1`. Values above 1 set `pagina` on the URL."}},{"name":"min_price","in":"query","required":false,"description":"Minimum asking price in BRL.\n\n**Example:**\n\n    500000","schema":{"type":"number","description":"Minimum asking price in BRL.\n\n**Example:**\n\n    500000"}},{"name":"max_price","in":"query","required":false,"description":"Maximum asking price in BRL.\n\n**Example:**\n\n    2000000","schema":{"type":"number","description":"Maximum asking price in BRL.\n\n**Example:**\n\n    2000000"}},{"name":"min_area","in":"query","required":false,"description":"Minimum area in m².\n\n**Example:**\n\n    70","schema":{"type":"number","description":"Minimum area in m².\n\n**Example:**\n\n    70"}},{"name":"max_area","in":"query","required":false,"description":"Maximum area in m².\n\n**Example:**\n\n    150","schema":{"type":"number","description":"Maximum area in m².\n\n**Example:**\n\n    150"}},{"name":"min_bedrooms","in":"query","required":false,"description":"Minimum bedroom count.\n\n**Example:**\n\n    3","schema":{"type":"number","description":"Minimum bedroom count.\n\n**Example:**\n\n    3"}},{"name":"min_bathrooms","in":"query","required":false,"description":"Minimum bathroom count.\n\n**Example:**\n\n    2","schema":{"type":"number","description":"Minimum bathroom count.\n\n**Example:**\n\n    2"}},{"name":"min_parking","in":"query","required":false,"description":"Minimum parking spaces.\n\n**Example:**\n\n    1","schema":{"type":"number","description":"Minimum parking spaces.\n\n**Example:**\n\n    1"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"iptu":{"type":"integer"},"floor":{"type":"integer"},"price":{"type":"integer"},"state":{"type":"string"},"title":{"type":"string"},"suites":{"type":"integer"},"address":{"type":"string"},"area_m2":{"type":"integer"},"area_max":{"nullable":true},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"operation":{"type":"string"},"price_max":{"nullable":true},"state_code":{"type":"string"},"condominium":{"type":"integer"},"neighborhood":{"type":"string"},"price_per_m2":{"type":"integer"},"price_period":{"nullable":true},"published_at":{"type":"string"},"property_type":{"type":"string"},"thumbnail_url":{"type":"string"},"parking_spaces":{"type":"integer"},"publisher_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Apartments for sale in São Paulo":{"value":{"results":[{"id":"2912096343","url":"https://www.zapimoveis.com.br/imovel/venda-apartamento-3-quartos-mobiliado-jardim-paulista-zona-sul-sao-paulo-sp-170m2-id-2912096343/","city":"São Paulo","iptu":800,"floor":9,"price":2500000,"state":"São Paulo","title":"Apartamento para comprar com 170 m², 3 quartos, 3 banheiros, 2 vagas","suites":1,"address":"Alameda Joaquim Eugênio de Lima","area_m2":170,"area_max":null,"bedrooms":3,"currency":"BRL","latitude":-23.571,"bathrooms":3,"longitude":-46.656,"operation":"sale","price_max":null,"state_code":"SP","condominium":3300,"neighborhood":"Jardim Paulista","price_per_m2":14706,"price_period":null,"published_at":"2021-06-04T20:57:05Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/ab361b6c58c7374a2d3ddb8893e24c4f/apartamento-com-3-quartos-a-venda-170m-no-jardim-paulista-sao-paulo.webp?action=fit-in&dimension=614x297","parking_spaces":2,"publisher_name":"Paulo Roberto Leardi"},{"id":"2856335837","url":"https://www.zapimoveis.com.br/lancamentos/joya-jardins-id-2856335837/","city":"São Paulo","iptu":null,"floor":0,"price":1707192,"state":"São Paulo","title":"Apartamento para comprar com 57 - 153 m², 1 quarto, 1 banheiro, 1 vaga","suites":1,"address":"Rua da Consolação","area_m2":57,"area_max":153,"bedrooms":1,"currency":"BRL","latitude":-23.558224,"bathrooms":1,"longitude":-46.665412,"operation":"sale","price_max":4740872,"state_code":"SP","condominium":null,"neighborhood":"Cerqueira César","price_per_m2":29951,"price_period":null,"published_at":"2025-03-12T11:42:11Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/dab3db62b3c764fd96d0457e7fcd4431/joya-jardins-no-cerqueira-cesar-sao-paulo.webp?action=fit-in&dimension=614x297","parking_spaces":1,"publisher_name":"Bom Negocio Atividades De Internet Ltda"}],"pagination":{"next":"https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/?pagina=2","page":1,"per_page":30,"total_pages":14528,"total_results":435826}}},"Apartments for rent in Rio de Janeiro":{"value":{"results":[{"id":"2908582541","url":"https://www.zapimoveis.com.br/imovel/aluguel-apartamento-2-quartos-com-piscina-gavea-zona-sul-rio-de-janeiro-rj-71m2-id-2908582541/","city":"Rio de Janeiro","iptu":598,"floor":0,"price":10800,"state":"Rio de Janeiro","title":"Apartamento para alugar com 71 m², 2 quartos, 2 banheiros, 1 vaga","suites":1,"address":"Rua Marquês de São Vicente","area_m2":71,"area_max":null,"bedrooms":2,"currency":"BRL","latitude":-22.978,"bathrooms":2,"longitude":-43.233,"operation":"rent","price_max":null,"state_code":"RJ","condominium":1765,"neighborhood":"Gávea","price_per_m2":152,"price_period":"monthly","published_at":"2021-12-02T12:49:25Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/fe13b29d87b1a8911fd4d65545218846/apartamento-com-2-quartos-para-alugar-71m-no-gavea-rio-de-janeiro.webp?action=fit-in&dimension=614x297","parking_spaces":1,"publisher_name":"Stella Maris Real Estate"},{"id":"2887904208","url":"https://www.zapimoveis.com.br/imovel/aluguel-apartamento-4-quartos-com-piscina-barra-da-tijuca-zona-oeste-rio-de-janeiro-rj-226m2-id-2887904208/","city":"Rio de Janeiro","iptu":907,"floor":0,"price":12000,"state":"Rio de Janeiro","title":"Apartamento para alugar com 226 m², 4 quartos, 4 banheiros, 2 vagas","suites":4,"address":"Rua Coronel Aviador Antônio Arthur Braga","area_m2":226,"area_max":null,"bedrooms":4,"currency":"BRL","latitude":-23.004,"bathrooms":4,"longitude":-43.366,"operation":"rent","price_max":null,"state_code":"RJ","condominium":3900,"neighborhood":"Barra da Tijuca","price_per_m2":53,"price_period":"monthly","published_at":"2018-03-27T15:37:39Z","property_type":"apartment","thumbnail_url":"https://resizedimgs.zapimoveis.com.br/img/vr-listing/a2ad722d269d08f6537ebb271bdbc248/apartamento-com-4-quartos-para-alugar-226m-no-barra-da-tijuca-rio-de-janeiro.webp?action=fit-in&dimension=614x297","parking_spaces":2,"publisher_name":"Jtavares Administradora Ipanema"}],"pagination":{"next":"https://www.zapimoveis.com.br/aluguel/apartamentos/rj+rio-de-janeiro/?pagina=2","page":1,"per_page":30,"total_pages":290,"total_results":8681}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/vestiairecollective/product":{"get":{"summary":"Vestiaire Collective Product","description":"Fetch one Vestiaire Collective listing by product URL. The response is a flat object with price, size, condition, and seller.\n\n**Credit cost:** 2 credits per call","operationId":"get-vestiairecollective-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A vestiairecollective.com product URL ending in the item id and .shtml. The response is one flat listing. price is the number on the page and price_display is that amount as written. A keyword or a search URL returns 400.\n\nProduct URL\n\n```\nhttps://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml\n```","schema":{"type":"string","description":"A vestiairecollective.com product URL ending in the item id and .shtml. The response is one flat listing. price is the number on the page and price_display is that amount as written. A keyword or a search URL returns 400.\n\nProduct URL\n\n```\nhttps://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces the listing with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces the listing with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"sold":{"type":"boolean"},"brand":{"type":"string"},"color":{"type":"string"},"image":{"type":"string"},"model":{"type":"string"},"price":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"material":{"type":"string"},"universe":{"type":"string"},"available":{"type":"boolean"},"brand_url":{"type":"string"},"condition":{"type":"string"},"listed_at":{"type":"string"},"like_count":{"type":"integer"},"negotiable":{"type":"boolean"},"ships_from":{"type":"string"},"description":{"type":"string"},"offer_count":{"type":"integer"},"seller_name":{"type":"string"},"subcategory":{"type":"string"},"seller_badge":{"type":"string"},"price_display":{"type":"string"},"seller_country":{"type":"string"},"parent_category":{"type":"string"},"authentication_included":{"type":"boolean"}}},"examples":{"Blouson en tweed La Petite Veste Noire":{"value":{"id":"73024488","url":"https://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml","name":"Blouson en tweed La Petite Veste Noire","size":"34 FR","sold":false,"brand":"Chanel","color":"Rose","image":"https://images.vestiairecollective.com/images/resized/w=1024,q=75,f=auto,/produit/73024488-1_2.jpg","model":"La Petite Veste Noire","price":1315,"category":"Vestes","currency":"EUR","material":"Tweed","universe":"Femme","available":true,"brand_url":"https://www.vestiairecollective.com/chanel/","condition":"Très bon état","listed_at":"2026-10-30T12:00:51Z","like_count":14,"negotiable":true,"ships_from":"France","description":"Veste pour femme Chanel La Petite Veste Noire en tweed rose. Très bon état. Taille 34 FR.","offer_count":3,"seller_name":"Tina","subcategory":"Blouson","seller_badge":"Expert","price_display":"1315 €","seller_country":"France","parent_category":"Vêtements","authentication_included":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Vestiaire Collective Product","description":"Fetch one Vestiaire Collective listing by product URL. The response is a flat object with price, size, condition, and seller.\n\n**Credit cost:** 2 credits per call","operationId":"post-vestiairecollective-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A vestiairecollective.com product URL ending in the item id and .shtml. The response is one flat listing. price is the number on the page and price_display is that amount as written. A keyword or a search URL returns 400.\n\nProduct URL\n\n```\nhttps://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml\n```","schema":{"type":"string","description":"A vestiairecollective.com product URL ending in the item id and .shtml. The response is one flat listing. price is the number on the page and price_display is that amount as written. A keyword or a search URL returns 400.\n\nProduct URL\n\n```\nhttps://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces the listing with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces the listing with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"sold":{"type":"boolean"},"brand":{"type":"string"},"color":{"type":"string"},"image":{"type":"string"},"model":{"type":"string"},"price":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"material":{"type":"string"},"universe":{"type":"string"},"available":{"type":"boolean"},"brand_url":{"type":"string"},"condition":{"type":"string"},"listed_at":{"type":"string"},"like_count":{"type":"integer"},"negotiable":{"type":"boolean"},"ships_from":{"type":"string"},"description":{"type":"string"},"offer_count":{"type":"integer"},"seller_name":{"type":"string"},"subcategory":{"type":"string"},"seller_badge":{"type":"string"},"price_display":{"type":"string"},"seller_country":{"type":"string"},"parent_category":{"type":"string"},"authentication_included":{"type":"boolean"}}},"examples":{"Blouson en tweed La Petite Veste Noire":{"value":{"id":"73024488","url":"https://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml","name":"Blouson en tweed La Petite Veste Noire","size":"34 FR","sold":false,"brand":"Chanel","color":"Rose","image":"https://images.vestiairecollective.com/images/resized/w=1024,q=75,f=auto,/produit/73024488-1_2.jpg","model":"La Petite Veste Noire","price":1315,"category":"Vestes","currency":"EUR","material":"Tweed","universe":"Femme","available":true,"brand_url":"https://www.vestiairecollective.com/chanel/","condition":"Très bon état","listed_at":"2026-10-30T12:00:51Z","like_count":14,"negotiable":true,"ships_from":"France","description":"Veste pour femme Chanel La Petite Veste Noire en tweed rose. Très bon état. Taille 34 FR.","offer_count":3,"seller_name":"Tina","subcategory":"Blouson","seller_badge":"Expert","price_display":"1315 €","seller_country":"France","parent_category":"Vêtements","authentication_included":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/vestiairecollective/search":{"get":{"summary":"Vestiaire Collective Search","description":"Search Vestiaire Collective by keyword or catalog URL. Each card has brand, name, price, size, and a product link.\n\n**Credit cost:** 2 credits per call","operationId":"get-vestiairecollective-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A keyword or a vestiairecollective.com search or category URL. Empty, another host, or a product URL returns 400. A keyword searches www.vestiairecollective.com. A full URL keeps its host. Each card has price as a number and price_display as the label on the card.\n\nKeyword\n\n```\nchanel\n```\n\nCategory URL\n\n```\nhttps://fr.vestiairecollective.com/sacs-femme/\n```","schema":{"type":"string","description":"A keyword or a vestiairecollective.com search or category URL. Empty, another host, or a product URL returns 400. A keyword searches www.vestiairecollective.com. A full URL keeps its host. Each card has price as a number and price_display as the label on the card.\n\nKeyword\n\n```\nchanel\n```\n\nCategory URL\n\n```\nhttps://fr.vestiairecollective.com/sacs-femme/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1, which has no /p-N/ segment. Page 2 requests /p-2/ and sets pagination.page to 2. pagination.next is the next catalog URL, or null on the last page. A value below 1 returns 400.","schema":{"type":"number","description":"Page number starting at 1. Omit it for page 1, which has no /p-N/ segment. Page 2 requests /p-2/ and sets pagination.page to 2. pagination.next is the next catalog URL, or null on the last page. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"ships_from":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Blouson en tweed La Petite Veste Noire":{"value":{"results":[{"id":"73024488","url":"https://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml","name":"Blouson en tweed La Petite Veste Noire","size":"34 FR","brand":"CHANEL","image":"https://images.vestiairecollective.com/images/resized/w=768,q=75,f=auto,/produit/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488-1_2.jpg","price":1315,"currency":"EUR","ships_from":"France","price_display":"1315 €"}],"pagination":{"next":"https://www.vestiairecollective.com/search/p-2/?q=chanel","page":1,"per_page":15,"total_pages":null,"total_results":999}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Vestiaire Collective Search","description":"Search Vestiaire Collective by keyword or catalog URL. Each card has brand, name, price, size, and a product link.\n\n**Credit cost:** 2 credits per call","operationId":"post-vestiairecollective-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A keyword or a vestiairecollective.com search or category URL. Empty, another host, or a product URL returns 400. A keyword searches www.vestiairecollective.com. A full URL keeps its host. Each card has price as a number and price_display as the label on the card.\n\nKeyword\n\n```\nchanel\n```\n\nCategory URL\n\n```\nhttps://fr.vestiairecollective.com/sacs-femme/\n```","schema":{"type":"string","description":"A keyword or a vestiairecollective.com search or category URL. Empty, another host, or a product URL returns 400. A keyword searches www.vestiairecollective.com. A full URL keeps its host. Each card has price as a number and price_display as the label on the card.\n\nKeyword\n\n```\nchanel\n```\n\nCategory URL\n\n```\nhttps://fr.vestiairecollective.com/sacs-femme/\n```"}},{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Omit it for page 1, which has no /p-N/ segment. Page 2 requests /p-2/ and sets pagination.page to 2. pagination.next is the next catalog URL, or null on the last page. A value below 1 returns 400.","schema":{"type":"number","description":"Page number starting at 1. Omit it for page 1, which has no /p-N/ segment. Page 2 requests /p-2/ and sets pagination.page to 2. pagination.next is the next catalog URL, or null on the last page. A value below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Default false. true replaces results and pagination with result, the rendered HTML.","schema":{"type":"boolean","description":"Default false. true replaces results and pagination with result, the rendered HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"currency":{"type":"string"},"ships_from":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Blouson en tweed La Petite Veste Noire":{"value":{"results":[{"id":"73024488","url":"https://www.vestiairecollective.com/vetements-femme/vestes/chanel/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488.shtml","name":"Blouson en tweed La Petite Veste Noire","size":"34 FR","brand":"CHANEL","image":"https://images.vestiairecollective.com/images/resized/w=768,q=75,f=auto,/produit/vesteblouson-chanel-la-petite-veste-noire-en-tweed-rose-73024488-1_2.jpg","price":1315,"currency":"EUR","ships_from":"France","price_display":"1315 €"}],"pagination":{"next":"https://www.vestiairecollective.com/search/p-2/?q=chanel","page":1,"per_page":15,"total_pages":null,"total_results":999}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/rightmove/search":{"get":{"summary":"Rightmove Search","description":"Search Rightmove by a UK place name or a search URL. Each card has a numeric price, a price label rebuilt from that number, the address, the agent, and a property URL.\n\n**Credit cost:** 2 credits per call","operationId":"get-rightmove-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"UK place name or a Rightmove search URL.\n\n**Example (place):**\n\n    Bristol\n\n**Example (search URL):**\n\n    https://www.rightmove.co.uk/property-for-sale/Bristol.html\n\n**Allowed:** any UK place Rightmove can slug, or a property-for-sale / property-to-rent / student search URL.\n\n**Default:** none. Required.\n\n**JSON:** a place opens property-for-sale. Cards then have channel BUY and transaction_type buy. A property-to-rent URL sets channel RENT, transaction_type rent, and price_frequency to pcm or pw when the card shows a rent period. results[].url is the link for /v2/rightmove/property. A /properties/{id} URL returns 400.","schema":{"type":"string","description":"UK place name or a Rightmove search URL.\n\n**Example (place):**\n\n    Bristol\n\n**Example (search URL):**\n\n    https://www.rightmove.co.uk/property-for-sale/Bristol.html\n\n**Allowed:** any UK place Rightmove can slug, or a property-for-sale / property-to-rent / student search URL.\n\n**Default:** none. Required.\n\n**JSON:** a place opens property-for-sale. Cards then have channel BUY and transaction_type buy. A property-to-rent URL sets channel RENT, transaction_type rent, and price_frequency to pcm or pw when the card shows a rent period. results[].url is the link for /v2/rightmove/property. A /properties/{id} URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Results page, from 1.\n\n**Example:**\n\n    2\n\n**Default:** omitted. The URL is fetched as written and pagination.page comes from that page.\n\n**JSON:** 1 sends index=0. 2 sends index=24 (24 results per page). pagination.page becomes that number. pagination.next is the next Rightmove URL, or null on the last page. Overrides index already on the URL.","schema":{"type":"number","description":"Results page, from 1.\n\n**Example:**\n\n    2\n\n**Default:** omitted. The URL is fetched as written and pagination.page comes from that page.\n\n**JSON:** 1 sends index=0. 2 sends index=24 (24 results per page). pagination.page becomes that number. pagination.next is the next Rightmove URL, or null on the last page. Overrides index already on the URL."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}}},"image":{"type":"string"},"price":{"type":"integer"},"tenure":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"summary":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"featured":{"type":"boolean"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"floor_area":{"type":"string"},"image_count":{"type":"integer"},"key_features":{"type":"array","items":{"type":"string"}},"price_display":{"type":"string"},"property_type":{"type":"string"},"listing_update":{"type":"string"},"price_frequency":{"nullable":true},"price_qualifier":{"nullable":true},"transaction_type":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Talbot Road, Notting Hill":{"value":{"results":[{"id":94960389,"url":"https://www.rightmove.co.uk/properties/94960389","agent":{"url":"https://www.rightmove.co.uk/estate-agents/agent/Kinleigh-Folkard-and-Hayward---Sales/Bayswater-55390.html","name":"Kinleigh Folkard & Hayward - Sales, Bayswater","phone":"020 3835 4072"},"image":"https://media.rightmove.co.uk/dir/crop/10:9-16:9/property-photo/2451b1f09/94960389/2451b1f09818a2091af4d44c668814d9_max_476x317.jpeg","price":550000,"tenure":"SHARE_OF_FREEHOLD","address":"Talbot Road, Notting Hill, London, W2","channel":"BUY","summary":"Talbot Road is one of the most desirable streets in the area, positioned between the vibrant neighbourhoods of Notting Hill and Bayswater. Residents enjoy immediate access to an outstanding selection of independent cafés, restaurants, boutiques, and local amenities, while the world-renowne...","bedrooms":1,"currency":"GBP","featured":false,"latitude":51.517913,"bathrooms":1,"longitude":-0.193037,"floor_area":"389 sq. ft.","image_count":8,"key_features":["One bedroom apartment","Private balcony","Excellent transport links","Chain free"],"price_display":"£550,000","property_type":"Flat","listing_update":"Added today","price_frequency":null,"price_qualifier":null,"transaction_type":"buy"}],"pagination":{"next":"https://www.rightmove.co.uk/property-for-sale/London-87490.html?index=24","page":1,"per_page":24,"total_pages":42,"total_results":59708}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Rightmove Search","description":"Search Rightmove by a UK place name or a search URL. Each card has a numeric price, a price label rebuilt from that number, the address, the agent, and a property URL.\n\n**Credit cost:** 2 credits per call","operationId":"post-rightmove-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"UK place name or a Rightmove search URL.\n\n**Example (place):**\n\n    Bristol\n\n**Example (search URL):**\n\n    https://www.rightmove.co.uk/property-for-sale/Bristol.html\n\n**Allowed:** any UK place Rightmove can slug, or a property-for-sale / property-to-rent / student search URL.\n\n**Default:** none. Required.\n\n**JSON:** a place opens property-for-sale. Cards then have channel BUY and transaction_type buy. A property-to-rent URL sets channel RENT, transaction_type rent, and price_frequency to pcm or pw when the card shows a rent period. results[].url is the link for /v2/rightmove/property. A /properties/{id} URL returns 400.","schema":{"type":"string","description":"UK place name or a Rightmove search URL.\n\n**Example (place):**\n\n    Bristol\n\n**Example (search URL):**\n\n    https://www.rightmove.co.uk/property-for-sale/Bristol.html\n\n**Allowed:** any UK place Rightmove can slug, or a property-for-sale / property-to-rent / student search URL.\n\n**Default:** none. Required.\n\n**JSON:** a place opens property-for-sale. Cards then have channel BUY and transaction_type buy. A property-to-rent URL sets channel RENT, transaction_type rent, and price_frequency to pcm or pw when the card shows a rent period. results[].url is the link for /v2/rightmove/property. A /properties/{id} URL returns 400."}},{"name":"page","in":"query","required":false,"description":"Results page, from 1.\n\n**Example:**\n\n    2\n\n**Default:** omitted. The URL is fetched as written and pagination.page comes from that page.\n\n**JSON:** 1 sends index=0. 2 sends index=24 (24 results per page). pagination.page becomes that number. pagination.next is the next Rightmove URL, or null on the last page. Overrides index already on the URL.","schema":{"type":"number","description":"Results page, from 1.\n\n**Example:**\n\n    2\n\n**Default:** omitted. The URL is fetched as written and pagination.page comes from that page.\n\n**JSON:** 1 sends index=0. 2 sends index=24 (24 results per page). pagination.page becomes that number. pagination.next is the next Rightmove URL, or null on the last page. Overrides index already on the URL."}},{"name":"return_page_source","in":"query","required":false,"description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields.","schema":{"type":"boolean","default":"false","description":"Optional. Default false.\n\nfalse returns the parsed JSON described below.\ntrue returns {\"result\": \"<page source>\"} and omits results, pagination, and listing fields."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}}},"image":{"type":"string"},"price":{"type":"integer"},"tenure":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"summary":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"featured":{"type":"boolean"},"latitude":{"type":"number"},"bathrooms":{"type":"integer"},"longitude":{"type":"number"},"floor_area":{"type":"string"},"image_count":{"type":"integer"},"key_features":{"type":"array","items":{"type":"string"}},"price_display":{"type":"string"},"property_type":{"type":"string"},"listing_update":{"type":"string"},"price_frequency":{"nullable":true},"price_qualifier":{"nullable":true},"transaction_type":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Talbot Road, Notting Hill":{"value":{"results":[{"id":94960389,"url":"https://www.rightmove.co.uk/properties/94960389","agent":{"url":"https://www.rightmove.co.uk/estate-agents/agent/Kinleigh-Folkard-and-Hayward---Sales/Bayswater-55390.html","name":"Kinleigh Folkard & Hayward - Sales, Bayswater","phone":"020 3835 4072"},"image":"https://media.rightmove.co.uk/dir/crop/10:9-16:9/property-photo/2451b1f09/94960389/2451b1f09818a2091af4d44c668814d9_max_476x317.jpeg","price":550000,"tenure":"SHARE_OF_FREEHOLD","address":"Talbot Road, Notting Hill, London, W2","channel":"BUY","summary":"Talbot Road is one of the most desirable streets in the area, positioned between the vibrant neighbourhoods of Notting Hill and Bayswater. Residents enjoy immediate access to an outstanding selection of independent cafés, restaurants, boutiques, and local amenities, while the world-renowne...","bedrooms":1,"currency":"GBP","featured":false,"latitude":51.517913,"bathrooms":1,"longitude":-0.193037,"floor_area":"389 sq. ft.","image_count":8,"key_features":["One bedroom apartment","Private balcony","Excellent transport links","Chain free"],"price_display":"£550,000","property_type":"Flat","listing_update":"Added today","price_frequency":null,"price_qualifier":null,"transaction_type":"buy"}],"pagination":{"next":"https://www.rightmove.co.uk/property-for-sale/London-87490.html?index=24","page":1,"per_page":24,"total_pages":42,"total_results":59708}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/realtor/property":{"get":{"summary":"Realtor Property","description":"Extract full property details from a Realtor.com listing URL, including price, specs, photos, agents, features, and location data.\n\n**Credit cost:** 2 credits per call","operationId":"get-realtor-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Realtor.com property detail URL.\n\n**Example:**\n\n    https://www.realtor.com/realestateandhomes-detail/1492-E-57th-St_Brooklyn_NY_11234_M46117-61190\n\n**Notes:**\n- Only Realtor.com `/realestateandhomes-detail/` URLs are accepted.\n- Copy the listing URL from search results or from realtor.com.","schema":{"type":"string","description":"Full Realtor.com property detail URL.\n\n**Example:**\n\n    https://www.realtor.com/realestateandhomes-detail/1492-E-57th-St_Brooklyn_NY_11234_M46117-61190\n\n**Notes:**\n- Only Realtor.com `/realestateandhomes-detail/` URLs are accepted.\n- Copy the listing URL from search results or from realtor.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}},"agent":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"agent_id":{"type":"string"},"office_id":{"type":"string"},"agent_name":{"nullable":true},"agent_email":{"type":"string"},"agent_phone":{"nullable":true},"office_name":{"type":"string"},"office_phone":{"nullable":true}}}},"flags":{"type":"object","properties":{"is_auction":{"nullable":true},"is_pending":{"type":"boolean"},"is_contingent":{"nullable":true},"is_non_deeded":{"nullable":true},"is_short_sale":{"nullable":true},"is_coming_soon":{"nullable":true},"is_foreclosure":{"nullable":true},"is_new_listing":{"type":"boolean"},"is_subdivision":{"nullable":true},"is_price_reduced":{"nullable":true},"is_usda_eligible":{"type":"boolean"},"is_new_construction":{"nullable":true},"is_fractionally_owned":{"nullable":true},"is_price_excludes_land":{"nullable":true}}},"local":{"nullable":true},"phones":{"type":"array","items":{}},"photos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"status":{"type":"string"},"details":{"type":"object","properties":{"beds":{"type":"integer"},"logo":{"nullable":true},"name":{"nullable":true},"pool":{"nullable":true},"sqft":{"nullable":true},"text":{"type":"string"},"type":{"type":"string"},"rooms":{"nullable":true},"units":{"nullable":true},"garage":{"nullable":true},"styles":{"nullable":true},"zoning":{"nullable":true},"cooling":{"nullable":true},"heating":{"nullable":true},"roofing":{"nullable":true},"stories":{"nullable":true},"beds_max":{"nullable":true},"beds_min":{"nullable":true},"exterior":{"nullable":true},"lot_sqft":{"type":"integer"},"sqft_max":{"nullable":true},"sqft_min":{"nullable":true},"sub_type":{"nullable":true},"baths_max":{"nullable":true},"baths_min":{"nullable":true},"fireplace":{"nullable":true},"baths_3qtr":{"type":"integer"},"baths_full":{"type":"integer"},"baths_half":{"nullable":true},"garage_max":{"nullable":true},"garage_min":{"nullable":true},"year_built":{"nullable":true},"baths_total":{"nullable":true},"garage_type":{"nullable":true},"construction":{"nullable":true},"year_renovated":{"nullable":true},"baths_consolidated":{"type":"string"}}},"history":{"nullable":true},"features":{"type":"object","properties":{"bedrooms":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"array","items":{"type":"string"}},"land _info":{"type":"array","items":{"type":"string"}},"other _rooms":{"type":"array","items":{"type":"string"}},"interior _features":{"type":"array","items":{"type":"string"}},"garage and _parking":{"type":"array","items":{"type":"string"}},"heating and _cooling":{"type":"array","items":{"type":"string"}},"other _property _info":{"type":"array","items":{"type":"string"}},"building and _construction":{"type":"array","items":{"type":"string"}},"exterior and _lot _features":{"type":"array","items":{"type":"string"}}}},"location":{"type":"object","properties":{"city":{"type":"object","properties":{"slug_id":{"type":"string"},"county_needed_for_uniq":{"type":"boolean"}}},"county":{"type":"object","properties":{"name":{"type":"string"},"fips_code":{"type":"string"},"state_code":{"type":"string"}}},"address":{"type":"object","properties":{"city":{"type":"string"},"line":{"type":"string"},"unit":{"nullable":true},"state":{"type":"string"},"country":{"type":"string"},"coordinate":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"state_code":{"type":"string"},"postal_code":{"type":"string"},"street_name":{"type":"string"},"street_number":{"type":"string"},"street_suffix":{"type":"string"},"validation_code":{"type":"string"},"street_direction":{"type":"string"},"street_post_direction":{"nullable":true}}},"postal_code":{"type":"object","properties":{"geo_statistics":{"type":"object","properties":{"housing_market":{"type":"object","properties":{"hot_market_badge":{"type":"string"}}}}}}},"search_areas":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"state_code":{"type":"string"}}}},"neighborhoods":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"street_view_url":{"type":"string"},"street_view_metadata_url":{"type":"string"}}},"list_date":{"type":"string"},"sold_date":{"type":"string"},"list_price":{"type":"integer"},"sold_price":{"type":"integer"},"advertisers":{"type":"array","items":{"type":"object","properties":{"href":{"nullable":true},"name":{"type":"string"},"team":{"nullable":true},"type":{"type":"string"},"email":{"type":"string"},"photo":{"nullable":true},"broker":{"type":"object","properties":{"logo":{"nullable":true},"name":{"nullable":true},"accent_color":{"nullable":true},"designations":{"type":"array","items":{}},"fulfillment_id":{"type":"string"}}},"office":{"type":"object","properties":{"href":{"nullable":true},"name":{"type":"string"},"email":{"type":"string"},"hours":{"nullable":true},"photo":{"nullable":true},"phones":{"nullable":true},"slogan":{"nullable":true},"address":{"type":"object","properties":{"city":{"nullable":true},"line":{"nullable":true},"state":{"nullable":true},"country":{"nullable":true},"coordinate":{"nullable":true},"state_code":{"nullable":true},"postal_code":{"nullable":true}}},"mls_set":{"type":"string"},"lead_email":{"nullable":true},"fulfillment_id":{"type":"string"},"application_url":{"nullable":true},"out_of_community":{"nullable":true}}},"phones":{"type":"array","items":{"type":"object","properties":{"ext":{"nullable":true},"type":{"type":"string"},"number":{"type":"string"},"primary":{"type":"boolean"},"trackable":{"nullable":true}}}},"slogan":{"nullable":true},"address":{"type":"object","properties":{"city":{"nullable":true},"line":{"nullable":true},"state":{"nullable":true},"country":{"nullable":true},"state_code":{"nullable":true},"postal_code":{"nullable":true}}},"builder":{"nullable":true},"mls_set":{"type":"string"},"nrds_id":{"nullable":true},"state_license":{"nullable":true},"fulfillment_id":{"type":"string"}}}},"tax_history":{"nullable":true},"list_price_last_change":{"nullable":true}}},"examples":{"Lookup 1492 E 57th St, Brooklyn":{"value":{"id":"2994403623","url":"https://www.realtor.com/realestateandhomes-detail/1492-E-57th-St_Brooklyn_NY_11234_M46117-61190","slug":"1492-E-57th-St_Brooklyn_NY_11234_M46117-61190","tags":[{"id":"hardwood_floors","label":"Hardwood floors"},{"id":"central_air","label":"Central air"}],"agent":[{"id":"BONY","type":"seller","agent_id":"YB6416","office_id":"117980","agent_name":null,"agent_email":"name@example.com","agent_phone":null,"office_name":"Remax Top Nest Real Estate","office_phone":null}],"flags":{"is_auction":null,"is_pending":true,"is_contingent":null,"is_non_deeded":null,"is_short_sale":null,"is_coming_soon":null,"is_foreclosure":null,"is_new_listing":false,"is_subdivision":null,"is_price_reduced":null,"is_usda_eligible":false,"is_new_construction":null,"is_fractionally_owned":null,"is_price_excludes_land":null},"local":null,"phones":[],"photos":[{"url":"https://ap.rdcpix.com/3ad76fc1d8db6123926f6cce8a7b838bl-m2523758046s.jpg","tags":["road","porch","nice_house","house_view","front_of_house_view","front_door","exterior","brick_building","complete","red","yard","lawn"]}],"status":"for_sale","details":{"beds":3,"logo":null,"name":null,"pool":null,"sqft":null,"text":"2 Family, semi-attached home being delivered vacant. Act now.","type":"multi_family","rooms":null,"units":null,"garage":null,"styles":null,"zoning":null,"cooling":null,"heating":null,"roofing":null,"stories":null,"beds_max":null,"beds_min":null,"exterior":null,"lot_sqft":1800,"sqft_max":null,"sqft_min":null,"sub_type":null,"baths_max":null,"baths_min":null,"fireplace":null,"baths_3qtr":1,"baths_full":1,"baths_half":null,"garage_max":null,"garage_min":null,"year_built":null,"baths_total":null,"garage_type":null,"construction":null,"year_renovated":null,"baths_consolidated":"2"},"history":null,"features":{"bedrooms":["Bedrooms: 3"],"bathrooms":["Full Bathrooms: 1","3/4 Bathrooms: 1"],"land _info":["Lot Size Acres: 0.0413223","Lot Size Square Feet: 1800"],"other _rooms":["Basement Features: Finished, Full"],"interior _features":["A/C Unit","Flooring: Hardwood"],"garage and _parking":["Parking Features: 1 Space, Shared Drive"],"heating and _cooling":["Cooling Features: 4, AC Units: 4","Heating Fuel: Gas"],"other _property _info":["Source Listing Status: Pending","County: Kings (Brooklyn)","Cross Street: Avenue M","Source Property Type: Residential","Area: Flatlands","Source Neighborhood: Flatlands","Property Subtype: Multi-Family"],"building and _construction":["Building Exterior Type: Brick","Construction Materials: Brick","Roof: Shingle","Structure Type: Semi-Detached"],"exterior and _lot _features":["Yard: Back"]},"location":{"city":{"slug_id":"Brooklyn_NY","county_needed_for_uniq":false},"county":{"name":"Kings","fips_code":"36047","state_code":"NY"},"address":{"city":"Brooklyn","line":"1492 E 57th St","unit":null,"state":"New York","country":"USA","coordinate":{"lat":40.617188,"lon":-73.920186},"state_code":"NY","postal_code":"11234","street_name":"57th","street_number":"1492","street_suffix":"St","validation_code":"121","street_direction":"E","street_post_direction":null},"postal_code":{"geo_statistics":{"housing_market":{"hot_market_badge":"Other"}}},"search_areas":[{"city":"brooklyn","state_code":"ny"},{"city":"new york","state_code":"ny"},{"city":"new york city","state_code":"ny"}],"neighborhoods":[{"name":"Flatlands"},{"name":"Southeastern Brooklyn"}],"street_view_url":"https://maps.googleapis.com/maps/api/streetview?channel=rdc-streetview&key=AIzaSyAP_xs30yS0J4xp8O1ZKUrUttIXKklrwaM&location=1492%20E%2057th%20St%2C%20Brooklyn%2C%20NY%2011234&size=950x428&source=outdoor&signature=r_CkqfMsaJMfaF_JBhICUY9jzX8=","street_view_metadata_url":"https://maps.googleapis.com/maps/api/streetview/metadata?channel=rdc-streetview&key=AIzaSyAP_xs30yS0J4xp8O1ZKUrUttIXKklrwaM&location=1492%20E%2057th%20St%2C%20Brooklyn%2C%20NY%2011234&size=640x480&source=outdoor&signature=Id5j65U6SnYs6YaBLxxB6RZsUvw="},"list_date":"2026-04-22T21:24:51Z","sold_date":"1998-03-11","list_price":500000,"sold_price":175000,"advertisers":[{"href":null,"name":"Alex Martin","team":null,"type":"seller","email":"alex.martin@example.com","photo":null,"broker":{"logo":null,"name":null,"accent_color":null,"designations":[],"fulfillment_id":"0"},"office":{"href":null,"name":"Top Nest Inc","email":"jordan.lee@example.com","hours":null,"photo":null,"phones":null,"slogan":null,"address":{"city":null,"line":null,"state":null,"country":null,"coordinate":null,"state_code":null,"postal_code":null},"mls_set":"O-BONY-117980","lead_email":null,"fulfillment_id":"0","application_url":null,"out_of_community":null},"phones":[{"ext":null,"type":"BUSINESS_MOBILE","number":"555-0100","primary":true,"trackable":null}],"slogan":null,"address":{"city":null,"line":null,"state":null,"country":null,"state_code":null,"postal_code":null},"builder":null,"mls_set":"A-BONY-YB6416","nrds_id":null,"state_license":null,"fulfillment_id":"100086239"}],"tax_history":null,"list_price_last_change":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Realtor Property","description":"Extract full property details from a Realtor.com listing URL, including price, specs, photos, agents, features, and location data.\n\n**Credit cost:** 2 credits per call","operationId":"post-realtor-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Realtor.com property detail URL.\n\n**Example:**\n\n    https://www.realtor.com/realestateandhomes-detail/1492-E-57th-St_Brooklyn_NY_11234_M46117-61190\n\n**Notes:**\n- Only Realtor.com `/realestateandhomes-detail/` URLs are accepted.\n- Copy the listing URL from search results or from realtor.com.","schema":{"type":"string","description":"Full Realtor.com property detail URL.\n\n**Example:**\n\n    https://www.realtor.com/realestateandhomes-detail/1492-E-57th-St_Brooklyn_NY_11234_M46117-61190\n\n**Notes:**\n- Only Realtor.com `/realestateandhomes-detail/` URLs are accepted.\n- Copy the listing URL from search results or from realtor.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}},"agent":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"agent_id":{"type":"string"},"office_id":{"type":"string"},"agent_name":{"nullable":true},"agent_email":{"type":"string"},"agent_phone":{"nullable":true},"office_name":{"type":"string"},"office_phone":{"nullable":true}}}},"flags":{"type":"object","properties":{"is_auction":{"nullable":true},"is_pending":{"type":"boolean"},"is_contingent":{"nullable":true},"is_non_deeded":{"nullable":true},"is_short_sale":{"nullable":true},"is_coming_soon":{"nullable":true},"is_foreclosure":{"nullable":true},"is_new_listing":{"type":"boolean"},"is_subdivision":{"nullable":true},"is_price_reduced":{"nullable":true},"is_usda_eligible":{"type":"boolean"},"is_new_construction":{"nullable":true},"is_fractionally_owned":{"nullable":true},"is_price_excludes_land":{"nullable":true}}},"local":{"nullable":true},"phones":{"type":"array","items":{}},"photos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"status":{"type":"string"},"details":{"type":"object","properties":{"beds":{"type":"integer"},"logo":{"nullable":true},"name":{"nullable":true},"pool":{"nullable":true},"sqft":{"nullable":true},"text":{"type":"string"},"type":{"type":"string"},"rooms":{"nullable":true},"units":{"nullable":true},"garage":{"nullable":true},"styles":{"nullable":true},"zoning":{"nullable":true},"cooling":{"nullable":true},"heating":{"nullable":true},"roofing":{"nullable":true},"stories":{"nullable":true},"beds_max":{"nullable":true},"beds_min":{"nullable":true},"exterior":{"nullable":true},"lot_sqft":{"type":"integer"},"sqft_max":{"nullable":true},"sqft_min":{"nullable":true},"sub_type":{"nullable":true},"baths_max":{"nullable":true},"baths_min":{"nullable":true},"fireplace":{"nullable":true},"baths_3qtr":{"type":"integer"},"baths_full":{"type":"integer"},"baths_half":{"nullable":true},"garage_max":{"nullable":true},"garage_min":{"nullable":true},"year_built":{"nullable":true},"baths_total":{"nullable":true},"garage_type":{"nullable":true},"construction":{"nullable":true},"year_renovated":{"nullable":true},"baths_consolidated":{"type":"string"}}},"history":{"nullable":true},"features":{"type":"object","properties":{"bedrooms":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"array","items":{"type":"string"}},"land _info":{"type":"array","items":{"type":"string"}},"other _rooms":{"type":"array","items":{"type":"string"}},"interior _features":{"type":"array","items":{"type":"string"}},"garage and _parking":{"type":"array","items":{"type":"string"}},"heating and _cooling":{"type":"array","items":{"type":"string"}},"other _property _info":{"type":"array","items":{"type":"string"}},"building and _construction":{"type":"array","items":{"type":"string"}},"exterior and _lot _features":{"type":"array","items":{"type":"string"}}}},"location":{"type":"object","properties":{"city":{"type":"object","properties":{"slug_id":{"type":"string"},"county_needed_for_uniq":{"type":"boolean"}}},"county":{"type":"object","properties":{"name":{"type":"string"},"fips_code":{"type":"string"},"state_code":{"type":"string"}}},"address":{"type":"object","properties":{"city":{"type":"string"},"line":{"type":"string"},"unit":{"nullable":true},"state":{"type":"string"},"country":{"type":"string"},"coordinate":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"state_code":{"type":"string"},"postal_code":{"type":"string"},"street_name":{"type":"string"},"street_number":{"type":"string"},"street_suffix":{"type":"string"},"validation_code":{"type":"string"},"street_direction":{"type":"string"},"street_post_direction":{"nullable":true}}},"postal_code":{"type":"object","properties":{"geo_statistics":{"type":"object","properties":{"housing_market":{"type":"object","properties":{"hot_market_badge":{"type":"string"}}}}}}},"search_areas":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"state_code":{"type":"string"}}}},"neighborhoods":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"street_view_url":{"type":"string"},"street_view_metadata_url":{"type":"string"}}},"list_date":{"type":"string"},"sold_date":{"type":"string"},"list_price":{"type":"integer"},"sold_price":{"type":"integer"},"advertisers":{"type":"array","items":{"type":"object","properties":{"href":{"nullable":true},"name":{"type":"string"},"team":{"nullable":true},"type":{"type":"string"},"email":{"type":"string"},"photo":{"nullable":true},"broker":{"type":"object","properties":{"logo":{"nullable":true},"name":{"nullable":true},"accent_color":{"nullable":true},"designations":{"type":"array","items":{}},"fulfillment_id":{"type":"string"}}},"office":{"type":"object","properties":{"href":{"nullable":true},"name":{"type":"string"},"email":{"type":"string"},"hours":{"nullable":true},"photo":{"nullable":true},"phones":{"nullable":true},"slogan":{"nullable":true},"address":{"type":"object","properties":{"city":{"nullable":true},"line":{"nullable":true},"state":{"nullable":true},"country":{"nullable":true},"coordinate":{"nullable":true},"state_code":{"nullable":true},"postal_code":{"nullable":true}}},"mls_set":{"type":"string"},"lead_email":{"nullable":true},"fulfillment_id":{"type":"string"},"application_url":{"nullable":true},"out_of_community":{"nullable":true}}},"phones":{"type":"array","items":{"type":"object","properties":{"ext":{"nullable":true},"type":{"type":"string"},"number":{"type":"string"},"primary":{"type":"boolean"},"trackable":{"nullable":true}}}},"slogan":{"nullable":true},"address":{"type":"object","properties":{"city":{"nullable":true},"line":{"nullable":true},"state":{"nullable":true},"country":{"nullable":true},"state_code":{"nullable":true},"postal_code":{"nullable":true}}},"builder":{"nullable":true},"mls_set":{"type":"string"},"nrds_id":{"nullable":true},"state_license":{"nullable":true},"fulfillment_id":{"type":"string"}}}},"tax_history":{"nullable":true},"list_price_last_change":{"nullable":true}}},"examples":{"Lookup 1492 E 57th St, Brooklyn":{"value":{"id":"2994403623","url":"https://www.realtor.com/realestateandhomes-detail/1492-E-57th-St_Brooklyn_NY_11234_M46117-61190","slug":"1492-E-57th-St_Brooklyn_NY_11234_M46117-61190","tags":[{"id":"hardwood_floors","label":"Hardwood floors"},{"id":"central_air","label":"Central air"}],"agent":[{"id":"BONY","type":"seller","agent_id":"YB6416","office_id":"117980","agent_name":null,"agent_email":"name@example.com","agent_phone":null,"office_name":"Remax Top Nest Real Estate","office_phone":null}],"flags":{"is_auction":null,"is_pending":true,"is_contingent":null,"is_non_deeded":null,"is_short_sale":null,"is_coming_soon":null,"is_foreclosure":null,"is_new_listing":false,"is_subdivision":null,"is_price_reduced":null,"is_usda_eligible":false,"is_new_construction":null,"is_fractionally_owned":null,"is_price_excludes_land":null},"local":null,"phones":[],"photos":[{"url":"https://ap.rdcpix.com/3ad76fc1d8db6123926f6cce8a7b838bl-m2523758046s.jpg","tags":["road","porch","nice_house","house_view","front_of_house_view","front_door","exterior","brick_building","complete","red","yard","lawn"]}],"status":"for_sale","details":{"beds":3,"logo":null,"name":null,"pool":null,"sqft":null,"text":"2 Family, semi-attached home being delivered vacant. Act now.","type":"multi_family","rooms":null,"units":null,"garage":null,"styles":null,"zoning":null,"cooling":null,"heating":null,"roofing":null,"stories":null,"beds_max":null,"beds_min":null,"exterior":null,"lot_sqft":1800,"sqft_max":null,"sqft_min":null,"sub_type":null,"baths_max":null,"baths_min":null,"fireplace":null,"baths_3qtr":1,"baths_full":1,"baths_half":null,"garage_max":null,"garage_min":null,"year_built":null,"baths_total":null,"garage_type":null,"construction":null,"year_renovated":null,"baths_consolidated":"2"},"history":null,"features":{"bedrooms":["Bedrooms: 3"],"bathrooms":["Full Bathrooms: 1","3/4 Bathrooms: 1"],"land _info":["Lot Size Acres: 0.0413223","Lot Size Square Feet: 1800"],"other _rooms":["Basement Features: Finished, Full"],"interior _features":["A/C Unit","Flooring: Hardwood"],"garage and _parking":["Parking Features: 1 Space, Shared Drive"],"heating and _cooling":["Cooling Features: 4, AC Units: 4","Heating Fuel: Gas"],"other _property _info":["Source Listing Status: Pending","County: Kings (Brooklyn)","Cross Street: Avenue M","Source Property Type: Residential","Area: Flatlands","Source Neighborhood: Flatlands","Property Subtype: Multi-Family"],"building and _construction":["Building Exterior Type: Brick","Construction Materials: Brick","Roof: Shingle","Structure Type: Semi-Detached"],"exterior and _lot _features":["Yard: Back"]},"location":{"city":{"slug_id":"Brooklyn_NY","county_needed_for_uniq":false},"county":{"name":"Kings","fips_code":"36047","state_code":"NY"},"address":{"city":"Brooklyn","line":"1492 E 57th St","unit":null,"state":"New York","country":"USA","coordinate":{"lat":40.617188,"lon":-73.920186},"state_code":"NY","postal_code":"11234","street_name":"57th","street_number":"1492","street_suffix":"St","validation_code":"121","street_direction":"E","street_post_direction":null},"postal_code":{"geo_statistics":{"housing_market":{"hot_market_badge":"Other"}}},"search_areas":[{"city":"brooklyn","state_code":"ny"},{"city":"new york","state_code":"ny"},{"city":"new york city","state_code":"ny"}],"neighborhoods":[{"name":"Flatlands"},{"name":"Southeastern Brooklyn"}],"street_view_url":"https://maps.googleapis.com/maps/api/streetview?channel=rdc-streetview&key=AIzaSyAP_xs30yS0J4xp8O1ZKUrUttIXKklrwaM&location=1492%20E%2057th%20St%2C%20Brooklyn%2C%20NY%2011234&size=950x428&source=outdoor&signature=r_CkqfMsaJMfaF_JBhICUY9jzX8=","street_view_metadata_url":"https://maps.googleapis.com/maps/api/streetview/metadata?channel=rdc-streetview&key=AIzaSyAP_xs30yS0J4xp8O1ZKUrUttIXKklrwaM&location=1492%20E%2057th%20St%2C%20Brooklyn%2C%20NY%2011234&size=640x480&source=outdoor&signature=Id5j65U6SnYs6YaBLxxB6RZsUvw="},"list_date":"2026-04-22T21:24:51Z","sold_date":"1998-03-11","list_price":500000,"sold_price":175000,"advertisers":[{"href":null,"name":"Alex Martin","team":null,"type":"seller","email":"alex.martin@example.com","photo":null,"broker":{"logo":null,"name":null,"accent_color":null,"designations":[],"fulfillment_id":"0"},"office":{"href":null,"name":"Top Nest Inc","email":"jordan.lee@example.com","hours":null,"photo":null,"phones":null,"slogan":null,"address":{"city":null,"line":null,"state":null,"country":null,"coordinate":null,"state_code":null,"postal_code":null},"mls_set":"O-BONY-117980","lead_email":null,"fulfillment_id":"0","application_url":null,"out_of_community":null},"phones":[{"ext":null,"type":"BUSINESS_MOBILE","number":"555-0100","primary":true,"trackable":null}],"slogan":null,"address":{"city":null,"line":null,"state":null,"country":null,"state_code":null,"postal_code":null},"builder":null,"mls_set":"A-BONY-YB6416","nrds_id":null,"state_license":null,"fulfillment_id":"100086239"}],"tax_history":null,"list_price_last_change":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/realtor/search":{"get":{"summary":"Realtor Search","description":"Search Realtor.com listings from a search URL and retrieve prices, beds, baths, sqft, photos, and property metadata.\n\n**Credit cost:** 2 credits per call","operationId":"get-realtor-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Realtor.com search results URL.\n\n**Example 1 (state search):**\n\n    https://www.realtor.com/realestateandhomes-search/New-York_NY\n\n**Example 2 (city search):**\n\n    https://www.realtor.com/realestateandhomes-search/Brooklyn_NY\n\n**Notes:**\n- Only Realtor.com search URLs are accepted.\n- Filters and pagination parameters in the URL are respected.\n- Use each result's `permalink` or property detail URL with the Realtor Property endpoint.","schema":{"type":"string","description":"Full Realtor.com search results URL.\n\n**Example 1 (state search):**\n\n    https://www.realtor.com/realestateandhomes-search/New-York_NY\n\n**Example 2 (city search):**\n\n    https://www.realtor.com/realestateandhomes-search/Brooklyn_NY\n\n**Notes:**\n- Only Realtor.com search URLs are accepted.\n- Filters and pagination parameters in the URL are respected.\n- Use each result's `permalink` or property detail URL with the Realtor Property endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"photos":{"type":"array","items":{"type":"object","properties":{"href":{"type":"string"}}}},"location":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string"},"line":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"}}}}},"permalink":{"type":"string"},"list_price":{"type":"integer"},"description":{"type":"object","properties":{"beds":{"type":"integer"},"sqft":{"type":"integer"},"type":{"type":"string"},"baths":{"type":"integer"},"lot_size":{"type":"integer"}}},"property_id":{"type":"string"}}}}}},"examples":{"Search homes for sale in New York":{"value":{"results":[{"photos":[{"href":"https://ap.rdcpix.com/67dd84d210896e04e1252c2c8bc52c57l-m3226683124s.jpg"}],"location":{"address":{"city":"Brooklyn","line":"299 Troutman St","state":"NY","postal_code":"11237"}},"permalink":"299-Troutman-St_Brooklyn_NY_11237_M99576-61733","list_price":500000,"description":{"beds":16,"sqft":6500,"type":"SingleFamilyResidence","baths":8,"lot_size":2500},"property_id":"9957661733"},{"photos":[{"href":"https://ap.rdcpix.com/eac307cc2348e0014f42e489f57f5d02l-m3092249856s.jpg"}],"location":{"address":{"city":"Bronx","line":"D132 Edgewater Unit D","state":"NY","postal_code":"10465"}},"permalink":"D132-Edgewater-Unit-D_Bronx_NY_10465_M94332-74355","list_price":255000,"description":{"beds":4,"sqft":1200,"type":"SingleFamilyResidence","baths":1,"lot_size":null},"property_id":"9433274355"},{"photos":[{"href":"https://ap.rdcpix.com/77415ad2b4919799a0cb455c54eab3fcl-m2351895655s.jpg"}],"location":{"address":{"city":"New York","line":"2573 Frederick Douglass Blvd Apt A","state":"NY","postal_code":"10030"}},"permalink":"2573-Frederick-Douglass-Blvd-Apt-A_New-York_NY_10030_M92978-65175","list_price":275000,"description":{"beds":2,"sqft":1175,"type":"Apartment","baths":2.5,"lot_size":null},"property_id":"9297865175"},{"photos":[{"href":"https://ap.rdcpix.com/e5f2913192e3c223cc21e05ea213844el-m1072321830s.jpg"}],"location":{"address":{"city":"Woodhaven","line":"86-34 77th St","state":"NY","postal_code":"11421"}},"permalink":"8634-77th-St_Woodhaven_NY_11421_M46500-03200","list_price":603200,"description":{"beds":6,"sqft":null,"type":"SingleFamilyResidence","baths":2,"lot_size":2614},"property_id":"4650003200"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Realtor Search","description":"Search Realtor.com listings from a search URL and retrieve prices, beds, baths, sqft, photos, and property metadata.\n\n**Credit cost:** 2 credits per call","operationId":"post-realtor-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Realtor.com search results URL.\n\n**Example 1 (state search):**\n\n    https://www.realtor.com/realestateandhomes-search/New-York_NY\n\n**Example 2 (city search):**\n\n    https://www.realtor.com/realestateandhomes-search/Brooklyn_NY\n\n**Notes:**\n- Only Realtor.com search URLs are accepted.\n- Filters and pagination parameters in the URL are respected.\n- Use each result's `permalink` or property detail URL with the Realtor Property endpoint.","schema":{"type":"string","description":"Full Realtor.com search results URL.\n\n**Example 1 (state search):**\n\n    https://www.realtor.com/realestateandhomes-search/New-York_NY\n\n**Example 2 (city search):**\n\n    https://www.realtor.com/realestateandhomes-search/Brooklyn_NY\n\n**Notes:**\n- Only Realtor.com search URLs are accepted.\n- Filters and pagination parameters in the URL are respected.\n- Use each result's `permalink` or property detail URL with the Realtor Property endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"photos":{"type":"array","items":{"type":"object","properties":{"href":{"type":"string"}}}},"location":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string"},"line":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"}}}}},"permalink":{"type":"string"},"list_price":{"type":"integer"},"description":{"type":"object","properties":{"beds":{"type":"integer"},"sqft":{"type":"integer"},"type":{"type":"string"},"baths":{"type":"integer"},"lot_size":{"type":"integer"}}},"property_id":{"type":"string"}}}}}},"examples":{"Search homes for sale in New York":{"value":{"results":[{"photos":[{"href":"https://ap.rdcpix.com/67dd84d210896e04e1252c2c8bc52c57l-m3226683124s.jpg"}],"location":{"address":{"city":"Brooklyn","line":"299 Troutman St","state":"NY","postal_code":"11237"}},"permalink":"299-Troutman-St_Brooklyn_NY_11237_M99576-61733","list_price":500000,"description":{"beds":16,"sqft":6500,"type":"SingleFamilyResidence","baths":8,"lot_size":2500},"property_id":"9957661733"},{"photos":[{"href":"https://ap.rdcpix.com/eac307cc2348e0014f42e489f57f5d02l-m3092249856s.jpg"}],"location":{"address":{"city":"Bronx","line":"D132 Edgewater Unit D","state":"NY","postal_code":"10465"}},"permalink":"D132-Edgewater-Unit-D_Bronx_NY_10465_M94332-74355","list_price":255000,"description":{"beds":4,"sqft":1200,"type":"SingleFamilyResidence","baths":1,"lot_size":null},"property_id":"9433274355"},{"photos":[{"href":"https://ap.rdcpix.com/77415ad2b4919799a0cb455c54eab3fcl-m2351895655s.jpg"}],"location":{"address":{"city":"New York","line":"2573 Frederick Douglass Blvd Apt A","state":"NY","postal_code":"10030"}},"permalink":"2573-Frederick-Douglass-Blvd-Apt-A_New-York_NY_10030_M92978-65175","list_price":275000,"description":{"beds":2,"sqft":1175,"type":"Apartment","baths":2.5,"lot_size":null},"property_id":"9297865175"},{"photos":[{"href":"https://ap.rdcpix.com/e5f2913192e3c223cc21e05ea213844el-m1072321830s.jpg"}],"location":{"address":{"city":"Woodhaven","line":"86-34 77th St","state":"NY","postal_code":"11421"}},"permalink":"8634-77th-St_Woodhaven_NY_11421_M46500-03200","list_price":603200,"description":{"beds":6,"sqft":null,"type":"SingleFamilyResidence","baths":2,"lot_size":2614},"property_id":"4650003200"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/immowelt/search":{"get":{"summary":"Immowelt Search","description":"Search Immowelt listings from a search URL and retrieve prices, specs, photos, agency info, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-immowelt-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Immowelt search URL.\n\n**Example 1 (rental search):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1\n\n**Example 2 (legacy liste URL):**\n\n    https://www.immowelt.de/liste/berlin/wohnungen/mieten\n\n**Example 3 (page 2):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1?page=2\n\n**Notes:**\n- Supports `/suche/` and `/liste/` search URLs copied from immowelt.de.\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the Immowelt Property endpoint for full listing data.","schema":{"type":"string","description":"Full Immowelt search URL.\n\n**Example 1 (rental search):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1\n\n**Example 2 (legacy liste URL):**\n\n    https://www.immowelt.de/liste/berlin/wohnungen/mieten\n\n**Example 3 (page 2):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1?page=2\n\n**Notes:**\n- Supports `/suche/` and `/liste/` search URLs copied from immowelt.de.\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the Immowelt Property endpoint for full listing data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"cps":{"type":"string"},"url":{"type":"string"},"tags":{"type":"object","properties":{"is_new":{"type":"boolean"},"has3_d_visit":{"type":"boolean"},"is_exclusive":{"type":"boolean"},"has_brokerage_fee":{"type":"boolean"}}},"type":{"type":"string"},"brand":{"type":"string"},"portal":{"type":"string"},"status":{"type":"string"},"display":{"type":"string"},"gallery":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"alt":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"aria_label":{"type":"string"},"description":{"type":"string"}}}}}},"location":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"zip_code":{"type":"string"}}},"is_address_published":{"type":"boolean"}}},"metadata":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"object","properties":{"status":{"type":"boolean"},"enrichments":{"type":"object","properties":{"geo":{"type":"boolean"},"media":{"type":"boolean"},"online_id":{"type":"boolean"},"intermediary":{"type":"boolean"},"contact_settings":{"type":"boolean"}}}}},"legacy_id":{"type":"string"},"update_date":{"type":"string"},"creation_date":{"type":"string"}}},"provider":{"type":"object","properties":{"badge":{"type":"object","properties":{"title":{"type":"string"},"image_url":{"type":"string"}}},"address":{"type":"string"},"website":{"type":"string"},"imprint_url":{"type":"string"},"profile_url":{"type":"string"},"agency_strip":{"type":"object","properties":{"font_color":{"type":"string"},"agency_color":{"type":"string"}}},"contact_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"nullable":true},"subtitle":{"type":"string"}}},"display_links":{"type":"boolean"},"phone_numbers":{"type":"array","items":{"type":"string"}},"publisher_type":{"type":"string"},"is_private_owner":{"type":"boolean"},"intermediary_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"type":"string"},"subtitle":{"type":"string"},"logo_href":{"type":"string"}}},"agency_legal_informations":{"type":"array","items":{}}}},"raw_data":{"type":"object","properties":{"price":{"type":"integer"},"nbroom":{"type":"integer"},"surface":{"type":"object","properties":{"main":{"type":"integer"},"plot":{"nullable":true}}},"providercity":{"type":"string"},"property_type":{"type":"string"},"providerzipcode":{"type":"string"},"geo_id_hierarchy":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type_key":{"type":"string"}}}},"distribution_type":{"type":"string"},"property_sub_type":{"type":"string"},"offerer_marketing_key":{"type":"string"},"contact_location_enabled":{"type":"boolean"}}},"tracking":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"region":{"type":"string"},"country":{"type":"string"},"currency":{"type":"string"},"zip_code":{"type":"string"},"client_id":{"type":"string"},"legacy_id":{"type":"string"},"list_name":{"type":"string"},"estate_type":{"type":"string"},"product_type":{"type":"string"},"building_state":{"type":"string"},"distribution_type":{"type":"string"},"energy_certificate":{"type":"string"}}},"hard_facts":{"type":"object","properties":{"facts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"split_value":{"type":"string"}}}},"price":{"type":"object","properties":{"value":{"type":"string"},"addition":{"type":"object","properties":{"value":{"type":"string"}}},"formatted":{"type":"string"},"aria_label":{"type":"string"},"financial_link":{"type":"object","properties":{"href":{"type":"string"},"label":{"type":"string"},"partner_name":{"type":"string"}}},"additional_information":{"type":"string"}}},"title":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"aria_label":{"type":"string"}}}},"keyfacts":{"type":"array","items":{"type":"string"}}}},"energy_class":{"type":"string"},"card_provider":{"type":"object","properties":{"title":{"type":"string"},"logo_url":{"nullable":true},"subtitle":{"type":"string"},"agency_strip":{"type":"object","properties":{"font_color":{"type":"string"},"agency_color":{"type":"string"}}}}},"main_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}},"has_ai_enrichment":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"per_page":{"type":"integer"},"previous":{"nullable":true},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search apartments for rent in Germany":{"value":{"results":[{"id":"26Y9EVQUEN6D","cps":"26Y9EVQUEN6D","url":"https://www.immowelt.de/expose/b4a08c88-83bf-46b0-a5a5-9a2c91051737","tags":{"is_new":false,"has3_d_visit":false,"is_exclusive":false,"has_brokerage_fee":false},"type":"PROFESSIONAL","brand":"immowelt","portal":"immowelt","status":"Published","display":"classified","gallery":{"images":[{"alt":"Studio zur Miete 530 € 1 Zimmer 22 m² 1. Geschoss frei ab sofort Neuffener Str. 61 Nürtingen 72622","key":"baf51e9e-a514-4f29-99f0-bc35b4be3b94","url":"https://mms.immowelt.de/b/a/f/5/baf51e9e-a514-4f29-99f0-bc35b4be3b94.jpg?ci_seal=37711d30b4599fff1634abf0c74393be07f600b2","title":"Außenansicht","aria_label":"Außenansicht","description":"Außenansicht"},{"key":"0bd9a17d-e22c-4e87-ba9d-42b3a7028eec","url":"https://mms.immowelt.de/0/b/d/9/0bd9a17d-e22c-4e87-ba9d-42b3a7028eec.jpg?ci_seal=3bbf4ba58dbba3745a76c810ddc7d182d9e35fe9","title":"Blick ins Bad - Waschtisch und WC","aria_label":"Blick ins Bad - Waschtisch und WC","description":"Blick ins Bad - Waschtisch und WC"}]},"location":{"address":{"city":"Nürtingen","street":"Neuffener Str. 61","country":"DEU","zip_code":"72622"},"is_address_published":true},"metadata":{"id":"26Y9EVQUEN6D","status":{"status":true,"enrichments":{"geo":false,"media":false,"online_id":false,"intermediary":false,"contact_settings":false}},"legacy_id":"b4a08c88-83bf-46b0-a5a5-9a2c91051737","update_date":"2026-05-26T13:20:35.489Z","creation_date":"2026-05-26T13:15:51.95Z"},"provider":{"badge":{"title":"Diamond Partner","image_url":"https://s.immowelt.org/shared/images/partner-badges/diamond-partner.svg"},"address":"Keplerstr. 21, 72810 Gomaringen","website":"http://www.fvi-gmbh.de/","imprint_url":"https://www.immowelt.de/profil/4ef6f9a229724bda8300b7a39c51e143#impressum","profile_url":"https://www.immowelt.de/profil/4ef6f9a229724bda8300b7a39c51e143","agency_strip":{"font_color":"#FFFFFF","agency_color":"#da0001"},"contact_card":{"title":"Herr Walter Restle","display":true,"logo_url":null,"subtitle":"Dein Kontakt"},"display_links":true,"phone_numbers":["07072-89 000 64"],"publisher_type":"AGENCY","is_private_owner":false,"intermediary_card":{"title":"FVI GmbH","display":true,"logo_url":"https://mms.immowelt.de/c/8/1/9/c819d63d-0aa6-4a5d-a325-f7bff214b06f.jpg?ci_seal=a97092648fa5b75def1b5873b3adf65ac47c0444","subtitle":"Gewerblicher Anbieter","logo_href":"https://www.immowelt.de/profil/4ef6f9a229724bda8300b7a39c51e143"},"agency_legal_informations":[]},"raw_data":{"price":670,"nbroom":1,"surface":{"main":22,"plot":null},"providercity":"Gomaringen","property_type":"APARTMENT","providerzipcode":"72810","geo_id_hierarchy":[{"id":"NBH2DE91300073","type_key":"NBH2"},{"id":"AD08DE5294","type_key":"AD08"},{"id":"AD06DE182","type_key":"AD06"},{"id":"AD05DE9","type_key":"AD05"},{"id":"AD04DE8","type_key":"AD04"},{"id":"AD02DE1","type_key":"AD02"}],"distribution_type":"RENT","property_sub_type":"STUDIO","offerer_marketing_key":"AP50","contact_location_enabled":false},"tracking":{"id":"26Y9EVQUEN6D","city":"Nürtingen","name":"classified","price":530,"region":"Baden-Württemberg","country":"Germany","currency":"EUR","zip_code":"72622","client_id":"1525951","legacy_id":"b4a08c88-83bf-46b0-a5a5-9a2c91051737","list_name":"classified_detail_similars_bottom","estate_type":"av_2","product_type":"standard","building_state":"MINT_CONDITION","distribution_type":"1","energy_certificate":"A"},"hard_facts":{"facts":[{"type":"numberOfRooms","label":"Zimmer","value":"1 Zimmer","split_value":"1"},{"type":"livingSpace","label":"m²","value":"22 m²","split_value":"22"},{"type":"numberOfFloors","label":"Geschoss","value":"1. Geschoss","split_value":"1."},{"type":"availability","label":"ab sofort","value":"frei ab sofort","split_value":"frei"}],"price":{"value":"530 €","addition":{"value":"Kaltmiete"},"formatted":"530 €","aria_label":"530 €","financial_link":{"href":"https://www.immowelt.de/immobilienfinanzierung-anfragen/?price=530&originvariant=expose-hardfacts&zip=72622&city=Nürtingen&classifiedid=b4a08c88-83bf-46b0-a5a5-9a2c91051737&m=classified_detail_request_offer_find_financing_partners_step1","label":"Finanzierung anfragen","partner_name":"KFW"},"additional_information":"Kaltmiete"},"title":"Studio zur Miete","prices":[{"label":"Kaltmiete","value":"530 €","aria_label":"530 €"},{"label":"Warmmiete","value":"670 €","aria_label":"670 €"}],"keyfacts":["1 Zimmer","22 m²","1. Geschoss","frei ab sofort"]},"energy_class":"A","card_provider":{"title":"Herr Walter Restle","logo_url":null,"subtitle":"Dein Kontakt","agency_strip":{"font_color":"#FFFFFF","agency_color":"#da0001"}},"main_description":{"headline":"Gepflegtes, möbliertes Mikroappartement","metadata":{"language":"de"},"description":"Objektbeschreibung Diese traumhafte Wohnung ist Teil einer gepflegten, aus insgesamt 66 Wohneinheiten bestehenden Wohnanlage. Raumaufteilung Das Mikroappartment besteht aus einem einzelnen, großen Zimmer sowie dem Bad/WC; Heizkörper suchen Sie hier übrigens vergebens - für Wärme sorgt in der gesamten Wohnung eine energiesparende Fußbodenheizung. Betritt man die zur Vermietung stehende Wohnung befindet man sich zunächst im Flur, in dem sich auf der linken Seite die moderne und vollwertig ausgest..."},"has_ai_enrichment":true},{"id":"233Z8N1F5GAI","cps":"233Z8N1F5GAI","url":"https://www.immowelt.de/expose/1066aba8-b3c0-43ef-a688-1ce257f0ee11","tags":{"is_new":true,"has3_d_visit":false,"is_exclusive":false,"has_brokerage_fee":false},"type":"PROFESSIONAL","brand":"immowelt","portal":"immowelt","status":"Published","display":"classified","gallery":{"images":[{"alt":"Terrassenwohnung zur Miete 3 Zimmer 155 m² EG Sutthauser Straße 390 Sutthausen Osnabrück 49082","key":"d2e596b3-13df-4137-8379-5295b8005fa8","url":"https://mms.immowelt.de/d/2/e/5/d2e596b3-13df-4137-8379-5295b8005fa8.jpg?ci_seal=971e18d7fae913cc5c573c7e415817bf4e8394bc","title":"Bild 1","aria_label":"Bild 1","description":"Bild 1"},{"key":"0555ee6c-9f66-47d0-b98c-9038fdb677f6","url":"https://mms.immowelt.de/0/5/5/5/0555ee6c-9f66-47d0-b98c-9038fdb677f6.jpg?ci_seal=4df0f0645f7e28688d10eb5e84344e0e73bdf85c","title":"Bild 2","aria_label":"Bild 2","description":"Bild 2","classification":{"name":"HOUSE_FACADE","version":"scene-classification-sagemaker-endpoint-live-1-3-10"}}]},"location":{"address":{"city":"Osnabrück","street":"Sutthauser Straße 390","country":"DEU","district":"Sutthausen","zip_code":"49082"},"is_address_published":true},"metadata":{"id":"233Z8N1F5GAI","status":{"status":true,"enrichments":{"geo":false,"media":false,"online_id":false,"intermediary":false,"contact_settings":false}},"legacy_id":"1066aba8-b3c0-43ef-a688-1ce257f0ee11","update_date":"2026-06-01T20:02:24.937Z","creation_date":"2014-01-19T16:18:06.623Z"},"provider":{"badge":{"title":"Diamond Partner","image_url":"https://s.immowelt.org/shared/images/partner-badges/diamond-partner.svg"},"rating":{"link":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a#rating","rating":4.8,"reviews":16},"address":"Hermann-Ehlers-Straße 3, 49082 Osnabrück","imprint_url":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a#impressum","profile_url":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a","agency_strip":{"font_color":"#000000","agency_color":"#ffffff"},"contact_card":{"title":"Herr Dipl.- Ing. W. Lintker","display":true,"logo_url":null,"subtitle":"Dein Kontakt"},"display_links":true,"phone_numbers":["1633364213"],"publisher_type":"AGENCY","is_private_owner":false,"intermediary_card":{"title":"Lintker Liegenschafts- & Immobiliendienst","display":true,"logo_url":"https://mms.immowelt.de/5/2/9/d/529dc5ff-b44f-4503-a838-6ce358518fd4.jpg?ci_seal=1a1b1d05859c5defb5ca704143165cb1ca704295","subtitle":"Gewerblicher Anbieter","logo_href":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a"},"agency_legal_informations":[]},"raw_data":{"nbroom":3,"surface":{"main":155,"plot":null},"providercity":"Osnabrück","property_type":"APARTMENT","providerzipcode":"49082","geo_id_hierarchy":[{"id":"NBH2DE91298376","type_key":"NBH2"},{"id":"AD08DE1864","type_key":"AD08"},{"id":"AD06DE49","type_key":"AD06"},{"id":"AD04DE3","type_key":"AD04"},{"id":"AD02DE1","type_key":"AD02"}],"distribution_type":"RENT","property_sub_type":"TERRACE","offerer_marketing_key":"390 - 1","contact_location_enabled":false},"tracking":{"id":"233Z8N1F5GAI","city":"Osnabrück","name":"classified","region":"Lower Saxony","country":"Germany","currency":"EUR","zip_code":"49082","client_id":"62682","legacy_id":"1066aba8-b3c0-43ef-a688-1ce257f0ee11","list_name":"classified_detail_similars_bottom","estate_type":"av_2","product_type":"standard","distribution_type":"1","energy_certificate":"D"},"hard_facts":{"facts":[{"type":"numberOfRooms","label":"Zimmer","value":"3 Zimmer","split_value":"3"},{"type":"livingSpace","label":"m²","value":"155 m²","split_value":"155"},{"type":"numberOfFloors","label":null,"value":"EG","split_value":"EG"}],"price":{"value":"Mietkosten auf Anfrage","formatted":"Mietkosten auf Anfrage"},"title":"Terrassenwohnung zur Miete","prices":[{"value":"Mietkosten auf Anfrage"}],"keyfacts":["3 Zimmer","155 m²","EG"],"enriched_title":"Terrassenwohnung zur Miete - Seniorenimmobilie"},"energy_class":"D","card_provider":{"title":"Herr Dipl.- Ing. W. Lintker","logo_url":null,"subtitle":"Dein Kontakt","agency_strip":{"font_color":"#000000","agency_color":"#ffffff"}},"main_description":{"headline":"Repräsentative und außergewöhnliche Wohnung in Osnabrück","metadata":{"language":"de"},"description":"Objektbeschreibung Das 2014 fertiggestellte Objekt befindet sich an der Sutthauser Straße, in direkter Nachbarschaft zum denkmalgeschützten Wulfter Turm im Stadtteil Sutthausen und verfügt über 4 repräsentative Wohneinheiten auf einem 2.500 m² großen Grundstück, welches an große zusammenhängende Wald- und Naherholungsgebiete angrenzt. Raumaufteilung Die repräsentative und seniorengerecht konzipierte Wohnung mit 155 m², die sich auf 3 Zimmer, Küche, Designbad mit begehbarer Dusche und Badewanne,..."},"has_ai_enrichment":true}],"pagination":{"next":2,"current":1,"per_page":30,"previous":null,"total_count":59295,"total_pages":1977,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Immowelt Search","description":"Search Immowelt listings from a search URL and retrieve prices, specs, photos, agency info, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-immowelt-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Immowelt search URL.\n\n**Example 1 (rental search):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1\n\n**Example 2 (legacy liste URL):**\n\n    https://www.immowelt.de/liste/berlin/wohnungen/mieten\n\n**Example 3 (page 2):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1?page=2\n\n**Notes:**\n- Supports `/suche/` and `/liste/` search URLs copied from immowelt.de.\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the Immowelt Property endpoint for full listing data.","schema":{"type":"string","description":"Full Immowelt search URL.\n\n**Example 1 (rental search):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1\n\n**Example 2 (legacy liste URL):**\n\n    https://www.immowelt.de/liste/berlin/wohnungen/mieten\n\n**Example 3 (page 2):**\n\n    https://www.immowelt.de/suche/mieten/wohnung/deutschland/ad02de1?page=2\n\n**Notes:**\n- Supports `/suche/` and `/liste/` search URLs copied from immowelt.de.\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the Immowelt Property endpoint for full listing data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"cps":{"type":"string"},"url":{"type":"string"},"tags":{"type":"object","properties":{"is_new":{"type":"boolean"},"has3_d_visit":{"type":"boolean"},"is_exclusive":{"type":"boolean"},"has_brokerage_fee":{"type":"boolean"}}},"type":{"type":"string"},"brand":{"type":"string"},"portal":{"type":"string"},"status":{"type":"string"},"display":{"type":"string"},"gallery":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"alt":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"aria_label":{"type":"string"},"description":{"type":"string"}}}}}},"location":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"zip_code":{"type":"string"}}},"is_address_published":{"type":"boolean"}}},"metadata":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"object","properties":{"status":{"type":"boolean"},"enrichments":{"type":"object","properties":{"geo":{"type":"boolean"},"media":{"type":"boolean"},"online_id":{"type":"boolean"},"intermediary":{"type":"boolean"},"contact_settings":{"type":"boolean"}}}}},"legacy_id":{"type":"string"},"update_date":{"type":"string"},"creation_date":{"type":"string"}}},"provider":{"type":"object","properties":{"badge":{"type":"object","properties":{"title":{"type":"string"},"image_url":{"type":"string"}}},"address":{"type":"string"},"website":{"type":"string"},"imprint_url":{"type":"string"},"profile_url":{"type":"string"},"agency_strip":{"type":"object","properties":{"font_color":{"type":"string"},"agency_color":{"type":"string"}}},"contact_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"nullable":true},"subtitle":{"type":"string"}}},"display_links":{"type":"boolean"},"phone_numbers":{"type":"array","items":{"type":"string"}},"publisher_type":{"type":"string"},"is_private_owner":{"type":"boolean"},"intermediary_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"type":"string"},"subtitle":{"type":"string"},"logo_href":{"type":"string"}}},"agency_legal_informations":{"type":"array","items":{}}}},"raw_data":{"type":"object","properties":{"price":{"type":"integer"},"nbroom":{"type":"integer"},"surface":{"type":"object","properties":{"main":{"type":"integer"},"plot":{"nullable":true}}},"providercity":{"type":"string"},"property_type":{"type":"string"},"providerzipcode":{"type":"string"},"geo_id_hierarchy":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type_key":{"type":"string"}}}},"distribution_type":{"type":"string"},"property_sub_type":{"type":"string"},"offerer_marketing_key":{"type":"string"},"contact_location_enabled":{"type":"boolean"}}},"tracking":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"region":{"type":"string"},"country":{"type":"string"},"currency":{"type":"string"},"zip_code":{"type":"string"},"client_id":{"type":"string"},"legacy_id":{"type":"string"},"list_name":{"type":"string"},"estate_type":{"type":"string"},"product_type":{"type":"string"},"building_state":{"type":"string"},"distribution_type":{"type":"string"},"energy_certificate":{"type":"string"}}},"hard_facts":{"type":"object","properties":{"facts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"split_value":{"type":"string"}}}},"price":{"type":"object","properties":{"value":{"type":"string"},"addition":{"type":"object","properties":{"value":{"type":"string"}}},"formatted":{"type":"string"},"aria_label":{"type":"string"},"financial_link":{"type":"object","properties":{"href":{"type":"string"},"label":{"type":"string"},"partner_name":{"type":"string"}}},"additional_information":{"type":"string"}}},"title":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"aria_label":{"type":"string"}}}},"keyfacts":{"type":"array","items":{"type":"string"}}}},"energy_class":{"type":"string"},"card_provider":{"type":"object","properties":{"title":{"type":"string"},"logo_url":{"nullable":true},"subtitle":{"type":"string"},"agency_strip":{"type":"object","properties":{"font_color":{"type":"string"},"agency_color":{"type":"string"}}}}},"main_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}},"has_ai_enrichment":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"per_page":{"type":"integer"},"previous":{"nullable":true},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search apartments for rent in Germany":{"value":{"results":[{"id":"26Y9EVQUEN6D","cps":"26Y9EVQUEN6D","url":"https://www.immowelt.de/expose/b4a08c88-83bf-46b0-a5a5-9a2c91051737","tags":{"is_new":false,"has3_d_visit":false,"is_exclusive":false,"has_brokerage_fee":false},"type":"PROFESSIONAL","brand":"immowelt","portal":"immowelt","status":"Published","display":"classified","gallery":{"images":[{"alt":"Studio zur Miete 530 € 1 Zimmer 22 m² 1. Geschoss frei ab sofort Neuffener Str. 61 Nürtingen 72622","key":"baf51e9e-a514-4f29-99f0-bc35b4be3b94","url":"https://mms.immowelt.de/b/a/f/5/baf51e9e-a514-4f29-99f0-bc35b4be3b94.jpg?ci_seal=37711d30b4599fff1634abf0c74393be07f600b2","title":"Außenansicht","aria_label":"Außenansicht","description":"Außenansicht"},{"key":"0bd9a17d-e22c-4e87-ba9d-42b3a7028eec","url":"https://mms.immowelt.de/0/b/d/9/0bd9a17d-e22c-4e87-ba9d-42b3a7028eec.jpg?ci_seal=3bbf4ba58dbba3745a76c810ddc7d182d9e35fe9","title":"Blick ins Bad - Waschtisch und WC","aria_label":"Blick ins Bad - Waschtisch und WC","description":"Blick ins Bad - Waschtisch und WC"}]},"location":{"address":{"city":"Nürtingen","street":"Neuffener Str. 61","country":"DEU","zip_code":"72622"},"is_address_published":true},"metadata":{"id":"26Y9EVQUEN6D","status":{"status":true,"enrichments":{"geo":false,"media":false,"online_id":false,"intermediary":false,"contact_settings":false}},"legacy_id":"b4a08c88-83bf-46b0-a5a5-9a2c91051737","update_date":"2026-05-26T13:20:35.489Z","creation_date":"2026-05-26T13:15:51.95Z"},"provider":{"badge":{"title":"Diamond Partner","image_url":"https://s.immowelt.org/shared/images/partner-badges/diamond-partner.svg"},"address":"Keplerstr. 21, 72810 Gomaringen","website":"http://www.fvi-gmbh.de/","imprint_url":"https://www.immowelt.de/profil/4ef6f9a229724bda8300b7a39c51e143#impressum","profile_url":"https://www.immowelt.de/profil/4ef6f9a229724bda8300b7a39c51e143","agency_strip":{"font_color":"#FFFFFF","agency_color":"#da0001"},"contact_card":{"title":"Herr Walter Restle","display":true,"logo_url":null,"subtitle":"Dein Kontakt"},"display_links":true,"phone_numbers":["07072-89 000 64"],"publisher_type":"AGENCY","is_private_owner":false,"intermediary_card":{"title":"FVI GmbH","display":true,"logo_url":"https://mms.immowelt.de/c/8/1/9/c819d63d-0aa6-4a5d-a325-f7bff214b06f.jpg?ci_seal=a97092648fa5b75def1b5873b3adf65ac47c0444","subtitle":"Gewerblicher Anbieter","logo_href":"https://www.immowelt.de/profil/4ef6f9a229724bda8300b7a39c51e143"},"agency_legal_informations":[]},"raw_data":{"price":670,"nbroom":1,"surface":{"main":22,"plot":null},"providercity":"Gomaringen","property_type":"APARTMENT","providerzipcode":"72810","geo_id_hierarchy":[{"id":"NBH2DE91300073","type_key":"NBH2"},{"id":"AD08DE5294","type_key":"AD08"},{"id":"AD06DE182","type_key":"AD06"},{"id":"AD05DE9","type_key":"AD05"},{"id":"AD04DE8","type_key":"AD04"},{"id":"AD02DE1","type_key":"AD02"}],"distribution_type":"RENT","property_sub_type":"STUDIO","offerer_marketing_key":"AP50","contact_location_enabled":false},"tracking":{"id":"26Y9EVQUEN6D","city":"Nürtingen","name":"classified","price":530,"region":"Baden-Württemberg","country":"Germany","currency":"EUR","zip_code":"72622","client_id":"1525951","legacy_id":"b4a08c88-83bf-46b0-a5a5-9a2c91051737","list_name":"classified_detail_similars_bottom","estate_type":"av_2","product_type":"standard","building_state":"MINT_CONDITION","distribution_type":"1","energy_certificate":"A"},"hard_facts":{"facts":[{"type":"numberOfRooms","label":"Zimmer","value":"1 Zimmer","split_value":"1"},{"type":"livingSpace","label":"m²","value":"22 m²","split_value":"22"},{"type":"numberOfFloors","label":"Geschoss","value":"1. Geschoss","split_value":"1."},{"type":"availability","label":"ab sofort","value":"frei ab sofort","split_value":"frei"}],"price":{"value":"530 €","addition":{"value":"Kaltmiete"},"formatted":"530 €","aria_label":"530 €","financial_link":{"href":"https://www.immowelt.de/immobilienfinanzierung-anfragen/?price=530&originvariant=expose-hardfacts&zip=72622&city=Nürtingen&classifiedid=b4a08c88-83bf-46b0-a5a5-9a2c91051737&m=classified_detail_request_offer_find_financing_partners_step1","label":"Finanzierung anfragen","partner_name":"KFW"},"additional_information":"Kaltmiete"},"title":"Studio zur Miete","prices":[{"label":"Kaltmiete","value":"530 €","aria_label":"530 €"},{"label":"Warmmiete","value":"670 €","aria_label":"670 €"}],"keyfacts":["1 Zimmer","22 m²","1. Geschoss","frei ab sofort"]},"energy_class":"A","card_provider":{"title":"Herr Walter Restle","logo_url":null,"subtitle":"Dein Kontakt","agency_strip":{"font_color":"#FFFFFF","agency_color":"#da0001"}},"main_description":{"headline":"Gepflegtes, möbliertes Mikroappartement","metadata":{"language":"de"},"description":"Objektbeschreibung Diese traumhafte Wohnung ist Teil einer gepflegten, aus insgesamt 66 Wohneinheiten bestehenden Wohnanlage. Raumaufteilung Das Mikroappartment besteht aus einem einzelnen, großen Zimmer sowie dem Bad/WC; Heizkörper suchen Sie hier übrigens vergebens - für Wärme sorgt in der gesamten Wohnung eine energiesparende Fußbodenheizung. Betritt man die zur Vermietung stehende Wohnung befindet man sich zunächst im Flur, in dem sich auf der linken Seite die moderne und vollwertig ausgest..."},"has_ai_enrichment":true},{"id":"233Z8N1F5GAI","cps":"233Z8N1F5GAI","url":"https://www.immowelt.de/expose/1066aba8-b3c0-43ef-a688-1ce257f0ee11","tags":{"is_new":true,"has3_d_visit":false,"is_exclusive":false,"has_brokerage_fee":false},"type":"PROFESSIONAL","brand":"immowelt","portal":"immowelt","status":"Published","display":"classified","gallery":{"images":[{"alt":"Terrassenwohnung zur Miete 3 Zimmer 155 m² EG Sutthauser Straße 390 Sutthausen Osnabrück 49082","key":"d2e596b3-13df-4137-8379-5295b8005fa8","url":"https://mms.immowelt.de/d/2/e/5/d2e596b3-13df-4137-8379-5295b8005fa8.jpg?ci_seal=971e18d7fae913cc5c573c7e415817bf4e8394bc","title":"Bild 1","aria_label":"Bild 1","description":"Bild 1"},{"key":"0555ee6c-9f66-47d0-b98c-9038fdb677f6","url":"https://mms.immowelt.de/0/5/5/5/0555ee6c-9f66-47d0-b98c-9038fdb677f6.jpg?ci_seal=4df0f0645f7e28688d10eb5e84344e0e73bdf85c","title":"Bild 2","aria_label":"Bild 2","description":"Bild 2","classification":{"name":"HOUSE_FACADE","version":"scene-classification-sagemaker-endpoint-live-1-3-10"}}]},"location":{"address":{"city":"Osnabrück","street":"Sutthauser Straße 390","country":"DEU","district":"Sutthausen","zip_code":"49082"},"is_address_published":true},"metadata":{"id":"233Z8N1F5GAI","status":{"status":true,"enrichments":{"geo":false,"media":false,"online_id":false,"intermediary":false,"contact_settings":false}},"legacy_id":"1066aba8-b3c0-43ef-a688-1ce257f0ee11","update_date":"2026-06-01T20:02:24.937Z","creation_date":"2014-01-19T16:18:06.623Z"},"provider":{"badge":{"title":"Diamond Partner","image_url":"https://s.immowelt.org/shared/images/partner-badges/diamond-partner.svg"},"rating":{"link":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a#rating","rating":4.8,"reviews":16},"address":"Hermann-Ehlers-Straße 3, 49082 Osnabrück","imprint_url":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a#impressum","profile_url":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a","agency_strip":{"font_color":"#000000","agency_color":"#ffffff"},"contact_card":{"title":"Herr Dipl.- Ing. W. Lintker","display":true,"logo_url":null,"subtitle":"Dein Kontakt"},"display_links":true,"phone_numbers":["1633364213"],"publisher_type":"AGENCY","is_private_owner":false,"intermediary_card":{"title":"Lintker Liegenschafts- & Immobiliendienst","display":true,"logo_url":"https://mms.immowelt.de/5/2/9/d/529dc5ff-b44f-4503-a838-6ce358518fd4.jpg?ci_seal=1a1b1d05859c5defb5ca704143165cb1ca704295","subtitle":"Gewerblicher Anbieter","logo_href":"https://www.immowelt.de/profil/6d1a2b1c9ef247a2afb9097108bc979a"},"agency_legal_informations":[]},"raw_data":{"nbroom":3,"surface":{"main":155,"plot":null},"providercity":"Osnabrück","property_type":"APARTMENT","providerzipcode":"49082","geo_id_hierarchy":[{"id":"NBH2DE91298376","type_key":"NBH2"},{"id":"AD08DE1864","type_key":"AD08"},{"id":"AD06DE49","type_key":"AD06"},{"id":"AD04DE3","type_key":"AD04"},{"id":"AD02DE1","type_key":"AD02"}],"distribution_type":"RENT","property_sub_type":"TERRACE","offerer_marketing_key":"390 - 1","contact_location_enabled":false},"tracking":{"id":"233Z8N1F5GAI","city":"Osnabrück","name":"classified","region":"Lower Saxony","country":"Germany","currency":"EUR","zip_code":"49082","client_id":"62682","legacy_id":"1066aba8-b3c0-43ef-a688-1ce257f0ee11","list_name":"classified_detail_similars_bottom","estate_type":"av_2","product_type":"standard","distribution_type":"1","energy_certificate":"D"},"hard_facts":{"facts":[{"type":"numberOfRooms","label":"Zimmer","value":"3 Zimmer","split_value":"3"},{"type":"livingSpace","label":"m²","value":"155 m²","split_value":"155"},{"type":"numberOfFloors","label":null,"value":"EG","split_value":"EG"}],"price":{"value":"Mietkosten auf Anfrage","formatted":"Mietkosten auf Anfrage"},"title":"Terrassenwohnung zur Miete","prices":[{"value":"Mietkosten auf Anfrage"}],"keyfacts":["3 Zimmer","155 m²","EG"],"enriched_title":"Terrassenwohnung zur Miete - Seniorenimmobilie"},"energy_class":"D","card_provider":{"title":"Herr Dipl.- Ing. W. Lintker","logo_url":null,"subtitle":"Dein Kontakt","agency_strip":{"font_color":"#000000","agency_color":"#ffffff"}},"main_description":{"headline":"Repräsentative und außergewöhnliche Wohnung in Osnabrück","metadata":{"language":"de"},"description":"Objektbeschreibung Das 2014 fertiggestellte Objekt befindet sich an der Sutthauser Straße, in direkter Nachbarschaft zum denkmalgeschützten Wulfter Turm im Stadtteil Sutthausen und verfügt über 4 repräsentative Wohneinheiten auf einem 2.500 m² großen Grundstück, welches an große zusammenhängende Wald- und Naherholungsgebiete angrenzt. Raumaufteilung Die repräsentative und seniorengerecht konzipierte Wohnung mit 155 m², die sich auf 3 Zimmer, Küche, Designbad mit begehbarer Dusche und Badewanne,..."},"has_ai_enrichment":true}],"pagination":{"next":2,"current":1,"per_page":30,"previous":null,"total_count":59295,"total_pages":1977,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/immowelt/property":{"get":{"summary":"Immowelt Property","description":"Extract full property details from an Immowelt listing URL, including price, specs, photo gallery, energy certificate, location, and contact data.\n\n**Credit cost:** 1 credit per call","operationId":"get-immowelt-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Immowelt property detail URL.\n\n**Example:**\n\n    https://www.immowelt.de/expose/65de0309-bf41-48ce-86fd-6a3441fd0487\n\n**Notes:**\n- Only `/expose/` listing URLs are accepted.\n- Copy the listing URL from search results or from immowelt.de.","schema":{"type":"string","description":"Full Immowelt property detail URL.\n\n**Example:**\n\n    https://www.immowelt.de/expose/65de0309-bf41-48ce-86fd-6a3441fd0487\n\n**Notes:**\n- Only `/expose/` listing URLs are accepted.\n- Copy the listing URL from search results or from immowelt.de."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"tags":{"type":"object","properties":{"is_new":{"type":"boolean"},"has3_d_visit":{"type":"boolean"},"is_exclusive":{"type":"boolean"},"has_brokerage_fee":{"type":"boolean"}}},"brand":{"type":"string"},"sections":{"type":"object","properties":{"key":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}},"price":{"type":"object","properties":{"base":{"type":"object","properties":{"main":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"alt":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}},"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}}}},"type":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}}}}}}},"layout":{"type":"string"},"breakdown":{"type":"object","properties":{"bar":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"color_type":{"type":"string"},"percentage":{"type":"number"}}}},"total":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"aria_label":{"type":"string"},"is_estimated":{"type":"boolean"}}},"groups":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"alt":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}},"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}},"color_type":{"type":"string"},"highlighted":{"type":"boolean"}}}}}},"additional":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"label":{"type":"string"}}}},"components":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"type":{"type":"string"},"units":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"main":{"type":"object","properties":{"price":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}},"highlighted":{"type":"boolean"}}}}},"details":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"alt":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}},"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}}}}}}}}}}}}}}}},"energy":{"type":"object","properties":{"features":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}}}},"has_scales":{"type":"boolean"},"certificates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"scales":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"type":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"segments":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"aria_label":{"type":"string"},"efficiency_class":{"type":"object","properties":{"index":{"type":"integer"},"rating":{"type":"string"}}}}}},"features":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}}}}}}}}},"gallery":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"alt":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"aria_label":{"type":"string"},"description":{"type":"string"}}}}}},"features":{"type":"object","properties":{"details":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"elements":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"string"},"value":{"type":"string"}}}}}}},"additional_text":{"type":"string"}}},"preview":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"string"},"value":{"type":"string"}}}}}},"location":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"district":{"type":"string"},"zip_code":{"type":"string"}}},"geometry":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"is_address_published":{"type":"boolean"}}},"mortgage":{"type":"object","properties":{"id":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"prov":{"type":"integer"},"brand":{"type":"string"},"price":{"type":"integer"},"region":{"type":"string"},"country":{"type":"string"},"monthly_amount":{"type":"integer"},"show_rent_label":{"type":"boolean"},"federal_state_geo_id":{"type":"string"},"show_monthly_rate_label":{"type":"boolean"},"formatted_monthly_amount":{"type":"string"}}},"documents":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"subtitle":{"type":"string"}}}},"display":{"type":"boolean"}}},"hard_facts":{"type":"object","properties":{"facts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"split_value":{"type":"string"}}}},"price":{"type":"object","properties":{"value":{"type":"string"},"addition":{"type":"object","properties":{"value":{"type":"string"}}},"formatted":{"type":"string"},"aria_label":{"type":"string"},"financial_link":{"type":"object","properties":{"href":{"type":"string"},"label":{"type":"string"},"partner_name":{"type":"string"}}},"additional_information":{"type":"string"}}},"title":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"aria_label":{"type":"string"}}}},"keyfacts":{"type":"array","items":{"type":"string"}},"location_description":{"type":"string"}}},"partner_ad":{"type":"object","properties":{"show_partner_ad":{"type":"boolean"}}},"description":{"type":"object","properties":{"texts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}},"headline":{"type":"string"},"description":{"type":"string"}}},"enriched_media":{"type":"object","properties":{"medias":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"url_type":{"type":"string"},"preview_image":{"type":"object","properties":{"alt":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"aria_label":{"type":"string"},"description":{"type":"string"}}},"virtual_tours":{"type":"object","properties":{"provider":{"type":"string"},"policy_value":{"type":"string"}}}}}}}},"area_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}},"main_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}},"price_comparison":{"type":"object","properties":{"is_sale":{"type":"boolean"},"legal_text":{"type":"string"},"price_per_sqm":{"type":"string"},"has_main_price":{"type":"boolean"}}},"seller_lead_link":{"type":"object","properties":{}},"extended_info_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}}}},"contact_sections":{"type":"object","properties":{"id":{"type":"string"},"brand":{"type":"string"},"static":{"type":"object","properties":{"phone_numbers":{"type":"array","items":{"type":"string"}}}},"sticky":{"type":"object","properties":{"phone_numbers":{"type":"array","items":{"type":"string"}}}},"provider":{"type":"object","properties":{"badges":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"duration":{"type":"string"},"image_url":{"type":"string"},"description":{"type":"string"}}}},"address":{"type":"string"},"website":{"type":"string"},"imprint_url":{"type":"string"},"profile_url":{"type":"string"},"contact_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"nullable":true},"subtitle":{"type":"string"}}},"display_links":{"type":"boolean"},"phone_numbers":{"type":"array","items":{"type":"string"}},"publisher_type":{"type":"string"},"is_private_owner":{"type":"boolean"},"intermediary_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"type":"string"},"subtitle":{"type":"string"},"logo_href":{"type":"string"}}},"agency_legal_informations":{"type":"array","items":{}}}},"agency_id":{"type":"string"},"legacy_id":{"type":"string"},"contact_card":{"type":"object","properties":{"title":{"type":"string"},"subtitle":{"type":"string"},"agency_logo":{"type":"object","properties":{"display":{"type":"boolean"},"logo_url":{"type":"string"}}},"contact_logo":{"type":"object","properties":{"display":{"type":"boolean"},"logo_url":{"nullable":true}}},"phone_numbers":{"type":"array","items":{"type":"string"}},"is_private_owner":{"type":"boolean"}}},"contact_form":{"type":"object","properties":{"contact_card":{"type":"object","properties":{"title":{"type":"string"},"logo_url":{"type":"string"},"subtitle":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"string"}},"is_private_owner":{"type":"boolean"}}},"custom_fields":{"type":"object","properties":{"location_enabled":{"type":"boolean"}}},"subject_label":{"type":"string"},"display_owner_flag":{"type":"boolean"},"should_send_lead_value":{"type":"boolean"}}},"mobile_phones":{"type":"object","properties":{"title":{"type":"string"},"logo_url":{"nullable":true},"subtitle":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"string"}},"is_private_owner":{"type":"boolean"}}},"confirmation_page":{"type":"object","properties":{"is_finance_offer_button_enabled":{"type":"boolean"}}}}}}},"examples":{"Lookup Smyles Living rental in Berlin Friedenau":{"value":{"id":"26UBAUCV6EY5","tags":{"is_new":true,"has3_d_visit":true,"is_exclusive":false,"has_brokerage_fee":false},"brand":"immowelt","sections":{"key":{"keys":[{"label":"Online-ID","value":"26UBAUCV6EY5"},{"label":"Referenznummer","value":"Smyles519"}]},"price":{"base":{"main":{"key":"71551910-0abf-4d06-8f27-4fde2e081154","label":{"main":"Kaltmiete"},"value":{"alt":{"value":"31,54 €/m²","aria_label":"31,54 Euro pro Quadratmeter"},"main":{"value":"929 €","aria_label":"929 €"}}},"type":"RENT","details":[{"key":"36dbb5df-3851-451f-881f-09ffee2179ed","label":{"main":"Nebenkosten"},"value":{"main":{"value":"85 €","aria_label":"85 €"}}},{"key":"0989e604-7621-4a4a-bf87-cfc17aa9a3fd","label":{"main":"Heizkosten"},"value":{"main":{"value":"35 €","aria_label":"35 €"}}},{"key":"b3a886a2-490b-4c31-8948-e449245d1f79","label":{"main":"Warmmiete"},"value":{"main":{"value":"1.049 €","aria_label":"1049 €"}}}]},"layout":"GERMAN_RENT","breakdown":{"bar":[{"key":"473faa56-8912-4ac9-807a-3c8f0ae6d71c","color_type":"BASE_RENT","percentage":0.8856},{"key":"379bf29e-db44-4a8d-a92b-0cb021107f65","color_type":"OPERATING_COSTS","percentage":0.081},{"key":"d35e26a6-9b99-4ff9-9319-187c18b3d35e","color_type":"HEATING_COSTS","percentage":0.0334}],"total":{"type":"DEFAULT","label":"Warmmiete","value":"1.049 €","aria_label":"1049 €","is_estimated":false},"groups":[{"key":"473faa56-8912-4ac9-807a-3c8f0ae6d71c","label":{"main":"Kaltmiete"},"value":{"alt":{"value":"31,54 €/m²","aria_label":"31,54 Euro pro Quadratmeter"},"main":{"value":"929 €","aria_label":"929 €"}},"color_type":"BASE_RENT","highlighted":true},{"key":"379bf29e-db44-4a8d-a92b-0cb021107f65","label":{"main":"Nebenkosten"},"value":{"main":{"value":"85 €","aria_label":"85 €"}},"color_type":"OPERATING_COSTS","highlighted":true},{"key":"d35e26a6-9b99-4ff9-9319-187c18b3d35e","label":{"main":"Heizkosten"},"value":{"main":{"value":"35 €","aria_label":"35 €"}},"color_type":"HEATING_COSTS","highlighted":true}]},"additional":[{"text":"3 Nettokaltmieten","label":"Kaution"}],"components":[{"key":"7b6a72d6-5227-4169-9eb1-24d890af84da","type":"PRIMARY","units":[{"key":"c4fa6f93-0047-413d-97ee-0d7ca56b53e0","main":{"price":{"key":"3dd2fc16-b878-4eee-9c67-d81a9695b90a","label":{"main":"Warmmiete"},"value":{"main":{"value":"1.049 €","aria_label":"1049 €"}},"highlighted":true}},"details":[{"key":"f1adb411-938c-49d3-91b0-cdf028f739d0","label":"davon","prices":[{"key":"89b564ac-f7b6-4333-9197-1d7253b7d960","label":{"main":"Kaltmiete"},"value":{"alt":{"value":"31,54 €/m²","aria_label":"31,54 Euro pro Quadratmeter"},"main":{"value":"929 €","aria_label":"929 €"}}},{"key":"3caa79f6-0c02-494a-af8a-2db276fd2080","label":{"main":"Nebenkosten"},"value":{"main":{"value":"85 €","aria_label":"85 €"}}},{"key":"13edf3f5-1ff3-4039-ab41-70b729522c4f","label":{"main":"Heizkosten"},"value":{"main":{"value":"35 €","aria_label":"35 €"}}}]}]}]},{"key":"c843849f-1da1-44d6-9d9c-aac51518b9b1","type":"SECONDARY","units":[{"key":"d25e635a-5e58-45a5-8998-152fa2e7cdf1","text":{"value":"3 Nettokaltmieten"},"label":"Kaution"}]}]},"energy":{"features":[{"type":"yearOfConstruction","label":"Baujahr","value":"2023"},{"type":"state","label":"Zustand der Immobilie","value":"neuwertig"},{"type":"heatingSystem","label":"Heizungsart","value":"Fußbodenheizung"},{"type":"energySource","label":"Energieträger","value":"Fernwärme"}],"has_scales":true,"certificates":[{"key":"041953b9-4bac-48d8-b1b2-e58bec2ef608","name":"Energieausweis","scales":[{"key":"08c32c82-459d-4776-b0b4-b830f0d8505a","type":"DE_RESIDENTIAL","values":[{"label":"Energiebedarf","value":"59,6 kWh/(m²·a)"}],"segments":[{"label":"A+","value":"< 30"},{"label":"A","value":"30 - 49"},{"label":"B","value":"50 - 74"},{"label":"C","value":"75 - 99"},{"label":"D","value":"100 - 129"},{"label":"E","value":"130 - 159"},{"label":"F","value":"160 - 199"},{"label":"G","value":"200 - 250"},{"label":"H","value":"> 250"}],"aria_label":"EfficiencyClass: B bei einer Spanne von A+ bis H.Der Energieverbrauch liegt bei 59,6 Kilowattstunden pro Quadratmeter.","efficiency_class":{"index":2,"rating":"B"}}],"features":[{"type":"basedOn","label":"Energieausweistyp","value":"Bedarfsausweis"},{"type":"validity","label":"Gültigkeit","value":"15.02.2024 bis 14.02.2034"},{"type":"primaryEnergySource","label":"Wesentliche Energieträger","value":"Fernwärme"}]}]},"gallery":{"images":[{"alt":"Studio zur Miete 929 € 1 Zimmer 29,5 m² 5. Geschoss Friedenauer Höhe 6 Friedenau Berlin 12159","key":"554acc95-7aee-4dc3-a01d-e00f876f9a68","url":"https://mms.immowelt.de/5/5/4/a/554acc95-7aee-4dc3-a01d-e00f876f9a68.jpg?ci_seal=f34633da6f4e5aa7785e4bc48d864e4398d35f3c","title":"Neues Stadtquartier in Friedenau","aria_label":"Neues Stadtquartier in Friedenau","description":"Neues Stadtquartier in Friedenau"},{"key":"a2804941-cfb3-42d6-857d-3e8e919a7595","url":"https://mms.immowelt.de/a/2/8/0/a2804941-cfb3-42d6-857d-3e8e919a7595.jpg?ci_seal=c2871e14512b62ab70c1b30f41476866ddc2af71","title":"lichtdurchflutete Räume","aria_label":"lichtdurchflutete Räume","description":"lichtdurchflutete Räume"}]},"features":{"details":{"categories":[{"title":"Allgemeine Informationen","elements":[{"icon":"availability","value":"Bezug: Sofort"},{"icon":"floors","value":"5. Geschoss"}]},{"title":"Barrierefreiheit","elements":[{"icon":"elevator","value":"Personenaufzug"}]},{"title":"Innenbereich","elements":[{"icon":"kitchen","value":"Einbauküche"},{"icon":"bathroom-amenities","value":"Bad mit Dusche"},{"icon":"cellar","value":"Keller"}]},{"title":"Außenbereich","elements":[{"icon":"balcony","value":"Balkon"},{"icon":"terrace","value":"Terrasse","enrichment":"ai"},{"icon":"parking-lots","value":"Stellplatz","enrichment":"ai"}]}],"additional_text":"- Große Balkone und Terrassen in Südausrichtung<br>- Designböden und Parkett mit Fußbodenheizung<br>- Geschmackvolle Dusch- und Wannenbäder<br>- Hochwertige Einbauküchen mit Geräten<br>- 1 bis 3 Zimmer mit 27 bis 91 m² Wohnfläche<br>- Große bodentiefe Fenster<br>- Ca. 2,70 m Deckenhöhe<br>- Lift von der Tiefgarage in alle Etagen<br>- Digitales Schließsystem<br>- Zahlreiche Fahrradstellplätze<br>- Pkw-Tiefgaragenstellplätze optional"},"preview":[{"icon":"availability","value":"Bezug: Sofort"},{"icon":"floors","value":"5. Geschoss"},{"icon":"kitchen","value":"Einbauküche"},{"icon":"elevator","value":"Personenaufzug"},{"icon":"cellar","value":"Keller"},{"icon":"parking-lots","value":"Stellplatz","enrichment":"ai"},{"icon":"balcony","value":"Balkon"},{"icon":"terrace","value":"Terrasse","enrichment":"ai"}]},"location":{"address":{"city":"Berlin","street":"Friedenauer Höhe 6","country":"DEU","district":"Friedenau","zip_code":"12159"},"geometry":{"type":"Point","coordinates":[13.33655452728271,52.47751617431641]},"is_address_published":true},"mortgage":{"id":"7847437c-82b4-4347-a6b6-452ecc09f62d","zip":"12159","city":"Berlin","prov":0,"brand":"immowelt","price":0,"region":"Berlin","country":"DEU","monthly_amount":0,"show_rent_label":true,"federal_state_geo_id":"AD04DE11","show_monthly_rate_label":false,"formatted_monthly_amount":"0"},"documents":{"files":[{"key":"2ac74527-9151-42ca-8a63-1a8b0f32201b","url":"https://mms.immowelt.de/2/a/c/7/2ac74527-9151-42ca-8a63-1a8b0f32201b.pdf?ci_seal=d475b460f9385aab130cb29e65b7c1b7b50ce55f","title":"Grundriss_WE_519.pdf","subtitle":"PDF-Dokument"}],"display":true},"hard_facts":{"facts":[{"type":"numberOfRooms","label":"Zimmer","value":"1 Zimmer","split_value":"1"},{"type":"livingSpace","label":"m²","value":"29,5 m²","split_value":"29,5"},{"type":"numberOfFloors","label":"Geschoss","value":"5. Geschoss","split_value":"5."}],"price":{"value":"929 €","addition":{"value":"Kaltmiete"},"formatted":"929 €","aria_label":"929 €","financial_link":{"href":"https://www.immowelt.de/immobilienfinanzierung-anfragen/?price=929&originvariant=expose-hardfacts&zip=12159&city=Berlin&classifiedid=7847437c-82b4-4347-a6b6-452ecc09f62d&m=classified_detail_request_offer_find_financing_partners_step1","label":"Finanzierung anfragen","partner_name":"KFW"},"additional_information":"Kaltmiete"},"title":"Studio zur Miete","prices":[{"label":"Kaltmiete","value":"929 €","aria_label":"929 €"},{"label":"Warmmiete","value":"1.049 €","aria_label":"1049 €"}],"keyfacts":["1 Zimmer","29,5 m²","5. Geschoss"],"location_description":"Friedenau ist ein besonders liebenswerter kleiner Ortsteil im Zentrum von Berlin und von den Bezirken Schöneberg, Steglitz und Wilmersdorf umgeben. Mit seinen idyllischen Straßen und charmanten Altbauten strahlt Friedenau eine ruhige und friedliche Atmosphäre aus. Die Gegend ist von vielen Parks und Grünflächen durchzogen, die zum Entspannen und Spazierengehen einladen. Die Infrastruktur ist über Jahrzehnte gewachsen und sehr gut entwickelt, mit einer Vielzahl von Geschäften, Restaurants, Cafés und Supermärkten, die alle Bedürfnisse des täglichen Lebens abdecken. In wenigen Minuten Fußweg erreicht man den S- und U-Bahnhof Bundesplatz und den S- und U-Bahnhof Innsbrucker Platz, wo jeweils auch die Ringbahn hält. Friedenau ist ein beliebter Wohnort für alle, die eine entspannte und ruhige Umgebung im Berliner Zentrum suchen und dabei auch einen lebendigen Kiez schätzen, stellvertretend seien hier der Wochenmarkt am Breslauer Platz, das Cosima-Filmtheater am Varziner Platz und der Zig Zag Jazz Club in der Hauptstraße genannt."},"partner_ad":{"show_partner_ad":true},"description":{"texts":[{"text":"Das neue Stadtquartier Smyles Berlin im Schöneberger Ortsteil Friedenau verfügt über fünf moderne Gebäude mit insgesamt 537 hellen 1- bis 3-Zimmer-Wohnungen zur Miete. Über acht Geschosse verteilen sich unterschiedlichste Wohnungstypen für nahezu jeden Bedarf, vom kleinen Gartenstudio im Erdgeschoss, über das klassische Apartment im Obergeschoss bis hin zum großzügigen Penthouse mit Dachterrasse. Die Wohnflächen variieren zwischen 27 und 91 m² und alle Wohnungen verfügen über einen sonnigen Balkon oder eine Terrasse. Bodentiefe Fenster sorgen für viel Tageslicht, geschmackvolle Dusch- und Wannenbäder und eine hochwertige Einbauküche mit allen Geräten runden die bezugsfertige Ausstattung ab. Neben zahlreichen Fahrradstellplätzen stehen optional Pkw-Stellplätze in der Tiefgarage zur Verfügung."},{"text":"Friedenau ist ein besonders liebenswerter kleiner Ortsteil im Zentrum von Berlin und von den Bezirken Schöneberg, Steglitz und Wilmersdorf umgeben. Mit seinen idyllischen Straßen und charmanten Altbauten strahlt Friedenau eine ruhige und friedliche Atmosphäre aus. Die Gegend ist von vielen Parks und Grünflächen durchzogen, die zum Entspannen und Spazierengehen einladen. Die Infrastruktur ist über Jahrzehnte gewachsen und sehr gut entwickelt, mit einer Vielzahl von Geschäften, Restaurants, Cafés und Supermärkten, die alle Bedürfnisse des täglichen Lebens abdecken. In wenigen Minuten Fußweg erreicht man den S- und U-Bahnhof Bundesplatz und den S- und U-Bahnhof Innsbrucker Platz, wo jeweils auch die Ringbahn hält. Friedenau ist ein beliebter Wohnort für alle, die eine entspannte und ruhige Umgebung im Berliner Zentrum suchen und dabei auch einen lebendigen Kiez schätzen, stellvertretend seien hier der Wochenmarkt am Breslauer Platz, das Cosima-Filmtheater am Varziner Platz und der Zig Zag Jazz Club in der Hauptstraße genannt.","headline":"Lage"},{"text":"Stichworte\nTiefgarage vorhanden, Anzahl der Badezimmer: 1, Anzahl Balkone: 1, Bundesland: Berlin, 7 Etagen, Wohnungsnr.: WE 01.05.12","headline":"Weitere Informationen"}],"headline":"Smyles Living - kompakte Neubauwohnung mit Charme","description":"Das neue Stadtquartier Smyles Berlin im Schöneberger Ortsteil Friedenau verfügt über fünf moderne Gebäude mit insgesamt 537 hellen 1- bis 3-Zimmer-Wohnungen zur Miete. Über acht Geschosse verteilen sich unterschiedlichste Wohnungstypen für nahezu jeden Bedarf, vom kleinen Gartenstudio im Erdgeschoss, über das klassische Apartment im Obergeschoss bi..."},"enriched_media":{"medias":[{"key":"dda18726-791f-447f-ba6d-d9ab377ff02a","url":"https://my.matterport.com/show/?m=mAtY3DcCaPZ","title":"virtueller Beispielrundgang","url_type":"VIRTUAL_TOUR","preview_image":{"alt":"Neues Stadtquartier in Friedenau","key":"554acc95-7aee-4dc3-a01d-e00f876f9a68","url":"https://mms.immowelt.de/5/5/4/a/554acc95-7aee-4dc3-a01d-e00f876f9a68.jpg?ci_seal=f34633da6f4e5aa7785e4bc48d864e4398d35f3c","title":"Neues Stadtquartier in Friedenau","aria_label":"Neues Stadtquartier in Friedenau","description":"Neues Stadtquartier in Friedenau"},"virtual_tours":{"provider":"MATTERPORT","policy_value":"translation.enriched_media.virtual_tour.matterport.policy"}},{"key":"c9e7c5f7-9009-409b-931a-361ca0ef0cf7","url":"https://www.youtube.com/v/bdBl1szHs9s","title":"Smyles Living","url_type":"MOVIE"}]},"area_description":{"headline":"Lage","metadata":{"language":"de"},"description":"Friedenau ist ein besonders liebenswerter kleiner Ortsteil im Zentrum von Berlin und von den Bezirken Schöneberg, Steglitz und Wilmersdorf umgeben. Mit seinen idyllischen Straßen und charmanten Altbauten strahlt Friedenau eine ruhige und friedliche Atmosphäre aus. Die Gegend ist von vielen Parks und Grünflächen durchzogen, die zum Entspannen und Sp..."},"main_description":{"headline":"Smyles Living - kompakte Neubauwohnung mit Charme","metadata":{"language":"de"},"description":"Das neue Stadtquartier Smyles Berlin im Schöneberger Ortsteil Friedenau verfügt über fünf moderne Gebäude mit insgesamt 537 hellen 1- bis 3-Zimmer-Wohnungen zur Miete. Über acht Geschosse verteilen sich unterschiedlichste Wohnungstypen für nahezu jeden Bedarf, vom kleinen Gartenstudio im Erdgeschoss, über das klassische Apartment im Obergeschoss bi..."},"price_comparison":{"is_sale":false,"legal_text":"Der angegebene Quadratmeterpreis wurde von AVIV Germany automatisch anhand des angegebenen Verkaufspreises und der angegebenen Quadratmeterzahl des Objektes berechnet. Der Vergleichswert basiert auf den verfügbaren Marktwerten zu Objekten ähnlicher Beschaffenheit und Lage. Diese Angaben können eine gutachterliche Bewertung nicht ersetzen, da diese immer auch vom Zustand und der Lage des konkreten Objektes abhängig ist.","price_per_sqm":"31,54","has_main_price":true},"seller_lead_link":{},"extended_info_description":{"headline":"Weitere Informationen","metadata":{"language":"de"},"description":"Stichworte\nTiefgarage vorhanden, Anzahl der Badezimmer: 1, Anzahl Balkone: 1, Bundesland: Berlin, 7 Etagen, Wohnungsnr.: WE 01.05.12"}},"contact_sections":{"id":"26UBAUCV6EY5","brand":"immowelt","static":{"phone_numbers":["030 44353300"]},"sticky":{"phone_numbers":["030 44353300"]},"provider":{"badges":[{"title":"Platin Partner","duration":"10 Jahre Partnerschaft","image_url":"https://s.immowelt.org/shared/images/partner-badges/platin-partner.svg","description":"10 Jahre Partnerschaft – das kann sich sehen lassen! immowelt zeichnet die langjährige Zusammenarbeit mit dem immowelt Platin Partner Award aus."}],"address":"Leipziger Straße 51, 10117 Berlin","website":"https://www.strategis.de/","imprint_url":"https://www.immowelt.de/profil/9e54973f13ffde498cb2190efc8b9890#impressum","profile_url":"https://www.immowelt.de/profil/9e54973f13ffde498cb2190efc8b9890","contact_card":{"title":"Stefan Prill","display":true,"logo_url":null,"subtitle":"Dein Kontakt"},"display_links":true,"phone_numbers":["030 44353300"],"publisher_type":"AGENCY","is_private_owner":false,"intermediary_card":{"title":"STRATEGIS AG","display":true,"logo_url":"https://mms.immowelt.de/b/f/2/1/bf213538-3e94-4549-9aef-a9063d983f6f.jpg?ci_seal=3b1d4022350df6c3ca4b9f8fb7eec7acb30acdfe","subtitle":"Gewerblicher Anbieter","logo_href":"https://www.immowelt.de/profil/9e54973f13ffde498cb2190efc8b9890"},"agency_legal_informations":[]},"agency_id":"1107086","legacy_id":"7847437c-82b4-4347-a6b6-452ecc09f62d","contact_card":{"title":"STRATEGIS AG","subtitle":"Stefan Prill","agency_logo":{"display":true,"logo_url":"https://mms.immowelt.de/b/f/2/1/bf213538-3e94-4549-9aef-a9063d983f6f.jpg?ci_seal=3b1d4022350df6c3ca4b9f8fb7eec7acb30acdfe"},"contact_logo":{"display":false,"logo_url":null},"phone_numbers":["030 44353300"],"is_private_owner":false},"contact_form":{"contact_card":{"title":"STRATEGIS AG","logo_url":"https://mms.immowelt.de/b/f/2/1/bf213538-3e94-4549-9aef-a9063d983f6f.jpg?ci_seal=3b1d4022350df6c3ca4b9f8fb7eec7acb30acdfe","subtitle":"Stefan Prill","phone_numbers":["030 44353300"],"is_private_owner":false},"custom_fields":{"location_enabled":false},"subject_label":"Deine Nachricht an Stefan Prill","display_owner_flag":true,"should_send_lead_value":true},"mobile_phones":{"title":"Stefan Prill","logo_url":null,"subtitle":"STRATEGIS AG","phone_numbers":["030 44353300"],"is_private_owner":false},"confirmation_page":{"is_finance_offer_button_enabled":false}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Immowelt Property","description":"Extract full property details from an Immowelt listing URL, including price, specs, photo gallery, energy certificate, location, and contact data.\n\n**Credit cost:** 1 credit per call","operationId":"post-immowelt-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Immowelt property detail URL.\n\n**Example:**\n\n    https://www.immowelt.de/expose/65de0309-bf41-48ce-86fd-6a3441fd0487\n\n**Notes:**\n- Only `/expose/` listing URLs are accepted.\n- Copy the listing URL from search results or from immowelt.de.","schema":{"type":"string","description":"Full Immowelt property detail URL.\n\n**Example:**\n\n    https://www.immowelt.de/expose/65de0309-bf41-48ce-86fd-6a3441fd0487\n\n**Notes:**\n- Only `/expose/` listing URLs are accepted.\n- Copy the listing URL from search results or from immowelt.de."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"tags":{"type":"object","properties":{"is_new":{"type":"boolean"},"has3_d_visit":{"type":"boolean"},"is_exclusive":{"type":"boolean"},"has_brokerage_fee":{"type":"boolean"}}},"brand":{"type":"string"},"sections":{"type":"object","properties":{"key":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}},"price":{"type":"object","properties":{"base":{"type":"object","properties":{"main":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"alt":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}},"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}}}},"type":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}}}}}}},"layout":{"type":"string"},"breakdown":{"type":"object","properties":{"bar":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"color_type":{"type":"string"},"percentage":{"type":"number"}}}},"total":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"aria_label":{"type":"string"},"is_estimated":{"type":"boolean"}}},"groups":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"alt":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}},"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}},"color_type":{"type":"string"},"highlighted":{"type":"boolean"}}}}}},"additional":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"label":{"type":"string"}}}},"components":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"type":{"type":"string"},"units":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"main":{"type":"object","properties":{"price":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}},"highlighted":{"type":"boolean"}}}}},"details":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"object","properties":{"main":{"type":"string"}}},"value":{"type":"object","properties":{"alt":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}},"main":{"type":"object","properties":{"value":{"type":"string"},"aria_label":{"type":"string"}}}}}}}}}}}}}}}}}}},"energy":{"type":"object","properties":{"features":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}}}},"has_scales":{"type":"boolean"},"certificates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"scales":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"type":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"segments":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"aria_label":{"type":"string"},"efficiency_class":{"type":"object","properties":{"index":{"type":"integer"},"rating":{"type":"string"}}}}}},"features":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}}}}}}}}},"gallery":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"alt":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"aria_label":{"type":"string"},"description":{"type":"string"}}}}}},"features":{"type":"object","properties":{"details":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"elements":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"string"},"value":{"type":"string"}}}}}}},"additional_text":{"type":"string"}}},"preview":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"string"},"value":{"type":"string"}}}}}},"location":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"district":{"type":"string"},"zip_code":{"type":"string"}}},"geometry":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"is_address_published":{"type":"boolean"}}},"mortgage":{"type":"object","properties":{"id":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"prov":{"type":"integer"},"brand":{"type":"string"},"price":{"type":"integer"},"region":{"type":"string"},"country":{"type":"string"},"monthly_amount":{"type":"integer"},"show_rent_label":{"type":"boolean"},"federal_state_geo_id":{"type":"string"},"show_monthly_rate_label":{"type":"boolean"},"formatted_monthly_amount":{"type":"string"}}},"documents":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"subtitle":{"type":"string"}}}},"display":{"type":"boolean"}}},"hard_facts":{"type":"object","properties":{"facts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"split_value":{"type":"string"}}}},"price":{"type":"object","properties":{"value":{"type":"string"},"addition":{"type":"object","properties":{"value":{"type":"string"}}},"formatted":{"type":"string"},"aria_label":{"type":"string"},"financial_link":{"type":"object","properties":{"href":{"type":"string"},"label":{"type":"string"},"partner_name":{"type":"string"}}},"additional_information":{"type":"string"}}},"title":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"aria_label":{"type":"string"}}}},"keyfacts":{"type":"array","items":{"type":"string"}},"location_description":{"type":"string"}}},"partner_ad":{"type":"object","properties":{"show_partner_ad":{"type":"boolean"}}},"description":{"type":"object","properties":{"texts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}},"headline":{"type":"string"},"description":{"type":"string"}}},"enriched_media":{"type":"object","properties":{"medias":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"url_type":{"type":"string"},"preview_image":{"type":"object","properties":{"alt":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"aria_label":{"type":"string"},"description":{"type":"string"}}},"virtual_tours":{"type":"object","properties":{"provider":{"type":"string"},"policy_value":{"type":"string"}}}}}}}},"area_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}},"main_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}},"price_comparison":{"type":"object","properties":{"is_sale":{"type":"boolean"},"legal_text":{"type":"string"},"price_per_sqm":{"type":"string"},"has_main_price":{"type":"boolean"}}},"seller_lead_link":{"type":"object","properties":{}},"extended_info_description":{"type":"object","properties":{"headline":{"type":"string"},"metadata":{"type":"object","properties":{"language":{"type":"string"}}},"description":{"type":"string"}}}}},"contact_sections":{"type":"object","properties":{"id":{"type":"string"},"brand":{"type":"string"},"static":{"type":"object","properties":{"phone_numbers":{"type":"array","items":{"type":"string"}}}},"sticky":{"type":"object","properties":{"phone_numbers":{"type":"array","items":{"type":"string"}}}},"provider":{"type":"object","properties":{"badges":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"duration":{"type":"string"},"image_url":{"type":"string"},"description":{"type":"string"}}}},"address":{"type":"string"},"website":{"type":"string"},"imprint_url":{"type":"string"},"profile_url":{"type":"string"},"contact_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"nullable":true},"subtitle":{"type":"string"}}},"display_links":{"type":"boolean"},"phone_numbers":{"type":"array","items":{"type":"string"}},"publisher_type":{"type":"string"},"is_private_owner":{"type":"boolean"},"intermediary_card":{"type":"object","properties":{"title":{"type":"string"},"display":{"type":"boolean"},"logo_url":{"type":"string"},"subtitle":{"type":"string"},"logo_href":{"type":"string"}}},"agency_legal_informations":{"type":"array","items":{}}}},"agency_id":{"type":"string"},"legacy_id":{"type":"string"},"contact_card":{"type":"object","properties":{"title":{"type":"string"},"subtitle":{"type":"string"},"agency_logo":{"type":"object","properties":{"display":{"type":"boolean"},"logo_url":{"type":"string"}}},"contact_logo":{"type":"object","properties":{"display":{"type":"boolean"},"logo_url":{"nullable":true}}},"phone_numbers":{"type":"array","items":{"type":"string"}},"is_private_owner":{"type":"boolean"}}},"contact_form":{"type":"object","properties":{"contact_card":{"type":"object","properties":{"title":{"type":"string"},"logo_url":{"type":"string"},"subtitle":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"string"}},"is_private_owner":{"type":"boolean"}}},"custom_fields":{"type":"object","properties":{"location_enabled":{"type":"boolean"}}},"subject_label":{"type":"string"},"display_owner_flag":{"type":"boolean"},"should_send_lead_value":{"type":"boolean"}}},"mobile_phones":{"type":"object","properties":{"title":{"type":"string"},"logo_url":{"nullable":true},"subtitle":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"string"}},"is_private_owner":{"type":"boolean"}}},"confirmation_page":{"type":"object","properties":{"is_finance_offer_button_enabled":{"type":"boolean"}}}}}}},"examples":{"Lookup Smyles Living rental in Berlin Friedenau":{"value":{"id":"26UBAUCV6EY5","tags":{"is_new":true,"has3_d_visit":true,"is_exclusive":false,"has_brokerage_fee":false},"brand":"immowelt","sections":{"key":{"keys":[{"label":"Online-ID","value":"26UBAUCV6EY5"},{"label":"Referenznummer","value":"Smyles519"}]},"price":{"base":{"main":{"key":"71551910-0abf-4d06-8f27-4fde2e081154","label":{"main":"Kaltmiete"},"value":{"alt":{"value":"31,54 €/m²","aria_label":"31,54 Euro pro Quadratmeter"},"main":{"value":"929 €","aria_label":"929 €"}}},"type":"RENT","details":[{"key":"36dbb5df-3851-451f-881f-09ffee2179ed","label":{"main":"Nebenkosten"},"value":{"main":{"value":"85 €","aria_label":"85 €"}}},{"key":"0989e604-7621-4a4a-bf87-cfc17aa9a3fd","label":{"main":"Heizkosten"},"value":{"main":{"value":"35 €","aria_label":"35 €"}}},{"key":"b3a886a2-490b-4c31-8948-e449245d1f79","label":{"main":"Warmmiete"},"value":{"main":{"value":"1.049 €","aria_label":"1049 €"}}}]},"layout":"GERMAN_RENT","breakdown":{"bar":[{"key":"473faa56-8912-4ac9-807a-3c8f0ae6d71c","color_type":"BASE_RENT","percentage":0.8856},{"key":"379bf29e-db44-4a8d-a92b-0cb021107f65","color_type":"OPERATING_COSTS","percentage":0.081},{"key":"d35e26a6-9b99-4ff9-9319-187c18b3d35e","color_type":"HEATING_COSTS","percentage":0.0334}],"total":{"type":"DEFAULT","label":"Warmmiete","value":"1.049 €","aria_label":"1049 €","is_estimated":false},"groups":[{"key":"473faa56-8912-4ac9-807a-3c8f0ae6d71c","label":{"main":"Kaltmiete"},"value":{"alt":{"value":"31,54 €/m²","aria_label":"31,54 Euro pro Quadratmeter"},"main":{"value":"929 €","aria_label":"929 €"}},"color_type":"BASE_RENT","highlighted":true},{"key":"379bf29e-db44-4a8d-a92b-0cb021107f65","label":{"main":"Nebenkosten"},"value":{"main":{"value":"85 €","aria_label":"85 €"}},"color_type":"OPERATING_COSTS","highlighted":true},{"key":"d35e26a6-9b99-4ff9-9319-187c18b3d35e","label":{"main":"Heizkosten"},"value":{"main":{"value":"35 €","aria_label":"35 €"}},"color_type":"HEATING_COSTS","highlighted":true}]},"additional":[{"text":"3 Nettokaltmieten","label":"Kaution"}],"components":[{"key":"7b6a72d6-5227-4169-9eb1-24d890af84da","type":"PRIMARY","units":[{"key":"c4fa6f93-0047-413d-97ee-0d7ca56b53e0","main":{"price":{"key":"3dd2fc16-b878-4eee-9c67-d81a9695b90a","label":{"main":"Warmmiete"},"value":{"main":{"value":"1.049 €","aria_label":"1049 €"}},"highlighted":true}},"details":[{"key":"f1adb411-938c-49d3-91b0-cdf028f739d0","label":"davon","prices":[{"key":"89b564ac-f7b6-4333-9197-1d7253b7d960","label":{"main":"Kaltmiete"},"value":{"alt":{"value":"31,54 €/m²","aria_label":"31,54 Euro pro Quadratmeter"},"main":{"value":"929 €","aria_label":"929 €"}}},{"key":"3caa79f6-0c02-494a-af8a-2db276fd2080","label":{"main":"Nebenkosten"},"value":{"main":{"value":"85 €","aria_label":"85 €"}}},{"key":"13edf3f5-1ff3-4039-ab41-70b729522c4f","label":{"main":"Heizkosten"},"value":{"main":{"value":"35 €","aria_label":"35 €"}}}]}]}]},{"key":"c843849f-1da1-44d6-9d9c-aac51518b9b1","type":"SECONDARY","units":[{"key":"d25e635a-5e58-45a5-8998-152fa2e7cdf1","text":{"value":"3 Nettokaltmieten"},"label":"Kaution"}]}]},"energy":{"features":[{"type":"yearOfConstruction","label":"Baujahr","value":"2023"},{"type":"state","label":"Zustand der Immobilie","value":"neuwertig"},{"type":"heatingSystem","label":"Heizungsart","value":"Fußbodenheizung"},{"type":"energySource","label":"Energieträger","value":"Fernwärme"}],"has_scales":true,"certificates":[{"key":"041953b9-4bac-48d8-b1b2-e58bec2ef608","name":"Energieausweis","scales":[{"key":"08c32c82-459d-4776-b0b4-b830f0d8505a","type":"DE_RESIDENTIAL","values":[{"label":"Energiebedarf","value":"59,6 kWh/(m²·a)"}],"segments":[{"label":"A+","value":"< 30"},{"label":"A","value":"30 - 49"},{"label":"B","value":"50 - 74"},{"label":"C","value":"75 - 99"},{"label":"D","value":"100 - 129"},{"label":"E","value":"130 - 159"},{"label":"F","value":"160 - 199"},{"label":"G","value":"200 - 250"},{"label":"H","value":"> 250"}],"aria_label":"EfficiencyClass: B bei einer Spanne von A+ bis H.Der Energieverbrauch liegt bei 59,6 Kilowattstunden pro Quadratmeter.","efficiency_class":{"index":2,"rating":"B"}}],"features":[{"type":"basedOn","label":"Energieausweistyp","value":"Bedarfsausweis"},{"type":"validity","label":"Gültigkeit","value":"15.02.2024 bis 14.02.2034"},{"type":"primaryEnergySource","label":"Wesentliche Energieträger","value":"Fernwärme"}]}]},"gallery":{"images":[{"alt":"Studio zur Miete 929 € 1 Zimmer 29,5 m² 5. Geschoss Friedenauer Höhe 6 Friedenau Berlin 12159","key":"554acc95-7aee-4dc3-a01d-e00f876f9a68","url":"https://mms.immowelt.de/5/5/4/a/554acc95-7aee-4dc3-a01d-e00f876f9a68.jpg?ci_seal=f34633da6f4e5aa7785e4bc48d864e4398d35f3c","title":"Neues Stadtquartier in Friedenau","aria_label":"Neues Stadtquartier in Friedenau","description":"Neues Stadtquartier in Friedenau"},{"key":"a2804941-cfb3-42d6-857d-3e8e919a7595","url":"https://mms.immowelt.de/a/2/8/0/a2804941-cfb3-42d6-857d-3e8e919a7595.jpg?ci_seal=c2871e14512b62ab70c1b30f41476866ddc2af71","title":"lichtdurchflutete Räume","aria_label":"lichtdurchflutete Räume","description":"lichtdurchflutete Räume"}]},"features":{"details":{"categories":[{"title":"Allgemeine Informationen","elements":[{"icon":"availability","value":"Bezug: Sofort"},{"icon":"floors","value":"5. Geschoss"}]},{"title":"Barrierefreiheit","elements":[{"icon":"elevator","value":"Personenaufzug"}]},{"title":"Innenbereich","elements":[{"icon":"kitchen","value":"Einbauküche"},{"icon":"bathroom-amenities","value":"Bad mit Dusche"},{"icon":"cellar","value":"Keller"}]},{"title":"Außenbereich","elements":[{"icon":"balcony","value":"Balkon"},{"icon":"terrace","value":"Terrasse","enrichment":"ai"},{"icon":"parking-lots","value":"Stellplatz","enrichment":"ai"}]}],"additional_text":"- Große Balkone und Terrassen in Südausrichtung<br>- Designböden und Parkett mit Fußbodenheizung<br>- Geschmackvolle Dusch- und Wannenbäder<br>- Hochwertige Einbauküchen mit Geräten<br>- 1 bis 3 Zimmer mit 27 bis 91 m² Wohnfläche<br>- Große bodentiefe Fenster<br>- Ca. 2,70 m Deckenhöhe<br>- Lift von der Tiefgarage in alle Etagen<br>- Digitales Schließsystem<br>- Zahlreiche Fahrradstellplätze<br>- Pkw-Tiefgaragenstellplätze optional"},"preview":[{"icon":"availability","value":"Bezug: Sofort"},{"icon":"floors","value":"5. Geschoss"},{"icon":"kitchen","value":"Einbauküche"},{"icon":"elevator","value":"Personenaufzug"},{"icon":"cellar","value":"Keller"},{"icon":"parking-lots","value":"Stellplatz","enrichment":"ai"},{"icon":"balcony","value":"Balkon"},{"icon":"terrace","value":"Terrasse","enrichment":"ai"}]},"location":{"address":{"city":"Berlin","street":"Friedenauer Höhe 6","country":"DEU","district":"Friedenau","zip_code":"12159"},"geometry":{"type":"Point","coordinates":[13.33655452728271,52.47751617431641]},"is_address_published":true},"mortgage":{"id":"7847437c-82b4-4347-a6b6-452ecc09f62d","zip":"12159","city":"Berlin","prov":0,"brand":"immowelt","price":0,"region":"Berlin","country":"DEU","monthly_amount":0,"show_rent_label":true,"federal_state_geo_id":"AD04DE11","show_monthly_rate_label":false,"formatted_monthly_amount":"0"},"documents":{"files":[{"key":"2ac74527-9151-42ca-8a63-1a8b0f32201b","url":"https://mms.immowelt.de/2/a/c/7/2ac74527-9151-42ca-8a63-1a8b0f32201b.pdf?ci_seal=d475b460f9385aab130cb29e65b7c1b7b50ce55f","title":"Grundriss_WE_519.pdf","subtitle":"PDF-Dokument"}],"display":true},"hard_facts":{"facts":[{"type":"numberOfRooms","label":"Zimmer","value":"1 Zimmer","split_value":"1"},{"type":"livingSpace","label":"m²","value":"29,5 m²","split_value":"29,5"},{"type":"numberOfFloors","label":"Geschoss","value":"5. Geschoss","split_value":"5."}],"price":{"value":"929 €","addition":{"value":"Kaltmiete"},"formatted":"929 €","aria_label":"929 €","financial_link":{"href":"https://www.immowelt.de/immobilienfinanzierung-anfragen/?price=929&originvariant=expose-hardfacts&zip=12159&city=Berlin&classifiedid=7847437c-82b4-4347-a6b6-452ecc09f62d&m=classified_detail_request_offer_find_financing_partners_step1","label":"Finanzierung anfragen","partner_name":"KFW"},"additional_information":"Kaltmiete"},"title":"Studio zur Miete","prices":[{"label":"Kaltmiete","value":"929 €","aria_label":"929 €"},{"label":"Warmmiete","value":"1.049 €","aria_label":"1049 €"}],"keyfacts":["1 Zimmer","29,5 m²","5. Geschoss"],"location_description":"Friedenau ist ein besonders liebenswerter kleiner Ortsteil im Zentrum von Berlin und von den Bezirken Schöneberg, Steglitz und Wilmersdorf umgeben. Mit seinen idyllischen Straßen und charmanten Altbauten strahlt Friedenau eine ruhige und friedliche Atmosphäre aus. Die Gegend ist von vielen Parks und Grünflächen durchzogen, die zum Entspannen und Spazierengehen einladen. Die Infrastruktur ist über Jahrzehnte gewachsen und sehr gut entwickelt, mit einer Vielzahl von Geschäften, Restaurants, Cafés und Supermärkten, die alle Bedürfnisse des täglichen Lebens abdecken. In wenigen Minuten Fußweg erreicht man den S- und U-Bahnhof Bundesplatz und den S- und U-Bahnhof Innsbrucker Platz, wo jeweils auch die Ringbahn hält. Friedenau ist ein beliebter Wohnort für alle, die eine entspannte und ruhige Umgebung im Berliner Zentrum suchen und dabei auch einen lebendigen Kiez schätzen, stellvertretend seien hier der Wochenmarkt am Breslauer Platz, das Cosima-Filmtheater am Varziner Platz und der Zig Zag Jazz Club in der Hauptstraße genannt."},"partner_ad":{"show_partner_ad":true},"description":{"texts":[{"text":"Das neue Stadtquartier Smyles Berlin im Schöneberger Ortsteil Friedenau verfügt über fünf moderne Gebäude mit insgesamt 537 hellen 1- bis 3-Zimmer-Wohnungen zur Miete. Über acht Geschosse verteilen sich unterschiedlichste Wohnungstypen für nahezu jeden Bedarf, vom kleinen Gartenstudio im Erdgeschoss, über das klassische Apartment im Obergeschoss bis hin zum großzügigen Penthouse mit Dachterrasse. Die Wohnflächen variieren zwischen 27 und 91 m² und alle Wohnungen verfügen über einen sonnigen Balkon oder eine Terrasse. Bodentiefe Fenster sorgen für viel Tageslicht, geschmackvolle Dusch- und Wannenbäder und eine hochwertige Einbauküche mit allen Geräten runden die bezugsfertige Ausstattung ab. Neben zahlreichen Fahrradstellplätzen stehen optional Pkw-Stellplätze in der Tiefgarage zur Verfügung."},{"text":"Friedenau ist ein besonders liebenswerter kleiner Ortsteil im Zentrum von Berlin und von den Bezirken Schöneberg, Steglitz und Wilmersdorf umgeben. Mit seinen idyllischen Straßen und charmanten Altbauten strahlt Friedenau eine ruhige und friedliche Atmosphäre aus. Die Gegend ist von vielen Parks und Grünflächen durchzogen, die zum Entspannen und Spazierengehen einladen. Die Infrastruktur ist über Jahrzehnte gewachsen und sehr gut entwickelt, mit einer Vielzahl von Geschäften, Restaurants, Cafés und Supermärkten, die alle Bedürfnisse des täglichen Lebens abdecken. In wenigen Minuten Fußweg erreicht man den S- und U-Bahnhof Bundesplatz und den S- und U-Bahnhof Innsbrucker Platz, wo jeweils auch die Ringbahn hält. Friedenau ist ein beliebter Wohnort für alle, die eine entspannte und ruhige Umgebung im Berliner Zentrum suchen und dabei auch einen lebendigen Kiez schätzen, stellvertretend seien hier der Wochenmarkt am Breslauer Platz, das Cosima-Filmtheater am Varziner Platz und der Zig Zag Jazz Club in der Hauptstraße genannt.","headline":"Lage"},{"text":"Stichworte\nTiefgarage vorhanden, Anzahl der Badezimmer: 1, Anzahl Balkone: 1, Bundesland: Berlin, 7 Etagen, Wohnungsnr.: WE 01.05.12","headline":"Weitere Informationen"}],"headline":"Smyles Living - kompakte Neubauwohnung mit Charme","description":"Das neue Stadtquartier Smyles Berlin im Schöneberger Ortsteil Friedenau verfügt über fünf moderne Gebäude mit insgesamt 537 hellen 1- bis 3-Zimmer-Wohnungen zur Miete. Über acht Geschosse verteilen sich unterschiedlichste Wohnungstypen für nahezu jeden Bedarf, vom kleinen Gartenstudio im Erdgeschoss, über das klassische Apartment im Obergeschoss bi..."},"enriched_media":{"medias":[{"key":"dda18726-791f-447f-ba6d-d9ab377ff02a","url":"https://my.matterport.com/show/?m=mAtY3DcCaPZ","title":"virtueller Beispielrundgang","url_type":"VIRTUAL_TOUR","preview_image":{"alt":"Neues Stadtquartier in Friedenau","key":"554acc95-7aee-4dc3-a01d-e00f876f9a68","url":"https://mms.immowelt.de/5/5/4/a/554acc95-7aee-4dc3-a01d-e00f876f9a68.jpg?ci_seal=f34633da6f4e5aa7785e4bc48d864e4398d35f3c","title":"Neues Stadtquartier in Friedenau","aria_label":"Neues Stadtquartier in Friedenau","description":"Neues Stadtquartier in Friedenau"},"virtual_tours":{"provider":"MATTERPORT","policy_value":"translation.enriched_media.virtual_tour.matterport.policy"}},{"key":"c9e7c5f7-9009-409b-931a-361ca0ef0cf7","url":"https://www.youtube.com/v/bdBl1szHs9s","title":"Smyles Living","url_type":"MOVIE"}]},"area_description":{"headline":"Lage","metadata":{"language":"de"},"description":"Friedenau ist ein besonders liebenswerter kleiner Ortsteil im Zentrum von Berlin und von den Bezirken Schöneberg, Steglitz und Wilmersdorf umgeben. Mit seinen idyllischen Straßen und charmanten Altbauten strahlt Friedenau eine ruhige und friedliche Atmosphäre aus. Die Gegend ist von vielen Parks und Grünflächen durchzogen, die zum Entspannen und Sp..."},"main_description":{"headline":"Smyles Living - kompakte Neubauwohnung mit Charme","metadata":{"language":"de"},"description":"Das neue Stadtquartier Smyles Berlin im Schöneberger Ortsteil Friedenau verfügt über fünf moderne Gebäude mit insgesamt 537 hellen 1- bis 3-Zimmer-Wohnungen zur Miete. Über acht Geschosse verteilen sich unterschiedlichste Wohnungstypen für nahezu jeden Bedarf, vom kleinen Gartenstudio im Erdgeschoss, über das klassische Apartment im Obergeschoss bi..."},"price_comparison":{"is_sale":false,"legal_text":"Der angegebene Quadratmeterpreis wurde von AVIV Germany automatisch anhand des angegebenen Verkaufspreises und der angegebenen Quadratmeterzahl des Objektes berechnet. Der Vergleichswert basiert auf den verfügbaren Marktwerten zu Objekten ähnlicher Beschaffenheit und Lage. Diese Angaben können eine gutachterliche Bewertung nicht ersetzen, da diese immer auch vom Zustand und der Lage des konkreten Objektes abhängig ist.","price_per_sqm":"31,54","has_main_price":true},"seller_lead_link":{},"extended_info_description":{"headline":"Weitere Informationen","metadata":{"language":"de"},"description":"Stichworte\nTiefgarage vorhanden, Anzahl der Badezimmer: 1, Anzahl Balkone: 1, Bundesland: Berlin, 7 Etagen, Wohnungsnr.: WE 01.05.12"}},"contact_sections":{"id":"26UBAUCV6EY5","brand":"immowelt","static":{"phone_numbers":["030 44353300"]},"sticky":{"phone_numbers":["030 44353300"]},"provider":{"badges":[{"title":"Platin Partner","duration":"10 Jahre Partnerschaft","image_url":"https://s.immowelt.org/shared/images/partner-badges/platin-partner.svg","description":"10 Jahre Partnerschaft – das kann sich sehen lassen! immowelt zeichnet die langjährige Zusammenarbeit mit dem immowelt Platin Partner Award aus."}],"address":"Leipziger Straße 51, 10117 Berlin","website":"https://www.strategis.de/","imprint_url":"https://www.immowelt.de/profil/9e54973f13ffde498cb2190efc8b9890#impressum","profile_url":"https://www.immowelt.de/profil/9e54973f13ffde498cb2190efc8b9890","contact_card":{"title":"Stefan Prill","display":true,"logo_url":null,"subtitle":"Dein Kontakt"},"display_links":true,"phone_numbers":["030 44353300"],"publisher_type":"AGENCY","is_private_owner":false,"intermediary_card":{"title":"STRATEGIS AG","display":true,"logo_url":"https://mms.immowelt.de/b/f/2/1/bf213538-3e94-4549-9aef-a9063d983f6f.jpg?ci_seal=3b1d4022350df6c3ca4b9f8fb7eec7acb30acdfe","subtitle":"Gewerblicher Anbieter","logo_href":"https://www.immowelt.de/profil/9e54973f13ffde498cb2190efc8b9890"},"agency_legal_informations":[]},"agency_id":"1107086","legacy_id":"7847437c-82b4-4347-a6b6-452ecc09f62d","contact_card":{"title":"STRATEGIS AG","subtitle":"Stefan Prill","agency_logo":{"display":true,"logo_url":"https://mms.immowelt.de/b/f/2/1/bf213538-3e94-4549-9aef-a9063d983f6f.jpg?ci_seal=3b1d4022350df6c3ca4b9f8fb7eec7acb30acdfe"},"contact_logo":{"display":false,"logo_url":null},"phone_numbers":["030 44353300"],"is_private_owner":false},"contact_form":{"contact_card":{"title":"STRATEGIS AG","logo_url":"https://mms.immowelt.de/b/f/2/1/bf213538-3e94-4549-9aef-a9063d983f6f.jpg?ci_seal=3b1d4022350df6c3ca4b9f8fb7eec7acb30acdfe","subtitle":"Stefan Prill","phone_numbers":["030 44353300"],"is_private_owner":false},"custom_fields":{"location_enabled":false},"subject_label":"Deine Nachricht an Stefan Prill","display_owner_flag":true,"should_send_lead_value":true},"mobile_phones":{"title":"Stefan Prill","logo_url":null,"subtitle":"STRATEGIS AG","phone_numbers":["030 44353300"],"is_private_owner":false},"confirmation_page":{"is_finance_offer_button_enabled":false}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/copart/search":{"get":{"summary":"Copart Search","description":"Copart Search API: search auction lots by keyword or URL across Copart regional sites. Returns lot listings and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-copart-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Copart search URL.\n\n**Examples:**\n\n```\nchevrolet\n```\n\n```\naudi + region=ca\n```\n\n```\nhttps://www.copart.co.uk/lotSearchResults?query=bmw\n```\n\nUse **Copart Lot** on any result `id` or `url` for full details.","schema":{"type":"string","description":"Search keyword or full Copart search URL.\n\n**Examples:**\n\n```\nchevrolet\n```\n\n```\naudi + region=ca\n```\n\n```\nhttps://www.copart.co.uk/lotSearchResults?query=bmw\n```\n\nUse **Copart Lot** on any result `id` or `url` for full details."}},{"name":"region","in":"query","required":false,"description":"Copart regional site when `query` is a keyword or lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```","schema":{"type":"string","description":"Copart regional site when `query` is a keyword or lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```"}},{"name":"page","in":"query","required":false,"description":"Page number (default: 1).","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number (default: 1)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"region":{"type":"string"},"image_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"region":{"type":"string"},"keyword":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search chevrolet on copart.com (page 1)":{"value":{"results":[{"id":"99998285","url":"https://www.copart.com/lot/99998285/2018-chevrolet-volt-lt-ky-walton","title":"Lot Details","region":"www.copart.com","image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0126/c52d88ab17584eef8aaeec778bfd0cf7_thb.jpg"},{"id":"99997735","url":"https://www.copart.com/lot/99997735/2017-chevrolet-silverado-k1500-high-country-ky-louisville","title":"Lot Details","region":"www.copart.com","image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0126/24b81615824643148af9cd947ab96c3c_thb.jpg"},{"id":"99997465","url":"https://www.copart.com/lot/99997465/2020-transcraft-drop-deck-trailer-va-richmond","title":"Lot Details","region":"www.copart.com","image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0126/1d92611531ed43c89a846d17fd7a0e87_thb.jpg"}],"pagination":{"next":"https://www.copart.com/lotSearchResults?free=true&query=chevrolet&page=2","page":1,"region":"www.copart.com","keyword":"chevrolet","per_page":20,"total_pages":500,"total_results":10000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Copart Search","description":"Copart Search API: search auction lots by keyword or URL across Copart regional sites. Returns lot listings and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-copart-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Copart search URL.\n\n**Examples:**\n\n```\nchevrolet\n```\n\n```\naudi + region=ca\n```\n\n```\nhttps://www.copart.co.uk/lotSearchResults?query=bmw\n```\n\nUse **Copart Lot** on any result `id` or `url` for full details.","schema":{"type":"string","description":"Search keyword or full Copart search URL.\n\n**Examples:**\n\n```\nchevrolet\n```\n\n```\naudi + region=ca\n```\n\n```\nhttps://www.copart.co.uk/lotSearchResults?query=bmw\n```\n\nUse **Copart Lot** on any result `id` or `url` for full details."}},{"name":"region","in":"query","required":false,"description":"Copart regional site when `query` is a keyword or lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```","schema":{"type":"string","description":"Copart regional site when `query` is a keyword or lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```"}},{"name":"page","in":"query","required":false,"description":"Page number (default: 1).","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number (default: 1)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"region":{"type":"string"},"image_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"region":{"type":"string"},"keyword":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search chevrolet on copart.com (page 1)":{"value":{"results":[{"id":"99998285","url":"https://www.copart.com/lot/99998285/2018-chevrolet-volt-lt-ky-walton","title":"Lot Details","region":"www.copart.com","image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0126/c52d88ab17584eef8aaeec778bfd0cf7_thb.jpg"},{"id":"99997735","url":"https://www.copart.com/lot/99997735/2017-chevrolet-silverado-k1500-high-country-ky-louisville","title":"Lot Details","region":"www.copart.com","image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0126/24b81615824643148af9cd947ab96c3c_thb.jpg"},{"id":"99997465","url":"https://www.copart.com/lot/99997465/2020-transcraft-drop-deck-trailer-va-richmond","title":"Lot Details","region":"www.copart.com","image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0126/1d92611531ed43c89a846d17fd7a0e87_thb.jpg"}],"pagination":{"next":"https://www.copart.com/lotSearchResults?free=true&query=chevrolet&page=2","page":1,"region":"www.copart.com","keyword":"chevrolet","per_page":20,"total_pages":500,"total_results":10000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/copart/lot":{"get":{"summary":"Copart Lot","description":"Copart Lot API: retrieve structured auction lot data by lot number or URL. Specs, damage, bids, photos, yard location and sale status across regional Copart sites.\n\n**Credit cost:** 2 credits per call","operationId":"get-copart-lot","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Copart lot number or full lot URL.\n\n**Examples:**\n\n```\n55295666\n```\n\n```\n55295666 + region=uk\n```\n\n```\nhttps://www.copart.co.uk/lot/55295666/clean-title-2014-porsche-panamera\n```","schema":{"type":"string","description":"Copart lot number or full lot URL.\n\n**Examples:**\n\n```\n55295666\n```\n\n```\n55295666 + region=uk\n```\n\n```\nhttps://www.copart.co.uk/lot/55295666/clean-title-2014-porsche-panamera\n```"}},{"name":"region","in":"query","required":false,"description":"Regional Copart site when `query` is a lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```","schema":{"type":"string","description":"Regional Copart site when `query` is a lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"lic":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"fuel":{"type":"string"},"keys":{"type":"string"},"make":{"type":"string"},"year":{"type":"integer"},"color":{"type":"string"},"drive":{"type":"string"},"model":{"type":"string"},"title":{"type":"string"},"engine":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"latitude":{"type":"number"},"lot_sold":{"type":"boolean"},"odometer":{"type":"integer"},"image_url":{"type":"string"},"longitude":{"type":"number"},"sale_date":{"type":"string"},"yard_city":{"type":"string"},"yard_name":{"type":"string"},"bid_status":{"type":"string"},"buy_it_now":{"type":"boolean"},"run_status":{"type":"string"},"title_code":{"type":"string"},"yard_state":{"type":"string"},"current_bid":{"type":"integer"},"model_group":{"type":"string"},"sale_status":{"type":"string"},"vin_partial":{"type":"string"},"yard_number":{"type":"integer"},"last_updated":{"type":"string"},"title_status":{"type":"string"},"transmission":{"type":"string"},"vehicle_type":{"type":"string"},"yard_country":{"type":"string"},"primary_damage":{"type":"string"},"buy_it_now_price":{"type":"integer"},"secondary_damage":{"type":"string"}}},"examples":{"Lot 55295666 on copart.co.uk":{"value":{"id":"55295666","lic":["ADDL-INFO","CERT-D","IV","VHDRP"],"url":"https://www.copart.co.uk/lot/55295666/clean-title-2014-porsche-panamera-4-8-v8-gts-4dr-pdk-sandy","fuel":"PETROL","keys":"YES","make":"PORSCHE","year":2014,"color":"GREY","drive":"2 AXLE RIGID BODY","model":"PANAMERA G","title":"2014 PORSCHE PANAMERA 4.8 V8 GTS 4DR PDK","engine":"4806 cc","images":["https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0626/7834e4c0e5da4ef3809e87b2e31a987d_thb.jpg"],"currency":"GBP","latitude":52.14,"lot_sold":false,"odometer":74190,"image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0626/7834e4c0e5da4ef3809e87b2e31a987d_thb.jpg","longitude":-0.3,"sale_date":"2026-07-01T09:00:00+00:00","yard_city":"SANDY","yard_name":"SANDY","bid_status":"NEVER_BID","buy_it_now":true,"run_status":"RUNS AND DRIVES","title_code":"U - Used Unrecorded","yard_state":"GB","current_bid":4100,"model_group":"PANAMERA","sale_status":"MINIMUM_BID","vin_partial":"*****************","yard_number":401,"last_updated":"2026-06-30T13:12:15+00:00","title_status":"CLEAN TITLE","transmission":"7 SPEED S-AUTO","vehicle_type":"VEHICLES UNDER 7.5 TONNES","yard_country":"GBR","primary_damage":"FRONT END","buy_it_now_price":0,"secondary_damage":"PREVIOUS REPAIR"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Copart Lot","description":"Copart Lot API: retrieve structured auction lot data by lot number or URL. Specs, damage, bids, photos, yard location and sale status across regional Copart sites.\n\n**Credit cost:** 2 credits per call","operationId":"post-copart-lot","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Copart lot number or full lot URL.\n\n**Examples:**\n\n```\n55295666\n```\n\n```\n55295666 + region=uk\n```\n\n```\nhttps://www.copart.co.uk/lot/55295666/clean-title-2014-porsche-panamera\n```","schema":{"type":"string","description":"Copart lot number or full lot URL.\n\n**Examples:**\n\n```\n55295666\n```\n\n```\n55295666 + region=uk\n```\n\n```\nhttps://www.copart.co.uk/lot/55295666/clean-title-2014-porsche-panamera\n```"}},{"name":"region","in":"query","required":false,"description":"Regional Copart site when `query` is a lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```","schema":{"type":"string","description":"Regional Copart site when `query` is a lot number only. Defaults to US.\n\n**Examples:**\n\n```\nca\n```\n\n```\nuk\n```\n\n```\nde\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"lic":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"fuel":{"type":"string"},"keys":{"type":"string"},"make":{"type":"string"},"year":{"type":"integer"},"color":{"type":"string"},"drive":{"type":"string"},"model":{"type":"string"},"title":{"type":"string"},"engine":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"latitude":{"type":"number"},"lot_sold":{"type":"boolean"},"odometer":{"type":"integer"},"image_url":{"type":"string"},"longitude":{"type":"number"},"sale_date":{"type":"string"},"yard_city":{"type":"string"},"yard_name":{"type":"string"},"bid_status":{"type":"string"},"buy_it_now":{"type":"boolean"},"run_status":{"type":"string"},"title_code":{"type":"string"},"yard_state":{"type":"string"},"current_bid":{"type":"integer"},"model_group":{"type":"string"},"sale_status":{"type":"string"},"vin_partial":{"type":"string"},"yard_number":{"type":"integer"},"last_updated":{"type":"string"},"title_status":{"type":"string"},"transmission":{"type":"string"},"vehicle_type":{"type":"string"},"yard_country":{"type":"string"},"primary_damage":{"type":"string"},"buy_it_now_price":{"type":"integer"},"secondary_damage":{"type":"string"}}},"examples":{"Lot 55295666 on copart.co.uk":{"value":{"id":"55295666","lic":["ADDL-INFO","CERT-D","IV","VHDRP"],"url":"https://www.copart.co.uk/lot/55295666/clean-title-2014-porsche-panamera-4-8-v8-gts-4dr-pdk-sandy","fuel":"PETROL","keys":"YES","make":"PORSCHE","year":2014,"color":"GREY","drive":"2 AXLE RIGID BODY","model":"PANAMERA G","title":"2014 PORSCHE PANAMERA 4.8 V8 GTS 4DR PDK","engine":"4806 cc","images":["https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0626/7834e4c0e5da4ef3809e87b2e31a987d_thb.jpg"],"currency":"GBP","latitude":52.14,"lot_sold":false,"odometer":74190,"image_url":"https://cs.copart.com/v1/AUTH_svc.pdoc00001/lpp/0626/7834e4c0e5da4ef3809e87b2e31a987d_thb.jpg","longitude":-0.3,"sale_date":"2026-07-01T09:00:00+00:00","yard_city":"SANDY","yard_name":"SANDY","bid_status":"NEVER_BID","buy_it_now":true,"run_status":"RUNS AND DRIVES","title_code":"U - Used Unrecorded","yard_state":"GB","current_bid":4100,"model_group":"PANAMERA","sale_status":"MINIMUM_BID","vin_partial":"*****************","yard_number":401,"last_updated":"2026-06-30T13:12:15+00:00","title_status":"CLEAN TITLE","transmission":"7 SPEED S-AUTO","vehicle_type":"VEHICLES UNDER 7.5 TONNES","yard_country":"GBR","primary_damage":"FRONT END","buy_it_now_price":0,"secondary_damage":"PREVIOUS REPAIR"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/lenovo/product":{"get":{"summary":"Lenovo Product","description":"Extract a Lenovo product page by URL: id, name, price, currency, availability, images, and description (browser rendering, 2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-lenovo-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Lenovo product URL (must contain `/p/`). Bare part numbers are rejected.\n\n**Examples:**\n\n```\nhttps://www.lenovo.com/fr/fr/p/workstations/thinkstationp/thinkstation-p5-gen-2-intel-tower-workstation/len102s0024\n```\n\n```\nhttps://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus\n```","schema":{"type":"string","description":"Full Lenovo product URL (must contain `/p/`). Bare part numbers are rejected.\n\n**Examples:**\n\n```\nhttps://www.lenovo.com/fr/fr/p/workstations/thinkstationp/thinkstation-p5-gen-2-intel-tower-workstation/len102s0024\n```\n\n```\nhttps://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"series":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"config_type":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"thumbnail_url":{"type":"string"}}},"examples":{"ThinkStation P5 Gen 2 (France)":{"value":{"mpn":"LEN102S0024","sku":"LEN102S0024","url":"https://www.lenovo.com/fr/fr/p/workstations/thinkstationp/thinkstation-p5-gen-2-intel-tower-workstation/len102s0024","name":"ThinkStation P5 Gen 2 (Intel) Tower","brand":"Série P","price":4439.02,"title":"ThinkStation P5 Gen 2 (Intel) Tower","images":["https://p4-ofp.static.pub/ShareResource/optimized/thinkstation/thinkstation-p5-gen2-intel-tower/lenovo-thinkstation-p5-gen-2-pdp-hero.png"],"series":"ThinkStation","category":"Workstations","currency":"EUR","product_id":"LEN102S0024","config_type":"CTO","description":"La station de travail tour Lenovo ThinkStation P5 Gen 2 (Intel) offre des performances prêtes pour l’IA, un processeur avancé et une carte graphique professionnelle pour les tâches critiques.","availability":"in_stock","thumbnail_url":"https://p4-ofp.static.pub/ShareResource/optimized/thinkstation/thinkstation-p5-gen2-intel-tower/lenovo-thinkstation-p5-gen-2-pdp-hero.png"}},"ThinkPad E16 Gen 3 (United States)":{"value":{"mpn":"LEN101T0125","sku":"21TF001NUS","url":"https://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus","name":"ThinkPad E16 Gen 3 (16″ Intel) Laptop","brand":"ThinkPad","price":1599,"title":"ThinkPad E16 Gen 3 (16″ Intel) Laptop","images":["https://p4-ofp.static.pub//fes/cms/2025/04/07/52kiu4uukvy6dnj3ryrs2grmwt7716558555.png"],"series":"ThinkPad","category":"Laptops","currency":"USD","product_id":"21TF001NUS","config_type":"MTM","description":"The 16″ Lenovo ThinkPad E16 Gen 3 laptop with Intel® Core™ processors boasts enhanced performance & long battery life for anywhere business.","availability":"in_stock","thumbnail_url":"https://p4-ofp.static.pub//fes/cms/2025/04/07/52kiu4uukvy6dnj3ryrs2grmwt7716558555.png"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Lenovo Product","description":"Extract a Lenovo product page by URL: id, name, price, currency, availability, images, and description (browser rendering, 2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-lenovo-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Lenovo product URL (must contain `/p/`). Bare part numbers are rejected.\n\n**Examples:**\n\n```\nhttps://www.lenovo.com/fr/fr/p/workstations/thinkstationp/thinkstation-p5-gen-2-intel-tower-workstation/len102s0024\n```\n\n```\nhttps://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus\n```","schema":{"type":"string","description":"Full Lenovo product URL (must contain `/p/`). Bare part numbers are rejected.\n\n**Examples:**\n\n```\nhttps://www.lenovo.com/fr/fr/p/workstations/thinkstationp/thinkstation-p5-gen-2-intel-tower-workstation/len102s0024\n```\n\n```\nhttps://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"series":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"config_type":{"type":"string"},"description":{"type":"string"},"availability":{"type":"string"},"thumbnail_url":{"type":"string"}}},"examples":{"ThinkStation P5 Gen 2 (France)":{"value":{"mpn":"LEN102S0024","sku":"LEN102S0024","url":"https://www.lenovo.com/fr/fr/p/workstations/thinkstationp/thinkstation-p5-gen-2-intel-tower-workstation/len102s0024","name":"ThinkStation P5 Gen 2 (Intel) Tower","brand":"Série P","price":4439.02,"title":"ThinkStation P5 Gen 2 (Intel) Tower","images":["https://p4-ofp.static.pub/ShareResource/optimized/thinkstation/thinkstation-p5-gen2-intel-tower/lenovo-thinkstation-p5-gen-2-pdp-hero.png"],"series":"ThinkStation","category":"Workstations","currency":"EUR","product_id":"LEN102S0024","config_type":"CTO","description":"La station de travail tour Lenovo ThinkStation P5 Gen 2 (Intel) offre des performances prêtes pour l’IA, un processeur avancé et une carte graphique professionnelle pour les tâches critiques.","availability":"in_stock","thumbnail_url":"https://p4-ofp.static.pub/ShareResource/optimized/thinkstation/thinkstation-p5-gen2-intel-tower/lenovo-thinkstation-p5-gen-2-pdp-hero.png"}},"ThinkPad E16 Gen 3 (United States)":{"value":{"mpn":"LEN101T0125","sku":"21TF001NUS","url":"https://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus","name":"ThinkPad E16 Gen 3 (16″ Intel) Laptop","brand":"ThinkPad","price":1599,"title":"ThinkPad E16 Gen 3 (16″ Intel) Laptop","images":["https://p4-ofp.static.pub//fes/cms/2025/04/07/52kiu4uukvy6dnj3ryrs2grmwt7716558555.png"],"series":"ThinkPad","category":"Laptops","currency":"USD","product_id":"21TF001NUS","config_type":"MTM","description":"The 16″ Lenovo ThinkPad E16 Gen 3 laptop with Intel® Core™ processors boasts enhanced performance & long battery life for anywhere business.","availability":"in_stock","thumbnail_url":"https://p4-ofp.static.pub//fes/cms/2025/04/07/52kiu4uukvy6dnj3ryrs2grmwt7716558555.png"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/lenovo/search":{"get":{"summary":"Lenovo Search","description":"Search Lenovo products by keyword or listing URL. Returns product id, price, currency, series, and availability via browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"get-lenovo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Lenovo search / category URL.\n\n**Examples:**\n\n```\nthinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/search?fq=&text=thinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/desktops/subseries-results/?visibleDatas=3906:ThinkStation\n```","schema":{"type":"string","description":"Keyword or full Lenovo search / category URL.\n\n**Examples:**\n\n```\nthinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/search?fq=&text=thinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/desktops/subseries-results/?visibleDatas=3906:ThinkStation\n```"}},{"name":"locale","in":"query","required":false,"description":"Store locale when `query` is a keyword (ignored for full URLs).\n\n- `fr/fr` (default, EUR)\n- `de/de` (EUR)\n- `gb/en` (GBP)\n- `us/en` (USD)\n- `es/es` (EUR)\n- `it/it` (EUR)","schema":{"type":"string","default":"fr/fr","description":"Store locale when `query` is a keyword (ignored for full URLs).\n\n- `fr/fr` (default, EUR)\n- `de/de` (EUR)\n- `gb/en` (GBP)\n- `us/en` (USD)\n- `es/es` (EUR)\n- `it/it` (EUR)"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"query":{"type":"string"},"current_page":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"series":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"availability":{"type":"string"},"thumbnail_url":{"type":"string"}}}}}},"examples":{"ThinkPad search France":{"value":{"meta":{"query":"https://www.lenovo.com/fr/fr/search?fq=&text=thinkpad","current_page":1,"has_next_page":false,"total_results":20},"results":[{"url":"https://www.lenovo.com/fr/fr/p/laptops/thinkpad/thinkpadp/thinkpad-p14s-gen-6-14-inch-amd-mobile-workstation/21qlcto1wwfr1","name":"ThinkPad P14s Gen 6 (AMD)","price":2519,"series":"ThinkPad","currency":"EUR","product_id":"21QLCTO1WWFR1","availability":"in_stock","thumbnail_url":"https://p3-ofp.static.pub/ShareResource/optimized/pdp/thinkpad/thinkpad-p-series/len101t0118/thinkpad-p14s-gen-6-14-amd-series.png?width=584&height=584"},{"url":"https://www.lenovo.com/fr/fr/p/laptops/thinkpad/thinkpadl/lenovo-thinkpad-l14-gen-6-14-inch-amd/21secto1wwfr4","name":"ThinkPad L14 Gen 6 (AMD)","price":1759.01,"series":"ThinkPad","currency":"EUR","product_id":"21SECTO1WWFR4","availability":"in_stock","thumbnail_url":"https://p1-ofp.static.pub/ShareResource/we/images/JK-2CD/len101t0144.png?width=584&height=584"},{"url":"https://www.lenovo.com/fr/fr/p/laptops/thinkpad/thinkpadl/lenovo-thinkpad-l14-gen-6-14-inch-amd/21secto1wwfr3","name":"ThinkPad L14 Gen 6 (AMD)","price":1623.9,"series":"ThinkPad","currency":"EUR","product_id":"21SECTO1WWFR3","availability":"in_stock","thumbnail_url":"https://p4-ofp.static.pub//fes/cms/2026/07/17/vlgy32mp541qdf1eeczc522skq63se938147.png?width=584&height=584"}]}},"ThinkPad search United States":{"value":{"meta":{"query":"https://www.lenovo.com/us/en/search?fq=&text=thinkpad","current_page":1,"has_next_page":false,"total_results":19},"results":[{"url":"https://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus","name":"ThinkPad E16 Gen 3 Intel (16ʺ)","price":1059,"series":"ThinkPad","currency":"USD","product_id":"21TF001NUS","availability":"in_stock","thumbnail_url":"https://p1-ofp.static.pub/medias/26999389948_ThinkPad_E16_3_eclipse_black_202502180427131748491814319.png?width=584&height=584"},{"url":"https://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e14-gen-7-14-inch-intel/21t9002hus","name":"ThinkPad E14 Gen 7 Intel (14″)","price":1059,"series":"ThinkPad","currency":"USD","product_id":"21T9002HUS","availability":"in_stock","thumbnail_url":"https://p1-ofp.static.pub/ShareResource/na/subseries/gallery/lenovo-thinkpad-e14-gen7-intel-14inch.png?width=584&height=584"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Lenovo Search","description":"Search Lenovo products by keyword or listing URL. Returns product id, price, currency, series, and availability via browser rendering (2 credits).\n\n**Credit cost:** 2 credits per call","operationId":"post-lenovo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Lenovo search / category URL.\n\n**Examples:**\n\n```\nthinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/search?fq=&text=thinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/desktops/subseries-results/?visibleDatas=3906:ThinkStation\n```","schema":{"type":"string","description":"Keyword or full Lenovo search / category URL.\n\n**Examples:**\n\n```\nthinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/search?fq=&text=thinkpad\n```\n\n```\nhttps://www.lenovo.com/fr/fr/desktops/subseries-results/?visibleDatas=3906:ThinkStation\n```"}},{"name":"locale","in":"query","required":false,"description":"Store locale when `query` is a keyword (ignored for full URLs).\n\n- `fr/fr` (default, EUR)\n- `de/de` (EUR)\n- `gb/en` (GBP)\n- `us/en` (USD)\n- `es/es` (EUR)\n- `it/it` (EUR)","schema":{"type":"string","default":"fr/fr","description":"Store locale when `query` is a keyword (ignored for full URLs).\n\n- `fr/fr` (default, EUR)\n- `de/de` (EUR)\n- `gb/en` (GBP)\n- `us/en` (USD)\n- `es/es` (EUR)\n- `it/it` (EUR)"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"query":{"type":"string"},"current_page":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"price":{"type":"integer"},"series":{"type":"string"},"currency":{"type":"string"},"product_id":{"type":"string"},"availability":{"type":"string"},"thumbnail_url":{"type":"string"}}}}}},"examples":{"ThinkPad search France":{"value":{"meta":{"query":"https://www.lenovo.com/fr/fr/search?fq=&text=thinkpad","current_page":1,"has_next_page":false,"total_results":20},"results":[{"url":"https://www.lenovo.com/fr/fr/p/laptops/thinkpad/thinkpadp/thinkpad-p14s-gen-6-14-inch-amd-mobile-workstation/21qlcto1wwfr1","name":"ThinkPad P14s Gen 6 (AMD)","price":2519,"series":"ThinkPad","currency":"EUR","product_id":"21QLCTO1WWFR1","availability":"in_stock","thumbnail_url":"https://p3-ofp.static.pub/ShareResource/optimized/pdp/thinkpad/thinkpad-p-series/len101t0118/thinkpad-p14s-gen-6-14-amd-series.png?width=584&height=584"},{"url":"https://www.lenovo.com/fr/fr/p/laptops/thinkpad/thinkpadl/lenovo-thinkpad-l14-gen-6-14-inch-amd/21secto1wwfr4","name":"ThinkPad L14 Gen 6 (AMD)","price":1759.01,"series":"ThinkPad","currency":"EUR","product_id":"21SECTO1WWFR4","availability":"in_stock","thumbnail_url":"https://p1-ofp.static.pub/ShareResource/we/images/JK-2CD/len101t0144.png?width=584&height=584"},{"url":"https://www.lenovo.com/fr/fr/p/laptops/thinkpad/thinkpadl/lenovo-thinkpad-l14-gen-6-14-inch-amd/21secto1wwfr3","name":"ThinkPad L14 Gen 6 (AMD)","price":1623.9,"series":"ThinkPad","currency":"EUR","product_id":"21SECTO1WWFR3","availability":"in_stock","thumbnail_url":"https://p4-ofp.static.pub//fes/cms/2026/07/17/vlgy32mp541qdf1eeczc522skq63se938147.png?width=584&height=584"}]}},"ThinkPad search United States":{"value":{"meta":{"query":"https://www.lenovo.com/us/en/search?fq=&text=thinkpad","current_page":1,"has_next_page":false,"total_results":19},"results":[{"url":"https://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e16-gen-3-16-inch-intel/21tf001nus","name":"ThinkPad E16 Gen 3 Intel (16ʺ)","price":1059,"series":"ThinkPad","currency":"USD","product_id":"21TF001NUS","availability":"in_stock","thumbnail_url":"https://p1-ofp.static.pub/medias/26999389948_ThinkPad_E16_3_eclipse_black_202502180427131748491814319.png?width=584&height=584"},{"url":"https://www.lenovo.com/us/en/p/laptops/thinkpad/thinkpade/lenovo-thinkpad-e14-gen-7-14-inch-intel/21t9002hus","name":"ThinkPad E14 Gen 7 Intel (14″)","price":1059,"series":"ThinkPad","currency":"USD","product_id":"21T9002HUS","availability":"in_stock","thumbnail_url":"https://p1-ofp.static.pub/ShareResource/na/subseries/gallery/lenovo-thinkpad-e14-gen7-intel-14inch.png?width=584&height=584"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/yelp/search":{"get":{"summary":"Yelp Search","description":"Search Yelp by keyword and location and retrieve paginated business cards with ratings, categories, photos, and sponsored flags.\n\n**Credit cost:** 2 credits per call","operationId":"get-yelp-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yelp search URL with `find_desc` and `find_loc` query parameters.\n\n**Example:**\n\n    https://www.yelp.com/search?find_desc=Cocktail+Bars&find_loc=San+Francisco%2C+CA\n\nUse organic `results[].link` values on **Yelp Business**, or `results[].biz_id` on **Yelp Reviews**.","schema":{"type":"string","description":"Full Yelp search URL with `find_desc` and `find_loc` query parameters.\n\n**Example:**\n\n    https://www.yelp.com/search?find_desc=Cocktail+Bars&find_loc=San+Francisco%2C+CA\n\nUse organic `results[].link` values on **Yelp Business**, or `results[].biz_id` on **Yelp Reviews**."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"is_ad":{"type":"boolean"},"phone":{"type":"string"},"biz_id":{"type":"string"},"rating":{"type":"integer"},"picture":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"price_range":{"type":"string"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Search cocktail bars in San Francisco":{"value":{"results":[{"link":"https://www.yelp.com/adredir?ad_business_id=tGntxs1wgwl2IVcwgfhm0A&campaign_id=219482732&click_origin=search_results&placement=vertical_0&placement_slot=0&redirect_url=https%3A%2F%2Fwww.yelp.com%2Fbiz%2Fcatch-san-francisco-3&request_id=e6a82d0dc569287b&signature=d85aa915d620355289b6c43276f79848a2e1eb5d29f8ad591ba5c13cbbab26c1&slot=0","name":"Catch","alias":"catch-san-francisco-3","is_ad":true,"phone":"(415) 431-5000","biz_id":"tGntxs1wgwl2IVcwgfhm0A","rating":4,"picture":"https://s3-media0.fl.yelpcdn.com/bphoto/fkCtr1sSfhz1DY4EjIqoBg/ls.jpg","categories":["Cocktail Bars","Breakfast & Brunch","Coffee & Tea"],"price_range":"$$$","review_count":70},{"link":"https://www.yelp.com/adredir?ad_business_id=e36DPs7qLGswtxbIy9XlVQ&campaign_id=214587588&click_origin=search_results&placement=vertical_0&placement_slot=0&redirect_url=https%3A%2F%2Fwww.yelp.com%2Fbiz%2F200-channels-san-francisco-3&request_id=e6a82d0dc569287b&signature=9a46a6284a56cbf0a0afb36c73bc3ba7c0a2097e6206a3a9f6a5127e12d29a31&slot=1","name":"200 Channels","alias":"200-channels-san-francisco-3","is_ad":true,"phone":"+1-415-728-9506","biz_id":"e36DPs7qLGswtxbIy9XlVQ","rating":4.8,"picture":"https://s3-media0.fl.yelpcdn.com/offerphoto/M9FHUPMUcnH82P-qUYCZLg/ls.jpg","categories":["Cabaret","Speakeasies"],"price_range":null,"review_count":5},{"link":"https://www.yelp.com/adredir?ad_business_id=9N2SyYEqGTL3pZnhyiFHzg&campaign_id=184504858&click_origin=search_results&placement=vertical_0&placement_slot=0&redirect_url=https%3A%2F%2Fwww.yelp.com%2Fbiz%2Fmoss-beach-distillery-moss-beach&request_id=e6a82d0dc569287b&signature=d6f93a1fce8a79a30db41a99c229bbe3a63fdf8028872bacf03720d274c815cc&slot=2","name":"Moss Beach Distillery","alias":"moss-beach-distillery-moss-beach","is_ad":true,"phone":"(650) 728-0220","biz_id":"9N2SyYEqGTL3pZnhyiFHzg","rating":3.8,"picture":"https://s3-media0.fl.yelpcdn.com/bphoto/RDcwAaluiXfR1IDBts78Ug/ls.jpg","categories":["Seafood","Venues & Event Spaces","Bars"],"price_range":"$$","review_count":1964}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9],"total_pages":9,"has_next_page":true,"total_results":0}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Yelp Search","description":"Search Yelp by keyword and location and retrieve paginated business cards with ratings, categories, photos, and sponsored flags.\n\n**Credit cost:** 2 credits per call","operationId":"post-yelp-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yelp search URL with `find_desc` and `find_loc` query parameters.\n\n**Example:**\n\n    https://www.yelp.com/search?find_desc=Cocktail+Bars&find_loc=San+Francisco%2C+CA\n\nUse organic `results[].link` values on **Yelp Business**, or `results[].biz_id` on **Yelp Reviews**.","schema":{"type":"string","description":"Full Yelp search URL with `find_desc` and `find_loc` query parameters.\n\n**Example:**\n\n    https://www.yelp.com/search?find_desc=Cocktail+Bars&find_loc=San+Francisco%2C+CA\n\nUse organic `results[].link` values on **Yelp Business**, or `results[].biz_id` on **Yelp Reviews**."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"is_ad":{"type":"boolean"},"phone":{"type":"string"},"biz_id":{"type":"string"},"rating":{"type":"integer"},"picture":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"price_range":{"type":"string"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Search cocktail bars in San Francisco":{"value":{"results":[{"link":"https://www.yelp.com/adredir?ad_business_id=tGntxs1wgwl2IVcwgfhm0A&campaign_id=219482732&click_origin=search_results&placement=vertical_0&placement_slot=0&redirect_url=https%3A%2F%2Fwww.yelp.com%2Fbiz%2Fcatch-san-francisco-3&request_id=e6a82d0dc569287b&signature=d85aa915d620355289b6c43276f79848a2e1eb5d29f8ad591ba5c13cbbab26c1&slot=0","name":"Catch","alias":"catch-san-francisco-3","is_ad":true,"phone":"(415) 431-5000","biz_id":"tGntxs1wgwl2IVcwgfhm0A","rating":4,"picture":"https://s3-media0.fl.yelpcdn.com/bphoto/fkCtr1sSfhz1DY4EjIqoBg/ls.jpg","categories":["Cocktail Bars","Breakfast & Brunch","Coffee & Tea"],"price_range":"$$$","review_count":70},{"link":"https://www.yelp.com/adredir?ad_business_id=e36DPs7qLGswtxbIy9XlVQ&campaign_id=214587588&click_origin=search_results&placement=vertical_0&placement_slot=0&redirect_url=https%3A%2F%2Fwww.yelp.com%2Fbiz%2F200-channels-san-francisco-3&request_id=e6a82d0dc569287b&signature=9a46a6284a56cbf0a0afb36c73bc3ba7c0a2097e6206a3a9f6a5127e12d29a31&slot=1","name":"200 Channels","alias":"200-channels-san-francisco-3","is_ad":true,"phone":"+1-415-728-9506","biz_id":"e36DPs7qLGswtxbIy9XlVQ","rating":4.8,"picture":"https://s3-media0.fl.yelpcdn.com/offerphoto/M9FHUPMUcnH82P-qUYCZLg/ls.jpg","categories":["Cabaret","Speakeasies"],"price_range":null,"review_count":5},{"link":"https://www.yelp.com/adredir?ad_business_id=9N2SyYEqGTL3pZnhyiFHzg&campaign_id=184504858&click_origin=search_results&placement=vertical_0&placement_slot=0&redirect_url=https%3A%2F%2Fwww.yelp.com%2Fbiz%2Fmoss-beach-distillery-moss-beach&request_id=e6a82d0dc569287b&signature=d6f93a1fce8a79a30db41a99c229bbe3a63fdf8028872bacf03720d274c815cc&slot=2","name":"Moss Beach Distillery","alias":"moss-beach-distillery-moss-beach","is_ad":true,"phone":"(650) 728-0220","biz_id":"9N2SyYEqGTL3pZnhyiFHzg","rating":3.8,"picture":"https://s3-media0.fl.yelpcdn.com/bphoto/RDcwAaluiXfR1IDBts78Ug/ls.jpg","categories":["Seafood","Venues & Event Spaces","Bars"],"price_range":"$$","review_count":1964}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9],"total_pages":9,"has_next_page":true,"total_results":0}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/leroymerlin-stores":{"get":{"summary":"Leroy Merlin Stores Finder","description":"Search Leroy Merlin stores by name, city or postal code to retrieve their store ID, slug, address and store locator URL.","operationId":"get-finder-leroymerlin-stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters Leroy Merlin stores based on a search string. The search is **non-case-sensitive** and matches store names, cities, postal codes and store slugs.\n\n**Example:**\n\n    balma","schema":{"type":"string","description":"Filters Leroy Merlin stores based on a search string. The search is **non-case-sensitive** and matches store names, cities, postal codes and store slugs.\n\n**Example:**\n\n    balma"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"domain":{"type":"string"},"address":{"type":"string"},"store_id":{"type":"string"},"store_slug":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"}}}},"examples":{"Search by city 'Balma'":{"value":[{"id":"110","url":"https://www.leroymerlin.fr/magasins/balma-toulouse.html","city":"Balma","name":"Balma - Toulouse","domain":"fr","address":"1 avenue Jean-René Lagasse, 31130 Balma","store_id":"110","store_slug":"balma-toulouse","postal_code":"31130","country_code":"FR"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Leroy Merlin Stores Finder","description":"Search Leroy Merlin stores by name, city or postal code to retrieve their store ID, slug, address and store locator URL.","operationId":"post-finder-leroymerlin-stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters Leroy Merlin stores based on a search string. The search is **non-case-sensitive** and matches store names, cities, postal codes and store slugs.\n\n**Example:**\n\n    balma","schema":{"type":"string","description":"Filters Leroy Merlin stores based on a search string. The search is **non-case-sensitive** and matches store names, cities, postal codes and store slugs.\n\n**Example:**\n\n    balma"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"domain":{"type":"string"},"address":{"type":"string"},"store_id":{"type":"string"},"store_slug":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"}}}},"examples":{"Search by city 'Balma'":{"value":[{"id":"110","url":"https://www.leroymerlin.fr/magasins/balma-toulouse.html","city":"Balma","name":"Balma - Toulouse","domain":"fr","address":"1 avenue Jean-René Lagasse, 31130 Balma","store_id":"110","store_slug":"balma-toulouse","postal_code":"31130","country_code":"FR"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/mrbricolage-stores":{"get":{"summary":"Mr.Bricolage Stores Finder","description":"Search Mr.Bricolage stores by name, city or postal code to retrieve their store ID, slug, contact information and geolocation.","operationId":"get-finder-mrbricolage-stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters Mr.Bricolage stores based on a search string. The search is **non-case-sensitive** and matches store names, cities and postal codes.\n\n**Example:**\n\n    matignon","schema":{"type":"string","description":"Filters Mr.Bricolage stores based on a search string. The search is **non-case-sensitive** and matches store names, cities and postal codes.\n\n**Example:**\n\n    matignon"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"epj":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"region":{"type":"string"},"seo_id":{"type":"string"},"store_id":{"type":"string"},"department":{"type":"string"},"store_slug":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"},"magento_slug":{"type":"string"},"live_page_url":{"type":"string"}}}},"examples":{"Search by city 'matignon'":{"value":[{"id":"58cbe9720cb81d1100996836","epj":"00794246","city":"MATIGNON","name":"Mr.Bricolage Matignon","phone":"+33 2 96 41 16 94","region":"Bretagne","seo_id":"137","store_id":"S727","department":"Côtes-d'Armor","store_slug":"Matignon","postal_code":"22550","country_code":"FR","magento_slug":"mr-bricolage-matignon","live_page_url":"https://magasin.mr-bricolage.fr/137-mr-bricolage-matignon"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Mr.Bricolage Stores Finder","description":"Search Mr.Bricolage stores by name, city or postal code to retrieve their store ID, slug, contact information and geolocation.","operationId":"post-finder-mrbricolage-stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters Mr.Bricolage stores based on a search string. The search is **non-case-sensitive** and matches store names, cities and postal codes.\n\n**Example:**\n\n    matignon","schema":{"type":"string","description":"Filters Mr.Bricolage stores based on a search string. The search is **non-case-sensitive** and matches store names, cities and postal codes.\n\n**Example:**\n\n    matignon"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"epj":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"region":{"type":"string"},"seo_id":{"type":"string"},"store_id":{"type":"string"},"department":{"type":"string"},"store_slug":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"},"magento_slug":{"type":"string"},"live_page_url":{"type":"string"}}}},"examples":{"Search by city 'matignon'":{"value":[{"id":"58cbe9720cb81d1100996836","epj":"00794246","city":"MATIGNON","name":"Mr.Bricolage Matignon","phone":"+33 2 96 41 16 94","region":"Bretagne","seo_id":"137","store_id":"S727","department":"Côtes-d'Armor","store_slug":"Matignon","postal_code":"22550","country_code":"FR","magento_slug":"mr-bricolage-matignon","live_page_url":"https://magasin.mr-bricolage.fr/137-mr-bricolage-matignon"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/shophouzz/product":{"get":{"summary":"Shophouzz Product","description":"Retrieve full product details from Shophouzz, including title, price, variants, images, vendor, and structured metadata.\n\n**Credit cost:** 1 credit per call","operationId":"get-shophouzz-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full URL of the Shophouzz product page to retrieve details for.\n\n**Example:**\n\n    https://shophouzz.com/products/burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078\n\n**Notes:**\n- **Full product URL required:** The query must be the complete product page URL, including the product handle.\n- **Handle-only format not supported:** Only full URLs starting with `https://shophouzz.com/products/` are accepted.","schema":{"type":"string","description":"Full URL of the Shophouzz product page to retrieve details for.\n\n**Example:**\n\n    https://shophouzz.com/products/burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078\n\n**Notes:**\n- **Full product URL required:** The query must be the complete product page URL, including the product handle.\n- **Handle-only format not supported:** Only full URLs starting with `https://shophouzz.com/products/` are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"tags":{"type":"string"},"image":{"type":"object","properties":{"id":{"type":"integer"},"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"variant_ids":{"type":"array","items":{}}}},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"variant_ids":{"type":"array","items":{}}}}},"vendor":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"},"product_id":{"type":"integer"}}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"grams":{"type":"integer"},"price":{"type":"string"},"title":{"type":"string"},"weight":{"type":"integer"},"barcode":{"type":"string"},"option1":{"type":"string"},"option2":{"type":"string"},"option3":{"type":"string"},"taxable":{"type":"boolean"},"image_id":{"nullable":true},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"weight_unit":{"type":"string"},"quantity_rule":{"type":"object","properties":{"max":{"nullable":true},"min":{"type":"integer"},"increment":{"type":"integer"}}},"price_currency":{"type":"string"},"compare_at_price":{"type":"string"},"requires_shipping":{"type":"boolean"},"fulfillment_service":{"type":"string"},"inventory_management":{"type":"string"},"quantity_price_breaks":{"type":"array","items":{}},"compare_at_price_currency":{"type":"string"}}}},"body_html":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"},"published_scope":{"type":"string"},"template_suffix":{"nullable":true}}},"examples":{"Product lookup by URL (Burke Counter Stool)":{"value":{"id":9992209793336,"tags":"assembly_required, best-seller, black, black faux leather, black faux leather straps, comfortable, compliance:cal-prop-65, contemporary, elegant, furniture, matte black metal frame, modern, soft black faux leather, vendor-type:direct, white oak veneer metal dowel, YGroup_857-Parent","image":{"id":51424882983224,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/d428cade-7856-43a2-b0ab-ad6d1fa4c68d.jpg?v=1770873702","width":478,"height":990,"position":1,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},"title":"Burke Counter Stool, Cognac, Vegan Leather, White Oak Veneer Metal Dowel","handle":"burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078","images":[{"id":51424882983224,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/d428cade-7856-43a2-b0ab-ad6d1fa4c68d.jpg?v=1770873702","width":478,"height":990,"position":1,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424882852152,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/9f98d8da-988d-4d34-b3ff-90ddc25486cf.jpg?v=1770873702","width":990,"height":990,"position":2,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424883114296,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/31ba4089-8a92-40b2-8b04-c7a3f02c4849.jpg?v=1770873702","width":624,"height":990,"position":3,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424882950456,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/673c4606-170e-4568-bd23-7d9e4a56a5b5.jpg?v=1770873702","width":690,"height":990,"position":4,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424883048760,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/f3267b6e-3bd2-4fe3-aed7-0fae3e1f183c.jpg?v=1770873702","width":990,"height":660,"position":5,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424882884920,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/e01a9298-c313-44e9-b47c-94009ee0fbde.jpg?v=1770873702","width":990,"height":738,"position":6,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]}],"vendor":"Meridian Furniture","options":[{"id":12575493423416,"name":"Color","values":["Cognac"],"position":1,"product_id":9992209793336},{"id":12575493456184,"name":"Configuration","values":["White Oak Veneer Metal Dowel"],"position":2,"product_id":9992209793336},{"id":12575493488952,"name":"Design","values":["Vegan Leather"],"position":3,"product_id":9992209793336}],"variants":[{"id":50554338476344,"sku":"857Cognac-C","grams":14061,"price":"237.99","title":"Cognac / White Oak Veneer Metal Dowel / Vegan Leather","weight":31,"barcode":"94308268583","option1":"Cognac","option2":"White Oak Veneer Metal Dowel","option3":"Vegan Leather","taxable":true,"image_id":null,"position":1,"created_at":"2025-06-27T23:07:26-07:00","product_id":9992209793336,"updated_at":"2026-04-27T08:03:33-07:00","weight_unit":"lb","quantity_rule":{"max":null,"min":1,"increment":1},"price_currency":"USD","compare_at_price":"","requires_shipping":true,"fulfillment_service":"manual","inventory_management":"shopify","quantity_price_breaks":[],"compare_at_price_currency":""}],"body_html":"<p>Kick back and relax with a drink in your hand with this Burke cognac vegan leather counter stool. Featuring soft cognac vegan leather upholstery and cognac vegan leather straps, this counter stool is cozy and stylish. Its matte cognac metal frame provides sturdy support so you can enjoy this stool for years to come. A white oak veneer metal dowel is tucked firmly in place beneath the front of the stool, providing extra support and added style.</p>\n\n<p>Overall Product Dimensions: 18\" W x 24\" D x 37.5\" H\n<br>Soft Cognac Vegan Leather\n<br>Black Vegan Leather Straps\n<br>Matte Black Metal Frame\n<br>White Oak Veneer Metal Dowel\n<br>Counter Height Stool\n<br>Contemporary Design</p>\n\n<p>Seat Dimensions: \n<br>Seat Width: 18\"\n<br>Seat Height: 26.4\"\n<br>Seat Depth: 16\"\n<br>Back Height: 11.25\"</p>","created_at":"2025-06-27T23:07:26-07:00","updated_at":"2026-04-27T08:03:33-07:00","product_type":"Product","published_at":"2025-06-27T23:07:27-07:00","published_scope":"web","template_suffix":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Shophouzz Product","description":"Retrieve full product details from Shophouzz, including title, price, variants, images, vendor, and structured metadata.\n\n**Credit cost:** 1 credit per call","operationId":"post-shophouzz-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full URL of the Shophouzz product page to retrieve details for.\n\n**Example:**\n\n    https://shophouzz.com/products/burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078\n\n**Notes:**\n- **Full product URL required:** The query must be the complete product page URL, including the product handle.\n- **Handle-only format not supported:** Only full URLs starting with `https://shophouzz.com/products/` are accepted.","schema":{"type":"string","description":"Full URL of the Shophouzz product page to retrieve details for.\n\n**Example:**\n\n    https://shophouzz.com/products/burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078\n\n**Notes:**\n- **Full product URL required:** The query must be the complete product page URL, including the product handle.\n- **Handle-only format not supported:** Only full URLs starting with `https://shophouzz.com/products/` are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"tags":{"type":"string"},"image":{"type":"object","properties":{"id":{"type":"integer"},"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"variant_ids":{"type":"array","items":{}}}},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"alt":{"nullable":true},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"variant_ids":{"type":"array","items":{}}}}},"vendor":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"},"product_id":{"type":"integer"}}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"grams":{"type":"integer"},"price":{"type":"string"},"title":{"type":"string"},"weight":{"type":"integer"},"barcode":{"type":"string"},"option1":{"type":"string"},"option2":{"type":"string"},"option3":{"type":"string"},"taxable":{"type":"boolean"},"image_id":{"nullable":true},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"weight_unit":{"type":"string"},"quantity_rule":{"type":"object","properties":{"max":{"nullable":true},"min":{"type":"integer"},"increment":{"type":"integer"}}},"price_currency":{"type":"string"},"compare_at_price":{"type":"string"},"requires_shipping":{"type":"boolean"},"fulfillment_service":{"type":"string"},"inventory_management":{"type":"string"},"quantity_price_breaks":{"type":"array","items":{}},"compare_at_price_currency":{"type":"string"}}}},"body_html":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"},"published_scope":{"type":"string"},"template_suffix":{"nullable":true}}},"examples":{"Product lookup by URL (Burke Counter Stool)":{"value":{"id":9992209793336,"tags":"assembly_required, best-seller, black, black faux leather, black faux leather straps, comfortable, compliance:cal-prop-65, contemporary, elegant, furniture, matte black metal frame, modern, soft black faux leather, vendor-type:direct, white oak veneer metal dowel, YGroup_857-Parent","image":{"id":51424882983224,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/d428cade-7856-43a2-b0ab-ad6d1fa4c68d.jpg?v=1770873702","width":478,"height":990,"position":1,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},"title":"Burke Counter Stool, Cognac, Vegan Leather, White Oak Veneer Metal Dowel","handle":"burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078","images":[{"id":51424882983224,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/d428cade-7856-43a2-b0ab-ad6d1fa4c68d.jpg?v=1770873702","width":478,"height":990,"position":1,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424882852152,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/9f98d8da-988d-4d34-b3ff-90ddc25486cf.jpg?v=1770873702","width":990,"height":990,"position":2,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424883114296,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/31ba4089-8a92-40b2-8b04-c7a3f02c4849.jpg?v=1770873702","width":624,"height":990,"position":3,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424882950456,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/673c4606-170e-4568-bd23-7d9e4a56a5b5.jpg?v=1770873702","width":690,"height":990,"position":4,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424883048760,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/f3267b6e-3bd2-4fe3-aed7-0fae3e1f183c.jpg?v=1770873702","width":990,"height":660,"position":5,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]},{"id":51424882884920,"alt":null,"src":"https://cdn.shopify.com/s/files/1/0941/8535/7624/files/e01a9298-c313-44e9-b47c-94009ee0fbde.jpg?v=1770873702","width":990,"height":738,"position":6,"created_at":"2025-06-27T23:07:28-07:00","product_id":9992209793336,"updated_at":"2026-02-11T21:21:42-08:00","variant_ids":[]}],"vendor":"Meridian Furniture","options":[{"id":12575493423416,"name":"Color","values":["Cognac"],"position":1,"product_id":9992209793336},{"id":12575493456184,"name":"Configuration","values":["White Oak Veneer Metal Dowel"],"position":2,"product_id":9992209793336},{"id":12575493488952,"name":"Design","values":["Vegan Leather"],"position":3,"product_id":9992209793336}],"variants":[{"id":50554338476344,"sku":"857Cognac-C","grams":14061,"price":"237.99","title":"Cognac / White Oak Veneer Metal Dowel / Vegan Leather","weight":31,"barcode":"94308268583","option1":"Cognac","option2":"White Oak Veneer Metal Dowel","option3":"Vegan Leather","taxable":true,"image_id":null,"position":1,"created_at":"2025-06-27T23:07:26-07:00","product_id":9992209793336,"updated_at":"2026-04-27T08:03:33-07:00","weight_unit":"lb","quantity_rule":{"max":null,"min":1,"increment":1},"price_currency":"USD","compare_at_price":"","requires_shipping":true,"fulfillment_service":"manual","inventory_management":"shopify","quantity_price_breaks":[],"compare_at_price_currency":""}],"body_html":"<p>Kick back and relax with a drink in your hand with this Burke cognac vegan leather counter stool. Featuring soft cognac vegan leather upholstery and cognac vegan leather straps, this counter stool is cozy and stylish. Its matte cognac metal frame provides sturdy support so you can enjoy this stool for years to come. A white oak veneer metal dowel is tucked firmly in place beneath the front of the stool, providing extra support and added style.</p>\n\n<p>Overall Product Dimensions: 18\" W x 24\" D x 37.5\" H\n<br>Soft Cognac Vegan Leather\n<br>Black Vegan Leather Straps\n<br>Matte Black Metal Frame\n<br>White Oak Veneer Metal Dowel\n<br>Counter Height Stool\n<br>Contemporary Design</p>\n\n<p>Seat Dimensions: \n<br>Seat Width: 18\"\n<br>Seat Height: 26.4\"\n<br>Seat Depth: 16\"\n<br>Back Height: 11.25\"</p>","created_at":"2025-06-27T23:07:26-07:00","updated_at":"2026-04-27T08:03:33-07:00","product_type":"Product","published_at":"2025-06-27T23:07:27-07:00","published_scope":"web","template_suffix":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/oceanio/search":{"get":{"summary":"Oceanio Search","description":"Search the Ocean.io B2B database by domain to find similar companies, retrieve contact details, employee profiles, and social network links.\n\n**Credit cost:** 1 credit per call","operationId":"get-oceanio-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain name or keyword to search for similar companies in the Ocean.io B2B database.\n\n**Required.** Accepts:\n- A domain name (e.g. `google.com`, `stripe.com`)\n- A company name or keyword\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- `results` contains semantically similar companies ranked by relevance score (0–1).\n- `companies` contains the exact company matching the queried domain.\n- Employee LinkedIn profiles are returned in the `people` field, keyed by domain.","schema":{"type":"string","description":"Domain name or keyword to search for similar companies in the Ocean.io B2B database.\n\n**Required.** Accepts:\n- A domain name (e.g. `google.com`, `stripe.com`)\n- A company name or keyword\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- `results` contains semantically similar companies ranked by relevance score (0–1).\n- `companies` contains the exact company matching the queried domain.\n- Employee LinkedIn profiles are returned in the `people` field, keyed by domain."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"people":{"type":"object","properties":{"google.com":{"type":"array","items":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}},"yandex.com":{"type":"array","items":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}},"marcombo.com":{"type":"array","items":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}},"wordcruncher.com":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}}},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"score":{"type":"integer"},"domain":{"type":"string"},"phones":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"country":{"type":"string"},"primary":{"type":"boolean"}}}},"countries":{"type":"array","items":{"type":"string"}},"company_size":{"type":"string"},"people_count":{"type":"integer"},"website_status":{"type":"integer"},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"platform":{"type":"string"}}}}}}},"companies":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"domain":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"phones":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"country":{"type":"string"}}}},"countries":{"type":"array","items":{"type":"string"}},"company_size":{"type":"string"},"people_count":{"type":"integer"},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"platform":{"type":"string"}}}}}}}}},"examples":{"Search by domain 'google.com'":{"value":{"total":1,"people":{"google.com":[{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Martin","first_name":"Alex"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Lee","first_name":"Jordan"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Rivera","first_name":"Sam"}],"yandex.com":[{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Nguyen","first_name":"Casey"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Blake","first_name":"Morgan"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Chen","first_name":"Riley"}],"marcombo.com":[{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Brooks","first_name":"Taylor"},{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Parker","first_name":"Quinn"},{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Kim","first_name":"Avery"}],"wordcruncher.com":{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Patel","first_name":"Drew"}},"results":[{"url":"https://yandex.com/","logo":"https://cdn.ocean.io/logos/yandex.com/06e6d49be593e44ad146aca4fd704e7b95827e0c.png","name":"Yandex","score":1,"domain":"yandex.com","phones":[{"number":"+7 495 739-70-00","country":"ru","primary":true},{"number":"+7 495 974-35-81","country":"ru"},{"number":"+7 499 110-11-33","country":"ru"},{"number":"+7 499 646-00-32","country":"ru"},{"number":"+31 20 206 6970","country":"nl"}],"countries":["br","by","ch","cl","cn","cz","fi","id","il","kz","nl","ru","tr","us"],"company_size":"I","people_count":16417,"website_status":3,"social_networks":[{"url":"https://www.facebook.com/yandex.gamesdev/","platform":"facebook"},{"url":"https://www.linkedin.com/company/yandex","platform":"linkedin"},{"url":"https://www.instagram.com/yandex/_gamesdev/","platform":"instagram"},{"url":"https://www.youtube.com/@yandexgamesdev","platform":"youtube"}]},{"url":"https://wordcruncher.com/","logo":"https://cdn.ocean.io/logos/wordcruncher.com/8255cc5617d89709428e9d5e932be29d0bf5d0ad.png","name":"WordCruncher","score":0.6465531587600708,"domain":"wordcruncher.com","countries":["us"],"company_size":"11-50","people_count":2,"website_status":1,"social_networks":[{"url":"https://www.facebook.com/WordCruncherBYU","platform":"facebook"},{"url":"https://www.linkedin.com/company/wordcruncher","platform":"linkedin"}]},{"url":"https://www.marcombo.com/","logo":"https://cdn2.ocean.io/logos/marcombo.com/eae96911bde77e56e8051d5e52391a579512b44b.png","name":"Ediciones Marcombo","score":0.6397462487220764,"domain":"marcombo.com","emails":"name@example.com","phones":[{"number":"+34 933 18 00 79","country":"es","primary":true}],"countries":["es"],"company_size":"11-50","people_count":13,"website_status":1,"social_networks":[{"url":"https://www.facebook.com/EdicionesMarcombo/","platform":"facebook"},{"url":"https://www.linkedin.com/company/marcombo-ediciones-t-cnicas","platform":"linkedin"},{"url":"https://www.instagram.com/edicionesmarcombo/","platform":"instagram"},{"url":"https://www.youtube.com/user/MarcomboEditorial","platform":"youtube"}]}],"companies":[{"url":"https://www.google.com/","logo":"https://cdn.ocean.io/logos/google.com/695712165c77cdf4b1c56c68bbf5cb6951e03d6c.png","name":"Google","domain":"google.com","emails":["alex.martin@example.com"],"phones":[{"number":"+33 1 85 14 96 65","country":"fr"},{"number":"+34 912 15 86 27","country":"es"},{"number":"+353 1 533 9837","country":"ie"}],"countries":["ar","au","br","ca","ch","cl","cn","co","de","es","fr","gb","ie","il","in","it","mx","nl","ph","pl","se","sg","us"],"company_size":"I","people_count":350846,"social_networks":[{"url":"https://www.facebook.com/Google","platform":"facebook"},{"url":"https://www.linkedin.com/company/google","platform":"linkedin"},{"url":"https://kids.youtube.com/privacynotice","platform":"youtube"},{"url":"https://www.xing.com/companies/yellowsocks","platform":"xing"}]}]}},"Search by domain 'stripe.com'":{"value":{"total":1,"people":{"stripe.com":[{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Costa","first_name":"Jamie"},{"photo":"https://media.licdn.cn/placeholder/example-user.jpg","last_name":"Singh","first_name":"Robin"},{"photo":"https://media.licdn.cn/placeholder/example-user.jpg","last_name":"Reed","first_name":"Sky"}]},"results":[],"companies":[{"url":"https://stripe.com/en-fi","logo":"https://cdn.ocean.io/logos/stripe.com/008f1d0fbdd803ca864ffb5dc9769e2399a06c7a.png","name":"Stripe","domain":"stripe.com","emails":"jordan.lee@example.com","phones":[{"number":"+1 458-555-2863","country":"us","primary":true},{"number":"+358 44 5559997","country":"fi"},{"number":"+1 647-748-5253","country":"ca"},{"number":"+65 6222 3322","country":"sg"},{"number":"+44 1234 567890","country":"gb"},{"number":"+1 888-926-2289","country":"us"}],"countries":["au","br","ca","fi","fr","gb","ie","in","jp","ke","mx","nl","sg","us","za"],"company_size":"10001-50000","people_count":11670,"social_networks":[{"url":"https://www.facebook.com/StripeHQ","platform":"facebook"},{"url":"https://www.linkedin.com/company/stripe","platform":"linkedin"},{"url":"https://youtube.com/@stripe","platform":"youtube"},{"url":"https://www.xing.com/companies/stripe","platform":"xing"}]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Oceanio Search","description":"Search the Ocean.io B2B database by domain to find similar companies, retrieve contact details, employee profiles, and social network links.\n\n**Credit cost:** 1 credit per call","operationId":"post-oceanio-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain name or keyword to search for similar companies in the Ocean.io B2B database.\n\n**Required.** Accepts:\n- A domain name (e.g. `google.com`, `stripe.com`)\n- A company name or keyword\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- `results` contains semantically similar companies ranked by relevance score (0–1).\n- `companies` contains the exact company matching the queried domain.\n- Employee LinkedIn profiles are returned in the `people` field, keyed by domain.","schema":{"type":"string","description":"Domain name or keyword to search for similar companies in the Ocean.io B2B database.\n\n**Required.** Accepts:\n- A domain name (e.g. `google.com`, `stripe.com`)\n- A company name or keyword\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- `results` contains semantically similar companies ranked by relevance score (0–1).\n- `companies` contains the exact company matching the queried domain.\n- Employee LinkedIn profiles are returned in the `people` field, keyed by domain."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"people":{"type":"object","properties":{"google.com":{"type":"array","items":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}},"yandex.com":{"type":"array","items":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}},"marcombo.com":{"type":"array","items":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}},"wordcruncher.com":{"type":"object","properties":{"photo":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}}}}},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"score":{"type":"integer"},"domain":{"type":"string"},"phones":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"country":{"type":"string"},"primary":{"type":"boolean"}}}},"countries":{"type":"array","items":{"type":"string"}},"company_size":{"type":"string"},"people_count":{"type":"integer"},"website_status":{"type":"integer"},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"platform":{"type":"string"}}}}}}},"companies":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"domain":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"phones":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"country":{"type":"string"}}}},"countries":{"type":"array","items":{"type":"string"}},"company_size":{"type":"string"},"people_count":{"type":"integer"},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"platform":{"type":"string"}}}}}}}}},"examples":{"Search by domain 'google.com'":{"value":{"total":1,"people":{"google.com":[{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Martin","first_name":"Alex"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Lee","first_name":"Jordan"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Rivera","first_name":"Sam"}],"yandex.com":[{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Nguyen","first_name":"Casey"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Blake","first_name":"Morgan"},{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Chen","first_name":"Riley"}],"marcombo.com":[{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Brooks","first_name":"Taylor"},{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Parker","first_name":"Quinn"},{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Kim","first_name":"Avery"}],"wordcruncher.com":{"photo":"https://media.licdn.com/placeholder/example-user.jpg","last_name":"Patel","first_name":"Drew"}},"results":[{"url":"https://yandex.com/","logo":"https://cdn.ocean.io/logos/yandex.com/06e6d49be593e44ad146aca4fd704e7b95827e0c.png","name":"Yandex","score":1,"domain":"yandex.com","phones":[{"number":"+7 495 739-70-00","country":"ru","primary":true},{"number":"+7 495 974-35-81","country":"ru"},{"number":"+7 499 110-11-33","country":"ru"},{"number":"+7 499 646-00-32","country":"ru"},{"number":"+31 20 206 6970","country":"nl"}],"countries":["br","by","ch","cl","cn","cz","fi","id","il","kz","nl","ru","tr","us"],"company_size":"I","people_count":16417,"website_status":3,"social_networks":[{"url":"https://www.facebook.com/yandex.gamesdev/","platform":"facebook"},{"url":"https://www.linkedin.com/company/yandex","platform":"linkedin"},{"url":"https://www.instagram.com/yandex/_gamesdev/","platform":"instagram"},{"url":"https://www.youtube.com/@yandexgamesdev","platform":"youtube"}]},{"url":"https://wordcruncher.com/","logo":"https://cdn.ocean.io/logos/wordcruncher.com/8255cc5617d89709428e9d5e932be29d0bf5d0ad.png","name":"WordCruncher","score":0.6465531587600708,"domain":"wordcruncher.com","countries":["us"],"company_size":"11-50","people_count":2,"website_status":1,"social_networks":[{"url":"https://www.facebook.com/WordCruncherBYU","platform":"facebook"},{"url":"https://www.linkedin.com/company/wordcruncher","platform":"linkedin"}]},{"url":"https://www.marcombo.com/","logo":"https://cdn2.ocean.io/logos/marcombo.com/eae96911bde77e56e8051d5e52391a579512b44b.png","name":"Ediciones Marcombo","score":0.6397462487220764,"domain":"marcombo.com","emails":"name@example.com","phones":[{"number":"+34 933 18 00 79","country":"es","primary":true}],"countries":["es"],"company_size":"11-50","people_count":13,"website_status":1,"social_networks":[{"url":"https://www.facebook.com/EdicionesMarcombo/","platform":"facebook"},{"url":"https://www.linkedin.com/company/marcombo-ediciones-t-cnicas","platform":"linkedin"},{"url":"https://www.instagram.com/edicionesmarcombo/","platform":"instagram"},{"url":"https://www.youtube.com/user/MarcomboEditorial","platform":"youtube"}]}],"companies":[{"url":"https://www.google.com/","logo":"https://cdn.ocean.io/logos/google.com/695712165c77cdf4b1c56c68bbf5cb6951e03d6c.png","name":"Google","domain":"google.com","emails":["alex.martin@example.com"],"phones":[{"number":"+33 1 85 14 96 65","country":"fr"},{"number":"+34 912 15 86 27","country":"es"},{"number":"+353 1 533 9837","country":"ie"}],"countries":["ar","au","br","ca","ch","cl","cn","co","de","es","fr","gb","ie","il","in","it","mx","nl","ph","pl","se","sg","us"],"company_size":"I","people_count":350846,"social_networks":[{"url":"https://www.facebook.com/Google","platform":"facebook"},{"url":"https://www.linkedin.com/company/google","platform":"linkedin"},{"url":"https://kids.youtube.com/privacynotice","platform":"youtube"},{"url":"https://www.xing.com/companies/yellowsocks","platform":"xing"}]}]}},"Search by domain 'stripe.com'":{"value":{"total":1,"people":{"stripe.com":[{"photo":"https://media-exp1.licdn.com/placeholder/example-user.jpg","last_name":"Costa","first_name":"Jamie"},{"photo":"https://media.licdn.cn/placeholder/example-user.jpg","last_name":"Singh","first_name":"Robin"},{"photo":"https://media.licdn.cn/placeholder/example-user.jpg","last_name":"Reed","first_name":"Sky"}]},"results":[],"companies":[{"url":"https://stripe.com/en-fi","logo":"https://cdn.ocean.io/logos/stripe.com/008f1d0fbdd803ca864ffb5dc9769e2399a06c7a.png","name":"Stripe","domain":"stripe.com","emails":"jordan.lee@example.com","phones":[{"number":"+1 458-555-2863","country":"us","primary":true},{"number":"+358 44 5559997","country":"fi"},{"number":"+1 647-748-5253","country":"ca"},{"number":"+65 6222 3322","country":"sg"},{"number":"+44 1234 567890","country":"gb"},{"number":"+1 888-926-2289","country":"us"}],"countries":["au","br","ca","fi","fr","gb","ie","in","jp","ke","mx","nl","sg","us","za"],"company_size":"10001-50000","people_count":11670,"social_networks":[{"url":"https://www.facebook.com/StripeHQ","platform":"facebook"},{"url":"https://www.linkedin.com/company/stripe","platform":"linkedin"},{"url":"https://youtube.com/@stripe","platform":"youtube"},{"url":"https://www.xing.com/companies/stripe","platform":"xing"}]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/leboncoin/ad":{"get":{"summary":"Leboncoin Ad","description":"Extract full details from a Leboncoin ad including price, location, attributes, seller info, and images. Returns structured JSON by default, or raw HTML on demand.\n\n**Credit cost:** 1 credit per call","operationId":"get-leboncoin-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Leboncoin ad ID or full ad URL. Both formats are accepted regardless of `return_page_source`.\n\n**Accepted formats:**\n- Ad ID: `3012186547`\n- Full URL: `https://www.leboncoin.fr/ad/equipement_auto/3012186547`\n\n**Examples:**\n\n```\n3012186547\n```\n\n```\nhttps://www.leboncoin.fr/ad/equipement_auto/3012186547\n```\n\n**Note:** If the ad has been deleted or expired on Leboncoin, the endpoint returns a `404` status code.","schema":{"type":"string","description":"Leboncoin ad ID or full ad URL. Both formats are accepted regardless of `return_page_source`.\n\n**Accepted formats:**\n- Ad ID: `3012186547`\n- Full URL: `https://www.leboncoin.fr/ad/equipement_auto/3012186547`\n\n**Examples:**\n\n```\n3012186547\n```\n\n```\nhttps://www.leboncoin.fr/ad/equipement_auto/3012186547\n```\n\n**Note:** If the ad has been deleted or expired on Leboncoin, the endpoint returns a `404` status code."}},{"name":"return_page_source","in":"query","required":false,"description":"Controls the response format.\n\n- `false` (default): returns a structured **JSON** object with all parsed ad fields (price, location, attributes, seller, images, etc.).\n- `true`: returns the raw **HTML** source of the ad page as a string. Useful for advanced extraction or debugging when a field is missing from the structured response.\n\n**Note:** The same `query` (ad ID or full URL) works in both modes. You don't need to change the input format depending on the value of this parameter.","schema":{"type":"boolean","default":"false","description":"Controls the response format.\n\n- `false` (default): returns a structured **JSON** object with all parsed ad fields (price, location, attributes, seller, images, etc.).\n- `true`: returns the raw **HTML** source of the ad page as a string. Useful for advanced extraction or debugging when a field is missing from the structured response.\n\n**Note:** The same `query` (ad ID or full URL) works in both modes. You don't need to change the input format depending on the value of this parameter."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"body":{"type":"string"},"owner":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"siren":{"nullable":true},"user_id":{"type":"string"}}},"price":{"type":"array","items":{"type":"integer"}},"images":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"}}}},"status":{"type":"string"},"list_id":{"type":"integer"},"subject":{"type":"string"},"category":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}},"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"city":{"type":"string"},"zipcode":{"type":"string"},"region_id":{"type":"string"},"region_name":{"type":"string"},"department_id":{"type":"string"},"department_name":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"value_label":{"type":"string"}}}},"price_cents":{"type":"array","items":{"type":"integer"}},"creation_date":{"type":"string"},"expiration_date":{"type":"string"}}},"examples":{"Lookup car listing on Leboncoin":{"value":{"url":"https://www.leboncoin.fr/voitures/2715494476.htm","body":"Renault Clio IV 1.5 DCI 90. Carnet d'entretien complet, CT OK, première main.","owner":{"name":"Alex Martin","type":"private","siren":null,"user_id":"abc123456"},"price":[8500],"images":{"urls":["https://img.leboncoin.fr/api/cdn/thumbs/abcdef1234567890.jpg"]},"status":"active","list_id":2715494476,"subject":"Renault Clio IV 1.5 DCI 90 Energy SL Rip Curl","category":{"id":"2","label":"Voitures"},"location":{"lat":44.8378,"lng":-0.5792,"city":"Bordeaux","zipcode":"33000","region_id":"14","region_name":"Nouvelle-Aquitaine","department_id":"33","department_name":"Gironde"},"attributes":[{"key":"regdate","value":"2015","value_label":"2015"},{"key":"mileage","value":"95000","value_label":"95 000 km"},{"key":"fuel","value":"diesel","value_label":"Diesel"},{"key":"gearbox","value":"manual","value_label":"Manuelle"},{"key":"horsepower","value":"8","value_label":"8 CV"},{"key":"brand","value":"renault","value_label":"Renault"},{"key":"model","value":"Clio IV","value_label":"Clio IV"},{"key":"vehicle_damage","value":"no_damage","value_label":"Non endommagé"},{"key":"seats","value":"5","value_label":"5 places"},{"key":"doors","value":"5","value_label":"5 portes"},{"key":"critair","value":"2","value_label":"Crit'Air 2"},{"key":"color","value":"silver","value_label":"Gris"},{"key":"vehicle_type","value":"berline","value_label":"Berline"}],"price_cents":[850000],"creation_date":"2024-09-15T14:22:00+02:00","expiration_date":"2024-10-15T14:22:00+02:00"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Leboncoin Ad","description":"Extract full details from a Leboncoin ad including price, location, attributes, seller info, and images. Returns structured JSON by default, or raw HTML on demand.\n\n**Credit cost:** 1 credit per call","operationId":"post-leboncoin-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Leboncoin ad ID or full ad URL. Both formats are accepted regardless of `return_page_source`.\n\n**Accepted formats:**\n- Ad ID: `3012186547`\n- Full URL: `https://www.leboncoin.fr/ad/equipement_auto/3012186547`\n\n**Examples:**\n\n```\n3012186547\n```\n\n```\nhttps://www.leboncoin.fr/ad/equipement_auto/3012186547\n```\n\n**Note:** If the ad has been deleted or expired on Leboncoin, the endpoint returns a `404` status code.","schema":{"type":"string","description":"Leboncoin ad ID or full ad URL. Both formats are accepted regardless of `return_page_source`.\n\n**Accepted formats:**\n- Ad ID: `3012186547`\n- Full URL: `https://www.leboncoin.fr/ad/equipement_auto/3012186547`\n\n**Examples:**\n\n```\n3012186547\n```\n\n```\nhttps://www.leboncoin.fr/ad/equipement_auto/3012186547\n```\n\n**Note:** If the ad has been deleted or expired on Leboncoin, the endpoint returns a `404` status code."}},{"name":"return_page_source","in":"query","required":false,"description":"Controls the response format.\n\n- `false` (default): returns a structured **JSON** object with all parsed ad fields (price, location, attributes, seller, images, etc.).\n- `true`: returns the raw **HTML** source of the ad page as a string. Useful for advanced extraction or debugging when a field is missing from the structured response.\n\n**Note:** The same `query` (ad ID or full URL) works in both modes. You don't need to change the input format depending on the value of this parameter.","schema":{"type":"boolean","default":"false","description":"Controls the response format.\n\n- `false` (default): returns a structured **JSON** object with all parsed ad fields (price, location, attributes, seller, images, etc.).\n- `true`: returns the raw **HTML** source of the ad page as a string. Useful for advanced extraction or debugging when a field is missing from the structured response.\n\n**Note:** The same `query` (ad ID or full URL) works in both modes. You don't need to change the input format depending on the value of this parameter."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"body":{"type":"string"},"owner":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"siren":{"nullable":true},"user_id":{"type":"string"}}},"price":{"type":"array","items":{"type":"integer"}},"images":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"}}}},"status":{"type":"string"},"list_id":{"type":"integer"},"subject":{"type":"string"},"category":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}},"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"city":{"type":"string"},"zipcode":{"type":"string"},"region_id":{"type":"string"},"region_name":{"type":"string"},"department_id":{"type":"string"},"department_name":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"value_label":{"type":"string"}}}},"price_cents":{"type":"array","items":{"type":"integer"}},"creation_date":{"type":"string"},"expiration_date":{"type":"string"}}},"examples":{"Lookup car listing on Leboncoin":{"value":{"url":"https://www.leboncoin.fr/voitures/2715494476.htm","body":"Renault Clio IV 1.5 DCI 90. Carnet d'entretien complet, CT OK, première main.","owner":{"name":"Alex Martin","type":"private","siren":null,"user_id":"abc123456"},"price":[8500],"images":{"urls":["https://img.leboncoin.fr/api/cdn/thumbs/abcdef1234567890.jpg"]},"status":"active","list_id":2715494476,"subject":"Renault Clio IV 1.5 DCI 90 Energy SL Rip Curl","category":{"id":"2","label":"Voitures"},"location":{"lat":44.8378,"lng":-0.5792,"city":"Bordeaux","zipcode":"33000","region_id":"14","region_name":"Nouvelle-Aquitaine","department_id":"33","department_name":"Gironde"},"attributes":[{"key":"regdate","value":"2015","value_label":"2015"},{"key":"mileage","value":"95000","value_label":"95 000 km"},{"key":"fuel","value":"diesel","value_label":"Diesel"},{"key":"gearbox","value":"manual","value_label":"Manuelle"},{"key":"horsepower","value":"8","value_label":"8 CV"},{"key":"brand","value":"renault","value_label":"Renault"},{"key":"model","value":"Clio IV","value_label":"Clio IV"},{"key":"vehicle_damage","value":"no_damage","value_label":"Non endommagé"},{"key":"seats","value":"5","value_label":"5 places"},{"key":"doors","value":"5","value_label":"5 portes"},{"key":"critair","value":"2","value_label":"Crit'Air 2"},{"key":"color","value":"silver","value_label":"Gris"},{"key":"vehicle_type","value":"berline","value_label":"Berline"}],"price_cents":[850000],"creation_date":"2024-09-15T14:22:00+02:00","expiration_date":"2024-10-15T14:22:00+02:00"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/leboncoin/search":{"get":{"summary":"Leboncoin Search","description":"Scrape Leboncoin search results or category pages by URL, returning paginated listings with price, location, and attributes. Returns structured JSON. return_page_source is deprecated and returns 400.\n\n**Credit cost:** 1 credit per call","operationId":"get-leboncoin-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Leboncoin search or category URL. Both keyword searches and category browse URLs are supported.\n\n**Supported URL types:**\n- Category page: `https://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747`\n- Keyword search: `https://www.leboncoin.fr/recherche?text=iphone+15&category=38`\n- Map view: `https://www.leboncoin.fr/carte/...`\n\n**Examples:**\n\n```\nhttps://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747\n```\n\n```\nhttps://www.leboncoin.fr/recherche?text=macbook&category=15\n```\n\n**Note:** Pagination can be added by appending `&page=2` to the URL.","schema":{"type":"string","description":"Full Leboncoin search or category URL. Both keyword searches and category browse URLs are supported.\n\n**Supported URL types:**\n- Category page: `https://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747`\n- Keyword search: `https://www.leboncoin.fr/recherche?text=iphone+15&category=38`\n- Map view: `https://www.leboncoin.fr/carte/...`\n\n**Examples:**\n\n```\nhttps://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747\n```\n\n```\nhttps://www.leboncoin.fr/recherche?text=macbook&category=15\n```\n\n**Note:** Pagination can be added by appending `&page=2` to the URL."}},{"name":"return_page_source","in":"query","required":false,"description":"Deprecated. Sending true returns 400.","deprecated":true,"schema":{"type":"boolean","default":"false","description":"Deprecated. Sending true returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ads":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"body":{"type":"string"},"owner":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"price":{"type":"array","items":{"type":"integer"}},"images":{"type":"object","properties":{"nb_images":{"type":"integer"},"small_url":{"type":"string"}}},"status":{"type":"string"},"list_id":{"type":"integer"},"subject":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"zipcode":{"type":"string"},"region_name":{"type":"string"},"department_name":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"value_label":{"type":"string"}}}},"category_id":{"type":"string"},"category_name":{"type":"string"},"creation_date":{"type":"string"}}}},"total":{"type":"integer"},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"total_pages":{"type":"integer"}}}}},"examples":{"Browse car listings in Île-de-France":{"value":{"ads":[{"url":"https://www.leboncoin.fr/voitures/2718234567.htm","body":"Renault Megane IV Estate diesel, CT valable 2 ans, révision à jour, non fumeur.","owner":{"name":"Alex Martin","type":"private"},"price":[9900],"images":{"nb_images":8,"small_url":"https://img.leboncoin.fr/api/cdn/thumbs/xyz12345.jpg"},"status":"active","list_id":2718234567,"subject":"Renault Megane IV Estate 1.5 DCI 110 Business","location":{"city":"Versailles","zipcode":"78000","region_name":"Île-de-France","department_name":"Yvelines"},"attributes":[{"key":"brand","value":"renault","value_label":"Renault"},{"key":"model","value":"Megane IV Estate","value_label":"Megane IV Estate"},{"key":"regdate","value":"2018","value_label":"2018"},{"key":"mileage","value":"89000","value_label":"89 000 km"},{"key":"fuel","value":"diesel","value_label":"Diesel"},{"key":"gearbox","value":"manual","value_label":"Manuelle"},{"key":"critair","value":"2","value_label":"Crit'Air 2"}],"category_id":"2","category_name":"Voitures","creation_date":"2024-09-18T09:30:00+02:00"}],"total":12481,"pagination":{"page":1,"total_pages":100}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Leboncoin Search","description":"Scrape Leboncoin search results or category pages by URL, returning paginated listings with price, location, and attributes. Returns structured JSON. return_page_source is deprecated and returns 400.\n\n**Credit cost:** 1 credit per call","operationId":"post-leboncoin-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Leboncoin search or category URL. Both keyword searches and category browse URLs are supported.\n\n**Supported URL types:**\n- Category page: `https://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747`\n- Keyword search: `https://www.leboncoin.fr/recherche?text=iphone+15&category=38`\n- Map view: `https://www.leboncoin.fr/carte/...`\n\n**Examples:**\n\n```\nhttps://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747\n```\n\n```\nhttps://www.leboncoin.fr/recherche?text=macbook&category=15\n```\n\n**Note:** Pagination can be added by appending `&page=2` to the URL.","schema":{"type":"string","description":"Full Leboncoin search or category URL. Both keyword searches and category browse URLs are supported.\n\n**Supported URL types:**\n- Category page: `https://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747`\n- Keyword search: `https://www.leboncoin.fr/recherche?text=iphone+15&category=38`\n- Map view: `https://www.leboncoin.fr/carte/...`\n\n**Examples:**\n\n```\nhttps://www.leboncoin.fr/c/offres_d_emploi?locations=Paris_75015__48.84105_2.29926_2747\n```\n\n```\nhttps://www.leboncoin.fr/recherche?text=macbook&category=15\n```\n\n**Note:** Pagination can be added by appending `&page=2` to the URL."}},{"name":"return_page_source","in":"query","required":false,"description":"Deprecated. Sending true returns 400.","deprecated":true,"schema":{"type":"boolean","default":"false","description":"Deprecated. Sending true returns 400."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ads":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"body":{"type":"string"},"owner":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"price":{"type":"array","items":{"type":"integer"}},"images":{"type":"object","properties":{"nb_images":{"type":"integer"},"small_url":{"type":"string"}}},"status":{"type":"string"},"list_id":{"type":"integer"},"subject":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"zipcode":{"type":"string"},"region_name":{"type":"string"},"department_name":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"value_label":{"type":"string"}}}},"category_id":{"type":"string"},"category_name":{"type":"string"},"creation_date":{"type":"string"}}}},"total":{"type":"integer"},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"total_pages":{"type":"integer"}}}}},"examples":{"Browse car listings in Île-de-France":{"value":{"ads":[{"url":"https://www.leboncoin.fr/voitures/2718234567.htm","body":"Renault Megane IV Estate diesel, CT valable 2 ans, révision à jour, non fumeur.","owner":{"name":"Alex Martin","type":"private"},"price":[9900],"images":{"nb_images":8,"small_url":"https://img.leboncoin.fr/api/cdn/thumbs/xyz12345.jpg"},"status":"active","list_id":2718234567,"subject":"Renault Megane IV Estate 1.5 DCI 110 Business","location":{"city":"Versailles","zipcode":"78000","region_name":"Île-de-France","department_name":"Yvelines"},"attributes":[{"key":"brand","value":"renault","value_label":"Renault"},{"key":"model","value":"Megane IV Estate","value_label":"Megane IV Estate"},{"key":"regdate","value":"2018","value_label":"2018"},{"key":"mileage","value":"89000","value_label":"89 000 km"},{"key":"fuel","value":"diesel","value_label":"Diesel"},{"key":"gearbox","value":"manual","value_label":"Manuelle"},{"key":"critair","value":"2","value_label":"Crit'Air 2"}],"category_id":"2","category_name":"Voitures","creation_date":"2024-09-18T09:30:00+02:00"}],"total":12481,"pagination":{"page":1,"total_pages":100}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/chewy-products":{"get":{"summary":"Chewy Products Finder","description":"Find Chewy product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.","operationId":"get-finder-chewy-products","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    dog food","schema":{"type":"string","description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    dog food"}},{"name":"query","in":"query","required":false,"description":"Legacy alias of `search`. Kept for backward compatibility.","deprecated":true,"schema":{"type":"string","description":"Legacy alias of `search`. Kept for backward compatibility."}},{"name":"id","in":"query","required":false,"description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    312253,312254","schema":{"type":"string","description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    312253,312254"}},{"name":"domain","in":"query","required":false,"description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    com","schema":{"type":"string","description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    com"}},{"name":"filter","in":"query","required":false,"description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"com\" AND title CONTAINS \"puppy\"","schema":{"type":"string","description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"com\" AND title CONTAINS \"puppy\""}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return. Default is 10, maximum is 100.","schema":{"type":"number","default":"10","description":"Maximum number of results to return. Default is 10, maximum is 100."}},{"name":"offset","in":"query","required":false,"description":"Number of results to skip for pagination. Default is 0.","schema":{"type":"number","default":"0","description":"Number of results to skip for pagination. Default is 0."}},{"name":"sort","in":"query","required":false,"description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc","schema":{"type":"string","description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url","schema":{"type":"string","description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url"}},{"name":"count","in":"query","required":false,"description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true","schema":{"type":"boolean","default":"false","description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"}}}},"examples":{"Search by query 'salmon'":{"value":[{"id":"312253","url":"https://www.chewy.com/blue-buffalo-life-protection-formula/dp/312253","title":"Blue Buffalo Life Protection Formula Adult Chicken & Brown Rice Recipe Dry Dog Food","domain":"com"},{"id":"133035","url":"https://www.chewy.com/wellness-complete-health-natural-dry/dp/133035","title":"Wellness Complete Health Natural Dry Dog Food, Salmon & Sweet Potato Recipe","domain":"com"}]},"Lookup multiple IDs":{"value":[{"id":"312253","url":"https://www.chewy.com/blue-buffalo-life-protection-formula/dp/312253","title":"Blue Buffalo Life Protection Formula Adult Chicken & Brown Rice Recipe Dry Dog Food","domain":"com"},{"id":"312254","url":"https://www.chewy.com/blue-buffalo-life-protection-formula-2/dp/312254","title":"Blue Buffalo Life Protection Formula Adult Lamb & Brown Rice Recipe Dry Dog Food","domain":"com"}]},"Search with count=true":{"value":{"hits":[{"id":"312253","url":"https://www.chewy.com/blue-buffalo-life-protection-formula/dp/312253","title":"Blue Buffalo Life Protection Formula Adult Chicken & Brown Rice Recipe Dry Dog Food","domain":"com"}],"count":842}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Chewy Products Finder","description":"Find Chewy product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.","operationId":"post-finder-chewy-products","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    dog food","schema":{"type":"string","description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    dog food"}},{"name":"query","in":"query","required":false,"description":"Legacy alias of `search`. Kept for backward compatibility.","deprecated":true,"schema":{"type":"string","description":"Legacy alias of `search`. Kept for backward compatibility."}},{"name":"id","in":"query","required":false,"description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    312253,312254","schema":{"type":"string","description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    312253,312254"}},{"name":"domain","in":"query","required":false,"description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    com","schema":{"type":"string","description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    com"}},{"name":"filter","in":"query","required":false,"description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"com\" AND title CONTAINS \"puppy\"","schema":{"type":"string","description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"com\" AND title CONTAINS \"puppy\""}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return. Default is 10, maximum is 100.","schema":{"type":"number","default":"10","description":"Maximum number of results to return. Default is 10, maximum is 100."}},{"name":"offset","in":"query","required":false,"description":"Number of results to skip for pagination. Default is 0.","schema":{"type":"number","default":"0","description":"Number of results to skip for pagination. Default is 0."}},{"name":"sort","in":"query","required":false,"description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc","schema":{"type":"string","description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url","schema":{"type":"string","description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url"}},{"name":"count","in":"query","required":false,"description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true","schema":{"type":"boolean","default":"false","description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"}}}},"examples":{"Search by query 'salmon'":{"value":[{"id":"312253","url":"https://www.chewy.com/blue-buffalo-life-protection-formula/dp/312253","title":"Blue Buffalo Life Protection Formula Adult Chicken & Brown Rice Recipe Dry Dog Food","domain":"com"},{"id":"133035","url":"https://www.chewy.com/wellness-complete-health-natural-dry/dp/133035","title":"Wellness Complete Health Natural Dry Dog Food, Salmon & Sweet Potato Recipe","domain":"com"}]},"Lookup multiple IDs":{"value":[{"id":"312253","url":"https://www.chewy.com/blue-buffalo-life-protection-formula/dp/312253","title":"Blue Buffalo Life Protection Formula Adult Chicken & Brown Rice Recipe Dry Dog Food","domain":"com"},{"id":"312254","url":"https://www.chewy.com/blue-buffalo-life-protection-formula-2/dp/312254","title":"Blue Buffalo Life Protection Formula Adult Lamb & Brown Rice Recipe Dry Dog Food","domain":"com"}]},"Search with count=true":{"value":{"hits":[{"id":"312253","url":"https://www.chewy.com/blue-buffalo-life-protection-formula/dp/312253","title":"Blue Buffalo Life Protection Formula Adult Chicken & Brown Rice Recipe Dry Dog Food","domain":"com"}],"count":842}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/leroymerlin-products":{"get":{"summary":"Leroy Merlin Products Finder","description":"Find Leroy Merlin product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.","operationId":"get-finder-leroymerlin-products","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    perceuse","schema":{"type":"string","description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    perceuse"}},{"name":"query","in":"query","required":false,"description":"Legacy alias of `search`. Kept for backward compatibility.","deprecated":true,"schema":{"type":"string","description":"Legacy alias of `search`. Kept for backward compatibility."}},{"name":"id","in":"query","required":false,"description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    84827484,84827521","schema":{"type":"string","description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    84827484,84827521"}},{"name":"domain","in":"query","required":false,"description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    fr","schema":{"type":"string","description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    fr"}},{"name":"filter","in":"query","required":false,"description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"fr\" AND title CONTAINS \"festool\"","schema":{"type":"string","description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"fr\" AND title CONTAINS \"festool\""}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return. Default is 10, maximum is 100.","schema":{"type":"number","default":"10","description":"Maximum number of results to return. Default is 10, maximum is 100."}},{"name":"offset","in":"query","required":false,"description":"Number of results to skip for pagination. Default is 0.","schema":{"type":"number","default":"0","description":"Number of results to skip for pagination. Default is 0."}},{"name":"sort","in":"query","required":false,"description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc","schema":{"type":"string","description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url","schema":{"type":"string","description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url"}},{"name":"count","in":"query","required":false,"description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true","schema":{"type":"boolean","default":"false","description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"}}}},"examples":{"Search by query 'festool'":{"value":[{"id":"83733175","url":"https://www.leroymerlin.fr/produits/sacs-filtre-double-paroi-festool-fis-sr-202-5-pieces-487482-83733175.html","title":"Sacs filtre double paroi FESTOOL FIS-SR 202 - 5 pièces - 487482","domain":"fr"},{"id":"83733177","url":"https://www.leroymerlin.fr/produits/sac-filtre-longlife-longlife-fis-ct-sys-festool-500642-83733177.html","title":"Sac filtre Longlife Longlife-FIS-CT SYS - FESTOOL 500642","domain":"fr"},{"id":"83733153","url":"https://www.leroymerlin.fr/produits/sac-elimination-des-dechets-festool-ens-ct-48-ac-5-pieces-497540-83733153.html","title":"Sac d'élimination des déchets FESTOOL ENS-CT 48 AC - 5 pièces - 497540","domain":"fr"},{"id":"83733154","url":"https://www.leroymerlin.fr/produits/5-sacs-elimination-des-dechets-ens-ct-26-ac-5-83733154.html","title":"5 Sacs d'élimination des déchets ENS-CT 26 AC/5","domain":"fr"},{"id":"83733155","url":"https://www.leroymerlin.fr/produits/sac-filtre-selfclean-sc-fis-ct-sys-5-festool-500438-83733155.html","title":"Sac filtre SELFCLEAN SC FIS-CT SYS/5 - FESTOOL 500438","domain":"fr"},{"id":"83733156","url":"https://www.leroymerlin.fr/produits/sac-filtre-festool-fis-ct-55-5-pieces-452973-83733156.html","title":"Sac filtre FESTOOL FIS-CT 55 - 5 pièces - 452973","domain":"fr"},{"id":"83733157","url":"https://www.leroymerlin.fr/produits/sac-filtre-festool-fis-ct-44-sp-vlies-5-pieces-456874-83733157.html","title":"Sac filtre FESTOOL FIS-CT 44 SP VLIES - 5 pièces - 456874","domain":"fr"},{"id":"83733158","url":"https://www.leroymerlin.fr/produits/sac-filtre-selfclean-sc-fis-ct-48-festool-5-pieces-497539-83733158.html","title":"Sac filtre Selfclean SC FIS-CT 48 FESTOOL - 5 pièces - 497539","domain":"fr"},{"id":"83733165","url":"https://www.leroymerlin.fr/produits/sacs-filtre-double-paroi-festool-fis-sr-150-5-pieces-488460-83733165.html","title":"Sacs filtre double paroi FESTOOL FIS-SR 150 - 5 pièces - 488460","domain":"fr"},{"id":"83733170","url":"https://www.leroymerlin.fr/produits/sac-filtre-festool-longlife-fis-ct-22-456737-83733170.html","title":"Sac filtre FESTOOL Longlife - FIS-CT 22 - 456737","domain":"fr"}]},"Lookup multiple IDs":{"value":[{"id":"84827484","url":"https://www.leroymerlin.fr/produits/a-tec-gris-310ml-par-12-84827484.html","title":"A-TEC gris 310ml (Par 12)","domain":"fr"},{"id":"84827521","url":"https://www.leroymerlin.fr/produits/a-tec-blanc-310ml-par-12-84827521.html","title":"A-TEC blanc 310ml (Par 12)","domain":"fr"}]},"Search with count=true":{"value":{"hits":[{"id":"83733175","url":"https://www.leroymerlin.fr/produits/sacs-filtre-double-paroi-festool-fis-sr-202-5-pieces-487482-83733175.html","title":"Sacs filtre double paroi FESTOOL FIS-SR 202 - 5 pièces - 487482","domain":"fr"},{"id":"83733177","url":"https://www.leroymerlin.fr/produits/sac-filtre-longlife-longlife-fis-ct-sys-festool-500642-83733177.html","title":"Sac filtre Longlife Longlife-FIS-CT SYS - FESTOOL 500642","domain":"fr"}],"count":1247}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Leroy Merlin Products Finder","description":"Find Leroy Merlin product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.","operationId":"post-finder-leroymerlin-products","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"search","in":"query","required":false,"description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    perceuse","schema":{"type":"string","description":"Free-text search across product titles and IDs. Optional if at least one filter is provided.\n\n**Example:**\n\n    perceuse"}},{"name":"query","in":"query","required":false,"description":"Legacy alias of `search`. Kept for backward compatibility.","deprecated":true,"schema":{"type":"string","description":"Legacy alias of `search`. Kept for backward compatibility."}},{"name":"id","in":"query","required":false,"description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    84827484,84827521","schema":{"type":"string","description":"Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.\n\n**Example:**\n\n    84827484,84827521"}},{"name":"domain","in":"query","required":false,"description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    fr","schema":{"type":"string","description":"Filter by website domain. Comma-separated values are accepted.\n\n**Example:**\n\n    fr"}},{"name":"filter","in":"query","required":false,"description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"fr\" AND title CONTAINS \"festool\"","schema":{"type":"string","description":"Raw filter expression for advanced filtering. Combined with the shorthand filters using `AND`.\n\n**Example:**\n\n    domain = \"fr\" AND title CONTAINS \"festool\""}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return. Default is 10, maximum is 100.","schema":{"type":"number","default":"10","description":"Maximum number of results to return. Default is 10, maximum is 100."}},{"name":"offset","in":"query","required":false,"description":"Number of results to skip for pagination. Default is 0.","schema":{"type":"number","default":"0","description":"Number of results to skip for pagination. Default is 0."}},{"name":"sort","in":"query","required":false,"description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc","schema":{"type":"string","description":"Sort the results. Provide one or several attributes with `:asc` or `:desc`, comma-separated.\n\n**Example:**\n\n    title:asc"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url","schema":{"type":"string","description":"Comma-separated list of fields to return. Defaults to all fields.\n\n**Example:**\n\n    id,title,url"}},{"name":"count","in":"query","required":false,"description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true","schema":{"type":"boolean","default":"false","description":"When `true`, the response is wrapped in an object containing the total estimated count plus the hits: `{ count, hits }`. When `false` or omitted, returns the raw hits array.\n\n**Example:**\n\n    true"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"}}}},"examples":{"Search by query 'festool'":{"value":[{"id":"83733175","url":"https://www.leroymerlin.fr/produits/sacs-filtre-double-paroi-festool-fis-sr-202-5-pieces-487482-83733175.html","title":"Sacs filtre double paroi FESTOOL FIS-SR 202 - 5 pièces - 487482","domain":"fr"},{"id":"83733177","url":"https://www.leroymerlin.fr/produits/sac-filtre-longlife-longlife-fis-ct-sys-festool-500642-83733177.html","title":"Sac filtre Longlife Longlife-FIS-CT SYS - FESTOOL 500642","domain":"fr"},{"id":"83733153","url":"https://www.leroymerlin.fr/produits/sac-elimination-des-dechets-festool-ens-ct-48-ac-5-pieces-497540-83733153.html","title":"Sac d'élimination des déchets FESTOOL ENS-CT 48 AC - 5 pièces - 497540","domain":"fr"},{"id":"83733154","url":"https://www.leroymerlin.fr/produits/5-sacs-elimination-des-dechets-ens-ct-26-ac-5-83733154.html","title":"5 Sacs d'élimination des déchets ENS-CT 26 AC/5","domain":"fr"},{"id":"83733155","url":"https://www.leroymerlin.fr/produits/sac-filtre-selfclean-sc-fis-ct-sys-5-festool-500438-83733155.html","title":"Sac filtre SELFCLEAN SC FIS-CT SYS/5 - FESTOOL 500438","domain":"fr"},{"id":"83733156","url":"https://www.leroymerlin.fr/produits/sac-filtre-festool-fis-ct-55-5-pieces-452973-83733156.html","title":"Sac filtre FESTOOL FIS-CT 55 - 5 pièces - 452973","domain":"fr"},{"id":"83733157","url":"https://www.leroymerlin.fr/produits/sac-filtre-festool-fis-ct-44-sp-vlies-5-pieces-456874-83733157.html","title":"Sac filtre FESTOOL FIS-CT 44 SP VLIES - 5 pièces - 456874","domain":"fr"},{"id":"83733158","url":"https://www.leroymerlin.fr/produits/sac-filtre-selfclean-sc-fis-ct-48-festool-5-pieces-497539-83733158.html","title":"Sac filtre Selfclean SC FIS-CT 48 FESTOOL - 5 pièces - 497539","domain":"fr"},{"id":"83733165","url":"https://www.leroymerlin.fr/produits/sacs-filtre-double-paroi-festool-fis-sr-150-5-pieces-488460-83733165.html","title":"Sacs filtre double paroi FESTOOL FIS-SR 150 - 5 pièces - 488460","domain":"fr"},{"id":"83733170","url":"https://www.leroymerlin.fr/produits/sac-filtre-festool-longlife-fis-ct-22-456737-83733170.html","title":"Sac filtre FESTOOL Longlife - FIS-CT 22 - 456737","domain":"fr"}]},"Lookup multiple IDs":{"value":[{"id":"84827484","url":"https://www.leroymerlin.fr/produits/a-tec-gris-310ml-par-12-84827484.html","title":"A-TEC gris 310ml (Par 12)","domain":"fr"},{"id":"84827521","url":"https://www.leroymerlin.fr/produits/a-tec-blanc-310ml-par-12-84827521.html","title":"A-TEC blanc 310ml (Par 12)","domain":"fr"}]},"Search with count=true":{"value":{"hits":[{"id":"83733175","url":"https://www.leroymerlin.fr/produits/sacs-filtre-double-paroi-festool-fis-sr-202-5-pieces-487482-83733175.html","title":"Sacs filtre double paroi FESTOOL FIS-SR 202 - 5 pièces - 487482","domain":"fr"},{"id":"83733177","url":"https://www.leroymerlin.fr/produits/sac-filtre-longlife-longlife-fis-ct-sys-festool-500642-83733177.html","title":"Sac filtre Longlife Longlife-FIS-CT SYS - FESTOOL 500642","domain":"fr"}],"count":1247}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/mobile/search":{"get":{"summary":"Mobile Search","description":"Mobile Search API. Same mobile.de inventory for every locale. `locale` sets the language label and ad links, not which cars are returned. (3 credits)\n\n**Credit cost:** 3 credits per call","operationId":"get-mobile-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search URL or make/model code (`ms=`).\n\n**Examples:**\n\n```\n20100\n```\n\n```\nhttps://www.mobile.de/fr/voiture/recherche.html?ms=20100&s=Car&vc=Car\n```\n\n```\nhttps://suchen.mobile.de/fahrzeuge/search.html?s=Car&vc=Car\n```\n\nUse **Mobile Ad** on any result `url` or `ad_id` for full listing data.","schema":{"type":"string","description":"Search URL or make/model code (`ms=`).\n\n**Examples:**\n\n```\n20100\n```\n\n```\nhttps://www.mobile.de/fr/voiture/recherche.html?ms=20100&s=Car&vc=Car\n```\n\n```\nhttps://suchen.mobile.de/fahrzeuge/search.html?s=Car&vc=Car\n```\n\nUse **Mobile Ad** on any result `url` or `ad_id` for full listing data."}},{"name":"locale","in":"query","required":false,"description":"Locale label for the results. The cars themselves stay the same for de, fr, and en.\n\nExamples: fr, de, en, es.\n\nA suchen.mobile.de search URL is read as the French search, with the same filters.","schema":{"type":"string","description":"Locale label for the results. The cars themselves stay the same for de, fr, and en.\n\nExamples: fr, de, en, es.\n\nA suchen.mobile.de search URL is read as the French search, with the same filters."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Same effect as page or pageNumber in the Mobile.de URL.\n\nThe response next uses pageNumber for the following page: page 1 links to pageNumber=2, page 2 links to pageNumber=3.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number, starting at 1. Same effect as page or pageNumber in the Mobile.de URL.\n\nThe response next uses pageNumber for the following page: page 1 links to pageNumber=2, page 2 links to pageNumber=3."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"make":{"type":"string"},"ad_id":{"type":"string"},"model":{"type":"string"},"power":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"locale":{"type":"string"},"mileage":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"fuel_type":{"type":"string"},"image_url":{"type":"string"},"price_rating":{"type":"string"},"transmission":{"type":"string"},"first_registration":{"type":"string"},"price_rating_label":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Search Porsche (ms=20100) on mobile.de FR":{"value":{"results":[{"url":"https://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455007337&s=Car&vc=Car","make":"Porsche","ad_id":"455007337","model":"Cayman","power":"265 kW (360 ch)","price":54990,"title":"Porsche Cayman S PDK","locale":"fr","mileage":"22.500 km","currency":"EUR","location":"München","fuel_type":"Essence","image_url":"https://img.classistatic.de/api/v1/mo-prod/images/jpg/normal/95/mt_mte247ax-wr.jpg","price_rating":"GOOD_PRICE","transmission":"Automatique","first_registration":"03/2021","price_rating_label":"Bon prix"}],"pagination":{"next":null,"page":1,"per_page":50,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Mobile Search","description":"Mobile Search API. Same mobile.de inventory for every locale. `locale` sets the language label and ad links, not which cars are returned. (3 credits)\n\n**Credit cost:** 3 credits per call","operationId":"post-mobile-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search URL or make/model code (`ms=`).\n\n**Examples:**\n\n```\n20100\n```\n\n```\nhttps://www.mobile.de/fr/voiture/recherche.html?ms=20100&s=Car&vc=Car\n```\n\n```\nhttps://suchen.mobile.de/fahrzeuge/search.html?s=Car&vc=Car\n```\n\nUse **Mobile Ad** on any result `url` or `ad_id` for full listing data.","schema":{"type":"string","description":"Search URL or make/model code (`ms=`).\n\n**Examples:**\n\n```\n20100\n```\n\n```\nhttps://www.mobile.de/fr/voiture/recherche.html?ms=20100&s=Car&vc=Car\n```\n\n```\nhttps://suchen.mobile.de/fahrzeuge/search.html?s=Car&vc=Car\n```\n\nUse **Mobile Ad** on any result `url` or `ad_id` for full listing data."}},{"name":"locale","in":"query","required":false,"description":"Locale label for the results. The cars themselves stay the same for de, fr, and en.\n\nExamples: fr, de, en, es.\n\nA suchen.mobile.de search URL is read as the French search, with the same filters.","schema":{"type":"string","description":"Locale label for the results. The cars themselves stay the same for de, fr, and en.\n\nExamples: fr, de, en, es.\n\nA suchen.mobile.de search URL is read as the French search, with the same filters."}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Same effect as page or pageNumber in the Mobile.de URL.\n\nThe response next uses pageNumber for the following page: page 1 links to pageNumber=2, page 2 links to pageNumber=3.","schema":{"type":"number","minimum":1,"maximum":500,"description":"Page number, starting at 1. Same effect as page or pageNumber in the Mobile.de URL.\n\nThe response next uses pageNumber for the following page: page 1 links to pageNumber=2, page 2 links to pageNumber=3."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"make":{"type":"string"},"ad_id":{"type":"string"},"model":{"type":"string"},"power":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"locale":{"type":"string"},"mileage":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"fuel_type":{"type":"string"},"image_url":{"type":"string"},"price_rating":{"type":"string"},"transmission":{"type":"string"},"first_registration":{"type":"string"},"price_rating_label":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Search Porsche (ms=20100) on mobile.de FR":{"value":{"results":[{"url":"https://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455007337&s=Car&vc=Car","make":"Porsche","ad_id":"455007337","model":"Cayman","power":"265 kW (360 ch)","price":54990,"title":"Porsche Cayman S PDK","locale":"fr","mileage":"22.500 km","currency":"EUR","location":"München","fuel_type":"Essence","image_url":"https://img.classistatic.de/api/v1/mo-prod/images/jpg/normal/95/mt_mte247ax-wr.jpg","price_rating":"GOOD_PRICE","transmission":"Automatique","first_registration":"03/2021","price_rating_label":"Bon prix"}],"pagination":{"next":null,"page":1,"per_page":50,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/mobile/ad":{"get":{"summary":"Mobile Ad","description":"Mobile Ad API. Fetch full car listing data from a mobile.de ad URL or numeric id. Returns pricing, specs, images and features via webunlocker.\n\n**Credit cost:** 3 credits per call","operationId":"get-mobile-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Mobile ad URL or numeric ad id.\n\n**Examples:**\n\n```\n455111824\n```\n\n```\nhttps://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455111824\n```\n\nRegion/locale is auto-detected from full URLs; pass `locale` with numeric ids.","schema":{"type":"string","description":"Mobile ad URL or numeric ad id.\n\n**Examples:**\n\n```\n455111824\n```\n\n```\nhttps://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455111824\n```\n\nRegion/locale is auto-detected from full URLs; pass `locale` with numeric ids."}},{"name":"locale","in":"query","required":false,"description":"Language for this ad. The same numeric id stays reachable for fr, es, de, and en.\n\nA full ad URL is reread in the requested locale.","schema":{"type":"string","description":"Language for this ad. The same numeric id stays reachable for fr, es, de, and en.\n\nA full ad URL is reread in the requested locale."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"make":{"type":"string"},"ad_id":{"type":"string"},"model":{"type":"string"},"power":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"locale":{"type":"string"},"mileage":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"fuel_type":{"type":"string"},"image_url":{"type":"string"},"transmission":{"type":"string"},"first_registration":{"type":"string"}}},"examples":{"Porsche Taycan 4S (455111824) on mobile.de FR":{"value":{"url":"https://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455111824","make":"Porsche","ad_id":"455111824","model":"Taycan","power":"390 kW (530 ch)","price":80990,"title":"Porsche Taycan 4S","locale":"fr","mileage":"22.000 km","category":"Berline","currency":"EUR","features":["ABS","Airbags"],"fuel_type":"Électrique","image_url":"https://img.classistatic.de/api/v1/mo-prod/images/jpg/normal/95/taycan_main.jpg","transmission":"Automatique","first_registration":"05/2021"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Mobile Ad","description":"Mobile Ad API. Fetch full car listing data from a mobile.de ad URL or numeric id. Returns pricing, specs, images and features via webunlocker.\n\n**Credit cost:** 3 credits per call","operationId":"post-mobile-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Mobile ad URL or numeric ad id.\n\n**Examples:**\n\n```\n455111824\n```\n\n```\nhttps://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455111824\n```\n\nRegion/locale is auto-detected from full URLs; pass `locale` with numeric ids.","schema":{"type":"string","description":"Mobile ad URL or numeric ad id.\n\n**Examples:**\n\n```\n455111824\n```\n\n```\nhttps://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455111824\n```\n\nRegion/locale is auto-detected from full URLs; pass `locale` with numeric ids."}},{"name":"locale","in":"query","required":false,"description":"Language for this ad. The same numeric id stays reachable for fr, es, de, and en.\n\nA full ad URL is reread in the requested locale.","schema":{"type":"string","description":"Language for this ad. The same numeric id stays reachable for fr, es, de, and en.\n\nA full ad URL is reread in the requested locale."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"make":{"type":"string"},"ad_id":{"type":"string"},"model":{"type":"string"},"power":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"locale":{"type":"string"},"mileage":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"fuel_type":{"type":"string"},"image_url":{"type":"string"},"transmission":{"type":"string"},"first_registration":{"type":"string"}}},"examples":{"Porsche Taycan 4S (455111824) on mobile.de FR":{"value":{"url":"https://www.mobile.de/fr/voiture/d%C3%A9tails.html?id=455111824","make":"Porsche","ad_id":"455111824","model":"Taycan","power":"390 kW (530 ch)","price":80990,"title":"Porsche Taycan 4S","locale":"fr","mileage":"22.000 km","category":"Berline","currency":"EUR","features":["ABS","Airbags"],"fuel_type":"Électrique","image_url":"https://img.classistatic.de/api/v1/mo-prod/images/jpg/normal/95/taycan_main.jpg","transmission":"Automatique","first_registration":"05/2021"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/similarweb/search":{"get":{"summary":"Similarweb Search","description":"Search the Similarweb database to retrieve websites, companies, mobile apps, search keywords, and technologies associated with a given domain or keyword.\n\n**Credit cost:** 1 credit per call","operationId":"get-similarweb-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain name or keyword to search for in the Similarweb database.\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- **Domain search:** Use a full domain (e.g. `google.com`) to find related websites, apps, companies, and technologies associated with that domain.\n- **Keyword search:** Use a plain keyword (e.g. `amazon`) to retrieve broader associations across the Similarweb index.","schema":{"type":"string","description":"Domain name or keyword to search for in the Similarweb database.\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- **Domain search:** Use a full domain (e.g. `google.com`) to find related websites, apps, companies, and technologies associated with that domain.\n- **Keyword search:** Use a plain keyword (e.g. `amazon`) to retrieve broader associations across the Similarweb index."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"apps":{"type":"object","properties":{"appStore":{"type":"array","items":{}},"googlePlay":{"type":"array","items":{}}}},"keywords":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"isVirtual":{"type":"boolean"}}}},"companies":{"type":"array","items":{}},"technologies":{"type":"array","items":{}}}},"examples":{"Search for google.com":{"value":{"apps":{"appStore":[],"googlePlay":[]},"keywords":["google","google translate","google maps","google docs","google drive","google flights","google scholar","google gemini","google map","google tradutor"],"websites":[{"name":"google.com","image":"https://site-images.similarcdn.com/image?url=google.com&t=2&s=1&h=eb35e0fbafa3eb290132ffdfe47187d950d68daaa659ec1bd4b4e834b8f16461","isVirtual":false},{"name":"google.com.br","image":"https://site-images.similarcdn.com/image?url=google.com.br&t=2&s=1&h=f504c8926f9f375805be71b441f7e0075edd929c948130d744438f373adaf17c","isVirtual":false},{"name":"google.com.hk","image":"https://site-images.similarcdn.com/image?url=google.com.hk&t=2&s=1&h=8a5f5d19c15ef49cb7f696519e8e3a0c8624c4b3837ebd6f32b707650e0d8cc2","isVirtual":false},{"name":"google.com.mx","image":"https://site-images.similarcdn.com/image?url=google.com.mx&t=2&s=1&h=83f6c37012ec87b1250e08d4526d9c4e6ab2efe753b88a00221ad7f0b61937af","isVirtual":false},{"name":"google.com.tw","image":"https://site-images.similarcdn.com/image?url=google.com.tw&t=2&s=1&h=3233beffce0879e0ba5d45edbb1944a58b7a83662388554b3e7e2c2c8b55676a","isVirtual":false},{"name":"google.com.vn","image":"https://site-images.similarcdn.com/image?url=google.com.vn&t=2&s=1&h=98b085fee62d7c3114230d1e68facb8838af2e6d7cb538900fa8e8a315b9eb35","isVirtual":false},{"name":"google.com.au","image":"https://site-images.similarcdn.com/image?url=google.com.au&t=2&s=1&h=75e1999f2c7d28d56cad490b012b1ec4a120ecf8a656fc72d522258728d59cad","isVirtual":false},{"name":"google.com.tr","image":"https://site-images.similarcdn.com/image?url=google.com.tr&t=2&s=1&h=56f80540717eca7791d12ad63c8d821b0e8aad3378db7ac067f44c710829e0e5","isVirtual":false},{"name":"google.com.ar","image":"https://site-images.similarcdn.com/image?url=google.com.ar&t=2&s=1&h=a84e684d02bc6266e64492b5022004ff84c9146f836f0db9864d2adf4184b3d8","isVirtual":false},{"name":"google.com.ua","image":"https://site-images.similarcdn.com/image?url=google.com.ua&t=2&s=1&h=8835b452e239898cd81d835ee4b93695b013909af5853882c434b40f5adee3d4","isVirtual":false}],"companies":[],"technologies":[]}},"Search for amazon.com":{"value":{"apps":{"appStore":[],"googlePlay":[]},"keywords":["amazon","amazon prime","amazon prime video","amazon uk","amazon de","amazon canada","amazon india","amazon jobs","amazon stock","amazone"],"websites":[{"name":"amazon.com","image":"https://site-images.similarcdn.com/image?url=amazon.com&t=2&s=1&h=43a07f575342a8fbb74cd3ca3ebf33760f2fbfbff603546fb4f7208244147dcc","isVirtual":false},{"name":"amazon.com.br","image":"https://site-images.similarcdn.com/image?url=amazon.com.br&t=2&s=1&h=ffbbda96260c8a0db9be9d4d4f04e76e327ebf480e86e0c625b3f4538a9bae4c","isVirtual":false},{"name":"amazon.com.mx","image":"https://site-images.similarcdn.com/image?url=amazon.com.mx&t=2&s=1&h=4ec42ab5be5ff4e02bfbc9dfc91f0355aac94c47a2d2953f79ffeaa584ac80a0","isVirtual":false},{"name":"amazon.com.au","image":"https://site-images.similarcdn.com/image?url=amazon.com.au&t=2&s=1&h=0433f91f2de5720b6422f8bbd688498ad8bb572c15bfb89f3808b8ac6b9b3818","isVirtual":false},{"name":"amazon.com.tr","image":"https://site-images.similarcdn.com/image?url=amazon.com.tr&t=2&s=1&h=407a09187beabb8042f30715b56fa452a8c1e048beb58e67cd841f04b4b4575d","isVirtual":false},{"name":"amazon.com.be","image":"https://site-images.similarcdn.com/image?url=amazon.com.be&t=2&s=1&h=27c3b82b3543ad384a97c08dc9098297fa8c92a13dff8f970ae00579697c5dcf","isVirtual":false},{"name":"amazon.com.in","image":"https://site-images.similarcdn.com/image?url=amazon.com.in&t=2&s=1&h=c00e149ede72e7a286ad6d01f00ae2fe15b5f486fcddd9a53008bc6d4434d864","isVirtual":false},{"name":"amazon.com.sg","image":"https://site-images.similarcdn.com/image?url=amazon.com.sg&t=2&s=1&h=37e0466bf2c6f7c40f1ffd478aad0a7d3ee306a828ad4636e8dae662556d60e8","isVirtual":false},{"name":"amazon.com.tw","image":"https://site-images.similarcdn.com/image?url=amazon.com.tw&t=2&s=1&h=31d41b49fc05eb05a1a8b6a14c99efee596f405390169a055fb0f2e392ee3e7a","isVirtual":false},{"name":"amazon.com.jp","image":"https://site-images.similarcdn.com/image?url=amazon.com.jp&t=2&s=1&h=655a9e7aba4af27277f4ec56d7e6b054960d5c38ec400aa10aeb697be93183ce","isVirtual":false}],"companies":[{"name":"Amazon.com, Inc.","domain":"amazon.com","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.in","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.co.jp","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.de","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.co.uk","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.it","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.com.br","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.ca","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.fr","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.es","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"}],"technologies":[]}},"Search for apple.com":{"value":{"apps":{"appStore":[],"googlePlay":[]},"keywords":["apple","apple tv","apple watch","apple music","apple store","apple stock","apple macbook neo","apple id","appletv","apple neo"],"websites":[{"name":"apple.com","image":"https://site-images.similarcdn.com/image?url=apple.com&t=2&s=1&h=f81bb484ae2fd14ee7d230f4992fcf6f0e071e846a94e3f49400616e3f9c5063","isVirtual":false},{"name":"apple.com.cn","image":"https://site-images.similarcdn.com/image?url=apple.com.cn&t=2&s=1&h=5d6a86bc69ab6e20c0b6da8d8686f00e3d53fd1467cd86603481894775730cd9","isVirtual":false},{"name":"apple.com.in","image":"https://site-images.similarcdn.com/image?url=apple.com.in&t=2&s=1&h=e848e90f18b6655c6ff9efeb1599c3650cbe6c440d28aff56659f1cc6d5f0d5b","isVirtual":false},{"name":"apple.com.tr","image":"https://site-images.similarcdn.com/image?url=apple.com.tr&t=2&s=1&h=58ad83dd930d1eee89d230d544c971106292dfbf8d899846f0f2513e860cad2f","isVirtual":false},{"name":"apple.com.id","image":"https://site-images.similarcdn.com/image?url=apple.com.id&t=2&s=1&h=a74051e6db2ec5ccd4a92530aa0fcd32972e5a349ac7b1516e3200e65dae46b7","isVirtual":false},{"name":"apple.com.uk","image":"https://site-images.similarcdn.com/image?url=apple.com.uk&t=2&s=1&h=b54e430f88a4200d7b7b38c07f00609eb83a9df0fcceb05c125cd2e415602846","isVirtual":false},{"name":"apple.com.com","image":"https://site-images.similarcdn.com/image?url=apple.com.com&t=2&s=1&h=389bf0171e2906dc2aba57b4f475c7913c60a7187a6713aa1e2d3436148081ee","isVirtual":false},{"name":"apple.com.au","image":"https://site-images.similarcdn.com/image?url=apple.com.au&t=2&s=1&h=dee8004c61e2966189b036eb6a324c6594cf12d488c9aa52b6504e33eb4dae7e","isVirtual":false},{"name":"apple.com.ng","image":"https://site-images.similarcdn.com/image?url=apple.com.ng&t=2&s=1&h=633a7aeb790991f06e57e9582e64eecdfd7c7de356c5680886dfb2a7068faadc","isVirtual":false},{"name":"apple.com.br","image":"https://site-images.similarcdn.com/image?url=apple.com.br&t=2&s=1&h=e081632d063e65b68077126c4a5ac6d4568a136940c8462a681c62330dde556f","isVirtual":false}],"companies":[],"technologies":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Similarweb Search","description":"Search the Similarweb database to retrieve websites, companies, mobile apps, search keywords, and technologies associated with a given domain or keyword.\n\n**Credit cost:** 1 credit per call","operationId":"post-similarweb-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Domain name or keyword to search for in the Similarweb database.\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- **Domain search:** Use a full domain (e.g. `google.com`) to find related websites, apps, companies, and technologies associated with that domain.\n- **Keyword search:** Use a plain keyword (e.g. `amazon`) to retrieve broader associations across the Similarweb index.","schema":{"type":"string","description":"Domain name or keyword to search for in the Similarweb database.\n\n**Example:**\n\n    google.com\n\n**Notes:**\n- **Domain search:** Use a full domain (e.g. `google.com`) to find related websites, apps, companies, and technologies associated with that domain.\n- **Keyword search:** Use a plain keyword (e.g. `amazon`) to retrieve broader associations across the Similarweb index."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"apps":{"type":"object","properties":{"appStore":{"type":"array","items":{}},"googlePlay":{"type":"array","items":{}}}},"keywords":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"isVirtual":{"type":"boolean"}}}},"companies":{"type":"array","items":{}},"technologies":{"type":"array","items":{}}}},"examples":{"Search for google.com":{"value":{"apps":{"appStore":[],"googlePlay":[]},"keywords":["google","google translate","google maps","google docs","google drive","google flights","google scholar","google gemini","google map","google tradutor"],"websites":[{"name":"google.com","image":"https://site-images.similarcdn.com/image?url=google.com&t=2&s=1&h=eb35e0fbafa3eb290132ffdfe47187d950d68daaa659ec1bd4b4e834b8f16461","isVirtual":false},{"name":"google.com.br","image":"https://site-images.similarcdn.com/image?url=google.com.br&t=2&s=1&h=f504c8926f9f375805be71b441f7e0075edd929c948130d744438f373adaf17c","isVirtual":false},{"name":"google.com.hk","image":"https://site-images.similarcdn.com/image?url=google.com.hk&t=2&s=1&h=8a5f5d19c15ef49cb7f696519e8e3a0c8624c4b3837ebd6f32b707650e0d8cc2","isVirtual":false},{"name":"google.com.mx","image":"https://site-images.similarcdn.com/image?url=google.com.mx&t=2&s=1&h=83f6c37012ec87b1250e08d4526d9c4e6ab2efe753b88a00221ad7f0b61937af","isVirtual":false},{"name":"google.com.tw","image":"https://site-images.similarcdn.com/image?url=google.com.tw&t=2&s=1&h=3233beffce0879e0ba5d45edbb1944a58b7a83662388554b3e7e2c2c8b55676a","isVirtual":false},{"name":"google.com.vn","image":"https://site-images.similarcdn.com/image?url=google.com.vn&t=2&s=1&h=98b085fee62d7c3114230d1e68facb8838af2e6d7cb538900fa8e8a315b9eb35","isVirtual":false},{"name":"google.com.au","image":"https://site-images.similarcdn.com/image?url=google.com.au&t=2&s=1&h=75e1999f2c7d28d56cad490b012b1ec4a120ecf8a656fc72d522258728d59cad","isVirtual":false},{"name":"google.com.tr","image":"https://site-images.similarcdn.com/image?url=google.com.tr&t=2&s=1&h=56f80540717eca7791d12ad63c8d821b0e8aad3378db7ac067f44c710829e0e5","isVirtual":false},{"name":"google.com.ar","image":"https://site-images.similarcdn.com/image?url=google.com.ar&t=2&s=1&h=a84e684d02bc6266e64492b5022004ff84c9146f836f0db9864d2adf4184b3d8","isVirtual":false},{"name":"google.com.ua","image":"https://site-images.similarcdn.com/image?url=google.com.ua&t=2&s=1&h=8835b452e239898cd81d835ee4b93695b013909af5853882c434b40f5adee3d4","isVirtual":false}],"companies":[],"technologies":[]}},"Search for amazon.com":{"value":{"apps":{"appStore":[],"googlePlay":[]},"keywords":["amazon","amazon prime","amazon prime video","amazon uk","amazon de","amazon canada","amazon india","amazon jobs","amazon stock","amazone"],"websites":[{"name":"amazon.com","image":"https://site-images.similarcdn.com/image?url=amazon.com&t=2&s=1&h=43a07f575342a8fbb74cd3ca3ebf33760f2fbfbff603546fb4f7208244147dcc","isVirtual":false},{"name":"amazon.com.br","image":"https://site-images.similarcdn.com/image?url=amazon.com.br&t=2&s=1&h=ffbbda96260c8a0db9be9d4d4f04e76e327ebf480e86e0c625b3f4538a9bae4c","isVirtual":false},{"name":"amazon.com.mx","image":"https://site-images.similarcdn.com/image?url=amazon.com.mx&t=2&s=1&h=4ec42ab5be5ff4e02bfbc9dfc91f0355aac94c47a2d2953f79ffeaa584ac80a0","isVirtual":false},{"name":"amazon.com.au","image":"https://site-images.similarcdn.com/image?url=amazon.com.au&t=2&s=1&h=0433f91f2de5720b6422f8bbd688498ad8bb572c15bfb89f3808b8ac6b9b3818","isVirtual":false},{"name":"amazon.com.tr","image":"https://site-images.similarcdn.com/image?url=amazon.com.tr&t=2&s=1&h=407a09187beabb8042f30715b56fa452a8c1e048beb58e67cd841f04b4b4575d","isVirtual":false},{"name":"amazon.com.be","image":"https://site-images.similarcdn.com/image?url=amazon.com.be&t=2&s=1&h=27c3b82b3543ad384a97c08dc9098297fa8c92a13dff8f970ae00579697c5dcf","isVirtual":false},{"name":"amazon.com.in","image":"https://site-images.similarcdn.com/image?url=amazon.com.in&t=2&s=1&h=c00e149ede72e7a286ad6d01f00ae2fe15b5f486fcddd9a53008bc6d4434d864","isVirtual":false},{"name":"amazon.com.sg","image":"https://site-images.similarcdn.com/image?url=amazon.com.sg&t=2&s=1&h=37e0466bf2c6f7c40f1ffd478aad0a7d3ee306a828ad4636e8dae662556d60e8","isVirtual":false},{"name":"amazon.com.tw","image":"https://site-images.similarcdn.com/image?url=amazon.com.tw&t=2&s=1&h=31d41b49fc05eb05a1a8b6a14c99efee596f405390169a055fb0f2e392ee3e7a","isVirtual":false},{"name":"amazon.com.jp","image":"https://site-images.similarcdn.com/image?url=amazon.com.jp&t=2&s=1&h=655a9e7aba4af27277f4ec56d7e6b054960d5c38ec400aa10aeb697be93183ce","isVirtual":false}],"companies":[{"name":"Amazon.com, Inc.","domain":"amazon.com","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.in","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.co.jp","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.de","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.co.uk","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.it","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.com.br","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.ca","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.fr","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"},{"name":"Amazon.com, Inc.","domain":"amazon.es","logoUrl":"https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/1b45ef2ee6d94a124859c7819de99e6c10a2529fdcdc9bed0344eb8e17468ae6.jpg"}],"technologies":[]}},"Search for apple.com":{"value":{"apps":{"appStore":[],"googlePlay":[]},"keywords":["apple","apple tv","apple watch","apple music","apple store","apple stock","apple macbook neo","apple id","appletv","apple neo"],"websites":[{"name":"apple.com","image":"https://site-images.similarcdn.com/image?url=apple.com&t=2&s=1&h=f81bb484ae2fd14ee7d230f4992fcf6f0e071e846a94e3f49400616e3f9c5063","isVirtual":false},{"name":"apple.com.cn","image":"https://site-images.similarcdn.com/image?url=apple.com.cn&t=2&s=1&h=5d6a86bc69ab6e20c0b6da8d8686f00e3d53fd1467cd86603481894775730cd9","isVirtual":false},{"name":"apple.com.in","image":"https://site-images.similarcdn.com/image?url=apple.com.in&t=2&s=1&h=e848e90f18b6655c6ff9efeb1599c3650cbe6c440d28aff56659f1cc6d5f0d5b","isVirtual":false},{"name":"apple.com.tr","image":"https://site-images.similarcdn.com/image?url=apple.com.tr&t=2&s=1&h=58ad83dd930d1eee89d230d544c971106292dfbf8d899846f0f2513e860cad2f","isVirtual":false},{"name":"apple.com.id","image":"https://site-images.similarcdn.com/image?url=apple.com.id&t=2&s=1&h=a74051e6db2ec5ccd4a92530aa0fcd32972e5a349ac7b1516e3200e65dae46b7","isVirtual":false},{"name":"apple.com.uk","image":"https://site-images.similarcdn.com/image?url=apple.com.uk&t=2&s=1&h=b54e430f88a4200d7b7b38c07f00609eb83a9df0fcceb05c125cd2e415602846","isVirtual":false},{"name":"apple.com.com","image":"https://site-images.similarcdn.com/image?url=apple.com.com&t=2&s=1&h=389bf0171e2906dc2aba57b4f475c7913c60a7187a6713aa1e2d3436148081ee","isVirtual":false},{"name":"apple.com.au","image":"https://site-images.similarcdn.com/image?url=apple.com.au&t=2&s=1&h=dee8004c61e2966189b036eb6a324c6594cf12d488c9aa52b6504e33eb4dae7e","isVirtual":false},{"name":"apple.com.ng","image":"https://site-images.similarcdn.com/image?url=apple.com.ng&t=2&s=1&h=633a7aeb790991f06e57e9582e64eecdfd7c7de356c5680886dfb2a7068faadc","isVirtual":false},{"name":"apple.com.br","image":"https://site-images.similarcdn.com/image?url=apple.com.br&t=2&s=1&h=e081632d063e65b68077126c4a5ac6d4568a136940c8462a681c62330dde556f","isVirtual":false}],"companies":[],"technologies":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/linkedin-industries":{"get":{"summary":"LinkedIn Industries Finder","description":"Search LinkedIn industry taxonomy to retrieve industry IDs and hierarchies for use in LinkedIn API calls and data enrichment.","operationId":"get-finder-linkedin-industries","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Restricts your search to industries that contain the supplied string.\n\n**Example:**\n\n    software development","schema":{"type":"string","description":"Restricts your search to industries that contain the supplied string.\n\n**Example:**\n\n    software development"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"level":{"type":"string"},"hierarchie":{"type":"string"},"description":{"type":"string"},"industry_id":{"type":"string"}}}},"examples":{"Search by query 'software development'":{"value":[{"id":356,"label":"Software Development","level":"3","hierarchie":"Retail > Professional Services > Services for Renewable Energy > Technology, Information and Media > Technology, Information and Internet > Software Development","description":"This industry includes entities that publish computer software and carry out operations necessary for production and distribution, such as design, documentation, installation, and support services. They may design, develop, and publish, or publish only; they may publish and distribute remotely through subscriptions and downloads.","industry_id":"4"},{"id":107,"label":"Embedded Software Products","level":"4","hierarchie":"Education > Utilities > Electric Power Transmission, Control, and Distribution > Consumer Services > Repair and Maintenance > Electronic and Precision Equipment Maintenance > Technology, Information and Media > Technology, Information and Internet > Software Development > Embedded Software Products","description":"This industry includes entities that produce software (or \"firmware\") for machines or devices that are not usually thought of as computers, ex: routers, refrigerators, display systems, washing machines, etc. such as, software for the internet of things but do not produce these devices.","industry_id":"3099"},{"id":91,"label":"Data Security Software Products","level":"4","hierarchie":"Consumer Services > Financial Services > Credit Intermediation > Technology, Information and Media > Technology, Information and Internet > Data Infrastructure and Analytics > Technology, Information and Media > Technology, Information and Internet > Software Development > Data Security Software Products","description":"This industry includes entities that produce software to ensure security of data and computing systems.","industry_id":"3130"},{"id":95,"label":"Desktop Computing Software Products","level":"4","hierarchie":"Consumer Services > Professional Services > Design Services > Hospitals and Health Care > Medical Practices > Dentists > Technology, Information and Media > Technology, Information and Internet > Software Development > Desktop Computing Software Products","description":"This industry includes entities that produce software which runs on desktop or laptop computers.","industry_id":"3101"},{"id":189,"label":"IT System Custom Software Development","level":"3","hierarchie":"Hospitals and Health Care > Professional Services > IT Services and IT Consulting > Professional Services > IT Services and IT Consulting > IT System Custom Software Development","description":"This industry includes entities that focus on creating, modifying, testing, and supporting software to meet the needs of a particular customer.","industry_id":"3102"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Industries Finder","description":"Search LinkedIn industry taxonomy to retrieve industry IDs and hierarchies for use in LinkedIn API calls and data enrichment.","operationId":"post-finder-linkedin-industries","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Restricts your search to industries that contain the supplied string.\n\n**Example:**\n\n    software development","schema":{"type":"string","description":"Restricts your search to industries that contain the supplied string.\n\n**Example:**\n\n    software development"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"level":{"type":"string"},"hierarchie":{"type":"string"},"description":{"type":"string"},"industry_id":{"type":"string"}}}},"examples":{"Search by query 'software development'":{"value":[{"id":356,"label":"Software Development","level":"3","hierarchie":"Retail > Professional Services > Services for Renewable Energy > Technology, Information and Media > Technology, Information and Internet > Software Development","description":"This industry includes entities that publish computer software and carry out operations necessary for production and distribution, such as design, documentation, installation, and support services. They may design, develop, and publish, or publish only; they may publish and distribute remotely through subscriptions and downloads.","industry_id":"4"},{"id":107,"label":"Embedded Software Products","level":"4","hierarchie":"Education > Utilities > Electric Power Transmission, Control, and Distribution > Consumer Services > Repair and Maintenance > Electronic and Precision Equipment Maintenance > Technology, Information and Media > Technology, Information and Internet > Software Development > Embedded Software Products","description":"This industry includes entities that produce software (or \"firmware\") for machines or devices that are not usually thought of as computers, ex: routers, refrigerators, display systems, washing machines, etc. such as, software for the internet of things but do not produce these devices.","industry_id":"3099"},{"id":91,"label":"Data Security Software Products","level":"4","hierarchie":"Consumer Services > Financial Services > Credit Intermediation > Technology, Information and Media > Technology, Information and Internet > Data Infrastructure and Analytics > Technology, Information and Media > Technology, Information and Internet > Software Development > Data Security Software Products","description":"This industry includes entities that produce software to ensure security of data and computing systems.","industry_id":"3130"},{"id":95,"label":"Desktop Computing Software Products","level":"4","hierarchie":"Consumer Services > Professional Services > Design Services > Hospitals and Health Care > Medical Practices > Dentists > Technology, Information and Media > Technology, Information and Internet > Software Development > Desktop Computing Software Products","description":"This industry includes entities that produce software which runs on desktop or laptop computers.","industry_id":"3101"},{"id":189,"label":"IT System Custom Software Development","level":"3","hierarchie":"Hospitals and Health Care > Professional Services > IT Services and IT Consulting > Professional Services > IT Services and IT Consulting > IT System Custom Software Development","description":"This industry includes entities that focus on creating, modifying, testing, and supporting software to meet the needs of a particular customer.","industry_id":"3102"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/google-locations":{"get":{"summary":"Google Locations Finder","description":"Search Google-supported locations by name to retrieve location IDs and GPS coordinates for geo-targeted search API calls.","operationId":"get-finder-google-locations","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Restricts your search to locations that contain the supplied string.\n\n**Example:**\n\n    Paris\n\n**Note:** Searching 'Austin' will find 'Austin, TX', 'The University of Texas at Austin', 'Rochester, MN-Mason City, IA-Austin, MN, United States', etc.","schema":{"type":"string","description":"Restricts your search to locations that contain the supplied string.\n\n**Example:**\n\n    Paris\n\n**Note:** Searching 'Austin' will find 'Austin, TX', 'The University of Texas at Austin', 'Rochester, MN-Mason City, IA-Austin, MN, United States', etc."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"gps":{"type":"array","items":{"type":"number"}},"name":{"type":"string"},"reach":{"type":"integer"},"google_id":{"type":"integer"},"target_type":{"type":"string"},"country_code":{"type":"string"},"canonical_name":{"type":"string"},"google_parent_id":{"type":"integer"}}}},"examples":{"Search by location 'Austin'":{"value":[{"id":"585069a2ee19ad271e9b5052","gps":[-98.936927,49.951529],"name":"Austin","reach":0,"google_id":1001982,"target_type":"City","country_code":"CA","canonical_name":"Austin,Manitoba,Canada","google_parent_id":20115}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Locations Finder","description":"Search Google-supported locations by name to retrieve location IDs and GPS coordinates for geo-targeted search API calls.","operationId":"post-finder-google-locations","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Restricts your search to locations that contain the supplied string.\n\n**Example:**\n\n    Paris\n\n**Note:** Searching 'Austin' will find 'Austin, TX', 'The University of Texas at Austin', 'Rochester, MN-Mason City, IA-Austin, MN, United States', etc.","schema":{"type":"string","description":"Restricts your search to locations that contain the supplied string.\n\n**Example:**\n\n    Paris\n\n**Note:** Searching 'Austin' will find 'Austin, TX', 'The University of Texas at Austin', 'Rochester, MN-Mason City, IA-Austin, MN, United States', etc."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"gps":{"type":"array","items":{"type":"number"}},"name":{"type":"string"},"reach":{"type":"integer"},"google_id":{"type":"integer"},"target_type":{"type":"string"},"country_code":{"type":"string"},"canonical_name":{"type":"string"},"google_parent_id":{"type":"integer"}}}},"examples":{"Search by location 'Austin'":{"value":[{"id":"585069a2ee19ad271e9b5052","gps":[-98.936927,49.951529],"name":"Austin","reach":0,"google_id":1001982,"target_type":"City","country_code":"CA","canonical_name":"Austin,Manitoba,Canada","google_parent_id":20115}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/google-languages":{"get":{"summary":"Google Languages Finder","description":"Search the list of Google-supported languages by name to retrieve language codes for use in Google Search API requests.","operationId":"get-finder-google-languages","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters languages based on a search string. The search is **non-case-sensitive** and returns all languages whose names contain the specified string.\n\n**Example:**\n\n    french","schema":{"type":"string","description":"Filters languages based on a search string. The search is **non-case-sensitive** and returns all languages whose names contain the specified string.\n\n**Example:**\n\n    french"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string"},"language_name":{"type":"string"}}}},"examples":{"Search by query 'french'":{"value":[{"language_code":"fr","language_name":"French"},{"language_code":"fy","language_name":"Frisian"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Languages Finder","description":"Search the list of Google-supported languages by name to retrieve language codes for use in Google Search API requests.","operationId":"post-finder-google-languages","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters languages based on a search string. The search is **non-case-sensitive** and returns all languages whose names contain the specified string.\n\n**Example:**\n\n    french","schema":{"type":"string","description":"Filters languages based on a search string. The search is **non-case-sensitive** and returns all languages whose names contain the specified string.\n\n**Example:**\n\n    french"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string"},"language_name":{"type":"string"}}}},"examples":{"Search by query 'french'":{"value":[{"language_code":"fr","language_name":"French"},{"language_code":"fy","language_name":"Frisian"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/google-countries":{"get":{"summary":"Google Countries Finder","description":"Search the list of Google-supported countries by name or country code to use in Google Search API requests.","operationId":"get-finder-google-countries","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters countries based on a search string. The search is **non-case-sensitive** and returns all countries whose names contain the specified string.\n\n**Example:**\n\n    fr","schema":{"type":"string","description":"Filters countries based on a search string. The search is **non-case-sensitive** and returns all countries whose names contain the specified string.\n\n**Example:**\n\n    fr"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"country_code":{"type":"string"},"country_name":{"type":"string"}}}},"examples":{"Search by query 'fr'":{"value":[{"country_code":"fr","country_name":"France"},{"country_code":"gf","country_name":"French Guiana"},{"country_code":"pf","country_name":"French Polynesia"},{"country_code":"tf","country_name":"French Southern Territories"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Countries Finder","description":"Search the list of Google-supported countries by name or country code to use in Google Search API requests.","operationId":"post-finder-google-countries","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters countries based on a search string. The search is **non-case-sensitive** and returns all countries whose names contain the specified string.\n\n**Example:**\n\n    fr","schema":{"type":"string","description":"Filters countries based on a search string. The search is **non-case-sensitive** and returns all countries whose names contain the specified string.\n\n**Example:**\n\n    fr"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"country_code":{"type":"string"},"country_name":{"type":"string"}}}},"examples":{"Search by query 'fr'":{"value":[{"country_code":"fr","country_name":"France"},{"country_code":"gf","country_name":"French Guiana"},{"country_code":"pf","country_name":"French Polynesia"},{"country_code":"tf","country_name":"French Southern Territories"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/finder/eleclerc-stores":{"get":{"summary":"Eleclerc Stores Finder","description":"Search Eleclerc stores by name or city to retrieve contact details, opening hours, and geolocation.","operationId":"get-finder-eleclerc-stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters stores based on a search string. The search is **non-case-sensitive** and returns all stores whose names contain the specified string.\n\n**Example:**\n\n    paris","schema":{"type":"string","description":"Filters stores based on a search string. The search is **non-case-sensitive** and returns all stores whose names contain the specified string.\n\n**Example:**\n\n    paris"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"lines":{"type":"array","items":{"type":"string"}},"zipcode":{"type":"string"},"country_code":{"nullable":true}}},"contact":{"type":"object","properties":{"email":{"nullable":true},"phone":{"type":"string"}}},"geometry":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"store_id":{"type":"string"},"opening_hours":{"type":"object","properties":{"usual":{"type":"object","properties":{"1":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"2":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"3":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"4":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"5":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"6":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"7":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}}}},"timezone":{"type":"string"}}},"weekly_opening":{"type":"object","properties":{"1":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"2":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"3":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"4":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"5":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"6":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"7":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"timezone":{"type":"string"}}}}}},"examples":{"Search by city 'paris'":{"value":[{"id":"1893t128t1","name":"PARIS PICPUS","address":{"city":"PARIS","lines":["67 rue de Picpus"],"zipcode":"75012","country_code":null},"contact":{"email":null,"phone":"01 87 46 07 00"},"geometry":{"type":"Point","coordinates":[2.3950581,48.8454278]},"store_id":"1893","opening_hours":{"usual":{"1":[{"end":"21:30","start":"07:30"}],"2":[{"end":"21:30","start":"07:30"}],"3":[{"end":"21:30","start":"07:30"}],"4":[{"end":"21:30","start":"07:30"}],"5":[{"end":"21:30","start":"07:30"}],"6":[{"end":"21:30","start":"07:30"}],"7":[{"end":"13:00","start":"08:30"}]},"timezone":"Europe/Paris"},"weekly_opening":{"1":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"2":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"3":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"4":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"5":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"6":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"7":{"hours":[{"end":"13:00","start":"08:30"}],"isSpecial":false},"timezone":"Europe/Paris"}}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Eleclerc Stores Finder","description":"Search Eleclerc stores by name or city to retrieve contact details, opening hours, and geolocation.","operationId":"post-finder-eleclerc-stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Filters stores based on a search string. The search is **non-case-sensitive** and returns all stores whose names contain the specified string.\n\n**Example:**\n\n    paris","schema":{"type":"string","description":"Filters stores based on a search string. The search is **non-case-sensitive** and returns all stores whose names contain the specified string.\n\n**Example:**\n\n    paris"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"lines":{"type":"array","items":{"type":"string"}},"zipcode":{"type":"string"},"country_code":{"nullable":true}}},"contact":{"type":"object","properties":{"email":{"nullable":true},"phone":{"type":"string"}}},"geometry":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"store_id":{"type":"string"},"opening_hours":{"type":"object","properties":{"usual":{"type":"object","properties":{"1":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"2":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"3":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"4":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"5":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"6":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"7":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}}}},"timezone":{"type":"string"}}},"weekly_opening":{"type":"object","properties":{"1":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"2":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"3":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"4":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"5":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"6":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"7":{"type":"object","properties":{"hours":{"type":"array","items":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}}},"isSpecial":{"type":"boolean"}}},"timezone":{"type":"string"}}}}}},"examples":{"Search by city 'paris'":{"value":[{"id":"1893t128t1","name":"PARIS PICPUS","address":{"city":"PARIS","lines":["67 rue de Picpus"],"zipcode":"75012","country_code":null},"contact":{"email":null,"phone":"01 87 46 07 00"},"geometry":{"type":"Point","coordinates":[2.3950581,48.8454278]},"store_id":"1893","opening_hours":{"usual":{"1":[{"end":"21:30","start":"07:30"}],"2":[{"end":"21:30","start":"07:30"}],"3":[{"end":"21:30","start":"07:30"}],"4":[{"end":"21:30","start":"07:30"}],"5":[{"end":"21:30","start":"07:30"}],"6":[{"end":"21:30","start":"07:30"}],"7":[{"end":"13:00","start":"08:30"}]},"timezone":"Europe/Paris"},"weekly_opening":{"1":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"2":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"3":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"4":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"5":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"6":{"hours":[{"end":"21:30","start":"07:30"}],"isSpecial":false},"7":{"hours":[{"end":"13:00","start":"08:30"}],"isSpecial":false},"timezone":"Europe/Paris"}}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/company":{"get":{"summary":"Company Database","description":"Retrieve comprehensive company data including financials, technologies, social profiles, and location by domain name.\n\n**Credit cost:** 1 credit per call","operationId":"get-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The domain name of the company to look up. Accepts multiple formats:\n\n- `gucci.com`: bare domain name\n- `https://gucci.com`: full URL format\n- `www.gucci.com`: www-prefixed domain\n\n**Note:** Using a unique domain name ensures accuracy and avoids ambiguity that may arise from common company names or spelling variations.\n\n**Example:**\n\n    gucci.com","schema":{"type":"string","description":"The domain name of the company to look up. Accepts multiple formats:\n\n- `gucci.com`: bare domain name\n- `https://gucci.com`: full URL format\n- `www.gucci.com`: www-prefixed domain\n\n**Note:** Using a unique domain name ensures accuracy and avoids ambiguity that may arise from common company names or spelling variations.\n\n**Example:**\n\n    gucci.com"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"},"founded":{"type":"integer"},"revenue":{"type":"string"},"location":{"type":"object","properties":{"lat":{"type":"string"},"lng":{"type":"string"},"city":{"type":"string"},"address":{"nullable":true},"country":{"type":"string"},"postcode":{"type":"string"},"country_code":{"type":"string"}}},"domain_tld":{"type":"string"},"industries":{"type":"array","items":{"type":"string"}},"updated_at":{"nullable":true},"description":{"type":"string"},"domain_name":{"type":"string"},"staff_range":{"type":"string"},"phone_number":{"type":"string"},"technologies":{"type":"array","items":{"type":"string"}},"business_type":{"nullable":true},"social_networks":{"type":"object","properties":{"twitter":{"type":"string"},"youtube":{"type":"string"},"facebook":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"pinterest":{"type":"string"},"twitter_id":{"type":"string"},"youtube_id":{"type":"string"},"facebook_id":{"type":"string"},"instagram_id":{"type":"string"},"pinterest_id":{"type":"string"},"linkedin_id_alpha":{"type":"string"},"linkedin_id_numeric":{"type":"integer"},"linkedin_sales_navigator":{"type":"string"}}},"monthly_visitors":{"type":"string"},"technology_categories":{"type":"array","items":{"type":"string"}}}},"examples":{"Lookup gucci.com":{"value":{"name":"Gucci","domain":"gucci.com","founded":1921,"revenue":"over-1b","location":{"lat":"43.7567104","lng":"11.1847619","city":"Scandicci","address":null,"country":"Italy","postcode":"50018","country_code":"IT"},"domain_tld":"com","industries":["fashion","jewelry","leather-goods","leisure","luxury-goods","luxury-goods-and-jewelry","mens-clothing","shopping","womens-clothing"],"updated_at":null,"description":"Influential, innovative and progressive, Gucci is reinventing a wholly modern approach to fashion. Under the new vision of creative director Alessandro Michele, the House has redefined luxury for the 21st century, further reinforcing its position as one of the world's most desirable fashion houses. Eclectic, contemporary, romantic-Gucci products represent the pinnacle of Italian craftsmanship and are unsurpassed for their quality and attention to detail. Gucci is part of the Kering Group, a world leader in apparel and accessories that owns a portfolio of powerful luxury and sport and lifestyle brands. For further information about Gucci, visit www.gucci.com","domain_name":"gucci","staff_range":"over-10k","phone_number":"+39 055 759221","technologies":["akamai","amazon-cloudfront","amazon-s3","apache","facebook-social-plugins","google-analytics","google-cloud","google-tag-manager","java","nginx","riskified","sap-commerce-cloud"],"business_type":null,"social_networks":{"twitter":"http://twitter.com/gucci","youtube":"https://youtube.com/user/gucciofficial","facebook":"http://www.facebook.com/gucci","linkedin":"https://www.linkedin.com/company/6585","instagram":"https://instagram.com/gucci","pinterest":"https://pinterest.com/gucci","twitter_id":"gucci","youtube_id":"gucciofficial","facebook_id":"gucci","instagram_id":"gucci","pinterest_id":"gucci","linkedin_id_alpha":"gucci","linkedin_id_numeric":6585,"linkedin_sales_navigator":"https://www.linkedin.com/sales/company/6585"},"monthly_visitors":"100m-500m","technology_categories":["accounting-and-finance","application-development","application-server","archive-storage","block-storage","cloud-file-storage","cloud-platform-as-a-service","commerce","container-management","content-delivery-network","digital-analytics","e-commerce","e-commerce-fraud-protection","e-commerce-platforms","enterprise-content-delivery-network","erp","hosting","marketing","security","tag-management","web-accelerator","web-security"]}},"Lookup stripe.com":{"value":{"name":"Stripe","domain":"stripe.com","founded":2010,"revenue":"100m-200m","location":{"lat":"37.7790262","lng":"-122.419906","city":"San Francisco","address":"510 townsend street","country":"United States","postcode":null,"country_code":"US"},"domain_tld":"com","industries":["cloud-infrastructure","computer-software","consumer-goods","credit-cards","developer-apis","developer-tools","enterprise-software","finance","information-technology","internet","payments","saas","software"],"updated_at":null,"description":"Stripe is a set of tools for building and running an internet business. We help businesses accept payments from anyone, anywhere, and build new kinds of companies like Lyft or Kickstarter. Internally, we say our goal is to increase the GDP of the internet---we want to bring more businesses online worldwide.","domain_name":"stripe","staff_range":"5k-10k","phone_number":"(650) 427-9276","technologies":["amazon-cloudfront","amazon-ecs","amazon-s3","apache","cloudflare-cdn","envoy-proxy","facebook-social-plugins","google-analytics","google-tag-manager","microsoft-azure-cdn","nginx","sentry","stripe"],"business_type":null,"social_networks":{"twitter":"http://twitter.com/stripe","facebook":"https://www.facebook.com/stripehq","linkedin":"https://www.linkedin.com/company/2135371","angellist":"http://angel.co/stripe","twitter_id":"stripe","facebook_id":"stripehq","angellist_id":"stripe","linkedin_id_alpha":"stripe","linkedin_id_numeric":2135371,"linkedin_sales_navigator":"https://www.linkedin.com/sales/company/2135371"},"monthly_visitors":"100m-500m","technology_categories":["application-development","application-performance-monitoring","application-server","archive-storage","bug-tracking","cloud-security","commerce","content-delivery-network","digital-analytics","financial-data-apis","financial-services","hosting","load-balancing","marketing","monitoring","payment","payment-gateways","security","tag-management","web-security"]}},"Lookup pennylane.com":{"value":{"name":"Pennylane","domain":"pennylane.com","founded":null,"revenue":null,"location":{"lat":null,"lng":null,"city":null,"address":null,"country":null,"postcode":null,"country_code":null},"domain_tld":"com","industries":[],"updated_at":null,"description":"Pennylane est la plateforme tout-en-un de gestion financière et comptabilité des dirigeants d'entreprise et de leurs experts-comptables","domain_name":"pennylane","staff_range":null,"phone_number":null,"technologies":["amazon-cloudfront","amazon-s3","contentful","cowboy","erlang","google-analytics","google-tag-manager","google-workspace","ruby","ruby-on-rails"],"business_type":null,"social_networks":{"twitter":"https://twitter.com/pennylane_tech","facebook":"https://facebook.com/pennylane.com","linkedin":"https://linkedin.com/company/pennylaneaccounting","instagram":"https://instagram.com/pennylane_accounting","twitter_id":"pennylane_tech","facebook_id":"pennylane.com","instagram_id":"pennylane_accounting","linkedin_id_alpha":"pennylaneaccounting","linkedin_id_numeric":null},"monthly_visitors":"under-10k","technology_categories":["application-development","application-server","cloud-content-collaboration","content-delivery-network","content-management","digital-analytics","headless-cms","hosting","marketing","mobile-development","object-storage","programming-languages","tag-management","web-frameworks"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Company Database","description":"Retrieve comprehensive company data including financials, technologies, social profiles, and location by domain name.\n\n**Credit cost:** 1 credit per call","operationId":"post-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The domain name of the company to look up. Accepts multiple formats:\n\n- `gucci.com`: bare domain name\n- `https://gucci.com`: full URL format\n- `www.gucci.com`: www-prefixed domain\n\n**Note:** Using a unique domain name ensures accuracy and avoids ambiguity that may arise from common company names or spelling variations.\n\n**Example:**\n\n    gucci.com","schema":{"type":"string","description":"The domain name of the company to look up. Accepts multiple formats:\n\n- `gucci.com`: bare domain name\n- `https://gucci.com`: full URL format\n- `www.gucci.com`: www-prefixed domain\n\n**Note:** Using a unique domain name ensures accuracy and avoids ambiguity that may arise from common company names or spelling variations.\n\n**Example:**\n\n    gucci.com"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"},"founded":{"type":"integer"},"revenue":{"type":"string"},"location":{"type":"object","properties":{"lat":{"type":"string"},"lng":{"type":"string"},"city":{"type":"string"},"address":{"nullable":true},"country":{"type":"string"},"postcode":{"type":"string"},"country_code":{"type":"string"}}},"domain_tld":{"type":"string"},"industries":{"type":"array","items":{"type":"string"}},"updated_at":{"nullable":true},"description":{"type":"string"},"domain_name":{"type":"string"},"staff_range":{"type":"string"},"phone_number":{"type":"string"},"technologies":{"type":"array","items":{"type":"string"}},"business_type":{"nullable":true},"social_networks":{"type":"object","properties":{"twitter":{"type":"string"},"youtube":{"type":"string"},"facebook":{"type":"string"},"linkedin":{"type":"string"},"instagram":{"type":"string"},"pinterest":{"type":"string"},"twitter_id":{"type":"string"},"youtube_id":{"type":"string"},"facebook_id":{"type":"string"},"instagram_id":{"type":"string"},"pinterest_id":{"type":"string"},"linkedin_id_alpha":{"type":"string"},"linkedin_id_numeric":{"type":"integer"},"linkedin_sales_navigator":{"type":"string"}}},"monthly_visitors":{"type":"string"},"technology_categories":{"type":"array","items":{"type":"string"}}}},"examples":{"Lookup gucci.com":{"value":{"name":"Gucci","domain":"gucci.com","founded":1921,"revenue":"over-1b","location":{"lat":"43.7567104","lng":"11.1847619","city":"Scandicci","address":null,"country":"Italy","postcode":"50018","country_code":"IT"},"domain_tld":"com","industries":["fashion","jewelry","leather-goods","leisure","luxury-goods","luxury-goods-and-jewelry","mens-clothing","shopping","womens-clothing"],"updated_at":null,"description":"Influential, innovative and progressive, Gucci is reinventing a wholly modern approach to fashion. Under the new vision of creative director Alessandro Michele, the House has redefined luxury for the 21st century, further reinforcing its position as one of the world's most desirable fashion houses. Eclectic, contemporary, romantic-Gucci products represent the pinnacle of Italian craftsmanship and are unsurpassed for their quality and attention to detail. Gucci is part of the Kering Group, a world leader in apparel and accessories that owns a portfolio of powerful luxury and sport and lifestyle brands. For further information about Gucci, visit www.gucci.com","domain_name":"gucci","staff_range":"over-10k","phone_number":"+39 055 759221","technologies":["akamai","amazon-cloudfront","amazon-s3","apache","facebook-social-plugins","google-analytics","google-cloud","google-tag-manager","java","nginx","riskified","sap-commerce-cloud"],"business_type":null,"social_networks":{"twitter":"http://twitter.com/gucci","youtube":"https://youtube.com/user/gucciofficial","facebook":"http://www.facebook.com/gucci","linkedin":"https://www.linkedin.com/company/6585","instagram":"https://instagram.com/gucci","pinterest":"https://pinterest.com/gucci","twitter_id":"gucci","youtube_id":"gucciofficial","facebook_id":"gucci","instagram_id":"gucci","pinterest_id":"gucci","linkedin_id_alpha":"gucci","linkedin_id_numeric":6585,"linkedin_sales_navigator":"https://www.linkedin.com/sales/company/6585"},"monthly_visitors":"100m-500m","technology_categories":["accounting-and-finance","application-development","application-server","archive-storage","block-storage","cloud-file-storage","cloud-platform-as-a-service","commerce","container-management","content-delivery-network","digital-analytics","e-commerce","e-commerce-fraud-protection","e-commerce-platforms","enterprise-content-delivery-network","erp","hosting","marketing","security","tag-management","web-accelerator","web-security"]}},"Lookup stripe.com":{"value":{"name":"Stripe","domain":"stripe.com","founded":2010,"revenue":"100m-200m","location":{"lat":"37.7790262","lng":"-122.419906","city":"San Francisco","address":"510 townsend street","country":"United States","postcode":null,"country_code":"US"},"domain_tld":"com","industries":["cloud-infrastructure","computer-software","consumer-goods","credit-cards","developer-apis","developer-tools","enterprise-software","finance","information-technology","internet","payments","saas","software"],"updated_at":null,"description":"Stripe is a set of tools for building and running an internet business. We help businesses accept payments from anyone, anywhere, and build new kinds of companies like Lyft or Kickstarter. Internally, we say our goal is to increase the GDP of the internet---we want to bring more businesses online worldwide.","domain_name":"stripe","staff_range":"5k-10k","phone_number":"(650) 427-9276","technologies":["amazon-cloudfront","amazon-ecs","amazon-s3","apache","cloudflare-cdn","envoy-proxy","facebook-social-plugins","google-analytics","google-tag-manager","microsoft-azure-cdn","nginx","sentry","stripe"],"business_type":null,"social_networks":{"twitter":"http://twitter.com/stripe","facebook":"https://www.facebook.com/stripehq","linkedin":"https://www.linkedin.com/company/2135371","angellist":"http://angel.co/stripe","twitter_id":"stripe","facebook_id":"stripehq","angellist_id":"stripe","linkedin_id_alpha":"stripe","linkedin_id_numeric":2135371,"linkedin_sales_navigator":"https://www.linkedin.com/sales/company/2135371"},"monthly_visitors":"100m-500m","technology_categories":["application-development","application-performance-monitoring","application-server","archive-storage","bug-tracking","cloud-security","commerce","content-delivery-network","digital-analytics","financial-data-apis","financial-services","hosting","load-balancing","marketing","monitoring","payment","payment-gateways","security","tag-management","web-security"]}},"Lookup pennylane.com":{"value":{"name":"Pennylane","domain":"pennylane.com","founded":null,"revenue":null,"location":{"lat":null,"lng":null,"city":null,"address":null,"country":null,"postcode":null,"country_code":null},"domain_tld":"com","industries":[],"updated_at":null,"description":"Pennylane est la plateforme tout-en-un de gestion financière et comptabilité des dirigeants d'entreprise et de leurs experts-comptables","domain_name":"pennylane","staff_range":null,"phone_number":null,"technologies":["amazon-cloudfront","amazon-s3","contentful","cowboy","erlang","google-analytics","google-tag-manager","google-workspace","ruby","ruby-on-rails"],"business_type":null,"social_networks":{"twitter":"https://twitter.com/pennylane_tech","facebook":"https://facebook.com/pennylane.com","linkedin":"https://linkedin.com/company/pennylaneaccounting","instagram":"https://instagram.com/pennylane_accounting","twitter_id":"pennylane_tech","facebook_id":"pennylane.com","instagram_id":"pennylane_accounting","linkedin_id_alpha":"pennylaneaccounting","linkedin_id_numeric":null},"monthly_visitors":"under-10k","technology_categories":["application-development","application-server","cloud-content-collaboration","content-delivery-network","content-management","digital-analytics","headless-cms","hosting","marketing","mobile-development","object-storage","programming-languages","tag-management","web-frameworks"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autodoc/product/related":{"get":{"summary":"Autodoc Product Related","description":"Vehicle fitment lines per maker for an Autodoc product. All parameters from Product `fetch.params` are required.\n\n**Credit cost:** 2 credits per call","operationId":"get-autodoc-product-related","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Same HTTPS product page URL as Product.\n\n**Example:** `https://www.auto-doc.fr/ridex/7999541`","schema":{"type":"string","description":"Same HTTPS product page URL as Product.\n\n**Example:** `https://www.auto-doc.fr/ridex/7999541`"}},{"name":"maker_id","in":"query","required":true,"description":"TecDoc maker id from `compatibility.cars[]` / `compatibility.trucks[]`, e.g. `93` for RENAULT.","schema":{"type":"number","description":"TecDoc maker id from `compatibility.cars[]` / `compatibility.trucks[]`, e.g. `93` for RENAULT."}},{"name":"vehicle_type","in":"query","required":true,"description":"Required. `pkw` (passenger cars) or `lkw` (commercial). Must match the compatibility row.","schema":{"type":"string","default":"pkw","description":"Required. `pkw` (passenger cars) or `lkw` (commercial). Must match the compatibility row."}},{"name":"maker_name","in":"query","required":true,"description":"Required maker label from compatibility, e.g. `RENAULT`. Used to parse vehicle lines.","schema":{"type":"string","description":"Required maker label from compatibility, e.g. `RENAULT`. Used to parse vehicle lines."}},{"name":"product_id","in":"query","required":true,"description":"Required article id from Product response or URL path, e.g. `7999541`.","schema":{"type":"number","description":"Required article id from Product response or URL path, e.g. `7999541`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"models":{"type":"array","items":{"type":"string"}},"maker_id":{"type":"integer"},"vehicles":{"type":"array","items":{"type":"object","properties":{"raw":{"type":"string"},"brand":{"type":"string"},"model":{"type":"string"},"end_date":{"type":"string"},"model_id":{"type":"integer"},"start_date":{"type":"string"}}}},"product_id":{"type":"integer"},"product_url":{"type":"string"},"vehicle_type":{"type":"string"}}},"examples":{"RENAULT models for RIDEX 7999541 (auto-doc.fr)":{"value":{"models":["RENAULT Rapid (F40, G40) (Année de construction 07.1985 - 11.2001)","RENAULT Clio I 3/5 portes (Année de construction 05.1990 - 09.1998)","RENAULT Twingo I 3 portes (Année de construction 03.1993 - 10.2012)","RENAULT R5 3/5 portes (Année de construction 01.1972 - 12.1985)","RENAULT Super 5 3/5 portes (B40, C40) (Année de construction 10.1984 - 12.1996)","RENAULT Clio I Van (Année de construction 01.1991 - 09.1998)","RENAULT Super 5 Van (S40) (Année de construction 10.1984 - 12.1996)","RENAULT Twingo I Van (Année de construction 03.1993 - 06.2012)"],"maker_id":93,"vehicles":[{"raw":"RENAULT Rapid (F40, G40) (Année de construction 07.1985 - 11.2001)","brand":"RENAULT","model":"Rapid (F40, G40) (Année de construction 07.1985 - 11.2001)","end_date":"11.2001","model_id":17,"start_date":"07.1985"},{"raw":"RENAULT Clio I 3/5 portes (Année de construction 05.1990 - 09.1998)","brand":"RENAULT","model":"Clio I 3/5 portes (Année de construction 05.1990 - 09.1998)","end_date":"09.1998","model_id":21,"start_date":"05.1990"},{"raw":"RENAULT Twingo I 3 portes (Année de construction 03.1993 - 10.2012)","brand":"RENAULT","model":"Twingo I 3 portes (Année de construction 03.1993 - 10.2012)","end_date":"10.2012","model_id":472,"start_date":"03.1993"},{"raw":"RENAULT R5 3/5 portes (Année de construction 01.1972 - 12.1985)","brand":"RENAULT","model":"R5 3/5 portes (Année de construction 01.1972 - 12.1985)","end_date":"12.1985","model_id":556,"start_date":"01.1972"},{"raw":"RENAULT Super 5 3/5 portes (B40, C40) (Année de construction 10.1984 - 12.1996)","brand":"RENAULT","model":"Super 5 3/5 portes (B40, C40) (Année de construction 10.1984 - 12.1996)","end_date":"12.1996","model_id":560,"start_date":"10.1984"},{"raw":"RENAULT Clio I Van (Année de construction 01.1991 - 09.1998)","brand":"RENAULT","model":"Clio I Van (Année de construction 01.1991 - 09.1998)","end_date":"09.1998","model_id":4218,"start_date":"01.1991"},{"raw":"RENAULT Super 5 Van (S40) (Année de construction 10.1984 - 12.1996)","brand":"RENAULT","model":"Super 5 Van (S40) (Année de construction 10.1984 - 12.1996)","end_date":"12.1996","model_id":4219,"start_date":"10.1984"},{"raw":"RENAULT Twingo I Van (Année de construction 03.1993 - 06.2012)","brand":"RENAULT","model":"Twingo I Van (Année de construction 03.1993 - 06.2012)","end_date":"06.2012","model_id":4227,"start_date":"03.1993"}],"product_id":7999541,"product_url":"https://www.auto-doc.fr/ridex/7999541","vehicle_type":"pkw"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Autodoc Product Related","description":"Vehicle fitment lines per maker for an Autodoc product. All parameters from Product `fetch.params` are required.\n\n**Credit cost:** 2 credits per call","operationId":"post-autodoc-product-related","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Same HTTPS product page URL as Product.\n\n**Example:** `https://www.auto-doc.fr/ridex/7999541`","schema":{"type":"string","description":"Same HTTPS product page URL as Product.\n\n**Example:** `https://www.auto-doc.fr/ridex/7999541`"}},{"name":"maker_id","in":"query","required":true,"description":"TecDoc maker id from `compatibility.cars[]` / `compatibility.trucks[]`, e.g. `93` for RENAULT.","schema":{"type":"number","description":"TecDoc maker id from `compatibility.cars[]` / `compatibility.trucks[]`, e.g. `93` for RENAULT."}},{"name":"vehicle_type","in":"query","required":true,"description":"Required. `pkw` (passenger cars) or `lkw` (commercial). Must match the compatibility row.","schema":{"type":"string","default":"pkw","description":"Required. `pkw` (passenger cars) or `lkw` (commercial). Must match the compatibility row."}},{"name":"maker_name","in":"query","required":true,"description":"Required maker label from compatibility, e.g. `RENAULT`. Used to parse vehicle lines.","schema":{"type":"string","description":"Required maker label from compatibility, e.g. `RENAULT`. Used to parse vehicle lines."}},{"name":"product_id","in":"query","required":true,"description":"Required article id from Product response or URL path, e.g. `7999541`.","schema":{"type":"number","description":"Required article id from Product response or URL path, e.g. `7999541`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"models":{"type":"array","items":{"type":"string"}},"maker_id":{"type":"integer"},"vehicles":{"type":"array","items":{"type":"object","properties":{"raw":{"type":"string"},"brand":{"type":"string"},"model":{"type":"string"},"end_date":{"type":"string"},"model_id":{"type":"integer"},"start_date":{"type":"string"}}}},"product_id":{"type":"integer"},"product_url":{"type":"string"},"vehicle_type":{"type":"string"}}},"examples":{"RENAULT models for RIDEX 7999541 (auto-doc.fr)":{"value":{"models":["RENAULT Rapid (F40, G40) (Année de construction 07.1985 - 11.2001)","RENAULT Clio I 3/5 portes (Année de construction 05.1990 - 09.1998)","RENAULT Twingo I 3 portes (Année de construction 03.1993 - 10.2012)","RENAULT R5 3/5 portes (Année de construction 01.1972 - 12.1985)","RENAULT Super 5 3/5 portes (B40, C40) (Année de construction 10.1984 - 12.1996)","RENAULT Clio I Van (Année de construction 01.1991 - 09.1998)","RENAULT Super 5 Van (S40) (Année de construction 10.1984 - 12.1996)","RENAULT Twingo I Van (Année de construction 03.1993 - 06.2012)"],"maker_id":93,"vehicles":[{"raw":"RENAULT Rapid (F40, G40) (Année de construction 07.1985 - 11.2001)","brand":"RENAULT","model":"Rapid (F40, G40) (Année de construction 07.1985 - 11.2001)","end_date":"11.2001","model_id":17,"start_date":"07.1985"},{"raw":"RENAULT Clio I 3/5 portes (Année de construction 05.1990 - 09.1998)","brand":"RENAULT","model":"Clio I 3/5 portes (Année de construction 05.1990 - 09.1998)","end_date":"09.1998","model_id":21,"start_date":"05.1990"},{"raw":"RENAULT Twingo I 3 portes (Année de construction 03.1993 - 10.2012)","brand":"RENAULT","model":"Twingo I 3 portes (Année de construction 03.1993 - 10.2012)","end_date":"10.2012","model_id":472,"start_date":"03.1993"},{"raw":"RENAULT R5 3/5 portes (Année de construction 01.1972 - 12.1985)","brand":"RENAULT","model":"R5 3/5 portes (Année de construction 01.1972 - 12.1985)","end_date":"12.1985","model_id":556,"start_date":"01.1972"},{"raw":"RENAULT Super 5 3/5 portes (B40, C40) (Année de construction 10.1984 - 12.1996)","brand":"RENAULT","model":"Super 5 3/5 portes (B40, C40) (Année de construction 10.1984 - 12.1996)","end_date":"12.1996","model_id":560,"start_date":"10.1984"},{"raw":"RENAULT Clio I Van (Année de construction 01.1991 - 09.1998)","brand":"RENAULT","model":"Clio I Van (Année de construction 01.1991 - 09.1998)","end_date":"09.1998","model_id":4218,"start_date":"01.1991"},{"raw":"RENAULT Super 5 Van (S40) (Année de construction 10.1984 - 12.1996)","brand":"RENAULT","model":"Super 5 Van (S40) (Année de construction 10.1984 - 12.1996)","end_date":"12.1996","model_id":4219,"start_date":"10.1984"},{"raw":"RENAULT Twingo I Van (Année de construction 03.1993 - 06.2012)","brand":"RENAULT","model":"Twingo I Van (Année de construction 03.1993 - 06.2012)","end_date":"06.2012","model_id":4227,"start_date":"03.1993"}],"product_id":7999541,"product_url":"https://www.auto-doc.fr/ridex/7999541","vehicle_type":"pkw"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autodoc/search":{"get":{"summary":"Autodoc Search","description":"Search Autodoc by URL: keyword pages use `/search?keyword=…` (e.g. `frein` on auto-doc.fr). Extract product cards, prices, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-autodoc-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Autodoc search/listing URL, or path only when `domain` sets the shop.\n\n**Typical keyword search (full URL, `domain` ignored):**\n```\nhttps://www.auto-doc.fr/search?keyword=frein\n```\n\n```\nhttps://www.autodoc.de/search?keyword=bremsen\n```\n\n**Path + `domain`:**\n- `query`: `search?keyword=frein`\n- `domain`: `auto-doc.fr`\n\n**Rules:**\n- If `query` starts with `http://` or `https://`, `domain` is ignored.\n- If `query` has no host, `domain` must be an allowed shop hostname (no `www.`, no `https://`).\n- France uses **`auto-doc.fr`**, not `autodoc.fr`.","schema":{"type":"string","description":"Full Autodoc search/listing URL, or path only when `domain` sets the shop.\n\n**Typical keyword search (full URL, `domain` ignored):**\n```\nhttps://www.auto-doc.fr/search?keyword=frein\n```\n\n```\nhttps://www.autodoc.de/search?keyword=bremsen\n```\n\n**Path + `domain`:**\n- `query`: `search?keyword=frein`\n- `domain`: `auto-doc.fr`\n\n**Rules:**\n- If `query` starts with `http://` or `https://`, `domain` is ignored.\n- If `query` has no host, `domain` must be an allowed shop hostname (no `www.`, no `https://`).\n- France uses **`auto-doc.fr`**, not `autodoc.fr`."}},{"name":"domain","in":"query","required":false,"description":"Regional shop hostname without `https://` or `www.` (e.g. `auto-doc.fr`, `autodoc.de`). Omit to default to `autodoc.de`.","schema":{"type":"string","description":"Regional shop hostname without `https://` or `www.` (e.g. `auto-doc.fr`, `autodoc.de`). Omit to default to `autodoc.de`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"number"},"seller":{"type":"string"},"brand_no":{"type":"string"},"discount":{"type":"integer"},"360_photo":{"type":"string"},"reference":{"type":"string"},"seller_id":{"type":"integer"},"product_id":{"type":"string"},"product_url":{"type":"string"},"availability":{"type":"string"},"generic_name":{"type":"string"},"product_image":{"type":"string"},"reviews_count":{"type":"integer"},"original_price":{"type":"number"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search frein on auto-doc.fr":{"value":{"results":[{"name":"RIDEX Étrier de frein Essieu avant gauche, Essieu avant, Fonte, 162 mm, sans fixation","price":42.99,"seller":"AUTODOC","brand_no":"100015","discount":42,"360_photo":"https://media.autodoc.de/360_photos/8381120","reference":"78B0410","seller_id":485,"product_id":"8381120","product_url":"https://www.auto-doc.fr/ridex/8381120","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/8381120/preview.jpg","reviews_count":10,"original_price":74.2},{"name":"RIDEX Étrier de frein Essieu avant gauche, Essieu avant, Fonte grise, 134 mm, sans fixation","price":36.99,"seller":"AUTODOC","brand_no":"100015","discount":47,"360_photo":"https://media.autodoc.de/360_photos/8099284","reference":"78B0328","seller_id":485,"product_id":"8099284","product_url":"https://www.auto-doc.fr/ridex/8099284","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/8099284/preview.jpg","reviews_count":18,"original_price":70.3},{"name":"RIDEX PLUS Étrier de frein Essieu arrière gauche, Essieu arrière, Aluminium, 118 mm, sans fixation","price":59.99,"seller":"AUTODOC","brand_no":"100762","discount":null,"360_photo":"https://media.autodoc.de/360_photos/22255932","reference":"78B0093P","seller_id":485,"product_id":"22255932","product_url":"https://www.auto-doc.fr/ridex-plus/22255932","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/22255932/preview.jpg","reviews_count":0,"original_price":null},{"name":"RIDEX Étrier de frein Essieu arrière gauche, Essieu arrière, Aluminium, 50 mm, 127 mm, sans fixation","price":51.49,"seller":"AUTODOC","brand_no":"100015","discount":57,"360_photo":"https://media.autodoc.de/360_photos/8099740","reference":"78B0194","seller_id":485,"product_id":"8099740","product_url":"https://www.auto-doc.fr/ridex/8099740","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/8099740/preview.jpg","reviews_count":20,"original_price":121.7}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5],"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Autodoc Search","description":"Search Autodoc by URL: keyword pages use `/search?keyword=…` (e.g. `frein` on auto-doc.fr). Extract product cards, prices, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-autodoc-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Autodoc search/listing URL, or path only when `domain` sets the shop.\n\n**Typical keyword search (full URL, `domain` ignored):**\n```\nhttps://www.auto-doc.fr/search?keyword=frein\n```\n\n```\nhttps://www.autodoc.de/search?keyword=bremsen\n```\n\n**Path + `domain`:**\n- `query`: `search?keyword=frein`\n- `domain`: `auto-doc.fr`\n\n**Rules:**\n- If `query` starts with `http://` or `https://`, `domain` is ignored.\n- If `query` has no host, `domain` must be an allowed shop hostname (no `www.`, no `https://`).\n- France uses **`auto-doc.fr`**, not `autodoc.fr`.","schema":{"type":"string","description":"Full Autodoc search/listing URL, or path only when `domain` sets the shop.\n\n**Typical keyword search (full URL, `domain` ignored):**\n```\nhttps://www.auto-doc.fr/search?keyword=frein\n```\n\n```\nhttps://www.autodoc.de/search?keyword=bremsen\n```\n\n**Path + `domain`:**\n- `query`: `search?keyword=frein`\n- `domain`: `auto-doc.fr`\n\n**Rules:**\n- If `query` starts with `http://` or `https://`, `domain` is ignored.\n- If `query` has no host, `domain` must be an allowed shop hostname (no `www.`, no `https://`).\n- France uses **`auto-doc.fr`**, not `autodoc.fr`."}},{"name":"domain","in":"query","required":false,"description":"Regional shop hostname without `https://` or `www.` (e.g. `auto-doc.fr`, `autodoc.de`). Omit to default to `autodoc.de`.","schema":{"type":"string","description":"Regional shop hostname without `https://` or `www.` (e.g. `auto-doc.fr`, `autodoc.de`). Omit to default to `autodoc.de`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"number"},"seller":{"type":"string"},"brand_no":{"type":"string"},"discount":{"type":"integer"},"360_photo":{"type":"string"},"reference":{"type":"string"},"seller_id":{"type":"integer"},"product_id":{"type":"string"},"product_url":{"type":"string"},"availability":{"type":"string"},"generic_name":{"type":"string"},"product_image":{"type":"string"},"reviews_count":{"type":"integer"},"original_price":{"type":"number"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search frein on auto-doc.fr":{"value":{"results":[{"name":"RIDEX Étrier de frein Essieu avant gauche, Essieu avant, Fonte, 162 mm, sans fixation","price":42.99,"seller":"AUTODOC","brand_no":"100015","discount":42,"360_photo":"https://media.autodoc.de/360_photos/8381120","reference":"78B0410","seller_id":485,"product_id":"8381120","product_url":"https://www.auto-doc.fr/ridex/8381120","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/8381120/preview.jpg","reviews_count":10,"original_price":74.2},{"name":"RIDEX Étrier de frein Essieu avant gauche, Essieu avant, Fonte grise, 134 mm, sans fixation","price":36.99,"seller":"AUTODOC","brand_no":"100015","discount":47,"360_photo":"https://media.autodoc.de/360_photos/8099284","reference":"78B0328","seller_id":485,"product_id":"8099284","product_url":"https://www.auto-doc.fr/ridex/8099284","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/8099284/preview.jpg","reviews_count":18,"original_price":70.3},{"name":"RIDEX PLUS Étrier de frein Essieu arrière gauche, Essieu arrière, Aluminium, 118 mm, sans fixation","price":59.99,"seller":"AUTODOC","brand_no":"100762","discount":null,"360_photo":"https://media.autodoc.de/360_photos/22255932","reference":"78B0093P","seller_id":485,"product_id":"22255932","product_url":"https://www.auto-doc.fr/ridex-plus/22255932","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/22255932/preview.jpg","reviews_count":0,"original_price":null},{"name":"RIDEX Étrier de frein Essieu arrière gauche, Essieu arrière, Aluminium, 50 mm, 127 mm, sans fixation","price":51.49,"seller":"AUTODOC","brand_no":"100015","discount":57,"360_photo":"https://media.autodoc.de/360_photos/8099740","reference":"78B0194","seller_id":485,"product_id":"8099740","product_url":"https://www.auto-doc.fr/ridex/8099740","availability":"En stock","generic_name":"Étrier de frein","product_image":"https://media.autodoc.de/360_photos/8099740/preview.jpg","reviews_count":20,"original_price":121.7}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5],"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autodoc/product":{"get":{"summary":"Autodoc Product","description":"Scrape Autodoc product pages: price, specs, EAN, images, compatibility, and TecDoc-related vehicle data via the Related endpoint.\n\n**Credit cost:** 2 credits per call","operationId":"get-autodoc-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"HTTPS URL of an Autodoc product page.\n\n**Example:**\n\n    https://www.auto-doc.fr/ridex/7999541\n\nFrance uses **`auto-doc.fr`**, not `autodoc.fr`. Response includes `compatibility` with `fetch.params` for Related.","schema":{"type":"string","description":"HTTPS URL of an Autodoc product page.\n\n**Example:**\n\n    https://www.auto-doc.fr/ridex/7999541\n\nFrance uses **`auto-doc.fr`**, not `autodoc.fr`. Response includes `compatibility` with `fetch.params` for Related."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"seller":{"type":"string"},"brand_no":{"type":"integer"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"subtitle":{"type":"string"},"reference":{"type":"string"},"seller_id":{"type":"integer"},"generic_id":{"type":"integer"},"product_id":{"type":"integer"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"oem_numbers":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"label":{"type":"string"}}}},"product_url":{"type":"string"},"seo_summary":{"type":"object","properties":{"moteurs":{"type":"string"},"modeles_de_voitures":{"type":"string"},"annees_de_fabrication":{"type":"string"},"numero(s)_de_piece_oe":{"type":"string"},"puissance_(kilowatts)":{"type":"string"},"numero_d_article_du_fabricant":{"type":"string"},"puissance_du_moteur_(chevaux)":{"type":"string"}}},"availability":{"type":"string"},"generic_name":{"type":"string"},"goods_ending":{"type":"integer"},"compatibility":{"type":"object","properties":{"cars":{"type":"array","items":{"type":"object","properties":{"fetch":{"type":"object","properties":{"path":{"type":"string"},"params":{"type":"object","properties":{"query":{"type":"string"},"maker_id":{"type":"integer"},"maker_name":{"type":"string"},"product_id":{"type":"integer"},"vehicle_type":{"type":"string"}}}}},"maker":{"type":"string"},"maker_id":{"type":"integer"},"vehicle_type":{"type":"string"}}}},"trucks":{"type":"array","items":{}}}},"has_360_photo":{"type":"boolean"},"reviews_count":{"type":"integer"},"specifications":{"type":"object","properties":{"etat":{"type":"string"},"hauteur":{"type":"string"},"perfore":{"type":"string"},"surface":{"type":"string"},"diametre":{"type":"string"},"materiel":{"type":"string"},"fabricant":{"type":"string"},"traitement":{"type":"string"},"numero_de_ean":{"type":"string"},"nombre_de_trous":{"type":"string"},"numero_d_article":{"type":"string"},"annee_a_partir_de":{"type":"string"},"cote_d_assemblage":{"type":"string"},"cercle_de_percage_ø":{"type":"string"},"diametre_du_centrage":{"type":"string"},"type_de_disque_de_frein":{"type":"string"},"epaisseur_du_disque_de_frein":{"type":"string"},"diametre_d_alesage_du_boulon_de_roue":{"type":"string"},"article_complementaire_info_complementaire_2":{"type":"string"}}},"rating_percentage":{"type":"integer"},"discount_percentage":{"type":"integer"}}},"examples":{"Brake disc RIDEX 82B0696 (auto-doc.fr)":{"value":{"ean":"4059191318797","name":"RIDEX 82B0696 Disque de freinEssieu avant, 238x8mm, 4/6x100, Plein, Fonte","price":13.99,"images":["https://media.autodoc.de/360_photos/7999541/preview.jpg","https://cdn.autodoc.de/thumb?id=7999541&m=1&n=0&lng=fr&rev=94078030"],"rating":8,"seller":"AUTODOC","brand_no":100015,"currency":"EUR","features":["Disques de frein standard conditionnés dans un emballage huilé","Matériel : fonte GG20","Qualité élevée constante","Installation facile","Compatibilité parfaite avec les composants du système de freinage RIDEX"],"subtitle":"Essieu avant, 238x8mm, 4/6x100, Plein, Fonte","reference":"82B0696","seller_id":485,"generic_id":82,"product_id":7999541,"breadcrumbs":[{"url":"https://www.auto-doc.fr/#parts","name":"Pièces auto magasin en ligne"},{"url":"https://www.auto-doc.fr/pieces-detachees","name":"Catalogue de pièces"},{"url":"https://www.auto-doc.fr/pieces-detachees/freinage","name":"Frein"},{"url":"https://www.auto-doc.fr/pieces-detachees/disque-de-frein-10132","name":"Disque de frein"},{"url":null,"name":"RIDEX Disque de frein"}],"oem_numbers":[{"url":"https://www.auto-doc.fr/pieces-detachees/oem/7701204285","label":"OE 77 01 204 285. RENAULT"},{"url":"https://www.auto-doc.fr/pieces-detachees/oem/7700716947","label":"OE 77 00 716 947. RENAULT"},{"url":"https://www.auto-doc.fr/pieces-detachees/oem/7701716947","label":"OE 77 01 716 947. RENAULT"}],"product_url":"https://www.auto-doc.fr/ridex/7999541","seo_summary":{"moteurs":"1.2; 1.2 16V; 1.1; 1.9 D; 1.4; 1.0; 1.6 D","modeles_de_voitures":"Renault Twingo 1; Clio 1; Renault Supercinq; R5 3/5 portes; Renault Rapid Van; Renault Twingo 1 Van; Renault Clio Van s57; Super 5 Van (s40)","annees_de_fabrication":"1980-2007","numero(s)_de_piece_oe":"77 01 204 285, 77 00 716 947, 77 01 716 947","puissance_(kilowatts)":"27-52 kW","numero_d_article_du_fabricant":"82B0696","puissance_du_moteur_(chevaux)":"37-71 CV"},"availability":"En stock","generic_name":"Disque de frein","goods_ending":392,"compatibility":{"cars":[{"fetch":{"path":"/v2/autodoc/product/related","params":{"query":"https://www.auto-doc.fr/ridex/7999541","maker_id":93,"maker_name":"RENAULT","product_id":7999541,"vehicle_type":"pkw"}},"maker":"RENAULT","maker_id":93,"vehicle_type":"pkw"}],"trucks":[]},"has_360_photo":true,"reviews_count":28,"specifications":{"etat":"Neuf","hauteur":"41","perfore":"non","surface":"nu / non protégé / non plastifié","diametre":"238","materiel":"Fonte","fabricant":"RIDEX","traitement":"non-traité","numero_de_ean":"4059191318797","nombre_de_trous":"4 / 6","numero_d_article":"82B0696","annee_a_partir_de":"Cette caractéristique varie en fonction du modèle de voiture.","cote_d_assemblage":"Essieu avant","cercle_de_percage_ø":"100","diametre_du_centrage":"61,1","type_de_disque_de_frein":"Plein","epaisseur_du_disque_de_frein":"8","diametre_d_alesage_du_boulon_de_roue":"13","article_complementaire_info_complementaire_2":"sans vis / boulons"},"rating_percentage":80,"discount_percentage":55}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Autodoc Product","description":"Scrape Autodoc product pages: price, specs, EAN, images, compatibility, and TecDoc-related vehicle data via the Related endpoint.\n\n**Credit cost:** 2 credits per call","operationId":"post-autodoc-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"HTTPS URL of an Autodoc product page.\n\n**Example:**\n\n    https://www.auto-doc.fr/ridex/7999541\n\nFrance uses **`auto-doc.fr`**, not `autodoc.fr`. Response includes `compatibility` with `fetch.params` for Related.","schema":{"type":"string","description":"HTTPS URL of an Autodoc product page.\n\n**Example:**\n\n    https://www.auto-doc.fr/ridex/7999541\n\nFrance uses **`auto-doc.fr`**, not `autodoc.fr`. Response includes `compatibility` with `fetch.params` for Related."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"seller":{"type":"string"},"brand_no":{"type":"integer"},"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"subtitle":{"type":"string"},"reference":{"type":"string"},"seller_id":{"type":"integer"},"generic_id":{"type":"integer"},"product_id":{"type":"integer"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"oem_numbers":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"label":{"type":"string"}}}},"product_url":{"type":"string"},"seo_summary":{"type":"object","properties":{"moteurs":{"type":"string"},"modeles_de_voitures":{"type":"string"},"annees_de_fabrication":{"type":"string"},"numero(s)_de_piece_oe":{"type":"string"},"puissance_(kilowatts)":{"type":"string"},"numero_d_article_du_fabricant":{"type":"string"},"puissance_du_moteur_(chevaux)":{"type":"string"}}},"availability":{"type":"string"},"generic_name":{"type":"string"},"goods_ending":{"type":"integer"},"compatibility":{"type":"object","properties":{"cars":{"type":"array","items":{"type":"object","properties":{"fetch":{"type":"object","properties":{"path":{"type":"string"},"params":{"type":"object","properties":{"query":{"type":"string"},"maker_id":{"type":"integer"},"maker_name":{"type":"string"},"product_id":{"type":"integer"},"vehicle_type":{"type":"string"}}}}},"maker":{"type":"string"},"maker_id":{"type":"integer"},"vehicle_type":{"type":"string"}}}},"trucks":{"type":"array","items":{}}}},"has_360_photo":{"type":"boolean"},"reviews_count":{"type":"integer"},"specifications":{"type":"object","properties":{"etat":{"type":"string"},"hauteur":{"type":"string"},"perfore":{"type":"string"},"surface":{"type":"string"},"diametre":{"type":"string"},"materiel":{"type":"string"},"fabricant":{"type":"string"},"traitement":{"type":"string"},"numero_de_ean":{"type":"string"},"nombre_de_trous":{"type":"string"},"numero_d_article":{"type":"string"},"annee_a_partir_de":{"type":"string"},"cote_d_assemblage":{"type":"string"},"cercle_de_percage_ø":{"type":"string"},"diametre_du_centrage":{"type":"string"},"type_de_disque_de_frein":{"type":"string"},"epaisseur_du_disque_de_frein":{"type":"string"},"diametre_d_alesage_du_boulon_de_roue":{"type":"string"},"article_complementaire_info_complementaire_2":{"type":"string"}}},"rating_percentage":{"type":"integer"},"discount_percentage":{"type":"integer"}}},"examples":{"Brake disc RIDEX 82B0696 (auto-doc.fr)":{"value":{"ean":"4059191318797","name":"RIDEX 82B0696 Disque de freinEssieu avant, 238x8mm, 4/6x100, Plein, Fonte","price":13.99,"images":["https://media.autodoc.de/360_photos/7999541/preview.jpg","https://cdn.autodoc.de/thumb?id=7999541&m=1&n=0&lng=fr&rev=94078030"],"rating":8,"seller":"AUTODOC","brand_no":100015,"currency":"EUR","features":["Disques de frein standard conditionnés dans un emballage huilé","Matériel : fonte GG20","Qualité élevée constante","Installation facile","Compatibilité parfaite avec les composants du système de freinage RIDEX"],"subtitle":"Essieu avant, 238x8mm, 4/6x100, Plein, Fonte","reference":"82B0696","seller_id":485,"generic_id":82,"product_id":7999541,"breadcrumbs":[{"url":"https://www.auto-doc.fr/#parts","name":"Pièces auto magasin en ligne"},{"url":"https://www.auto-doc.fr/pieces-detachees","name":"Catalogue de pièces"},{"url":"https://www.auto-doc.fr/pieces-detachees/freinage","name":"Frein"},{"url":"https://www.auto-doc.fr/pieces-detachees/disque-de-frein-10132","name":"Disque de frein"},{"url":null,"name":"RIDEX Disque de frein"}],"oem_numbers":[{"url":"https://www.auto-doc.fr/pieces-detachees/oem/7701204285","label":"OE 77 01 204 285. RENAULT"},{"url":"https://www.auto-doc.fr/pieces-detachees/oem/7700716947","label":"OE 77 00 716 947. RENAULT"},{"url":"https://www.auto-doc.fr/pieces-detachees/oem/7701716947","label":"OE 77 01 716 947. RENAULT"}],"product_url":"https://www.auto-doc.fr/ridex/7999541","seo_summary":{"moteurs":"1.2; 1.2 16V; 1.1; 1.9 D; 1.4; 1.0; 1.6 D","modeles_de_voitures":"Renault Twingo 1; Clio 1; Renault Supercinq; R5 3/5 portes; Renault Rapid Van; Renault Twingo 1 Van; Renault Clio Van s57; Super 5 Van (s40)","annees_de_fabrication":"1980-2007","numero(s)_de_piece_oe":"77 01 204 285, 77 00 716 947, 77 01 716 947","puissance_(kilowatts)":"27-52 kW","numero_d_article_du_fabricant":"82B0696","puissance_du_moteur_(chevaux)":"37-71 CV"},"availability":"En stock","generic_name":"Disque de frein","goods_ending":392,"compatibility":{"cars":[{"fetch":{"path":"/v2/autodoc/product/related","params":{"query":"https://www.auto-doc.fr/ridex/7999541","maker_id":93,"maker_name":"RENAULT","product_id":7999541,"vehicle_type":"pkw"}},"maker":"RENAULT","maker_id":93,"vehicle_type":"pkw"}],"trucks":[]},"has_360_photo":true,"reviews_count":28,"specifications":{"etat":"Neuf","hauteur":"41","perfore":"non","surface":"nu / non protégé / non plastifié","diametre":"238","materiel":"Fonte","fabricant":"RIDEX","traitement":"non-traité","numero_de_ean":"4059191318797","nombre_de_trous":"4 / 6","numero_d_article":"82B0696","annee_a_partir_de":"Cette caractéristique varie en fonction du modèle de voiture.","cote_d_assemblage":"Essieu avant","cercle_de_percage_ø":"100","diametre_du_centrage":"61,1","type_de_disque_de_frein":"Plein","epaisseur_du_disque_de_frein":"8","diametre_d_alesage_du_boulon_de_roue":"13","article_complementaire_info_complementaire_2":"sans vis / boulons"},"rating_percentage":80,"discount_percentage":55}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/wellfound/company/info":{"get":{"summary":"Wellfound Company Info","description":"Retrieve startup and company data from Wellfound (formerly AngelList), including description, funding, team size, hiring status, and social links.\n\n**Status:** Degraded\n\n**Credit cost:** 1 credit per call","operationId":"get-wellfound-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Wellfound company URL or company slug.\n\n**Examples:**\n\n    https://wellfound.com/company/dataiku\n\n\nBoth the full Wellfound URL and the company slug are accepted.","schema":{"type":"string","description":"A Wellfound company URL or company slug.\n\n**Examples:**\n\n    https://wellfound.com/company/dataiku\n\n\nBoth the full Wellfound URL and the company slug are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"hiring":{"type":"boolean"},"website":{"type":"string"},"headline":{"type":"string"},"description":{"type":"string"},"is_incubator":{"type":"boolean"},"is_operating":{"nullable":true},"employee_count":{"type":"string"},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"company_financials_highlights":{"type":"object","properties":{"funding_total":{"type":"integer"},"num_funding_rounds":{"type":"integer"}}}}},"examples":{"Get Wellfound company info for Dataiku":{"value":{"id":"141418","logo":"https://photos.wellfound.com/startups/i/141418-1a571520061744ccd50545d59ed3ff93-medium_jpg.jpg?buster=1631710332","name":"Dataiku","slug":"dataiku","hiring":true,"website":"http://www.dataiku.com/","headline":"Everyday AI, Extraordinary People","description":"Dataiku is the platform for Everyday AI, systemizing the use of data for exceptional business results. By making the use of data and AI an everyday behavior, Dataiku unlocks the creativity within individual employees to power collective success at companies of all sizes and across all industries.","is_incubator":false,"is_operating":null,"employee_count":"1001-5000","social_networks":[{"url":"http://twitter.com/dataiku","name":"twitter"},{"url":"http://www.facebook.com/dataiku","name":"facebook"},{"url":"http://www.linkedin.com/company/dataiku","name":"linkedin"},{"url":"http://www.dataiku.com/blog/","name":"blog"}],"company_financials_highlights":{"funding_total":837290000,"num_funding_rounds":9}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Wellfound Company Info","description":"Retrieve startup and company data from Wellfound (formerly AngelList), including description, funding, team size, hiring status, and social links.\n\n**Status:** Degraded\n\n**Credit cost:** 1 credit per call","operationId":"post-wellfound-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Wellfound company URL or company slug.\n\n**Examples:**\n\n    https://wellfound.com/company/dataiku\n\n\nBoth the full Wellfound URL and the company slug are accepted.","schema":{"type":"string","description":"A Wellfound company URL or company slug.\n\n**Examples:**\n\n    https://wellfound.com/company/dataiku\n\n\nBoth the full Wellfound URL and the company slug are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"hiring":{"type":"boolean"},"website":{"type":"string"},"headline":{"type":"string"},"description":{"type":"string"},"is_incubator":{"type":"boolean"},"is_operating":{"nullable":true},"employee_count":{"type":"string"},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"company_financials_highlights":{"type":"object","properties":{"funding_total":{"type":"integer"},"num_funding_rounds":{"type":"integer"}}}}},"examples":{"Get Wellfound company info for Dataiku":{"value":{"id":"141418","logo":"https://photos.wellfound.com/startups/i/141418-1a571520061744ccd50545d59ed3ff93-medium_jpg.jpg?buster=1631710332","name":"Dataiku","slug":"dataiku","hiring":true,"website":"http://www.dataiku.com/","headline":"Everyday AI, Extraordinary People","description":"Dataiku is the platform for Everyday AI, systemizing the use of data for exceptional business results. By making the use of data and AI an everyday behavior, Dataiku unlocks the creativity within individual employees to power collective success at companies of all sizes and across all industries.","is_incubator":false,"is_operating":null,"employee_count":"1001-5000","social_networks":[{"url":"http://twitter.com/dataiku","name":"twitter"},{"url":"http://www.facebook.com/dataiku","name":"facebook"},{"url":"http://www.linkedin.com/company/dataiku","name":"linkedin"},{"url":"http://www.dataiku.com/blog/","name":"blog"}],"company_financials_highlights":{"funding_total":837290000,"num_funding_rounds":9}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/weibo/search":{"get":{"summary":"Weibo Search","description":"Search public Weibo posts by keywords. Each post includes the author, text, publish time, engagement counts, image, and video link.\n\n**Credit cost:** 2 credits per call","operationId":"get-weibo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keywords to search, such as AI.\n\nA Weibo mobile search URL that already contains a containerid is also accepted and keeps that container.\n\nExample:\n\n    AI","schema":{"type":"string","description":"Keywords to search, such as AI.\n\nA Weibo mobile search URL that already contains a containerid is also accepted and keeps that container.\n\nExample:\n\n    AI"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Default 1. Page 2 is the next slice of the same keywords.","schema":{"type":"number","default":"1","description":"Page number, starting at 1. Default 1. Page 2 is the next slice of the same keywords."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"user_id":{"type":"integer"},"image_url":{"type":"string"},"user_name":{"type":"string"},"video_url":{"type":"string"},"avatar_url":{"type":"string"},"created_at":{"type":"string"},"reposts_count":{"type":"integer"},"comments_count":{"type":"integer"},"attitudes_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search Weibo for AI":{"value":{"results":[{"id":"5359719204259182","url":"https://m.weibo.cn/detail/5359719204259182","text":"看看人家《潜伏》天津站的年会！无言以对！吴站长&梅姐《Trouble Maker》（现在的AI进化太快了！一日千里，真假难辨。）","source":"历史博主","user_id":7660126398,"image_url":"https://wx3.sinaimg.cn/orj480/008mp6NMgy1iikcckwn2xj31hc0u0tbt.jpg","user_name":"收集老照片","video_url":"https://video.weibo.com/show?fid=1034:5359718869172258","avatar_url":"https://tvax3.sinaimg.cn/crop.0.0.1080.1080.180/008mp6NMly8i65clv146uj30u00u0n04.jpg","created_at":"Fri Oct 30 14:01:40 +0800 2026","reposts_count":1132,"comments_count":399,"attitudes_count":4491}],"pagination":{"next":"https://m.weibo.cn/api/container/getIndex?containerid=100103type%3D1%26q%3DAI&page_type=searchall&page=2","page":1,"per_page":1,"total_pages":100,"total_results":1000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Weibo Search","description":"Search public Weibo posts by keywords. Each post includes the author, text, publish time, engagement counts, image, and video link.\n\n**Credit cost:** 2 credits per call","operationId":"post-weibo-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keywords to search, such as AI.\n\nA Weibo mobile search URL that already contains a containerid is also accepted and keeps that container.\n\nExample:\n\n    AI","schema":{"type":"string","description":"Keywords to search, such as AI.\n\nA Weibo mobile search URL that already contains a containerid is also accepted and keeps that container.\n\nExample:\n\n    AI"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Default 1. Page 2 is the next slice of the same keywords.","schema":{"type":"number","default":"1","description":"Page number, starting at 1. Default 1. Page 2 is the next slice of the same keywords."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"user_id":{"type":"integer"},"image_url":{"type":"string"},"user_name":{"type":"string"},"video_url":{"type":"string"},"avatar_url":{"type":"string"},"created_at":{"type":"string"},"reposts_count":{"type":"integer"},"comments_count":{"type":"integer"},"attitudes_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search Weibo for AI":{"value":{"results":[{"id":"5359719204259182","url":"https://m.weibo.cn/detail/5359719204259182","text":"看看人家《潜伏》天津站的年会！无言以对！吴站长&梅姐《Trouble Maker》（现在的AI进化太快了！一日千里，真假难辨。）","source":"历史博主","user_id":7660126398,"image_url":"https://wx3.sinaimg.cn/orj480/008mp6NMgy1iikcckwn2xj31hc0u0tbt.jpg","user_name":"收集老照片","video_url":"https://video.weibo.com/show?fid=1034:5359718869172258","avatar_url":"https://tvax3.sinaimg.cn/crop.0.0.1080.1080.180/008mp6NMly8i65clv146uj30u00u0n04.jpg","created_at":"Fri Oct 30 14:01:40 +0800 2026","reposts_count":1132,"comments_count":399,"attitudes_count":4491}],"pagination":{"next":"https://m.weibo.cn/api/container/getIndex?containerid=100103type%3D1%26q%3DAI&page_type=searchall&page=2","page":1,"per_page":1,"total_pages":100,"total_results":1000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/weibo/post/info":{"get":{"summary":"Weibo Post Info","description":"Retrieve one public Weibo post by post id, including text, images, publish time, engagement counts, and author profile.\n\n**Credit cost:** 2 credits per call","operationId":"get-weibo-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Weibo post id.\n\nExample:\n\n    5062595839264600\n\nA mobile detail URL is also accepted. The id is the last path segment.","schema":{"type":"string","description":"Weibo post id.\n\nExample:\n\n    5062595839264600\n\nA mobile detail URL is also accepted. The id is the last path segment."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"post":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"pics":{"type":"array","items":{"type":"object","properties":{"pid":{"type":"string"},"url":{"type":"string"},"large":{"type":"object","properties":{"url":{"type":"string"}}}}}},"text":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"verified":{"type":"boolean"},"avatar_url":{"type":"string"},"screen_name":{"type":"string"},"followers_count":{"type":"string"}}},"source":{"type":"string"},"video_url":{"nullable":true},"created_at":{"type":"string"},"reposts_count":{"type":"integer"},"comments_count":{"type":"integer"},"attitudes_count":{"type":"integer"}}}}},"examples":{"Xinhua post 5062595839264600":{"value":{"post":{"id":"5062595839264600","url":"https://m.weibo.cn/detail/5062595839264600","pics":[{"pid":"001R0E0aly1hs8gb8rfhoj647k2yg4qt02","url":"https://wx4.sinaimg.cn/orj360/001R0E0aly1hs8gb8rfhoj647k2yg4qt02.jpg","large":{"url":"https://wx4.sinaimg.cn/mw2000/001R0E0aly1hs8gb8rfhoj647k2yg4qt02.jpg"}}],"text":"【祝贺！#刘宇坤50米步枪三姿金牌#】当地时间1日，中国选手刘宇坤在巴黎奥运会射击男子50米步枪三姿项目上夺得金牌。","user":{"id":1699432410,"verified":true,"avatar_url":"https://tvax2.sinaimg.cn/crop.58.61.875.875.180/001R0E0aly8h8vg6xx3srj60rs0rsdko02.jpg","screen_name":"新华社","followers_count":"1.14亿"},"source":"微博网页版","video_url":null,"created_at":"Thu Aug 01 16:19:29 +0800 2024","reposts_count":4064,"comments_count":5283,"attitudes_count":195163}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Weibo Post Info","description":"Retrieve one public Weibo post by post id, including text, images, publish time, engagement counts, and author profile.\n\n**Credit cost:** 2 credits per call","operationId":"post-weibo-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Weibo post id.\n\nExample:\n\n    5062595839264600\n\nA mobile detail URL is also accepted. The id is the last path segment.","schema":{"type":"string","description":"Weibo post id.\n\nExample:\n\n    5062595839264600\n\nA mobile detail URL is also accepted. The id is the last path segment."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"post":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"pics":{"type":"array","items":{"type":"object","properties":{"pid":{"type":"string"},"url":{"type":"string"},"large":{"type":"object","properties":{"url":{"type":"string"}}}}}},"text":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"verified":{"type":"boolean"},"avatar_url":{"type":"string"},"screen_name":{"type":"string"},"followers_count":{"type":"string"}}},"source":{"type":"string"},"video_url":{"nullable":true},"created_at":{"type":"string"},"reposts_count":{"type":"integer"},"comments_count":{"type":"integer"},"attitudes_count":{"type":"integer"}}}}},"examples":{"Xinhua post 5062595839264600":{"value":{"post":{"id":"5062595839264600","url":"https://m.weibo.cn/detail/5062595839264600","pics":[{"pid":"001R0E0aly1hs8gb8rfhoj647k2yg4qt02","url":"https://wx4.sinaimg.cn/orj360/001R0E0aly1hs8gb8rfhoj647k2yg4qt02.jpg","large":{"url":"https://wx4.sinaimg.cn/mw2000/001R0E0aly1hs8gb8rfhoj647k2yg4qt02.jpg"}}],"text":"【祝贺！#刘宇坤50米步枪三姿金牌#】当地时间1日，中国选手刘宇坤在巴黎奥运会射击男子50米步枪三姿项目上夺得金牌。","user":{"id":1699432410,"verified":true,"avatar_url":"https://tvax2.sinaimg.cn/crop.58.61.875.875.180/001R0E0aly8h8vg6xx3srj60rs0rsdko02.jpg","screen_name":"新华社","followers_count":"1.14亿"},"source":"微博网页版","video_url":null,"created_at":"Thu Aug 01 16:19:29 +0800 2024","reposts_count":4064,"comments_count":5283,"attitudes_count":195163}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/trustpilot/company/info":{"get":{"summary":"Trustpilot Company Info","description":"Retrieve Trustpilot company profile data, including trust score, star rating, categories, contact info, and review response behavior.\n\n**Credit cost:** 1 credit per call","operationId":"get-trustpilot-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Trustpilot company URL or domain name.\n\n**Examples:**\n\n    https://www.trustpilot.com/review/nordvpn.com\n\nBoth the full Trustpilot review URL and the company domain are accepted.","schema":{"type":"string","description":"A Trustpilot company URL or domain name.\n\n**Examples:**\n\n    https://www.trustpilot.com/review/nordvpn.com\n\nBoth the full Trustpilot review URL and the company domain are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"stars":{"type":"integer"},"activity":{"type":"object","properties":{"is_claimed":{"type":"boolean"},"reply_behavior":{"type":"object","properties":{"reply_percentage":{"type":"number"},"average_days_to_reply":{"type":"number"}}}}},"is_closed":{"type":"boolean"},"breadcrumb":{"type":"object","properties":{"mid_level_display_name":{"type":"string"},"top_level_display_name":{"type":"string"},"bottom_level_display_name":{"type":"string"}}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"string"},"is_primary":{"type":"boolean"}}}},"is_claimed":{"type":"boolean"},"trust_score":{"type":"number"},"website_url":{"type":"string"},"contact_info":{"type":"object","properties":{"city":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"country":{"type":"string"}}},"display_name":{"type":"string"},"website_title":{"type":"string"},"similar_business":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"}}}}}},"examples":{"Get Trustpilot info for NordVPN":{"value":{"id":"51abc000000064000538d348","stars":4,"activity":{"is_claimed":true,"reply_behavior":{"reply_percentage":98.93,"average_days_to_reply":-0.34}},"is_closed":false,"breadcrumb":{"mid_level_display_name":"Internet & Software","top_level_display_name":"Electronics & Technology","bottom_level_display_name":"VPN Service"},"categories":[{"id":"vpn_service","name":"VPN Service","rank":"15","is_primary":true},{"id":"internet_service_provider","name":"Internet Service Provider","rank":"38"}],"is_claimed":true,"trust_score":4.2,"website_url":"https://nordvpn.com","contact_info":{"city":"Panama City","email":"support@nordvpn.com","phone":"+44 131 463 6666","country":"PA"},"display_name":"NordVPN","website_title":"nordvpn.com","similar_business":[{"name":"Surfshark","domain":"surfshark.com"},{"name":"ExpressVPN","domain":"expressvpn.com"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Trustpilot Company Info","description":"Retrieve Trustpilot company profile data, including trust score, star rating, categories, contact info, and review response behavior.\n\n**Credit cost:** 1 credit per call","operationId":"post-trustpilot-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Trustpilot company URL or domain name.\n\n**Examples:**\n\n    https://www.trustpilot.com/review/nordvpn.com\n\nBoth the full Trustpilot review URL and the company domain are accepted.","schema":{"type":"string","description":"A Trustpilot company URL or domain name.\n\n**Examples:**\n\n    https://www.trustpilot.com/review/nordvpn.com\n\nBoth the full Trustpilot review URL and the company domain are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"stars":{"type":"integer"},"activity":{"type":"object","properties":{"is_claimed":{"type":"boolean"},"reply_behavior":{"type":"object","properties":{"reply_percentage":{"type":"number"},"average_days_to_reply":{"type":"number"}}}}},"is_closed":{"type":"boolean"},"breadcrumb":{"type":"object","properties":{"mid_level_display_name":{"type":"string"},"top_level_display_name":{"type":"string"},"bottom_level_display_name":{"type":"string"}}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"string"},"is_primary":{"type":"boolean"}}}},"is_claimed":{"type":"boolean"},"trust_score":{"type":"number"},"website_url":{"type":"string"},"contact_info":{"type":"object","properties":{"city":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"country":{"type":"string"}}},"display_name":{"type":"string"},"website_title":{"type":"string"},"similar_business":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"}}}}}},"examples":{"Get Trustpilot info for NordVPN":{"value":{"id":"51abc000000064000538d348","stars":4,"activity":{"is_claimed":true,"reply_behavior":{"reply_percentage":98.93,"average_days_to_reply":-0.34}},"is_closed":false,"breadcrumb":{"mid_level_display_name":"Internet & Software","top_level_display_name":"Electronics & Technology","bottom_level_display_name":"VPN Service"},"categories":[{"id":"vpn_service","name":"VPN Service","rank":"15","is_primary":true},{"id":"internet_service_provider","name":"Internet Service Provider","rank":"38"}],"is_claimed":true,"trust_score":4.2,"website_url":"https://nordvpn.com","contact_info":{"city":"Panama City","email":"support@nordvpn.com","phone":"+44 131 463 6666","country":"PA"},"display_name":"NordVPN","website_title":"nordvpn.com","similar_business":[{"name":"Surfshark","domain":"surfshark.com"},{"name":"ExpressVPN","domain":"expressvpn.com"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/stockx/trends":{"get":{"summary":"StockX Trends","description":"Retrieve trending products on StockX by category, with options to sort by featured, most active, or release date.\n\n**Credit cost:** 2 credits per call","operationId":"get-stockx-trends","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"StockX product category to retrieve trending items for.\n\nAccepted values:\n- `sneakers`: Trending sneakers\n- `streetwear`: Trending streetwear\n- `electronics`: Trending electronics\n- `trading cards`: Trending trading cards\n- `collectibles`: Trending collectibles\n- `apparel`: Trending apparel\n- `handbags`: Trending handbags\n- `watches`: Trending watches","schema":{"type":"string","description":"StockX product category to retrieve trending items for.\n\nAccepted values:\n- `sneakers`: Trending sneakers\n- `streetwear`: Trending streetwear\n- `electronics`: Trending electronics\n- `trading cards`: Trending trading cards\n- `collectibles`: Trending collectibles\n- `apparel`: Trending apparel\n- `handbags`: Trending handbags\n- `watches`: Trending watches"}},{"name":"sort_by","in":"query","required":false,"description":"Sort order for trending results.\n\n- `featured`: Featured/curated items (default)\n- `most_active`: Most actively traded items\n- `release_date`: Newest releases first","schema":{"type":"string","default":"featured","description":"Sort order for trending results.\n\n- `featured`: Featured/curated items (default)\n- `most_active`: Most actively traded items\n- `release_date`: Newest releases first"}},{"name":"country","in":"query","required":false,"description":"Country code for localized trending data.\n\n- `US`: United States\n- `FR`: France\n- `GB`: United Kingdom","schema":{"type":"string","default":"US","description":"Country code for localized trending data.\n\n- `US`: United States\n- `FR`: France\n- `GB`: United Kingdom"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"category":{"type":"string"},"release_date":{"type":"string"}}}},"examples":{"Get trending sneakers sorted by release date":{"value":[{"id":"6693bae8-39f1-4809-a6a3-b26c91a7aa5a","sku":"1J30-291-025/1J30-191-025","name":"A Bathing Ape Bape SK8 Sta Grey Gold White","slug":"a-bathing-ape-bape-sk8-sta-grey-gold-white","brand":"bape","image":"https://images.stockx.com/images/A-Bathing-Ape-Bape-SK8-Sta-Grey-Gold-White.jpg","category":"sneakers","release_date":"2023-04-14"},{"id":"0b450075-9f93-4423-8677-4d8029ff7348","sku":"DZ5485-612","name":"Jordan 1 Retro High OG Chicago 2022","slug":"air-jordan-1-high-og-chicago-2022","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-1-Retro-High-OG-Chicago-2022.jpg","category":"sneakers","release_date":"2023-05-06"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"StockX Trends","description":"Retrieve trending products on StockX by category, with options to sort by featured, most active, or release date.\n\n**Credit cost:** 2 credits per call","operationId":"post-stockx-trends","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"StockX product category to retrieve trending items for.\n\nAccepted values:\n- `sneakers`: Trending sneakers\n- `streetwear`: Trending streetwear\n- `electronics`: Trending electronics\n- `trading cards`: Trending trading cards\n- `collectibles`: Trending collectibles\n- `apparel`: Trending apparel\n- `handbags`: Trending handbags\n- `watches`: Trending watches","schema":{"type":"string","description":"StockX product category to retrieve trending items for.\n\nAccepted values:\n- `sneakers`: Trending sneakers\n- `streetwear`: Trending streetwear\n- `electronics`: Trending electronics\n- `trading cards`: Trending trading cards\n- `collectibles`: Trending collectibles\n- `apparel`: Trending apparel\n- `handbags`: Trending handbags\n- `watches`: Trending watches"}},{"name":"sort_by","in":"query","required":false,"description":"Sort order for trending results.\n\n- `featured`: Featured/curated items (default)\n- `most_active`: Most actively traded items\n- `release_date`: Newest releases first","schema":{"type":"string","default":"featured","description":"Sort order for trending results.\n\n- `featured`: Featured/curated items (default)\n- `most_active`: Most actively traded items\n- `release_date`: Newest releases first"}},{"name":"country","in":"query","required":false,"description":"Country code for localized trending data.\n\n- `US`: United States\n- `FR`: France\n- `GB`: United Kingdom","schema":{"type":"string","default":"US","description":"Country code for localized trending data.\n\n- `US`: United States\n- `FR`: France\n- `GB`: United Kingdom"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"category":{"type":"string"},"release_date":{"type":"string"}}}},"examples":{"Get trending sneakers sorted by release date":{"value":[{"id":"6693bae8-39f1-4809-a6a3-b26c91a7aa5a","sku":"1J30-291-025/1J30-191-025","name":"A Bathing Ape Bape SK8 Sta Grey Gold White","slug":"a-bathing-ape-bape-sk8-sta-grey-gold-white","brand":"bape","image":"https://images.stockx.com/images/A-Bathing-Ape-Bape-SK8-Sta-Grey-Gold-White.jpg","category":"sneakers","release_date":"2023-04-14"},{"id":"0b450075-9f93-4423-8677-4d8029ff7348","sku":"DZ5485-612","name":"Jordan 1 Retro High OG Chicago 2022","slug":"air-jordan-1-high-og-chicago-2022","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-1-Retro-High-OG-Chicago-2022.jpg","category":"sneakers","release_date":"2023-05-06"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/stockx/search":{"get":{"summary":"StockX Search","description":"Search StockX for products by name, brand, SKU, or slug and receive a list of matching items with product IDs, slugs, images, and colorways.\n\n**Credit cost:** 2 credits per call","operationId":"get-stockx-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search query for StockX products. Can be a product name, brand, SKU, or slug.\n\n**Examples:**\n\n    Air Jordan Retro\n\nAll three formats are supported: keyword phrases, style codes (SKU), and product slugs.","schema":{"type":"string","description":"Search query for StockX products. Can be a product name, brand, SKU, or slug.\n\n**Examples:**\n\n    Air Jordan Retro\n\nAll three formats are supported: keyword phrases, style codes (SKU), and product slugs."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"nullable":true},"name":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"category":{"type":"string"},"colorway":{"type":"string"}}}},"examples":{"Search for 'Air Jordan Retro' products":{"value":[{"id":"9acafeb5-bc4a-4d66-bc3a-4899d2e64775","sku":null,"name":"Jordan 4 Retro","slug":"air-jordan-4-retro-toro-bravo-2026","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-4-Retro-Toro-Bravo-2026-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1775837171","category":"sneakers","colorway":"Toro Bravo (2026)"},{"id":"019c8c79-5739-7557-8d1f-4825eb64694d","sku":null,"name":"Jordan 4 Retro OG","slug":"air-jordan-4-retro-og-nigel-sylvester-brick-after-brick","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-4-Retro-OG-Nigel-Sylvester-Sail-Cinnabar-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1777572762","category":"sneakers","colorway":"Nigel Sylvester Brick After Brick"},{"id":"019cfdb4-3545-7b24-8773-11f7411145fb","sku":null,"name":"Jordan 1 Retro Low OG SP","slug":"air-jordan-1-retro-low-og-sp-travis-scott-sail-tropical-pink","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-1-Retro-Low-OG-SP-Travis-Scott-Sail-Tropical-Pink-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1779381546","category":"sneakers","colorway":"Travis Scott Sail Tropical Pink"},{"id":"15795a80-5cc8-4d2d-9ed0-20250d83be7f","sku":null,"name":"Jordan 4 Retro","slug":"air-jordan-4-retro-black-cat-2025","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-4-Retro-Black-Cat-2025-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1762549807","category":"sneakers","colorway":"Black Cat (2025)"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"StockX Search","description":"Search StockX for products by name, brand, SKU, or slug and receive a list of matching items with product IDs, slugs, images, and colorways.\n\n**Credit cost:** 2 credits per call","operationId":"post-stockx-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search query for StockX products. Can be a product name, brand, SKU, or slug.\n\n**Examples:**\n\n    Air Jordan Retro\n\nAll three formats are supported: keyword phrases, style codes (SKU), and product slugs.","schema":{"type":"string","description":"Search query for StockX products. Can be a product name, brand, SKU, or slug.\n\n**Examples:**\n\n    Air Jordan Retro\n\nAll three formats are supported: keyword phrases, style codes (SKU), and product slugs."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"nullable":true},"name":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"category":{"type":"string"},"colorway":{"type":"string"}}}},"examples":{"Search for 'Air Jordan Retro' products":{"value":[{"id":"9acafeb5-bc4a-4d66-bc3a-4899d2e64775","sku":null,"name":"Jordan 4 Retro","slug":"air-jordan-4-retro-toro-bravo-2026","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-4-Retro-Toro-Bravo-2026-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1775837171","category":"sneakers","colorway":"Toro Bravo (2026)"},{"id":"019c8c79-5739-7557-8d1f-4825eb64694d","sku":null,"name":"Jordan 4 Retro OG","slug":"air-jordan-4-retro-og-nigel-sylvester-brick-after-brick","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-4-Retro-OG-Nigel-Sylvester-Sail-Cinnabar-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1777572762","category":"sneakers","colorway":"Nigel Sylvester Brick After Brick"},{"id":"019cfdb4-3545-7b24-8773-11f7411145fb","sku":null,"name":"Jordan 1 Retro Low OG SP","slug":"air-jordan-1-retro-low-og-sp-travis-scott-sail-tropical-pink","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-1-Retro-Low-OG-SP-Travis-Scott-Sail-Tropical-Pink-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1779381546","category":"sneakers","colorway":"Travis Scott Sail Tropical Pink"},{"id":"15795a80-5cc8-4d2d-9ed0-20250d83be7f","sku":null,"name":"Jordan 4 Retro","slug":"air-jordan-4-retro-black-cat-2025","brand":"Jordan","image":"https://images.stockx.com/images/Air-Jordan-4-Retro-Black-Cat-2025-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1762549807","category":"sneakers","colorway":"Black Cat (2025)"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/stockx/product":{"get":{"summary":"StockX Product","description":"Retrieve detailed product information from StockX, including market prices, bid/ask data, size variants, and product metadata.\n\n**Credit cost:** 2 credits per call","operationId":"get-stockx-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A StockX product slug.\n\n**Examples:**\n\n    nike-air-max-1-travis-scott-wheat\n\n**Note:** Use product slugs, not internal UUIDs (e.g. do NOT use `c318bbcc-312a-4396-9252-698c203d1dea`). Find slugs in the product URL on stockx.com.","schema":{"type":"string","description":"A StockX product slug.\n\n**Examples:**\n\n    nike-air-max-1-travis-scott-wheat\n\n**Note:** Use product slugs, not internal UUIDs (e.g. do NOT use `c318bbcc-312a-4396-9252-698c203d1dea`). Find slugs in the product URL on stockx.com."}},{"name":"country","in":"query","required":false,"description":"Country code for localized pricing and availability.\n\n- `US`: United States (default)\n- `FR`: France\n- `GB`: United Kingdom\n- `SV`: El Salvador\n\n**Example:** `US`","schema":{"type":"string","default":"US","description":"Country code for localized pricing and availability.\n\n- `US`: United States (default)\n- `FR`: France\n- `GB`: United Kingdom\n- `SV`: El Salvador\n\n**Example:** `US`"}},{"name":"currency","in":"query","required":false,"description":"Currency code for price display.\n\n- `USD`: US Dollar (default)\n- `EUR`: Euro\n- `GBP`: British Pound\n\n**Example:** `USD`","schema":{"type":"string","default":"USD","description":"Currency code for price display.\n\n- `USD`: US Dollar (default)\n- `EUR`: Euro\n- `GBP`: British Pound\n\n**Example:** `USD`"}},{"name":"language","in":"query","required":false,"description":"Language code for localized content.\n\n- `en-US`: English (default)\n- `fr-FR`: French\n- `en-GB`: British English\n\n**Example:** `en-US`","schema":{"type":"string","default":"en-US","description":"Language code for localized content.\n\n- `en-US`: English (default)\n- `fr-FR`: French\n- `en-GB`: British English\n\n**Example:** `en-US`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"model":{"type":"string"},"gender":{"type":"string"},"market":{"type":"object","properties":{"bids":{"type":"object","properties":{"lowest_ask":{"type":"integer"},"highest_bid":{"type":"integer"},"number_asks":{"type":"integer"},"number_bids":{"type":"integer"}}},"sales":{"type":"object","properties":{"last_sale":{"type":"integer"},"change_value":{"type":"integer"},"sales_last_72h":{"type":"integer"},"change_percentage":{"type":"number"}}},"shipping":{"type":"object","properties":{"standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"nullable":true},"latest_delivery_date":{"nullable":true},"expected_delivery_date":{"nullable":true}}},"express_next_day":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_expedited":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}}}}}},"traits":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"category":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"gtins":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"identifier":{"type":"string"}}}},"sizes":{"type":"array","items":{"type":"object","properties":{"size":{"type":"string"},"type":{"type":"string"}}}},"market":{"type":"object","properties":{"bids":{"type":"object","properties":{"lowest_ask":{"type":"integer"},"highest_bid":{"type":"integer"},"number_asks":{"type":"integer"},"number_bids":{"type":"integer"}}},"sales":{"type":"object","properties":{"last_sale":{"type":"integer"},"change_value":{"type":"integer"},"sales_last_72h":{"type":"integer"},"change_percentage":{"type":"number"}}},"shipping":{"type":"object","properties":{"standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"nullable":true},"latest_delivery_date":{"nullable":true},"expected_delivery_date":{"nullable":true}}},"express_next_day":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_expedited":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}}}}}},"traits":{"type":"object","properties":{"size":{"type":"string"}}}}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"level":{"type":"integer"}}}},"description":{"type":"string"},"small_image":{"type":"string"},"thumb_image":{"type":"string"},"primary_category":{"type":"string"}}},"examples":{"Get Nike Air Max 1 Travis Scott product":{"value":{"id":"c318bbcc-312a-4396-9252-698c203d1dea","sku":"DO9392-700","name":"Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold","slug":"nike-air-max-1-travis-scott-wheat","brand":"Nike","image":"https://images.stockx.com/images/Nike-Air-Max-1-Travis-Scott-Wheat-Product.jpg?fit=fill&bg=FFFFFF&w=700&h=500&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1738193358","model":"Nike Air Max 1","gender":"men","market":{"bids":{"lowest_ask":168,"highest_bid":270,"number_asks":373,"number_bids":272},"sales":{"last_sale":303,"change_value":-7,"sales_last_72h":6,"change_percentage":-0.0231},"shipping":{"standard":{"count":373,"lowest_ask":168,"inventory_type":null,"latest_delivery_date":null,"expected_delivery_date":null},"express_next_day":{"count":5,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-03T21:00:00.000Z","expected_delivery_date":"2026-06-03T21:00:00.000Z"},"express_standard":{"count":30,"lowest_ask":168,"inventory_type":"DFS","latest_delivery_date":"2026-06-09T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"},"express_expedited":{"count":5,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-04T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"}}},"traits":[{"name":"Style","value":"DO9392-700"},{"name":"Colorway","value":"Saturn Gold/Tea Tree Mist/Tent"},{"name":"Retail Price","value":"150"},{"name":"Release Date","value":"2022-05-27"},{"name":"Included Accessories","value":"Grey extra laces, Special paper "},{"name":"Featured","value":"false"},{"name":"Product Line","value":"Nike Air Max"}],"category":"sneakers","variants":[{"id":"c7e40ad8-030e-4444-baaf-30569c52347b","gtins":[{"type":"UPC","identifier":"195867114073"}],"sizes":[{"size":"US M 4","type":"us m"},{"size":"UK 3.5","type":"uk"},{"size":"CM 23","type":"cm"},{"size":"KR 230","type":"kr"},{"size":"EU 36","type":"eu"},{"size":"US W 5.5","type":"us w"}],"market":{"bids":{"lowest_ask":168,"highest_bid":90,"number_asks":15,"number_bids":8},"sales":{"last_sale":168,"change_value":17,"sales_last_72h":0,"change_percentage":0.1019},"shipping":{"standard":{"count":15,"lowest_ask":168,"inventory_type":null,"latest_delivery_date":null,"expected_delivery_date":null},"express_next_day":{"count":1,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-03T21:00:00.000Z","expected_delivery_date":"2026-06-03T21:00:00.000Z"},"express_standard":{"count":2,"lowest_ask":168,"inventory_type":"DFS","latest_delivery_date":"2026-06-09T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"},"express_expedited":{"count":1,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-04T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"}}},"traits":{"size":"4"}}],"breadcrumbs":[{"url":"/","name":"Home","level":1},{"url":"/sneakers","name":"sneakers","level":2},{"url":"/nike","name":"Nike","level":3},{"url":"/nike/air-max","name":"Air Max","level":4},{"url":"/nike/air-max/1","name":"1","level":5},{"url":"/nike-air-max-1-travis-scott-wheat","name":"Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold","level":6}],"description":"In collaboration with Travis Scott's record label Cactus Jack, the Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold pays homage to outdoor exploration and the Nike ACG Pocket Knife hiking shoe. It boasts a light yellow layered mesh upper with matching Durabuck overlays and reversed Swoosh logos. A drawstring Gillie lacing system nods to common features on trail runners. At the base, a yellowed sole with a cloudy Air unit adds the finishing touch.\n<br>\n<br>\nThe Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold released in May of 2022 and retailed for $150.","small_image":"https://images.stockx.com/images/Nike-Air-Max-1-Travis-Scott-Wheat-Product.jpg?fit=fill&bg=FFFFFF&w=300&h=214&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1738193358","thumb_image":"https://images.stockx.com/images/Nike-Air-Max-1-Travis-Scott-Wheat-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1738193358","primary_category":"Air Max"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"StockX Product","description":"Retrieve detailed product information from StockX, including market prices, bid/ask data, size variants, and product metadata.\n\n**Credit cost:** 2 credits per call","operationId":"post-stockx-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A StockX product slug.\n\n**Examples:**\n\n    nike-air-max-1-travis-scott-wheat\n\n**Note:** Use product slugs, not internal UUIDs (e.g. do NOT use `c318bbcc-312a-4396-9252-698c203d1dea`). Find slugs in the product URL on stockx.com.","schema":{"type":"string","description":"A StockX product slug.\n\n**Examples:**\n\n    nike-air-max-1-travis-scott-wheat\n\n**Note:** Use product slugs, not internal UUIDs (e.g. do NOT use `c318bbcc-312a-4396-9252-698c203d1dea`). Find slugs in the product URL on stockx.com."}},{"name":"country","in":"query","required":false,"description":"Country code for localized pricing and availability.\n\n- `US`: United States (default)\n- `FR`: France\n- `GB`: United Kingdom\n- `SV`: El Salvador\n\n**Example:** `US`","schema":{"type":"string","default":"US","description":"Country code for localized pricing and availability.\n\n- `US`: United States (default)\n- `FR`: France\n- `GB`: United Kingdom\n- `SV`: El Salvador\n\n**Example:** `US`"}},{"name":"currency","in":"query","required":false,"description":"Currency code for price display.\n\n- `USD`: US Dollar (default)\n- `EUR`: Euro\n- `GBP`: British Pound\n\n**Example:** `USD`","schema":{"type":"string","default":"USD","description":"Currency code for price display.\n\n- `USD`: US Dollar (default)\n- `EUR`: Euro\n- `GBP`: British Pound\n\n**Example:** `USD`"}},{"name":"language","in":"query","required":false,"description":"Language code for localized content.\n\n- `en-US`: English (default)\n- `fr-FR`: French\n- `en-GB`: British English\n\n**Example:** `en-US`","schema":{"type":"string","default":"en-US","description":"Language code for localized content.\n\n- `en-US`: English (default)\n- `fr-FR`: French\n- `en-GB`: British English\n\n**Example:** `en-US`"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"model":{"type":"string"},"gender":{"type":"string"},"market":{"type":"object","properties":{"bids":{"type":"object","properties":{"lowest_ask":{"type":"integer"},"highest_bid":{"type":"integer"},"number_asks":{"type":"integer"},"number_bids":{"type":"integer"}}},"sales":{"type":"object","properties":{"last_sale":{"type":"integer"},"change_value":{"type":"integer"},"sales_last_72h":{"type":"integer"},"change_percentage":{"type":"number"}}},"shipping":{"type":"object","properties":{"standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"nullable":true},"latest_delivery_date":{"nullable":true},"expected_delivery_date":{"nullable":true}}},"express_next_day":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_expedited":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}}}}}},"traits":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"category":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"gtins":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"identifier":{"type":"string"}}}},"sizes":{"type":"array","items":{"type":"object","properties":{"size":{"type":"string"},"type":{"type":"string"}}}},"market":{"type":"object","properties":{"bids":{"type":"object","properties":{"lowest_ask":{"type":"integer"},"highest_bid":{"type":"integer"},"number_asks":{"type":"integer"},"number_bids":{"type":"integer"}}},"sales":{"type":"object","properties":{"last_sale":{"type":"integer"},"change_value":{"type":"integer"},"sales_last_72h":{"type":"integer"},"change_percentage":{"type":"number"}}},"shipping":{"type":"object","properties":{"standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"nullable":true},"latest_delivery_date":{"nullable":true},"expected_delivery_date":{"nullable":true}}},"express_next_day":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_standard":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}},"express_expedited":{"type":"object","properties":{"count":{"type":"integer"},"lowest_ask":{"type":"integer"},"inventory_type":{"type":"string"},"latest_delivery_date":{"type":"string"},"expected_delivery_date":{"type":"string"}}}}}}},"traits":{"type":"object","properties":{"size":{"type":"string"}}}}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"level":{"type":"integer"}}}},"description":{"type":"string"},"small_image":{"type":"string"},"thumb_image":{"type":"string"},"primary_category":{"type":"string"}}},"examples":{"Get Nike Air Max 1 Travis Scott product":{"value":{"id":"c318bbcc-312a-4396-9252-698c203d1dea","sku":"DO9392-700","name":"Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold","slug":"nike-air-max-1-travis-scott-wheat","brand":"Nike","image":"https://images.stockx.com/images/Nike-Air-Max-1-Travis-Scott-Wheat-Product.jpg?fit=fill&bg=FFFFFF&w=700&h=500&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1738193358","model":"Nike Air Max 1","gender":"men","market":{"bids":{"lowest_ask":168,"highest_bid":270,"number_asks":373,"number_bids":272},"sales":{"last_sale":303,"change_value":-7,"sales_last_72h":6,"change_percentage":-0.0231},"shipping":{"standard":{"count":373,"lowest_ask":168,"inventory_type":null,"latest_delivery_date":null,"expected_delivery_date":null},"express_next_day":{"count":5,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-03T21:00:00.000Z","expected_delivery_date":"2026-06-03T21:00:00.000Z"},"express_standard":{"count":30,"lowest_ask":168,"inventory_type":"DFS","latest_delivery_date":"2026-06-09T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"},"express_expedited":{"count":5,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-04T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"}}},"traits":[{"name":"Style","value":"DO9392-700"},{"name":"Colorway","value":"Saturn Gold/Tea Tree Mist/Tent"},{"name":"Retail Price","value":"150"},{"name":"Release Date","value":"2022-05-27"},{"name":"Included Accessories","value":"Grey extra laces, Special paper "},{"name":"Featured","value":"false"},{"name":"Product Line","value":"Nike Air Max"}],"category":"sneakers","variants":[{"id":"c7e40ad8-030e-4444-baaf-30569c52347b","gtins":[{"type":"UPC","identifier":"195867114073"}],"sizes":[{"size":"US M 4","type":"us m"},{"size":"UK 3.5","type":"uk"},{"size":"CM 23","type":"cm"},{"size":"KR 230","type":"kr"},{"size":"EU 36","type":"eu"},{"size":"US W 5.5","type":"us w"}],"market":{"bids":{"lowest_ask":168,"highest_bid":90,"number_asks":15,"number_bids":8},"sales":{"last_sale":168,"change_value":17,"sales_last_72h":0,"change_percentage":0.1019},"shipping":{"standard":{"count":15,"lowest_ask":168,"inventory_type":null,"latest_delivery_date":null,"expected_delivery_date":null},"express_next_day":{"count":1,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-03T21:00:00.000Z","expected_delivery_date":"2026-06-03T21:00:00.000Z"},"express_standard":{"count":2,"lowest_ask":168,"inventory_type":"DFS","latest_delivery_date":"2026-06-09T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"},"express_expedited":{"count":1,"lowest_ask":170,"inventory_type":"CUSTODIAL","latest_delivery_date":"2026-06-04T21:00:00.000Z","expected_delivery_date":"2026-06-04T21:00:00.000Z"}}},"traits":{"size":"4"}}],"breadcrumbs":[{"url":"/","name":"Home","level":1},{"url":"/sneakers","name":"sneakers","level":2},{"url":"/nike","name":"Nike","level":3},{"url":"/nike/air-max","name":"Air Max","level":4},{"url":"/nike/air-max/1","name":"1","level":5},{"url":"/nike-air-max-1-travis-scott-wheat","name":"Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold","level":6}],"description":"In collaboration with Travis Scott's record label Cactus Jack, the Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold pays homage to outdoor exploration and the Nike ACG Pocket Knife hiking shoe. It boasts a light yellow layered mesh upper with matching Durabuck overlays and reversed Swoosh logos. A drawstring Gillie lacing system nods to common features on trail runners. At the base, a yellowed sole with a cloudy Air unit adds the finishing touch.\n<br>\n<br>\nThe Nike Air Max 1 Travis Scott Cactus Jack Saturn Gold released in May of 2022 and retailed for $150.","small_image":"https://images.stockx.com/images/Nike-Air-Max-1-Travis-Scott-Wheat-Product.jpg?fit=fill&bg=FFFFFF&w=300&h=214&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1738193358","thumb_image":"https://images.stockx.com/images/Nike-Air-Max-1-Travis-Scott-Wheat-Product.jpg?fit=fill&bg=FFFFFF&w=140&h=100&fm=webp&auto=compress&q=90&dpr=2&trim=color&updated_at=1738193358","primary_category":"Air Max"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/similarweb/domain":{"get":{"summary":"SimilarWeb Domain","description":"Retrieve website traffic and engagement metrics for any domain from SimilarWeb, including visits, bounce rate, top keywords, and traffic sources.\n\n**Credit cost:** 1 credit per call","operationId":"get-similarweb-domain","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name to retrieve traffic and engagement metrics for.\n\n**Examples:**\n\n    google.com\n\nProvide the bare domain without `https://` or `www.` prefixes.","schema":{"type":"string","description":"A domain name to retrieve traffic and engagement metrics for.\n\n**Examples:**\n\n    google.com\n\nProvide the bare domain without `https://` or `www.` prefixes."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"site_name":{"type":"string"},"engagments":{"type":"object","properties":{"year":{"type":"string"},"month":{"type":"string"},"visits":{"type":"string"},"bounce_rate":{"type":"string"},"time_on_site":{"type":"string"},"page_per_visit":{"type":"string"}}},"global_rank":{"type":"object","properties":{"rank":{"type":"integer"}}},"country_rank":{"type":"object","properties":{"rank":{"type":"integer"},"country":{"type":"integer"},"country_code":{"type":"string"}}},"top_keywords":{"type":"array","items":{"type":"object","properties":{"cpc":{"type":"number"},"name":{"type":"string"},"volume":{"type":"integer"},"estimated_value":{"type":"integer"}}}},"category_rank":{"type":"object","properties":{"rank":{"type":"string"},"category":{"type":"string"}}},"snapshot_date":{"type":"string"},"traffic_sources":{"type":"object","properties":{"mail":{"type":"number"},"direct":{"type":"number"},"search":{"type":"number"},"social":{"type":"number"},"referrals":{"type":"number"},"paid_referrals":{"type":"number"}}},"large_screenshot":{"type":"string"},"top_country_shares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"country":{"type":"integer"},"country_code":{"type":"string"}}}}}},"examples":{"Get SimilarWeb metrics for google.com":{"value":{"title":"","category":"computers_electronics_and_technology/search_engines","site_name":"google.com","engagments":{"year":"2024","month":"5","visits":"86249524745","bounce_rate":"0.28024037791407225","time_on_site":"641.4282025756406","page_per_visit":"8.752416969603086"},"global_rank":{"rank":1},"country_rank":{"rank":1,"country":840,"country_code":"US"},"top_keywords":[{"cpc":1.08870175,"name":"gmail","volume":107944750,"estimated_value":16490414},{"cpc":0.7102735625,"name":"google","volume":69586760,"estimated_value":6776722},{"cpc":0.40845490625,"name":"google maps","volume":59602370,"estimated_value":4539415}],"category_rank":{"rank":"1","category":"Computers_Electronics_and_Technology/Search_Engines"},"snapshot_date":"2024-05-01T00:00:00+00:00","traffic_sources":{"mail":0.0017641,"direct":0.9503452,"search":0.00488378,"social":0.0209163,"referrals":0.0214876,"paid_referrals":0.000602931},"large_screenshot":"https://site-images.similarcdn.com/image?url=google.com&t=1&s=1&h=eb35e0fbafa3eb290132ffdfe47187d950d68daaa659ec1bd4b4e834b8f16461","top_country_shares":[{"value":0.2648986,"country":840,"country_code":"US"},{"value":0.045608,"country":356,"country_code":"IN"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SimilarWeb Domain","description":"Retrieve website traffic and engagement metrics for any domain from SimilarWeb, including visits, bounce rate, top keywords, and traffic sources.\n\n**Credit cost:** 1 credit per call","operationId":"post-similarweb-domain","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name to retrieve traffic and engagement metrics for.\n\n**Examples:**\n\n    google.com\n\nProvide the bare domain without `https://` or `www.` prefixes.","schema":{"type":"string","description":"A domain name to retrieve traffic and engagement metrics for.\n\n**Examples:**\n\n    google.com\n\nProvide the bare domain without `https://` or `www.` prefixes."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"site_name":{"type":"string"},"engagments":{"type":"object","properties":{"year":{"type":"string"},"month":{"type":"string"},"visits":{"type":"string"},"bounce_rate":{"type":"string"},"time_on_site":{"type":"string"},"page_per_visit":{"type":"string"}}},"global_rank":{"type":"object","properties":{"rank":{"type":"integer"}}},"country_rank":{"type":"object","properties":{"rank":{"type":"integer"},"country":{"type":"integer"},"country_code":{"type":"string"}}},"top_keywords":{"type":"array","items":{"type":"object","properties":{"cpc":{"type":"number"},"name":{"type":"string"},"volume":{"type":"integer"},"estimated_value":{"type":"integer"}}}},"category_rank":{"type":"object","properties":{"rank":{"type":"string"},"category":{"type":"string"}}},"snapshot_date":{"type":"string"},"traffic_sources":{"type":"object","properties":{"mail":{"type":"number"},"direct":{"type":"number"},"search":{"type":"number"},"social":{"type":"number"},"referrals":{"type":"number"},"paid_referrals":{"type":"number"}}},"large_screenshot":{"type":"string"},"top_country_shares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"country":{"type":"integer"},"country_code":{"type":"string"}}}}}},"examples":{"Get SimilarWeb metrics for google.com":{"value":{"title":"","category":"computers_electronics_and_technology/search_engines","site_name":"google.com","engagments":{"year":"2024","month":"5","visits":"86249524745","bounce_rate":"0.28024037791407225","time_on_site":"641.4282025756406","page_per_visit":"8.752416969603086"},"global_rank":{"rank":1},"country_rank":{"rank":1,"country":840,"country_code":"US"},"top_keywords":[{"cpc":1.08870175,"name":"gmail","volume":107944750,"estimated_value":16490414},{"cpc":0.7102735625,"name":"google","volume":69586760,"estimated_value":6776722},{"cpc":0.40845490625,"name":"google maps","volume":59602370,"estimated_value":4539415}],"category_rank":{"rank":"1","category":"Computers_Electronics_and_Technology/Search_Engines"},"snapshot_date":"2024-05-01T00:00:00+00:00","traffic_sources":{"mail":0.0017641,"direct":0.9503452,"search":0.00488378,"social":0.0209163,"referrals":0.0214876,"paid_referrals":0.000602931},"large_screenshot":"https://site-images.similarcdn.com/image?url=google.com&t=1&s=1&h=eb35e0fbafa3eb290132ffdfe47187d950d68daaa659ec1bd4b4e834b8f16461","top_country_shares":[{"value":0.2648986,"country":840,"country_code":"US"},{"value":0.045608,"country":356,"country_code":"IN"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/producthunt/product/info":{"get":{"summary":"ProductHunt Product Info","description":"Retrieve product data from ProductHunt, including tagline, categories, screenshots, reviews rating, and social links.\n\n**Credit cost:** 1 credit per call","operationId":"get-producthunt-product-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A ProductHunt product URL or product slug.\n\n**Examples:**\n\n    https://www.producthunt.com/products/miro\n\nBoth the full ProductHunt URL and the product slug are accepted.","schema":{"type":"string","description":"A ProductHunt product URL or product slug.\n\n**Examples:**\n\n    https://www.producthunt.com/products/miro\n\nBoth the full ProductHunt URL and the product slug are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tagline":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"description":{"type":"string"},"posts_count":{"nullable":true},"screenshots":{"type":"array","items":{"type":"string"}},"pricing_type":{"nullable":true},"social_links":{"type":"object","properties":{"website":{"type":"string"}}},"reviews_count":{"nullable":true},"reviews_rating":{"type":"number"},"reviewers_count":{"type":"integer"}}},"examples":{"Product Hunt page for Miro":{"value":{"id":"111772","logo":"https://ph-files.imgix.net/01cca4e0-cc5d-4b42-931e-c76756e76f07.jpeg","name":"Miro","slug":"miro","tagline":"The visual collaboration platform for every team","categories":[{"name":"Software Engineering"}],"description":"The online collaborative whiteboard platform that enables distributed teams to work effectively together, from brainstorming with digital sticky notes to planning and managing agile workflows.","posts_count":null,"screenshots":["https://ph-files.imgix.net/8a41989e-dfd9-4002-8c1d-8a8ae637ce66.png","https://ph-files.imgix.net/385889b3-c385-4e5b-b414-32eeb68fa5f4.png","https://ph-files.imgix.net/8d508744-c0f3-471a-a355-8f907ab8ca10.png"],"pricing_type":null,"social_links":{"website":"https://miro.com"},"reviews_count":null,"reviews_rating":4.88,"reviewers_count":108}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ProductHunt Product Info","description":"Retrieve product data from ProductHunt, including tagline, categories, screenshots, reviews rating, and social links.\n\n**Credit cost:** 1 credit per call","operationId":"post-producthunt-product-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A ProductHunt product URL or product slug.\n\n**Examples:**\n\n    https://www.producthunt.com/products/miro\n\nBoth the full ProductHunt URL and the product slug are accepted.","schema":{"type":"string","description":"A ProductHunt product URL or product slug.\n\n**Examples:**\n\n    https://www.producthunt.com/products/miro\n\nBoth the full ProductHunt URL and the product slug are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tagline":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"description":{"type":"string"},"posts_count":{"nullable":true},"screenshots":{"type":"array","items":{"type":"string"}},"pricing_type":{"nullable":true},"social_links":{"type":"object","properties":{"website":{"type":"string"}}},"reviews_count":{"nullable":true},"reviews_rating":{"type":"number"},"reviewers_count":{"type":"integer"}}},"examples":{"Product Hunt page for Miro":{"value":{"id":"111772","logo":"https://ph-files.imgix.net/01cca4e0-cc5d-4b42-931e-c76756e76f07.jpeg","name":"Miro","slug":"miro","tagline":"The visual collaboration platform for every team","categories":[{"name":"Software Engineering"}],"description":"The online collaborative whiteboard platform that enables distributed teams to work effectively together, from brainstorming with digital sticky notes to planning and managing agile workflows.","posts_count":null,"screenshots":["https://ph-files.imgix.net/8a41989e-dfd9-4002-8c1d-8a8ae637ce66.png","https://ph-files.imgix.net/385889b3-c385-4e5b-b414-32eeb68fa5f4.png","https://ph-files.imgix.net/8d508744-c0f3-471a-a355-8f907ab8ca10.png"],"pricing_type":null,"social_links":{"website":"https://miro.com"},"reviews_count":null,"reviews_rating":4.88,"reviewers_count":108}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/pagesjaunes/search":{"get":{"summary":"PagesJaunes Search","description":"Search PagesJaunes for French local businesses by category and location, returning paginated results with contact details and ratings.\n\n**Credit cost:** 1 credit per call","operationId":"get-pagesjaunes-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid PagesJaunes search URL.\n\n**Example:**\n\n    https://www.pagesjaunes.fr/annuaire/chercherlespros?quoiqui=Dentiste&ou=Toulouse+(31000)&univers=pagesjaunes&idOu=\n\nYou can customize the search by changing the `quoiqui` (what/who) and `ou` (where) parameters in the URL.\n\n**Note:** URL-encode the `&` as `%26` when passing the full URL as a GET parameter value.","schema":{"type":"string","description":"A valid PagesJaunes search URL.\n\n**Example:**\n\n    https://www.pagesjaunes.fr/annuaire/chercherlespros?quoiqui=Dentiste&ou=Toulouse+(31000)&univers=pagesjaunes&idOu=\n\nYou can customize the search by changing the `quoiqui` (what/who) and `ou` (where) parameters in the URL.\n\n**Note:** URL-encode the `&` as `%26` when passing the full URL as a GET parameter value."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"activity":{"type":"string"},"image_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for dentists in Toulouse":{"value":{"results":[{"id":"56824689","url":"https://www.pagesjaunes.fr/pros/56824689","name":"Agustin Mayo","tags":["détartrage dentaire","radiologie dentaire","sur rendez-vous","blanchiment"],"address":"13 place Lafourcade 31400 Toulouse","activity":"Chirurgien-dentiste","image_url":"https://www.pagesjaunes.fr/media/newdam/preset-thumbnail-lr-health/5c/33/7e/00/00/f0/04/18/50/c1/5d415c337e0000f0041850c1/5d415c337e0000f0041850c2.jpg"},{"id":"62118760","url":"https://www.pagesjaunes.fr/pros/62118760","name":"Association Centre de Santé Toulouse Bayard","tags":["soin bucco-dentaire","chirurgie dentaire","blanchiment dentaire"],"address":"43 rue Bayard 31000 Toulouse","activity":"Centre dentaire"},{"id":"54123915","url":"https://www.pagesjaunes.fr/pros/54123915","name":"Fabrice Chapsal","tags":["Conventionné"],"rating":5,"address":"Centre Medical Croix De Pierre 4 boulevard Deodat de Severac 31300 Toulouse","activity":"Chirurgien-dentiste","reviews_count":1}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"total_pages":37,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PagesJaunes Search","description":"Search PagesJaunes for French local businesses by category and location, returning paginated results with contact details and ratings.\n\n**Credit cost:** 1 credit per call","operationId":"post-pagesjaunes-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid PagesJaunes search URL.\n\n**Example:**\n\n    https://www.pagesjaunes.fr/annuaire/chercherlespros?quoiqui=Dentiste&ou=Toulouse+(31000)&univers=pagesjaunes&idOu=\n\nYou can customize the search by changing the `quoiqui` (what/who) and `ou` (where) parameters in the URL.\n\n**Note:** URL-encode the `&` as `%26` when passing the full URL as a GET parameter value.","schema":{"type":"string","description":"A valid PagesJaunes search URL.\n\n**Example:**\n\n    https://www.pagesjaunes.fr/annuaire/chercherlespros?quoiqui=Dentiste&ou=Toulouse+(31000)&univers=pagesjaunes&idOu=\n\nYou can customize the search by changing the `quoiqui` (what/who) and `ou` (where) parameters in the URL.\n\n**Note:** URL-encode the `&` as `%26` when passing the full URL as a GET parameter value."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"activity":{"type":"string"},"image_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for dentists in Toulouse":{"value":{"results":[{"id":"56824689","url":"https://www.pagesjaunes.fr/pros/56824689","name":"Agustin Mayo","tags":["détartrage dentaire","radiologie dentaire","sur rendez-vous","blanchiment"],"address":"13 place Lafourcade 31400 Toulouse","activity":"Chirurgien-dentiste","image_url":"https://www.pagesjaunes.fr/media/newdam/preset-thumbnail-lr-health/5c/33/7e/00/00/f0/04/18/50/c1/5d415c337e0000f0041850c1/5d415c337e0000f0041850c2.jpg"},{"id":"62118760","url":"https://www.pagesjaunes.fr/pros/62118760","name":"Association Centre de Santé Toulouse Bayard","tags":["soin bucco-dentaire","chirurgie dentaire","blanchiment dentaire"],"address":"43 rue Bayard 31000 Toulouse","activity":"Centre dentaire"},{"id":"54123915","url":"https://www.pagesjaunes.fr/pros/54123915","name":"Fabrice Chapsal","tags":["Conventionné"],"rating":5,"address":"Centre Medical Croix De Pierre 4 boulevard Deodat de Severac 31300 Toulouse","activity":"Chirurgien-dentiste","reviews_count":1}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"total_pages":37,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/pagesjaunes/page/info":{"get":{"summary":"PagesJaunes Page Info","description":"Retrieve detailed business information from a PagesJaunes page, including contact details, opening hours, services, payment methods, and SIREN number.\n\n**Credit cost:** 1 credit per call","operationId":"get-pagesjaunes-page-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A PagesJaunes business page URL or business ID.\n\n**Examples:**\n\n    https://www.pagesjaunes.fr/pros/56824689\n\nBoth the full PagesJaunes URL and the numeric business ID are accepted.","schema":{"type":"string","description":"A PagesJaunes business page URL or business ID.\n\n**Examples:**\n\n    https://www.pagesjaunes.fr/pros/56824689\n\nBoth the full PagesJaunes URL and the numeric business ID are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"},"activity":{"type":"string"},"services":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}}},"business_info":{"type":"object","properties":{"siren":{"type":"string"},"forme_juridique":{"type":"string"},"effectif_entreprise":{"type":"string"},"creation_d_entreprise":{"type":"string"}}},"opening_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}}},"payment_methods":{"type":"array","items":{"type":"string"}}}},"examples":{"Get PagesJaunes page for dentist Agustin Mayo":{"value":{"url":"https://www.pagesjaunes.fr/pros/56824689","name":"Agustin Mayo","phone":"05 61 53 77 35","address":"13 place Lafourcade 31400 Toulouse","activity":"Chirurgien-dentiste","services":["détartrage dentaire","radiologie dentaire","sur rendez-vous","blanchiment","endodontie","implantologie dentaire","urgences dentaires"],"websites":[{"url":"https://www.facebook.com/dentistetoulouse/","type":"facebook"},{"url":"https://www.docteurmayo.fr","type":"website"}],"business_info":{"siren":"839625662","forme_juridique":"5785","effectif_entreprise":"3 à 5 salariés","creation_d_entreprise":"2 janvier 2018"},"opening_hours":[{"day":"Lundi","hours":"09h00 - 18h00"},{"day":"Mardi","hours":"09h00 - 18h00"},{"day":"Mercredi","hours":"09h00 - 18h00"},{"day":"Jeudi","hours":"09h00 - 18h00"},{"day":"Vendredi","hours":"09h00 - 18h00"}],"payment_methods":["Espèces","Visa","CB","Paypal","Mastercard","Virement bancaire"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"PagesJaunes Page Info","description":"Retrieve detailed business information from a PagesJaunes page, including contact details, opening hours, services, payment methods, and SIREN number.\n\n**Credit cost:** 1 credit per call","operationId":"post-pagesjaunes-page-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A PagesJaunes business page URL or business ID.\n\n**Examples:**\n\n    https://www.pagesjaunes.fr/pros/56824689\n\nBoth the full PagesJaunes URL and the numeric business ID are accepted.","schema":{"type":"string","description":"A PagesJaunes business page URL or business ID.\n\n**Examples:**\n\n    https://www.pagesjaunes.fr/pros/56824689\n\nBoth the full PagesJaunes URL and the numeric business ID are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"},"activity":{"type":"string"},"services":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}}},"business_info":{"type":"object","properties":{"siren":{"type":"string"},"forme_juridique":{"type":"string"},"effectif_entreprise":{"type":"string"},"creation_d_entreprise":{"type":"string"}}},"opening_hours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"hours":{"type":"string"}}}},"payment_methods":{"type":"array","items":{"type":"string"}}}},"examples":{"Get PagesJaunes page for dentist Agustin Mayo":{"value":{"url":"https://www.pagesjaunes.fr/pros/56824689","name":"Agustin Mayo","phone":"05 61 53 77 35","address":"13 place Lafourcade 31400 Toulouse","activity":"Chirurgien-dentiste","services":["détartrage dentaire","radiologie dentaire","sur rendez-vous","blanchiment","endodontie","implantologie dentaire","urgences dentaires"],"websites":[{"url":"https://www.facebook.com/dentistetoulouse/","type":"facebook"},{"url":"https://www.docteurmayo.fr","type":"website"}],"business_info":{"siren":"839625662","forme_juridique":"5785","effectif_entreprise":"3 à 5 salariés","creation_d_entreprise":"2 janvier 2018"},"opening_hours":[{"day":"Lundi","hours":"09h00 - 18h00"},{"day":"Mardi","hours":"09h00 - 18h00"},{"day":"Mercredi","hours":"09h00 - 18h00"},{"day":"Jeudi","hours":"09h00 - 18h00"},{"day":"Vendredi","hours":"09h00 - 18h00"}],"payment_methods":["Espèces","Visa","CB","Paypal","Mastercard","Virement bancaire"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/owler/search":{"get":{"summary":"Owler Search","description":"Search for companies on Owler by name or keyword, returning a list of matching companies with slugs, logos, domains, and profile URLs.\n\n**Credit cost:** 1 credit per call","operationId":"get-owler-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The company name or keyword to search for on Owler.\n\n**Examples:**\n\n    tesla\n\nThe API returns a list of matching companies from Owler's database, including their name, slug, logo, domain, and Owler profile URL.","schema":{"type":"string","description":"The company name or keyword to search for on Owler.\n\n**Examples:**\n\n    tesla\n\nThe API returns a list of matching companies from Owler's database, including their name, slug, logo, domain, and Owler profile URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"domain":{"type":"string"}}}},"examples":{"Search for companies matching 'norton'":{"value":[{"id":"15254378","url":"https://www.owler.com/company/nortonlifelock","logo":"https://s3.amazonaws.com/owler-image/logo/nortonlifelock_owler_20211115_162831_original.png","name":"NortonLifeLock, Inc.","slug":"nortonlifelock","domain":"nortonlifelock.com"},{"id":"145118","url":"https://www.owler.com/company/norton-rose-fulbright","logo":"https://s3.amazonaws.com/owler-image/logo/norton-rose-fulbright_owler_20241206_222941_original.jpg","name":"Norton Rose Fulbright, LLP","slug":"norton-rose-fulbright","domain":"nortonrosefulbright.com"},{"id":"191474","url":"https://www.owler.com/company/norton-antivirus","logo":"https://s3.amazonaws.com/owler-image/logo/norton-antivirus_owler_20200309_064538_original.png","name":"Norton AntiVirus","slug":"norton-antivirus","domain":"norton.com"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Owler Search","description":"Search for companies on Owler by name or keyword, returning a list of matching companies with slugs, logos, domains, and profile URLs.\n\n**Credit cost:** 1 credit per call","operationId":"post-owler-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The company name or keyword to search for on Owler.\n\n**Examples:**\n\n    tesla\n\nThe API returns a list of matching companies from Owler's database, including their name, slug, logo, domain, and Owler profile URL.","schema":{"type":"string","description":"The company name or keyword to search for on Owler.\n\n**Examples:**\n\n    tesla\n\nThe API returns a list of matching companies from Owler's database, including their name, slug, logo, domain, and Owler profile URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"domain":{"type":"string"}}}},"examples":{"Search for companies matching 'norton'":{"value":[{"id":"15254378","url":"https://www.owler.com/company/nortonlifelock","logo":"https://s3.amazonaws.com/owler-image/logo/nortonlifelock_owler_20211115_162831_original.png","name":"NortonLifeLock, Inc.","slug":"nortonlifelock","domain":"nortonlifelock.com"},{"id":"145118","url":"https://www.owler.com/company/norton-rose-fulbright","logo":"https://s3.amazonaws.com/owler-image/logo/norton-rose-fulbright_owler_20241206_222941_original.jpg","name":"Norton Rose Fulbright, LLP","slug":"norton-rose-fulbright","domain":"nortonrosefulbright.com"},{"id":"191474","url":"https://www.owler.com/company/norton-antivirus","logo":"https://s3.amazonaws.com/owler-image/logo/norton-antivirus_owler_20200309_064538_original.png","name":"Norton AntiVirus","slug":"norton-antivirus","domain":"norton.com"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/owler/company/info":{"get":{"summary":"Owler Company Info","description":"Retrieve detailed company intelligence from Owler, including revenue, employee count, CEO info, competitors, funding, and industry sectors.\n\n**Credit cost:** 1 credit per call","operationId":"get-owler-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The company to look up on Owler. Multiple formats are accepted:\n\n- **Company slug:** `airbus`\n- **Owler company URL:** `https://owler.com/company/airbus`\n\n**Examples:**\n\n    https://owler.com/company/tesla\n\nThe response includes the company's financials, CEO details, headcount, competitors, and industry sectors.","schema":{"type":"string","description":"The company to look up on Owler. Multiple formats are accepted:\n\n- **Company slug:** `airbus`\n- **Owler company URL:** `https://owler.com/company/airbus`\n\n**Examples:**\n\n    https://owler.com/company/tesla\n\nThe response includes the company's financials, CEO details, headcount, competitors, and industry sectors."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cg":{"type":"array","items":{"type":"object","properties":{"founded":{"type":"string"},"revenue":{"type":"integer"},"ownership":{"type":"string"},"ceo_detail":{"type":"object","properties":{"ceo_pic":{"type":"string"},"last_name":{"type":"string"},"ceo_rating":{"type":"integer"},"first_name":{"type":"string"},"designation":{"type":"string"}}},"headquarters":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"state_display_name":{"type":"string"}}},"revenue_range":{"type":"string"},"total_funding":{"type":"integer"},"employee_count":{"type":"integer"},"employee_range":{"type":"string"},"industry_sectors":{"type":"array","items":{"type":"string"}},"formatted_funding":{"type":"string"},"formatted_revenue":{"type":"string"},"company_basic_info":{"type":"object","properties":{"logo":{"type":"string"},"cp_link":{"type":"string"},"website":{"type":"string"},"team_name":{"type":"string"},"company_id":{"type":"integer"},"short_name":{"type":"string"}}},"formatted_employee_count":{"type":"string"}}}}}},"examples":{"Get Owler company info for Airbus":{"value":{"cg":[{"founded":"1916","revenue":69444000000,"ownership":"Public","ceo_detail":{"ceo_pic":"https://image4.owler.com/placeholder/example-user.jpg","last_name":"Martin","ceo_rating":67,"first_name":"Alex","designation":"President & CEO"},"headquarters":{"city":"Arlington","state":"US-VA","country":"USA","state_display_name":"Virginia"},"revenue_range":"$50B - 100B","total_funding":45000000000,"employee_count":156000,"employee_range":"100,000 - 9,999,999","industry_sectors":["Defense","Aviation"],"formatted_funding":"45B","formatted_revenue":"69.4B","company_basic_info":{"logo":"https://image4.owler.com/logo/boeing_owler_20190615_044954_small.png","cp_link":"https://www.owler.com/company/boeing","website":"https://www.boeing.com/","team_name":"boeing","company_id":124397,"short_name":"Boeing"},"formatted_employee_count":"156,000"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Owler Company Info","description":"Retrieve detailed company intelligence from Owler, including revenue, employee count, CEO info, competitors, funding, and industry sectors.\n\n**Credit cost:** 1 credit per call","operationId":"post-owler-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The company to look up on Owler. Multiple formats are accepted:\n\n- **Company slug:** `airbus`\n- **Owler company URL:** `https://owler.com/company/airbus`\n\n**Examples:**\n\n    https://owler.com/company/tesla\n\nThe response includes the company's financials, CEO details, headcount, competitors, and industry sectors.","schema":{"type":"string","description":"The company to look up on Owler. Multiple formats are accepted:\n\n- **Company slug:** `airbus`\n- **Owler company URL:** `https://owler.com/company/airbus`\n\n**Examples:**\n\n    https://owler.com/company/tesla\n\nThe response includes the company's financials, CEO details, headcount, competitors, and industry sectors."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cg":{"type":"array","items":{"type":"object","properties":{"founded":{"type":"string"},"revenue":{"type":"integer"},"ownership":{"type":"string"},"ceo_detail":{"type":"object","properties":{"ceo_pic":{"type":"string"},"last_name":{"type":"string"},"ceo_rating":{"type":"integer"},"first_name":{"type":"string"},"designation":{"type":"string"}}},"headquarters":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"state_display_name":{"type":"string"}}},"revenue_range":{"type":"string"},"total_funding":{"type":"integer"},"employee_count":{"type":"integer"},"employee_range":{"type":"string"},"industry_sectors":{"type":"array","items":{"type":"string"}},"formatted_funding":{"type":"string"},"formatted_revenue":{"type":"string"},"company_basic_info":{"type":"object","properties":{"logo":{"type":"string"},"cp_link":{"type":"string"},"website":{"type":"string"},"team_name":{"type":"string"},"company_id":{"type":"integer"},"short_name":{"type":"string"}}},"formatted_employee_count":{"type":"string"}}}}}},"examples":{"Get Owler company info for Airbus":{"value":{"cg":[{"founded":"1916","revenue":69444000000,"ownership":"Public","ceo_detail":{"ceo_pic":"https://image4.owler.com/placeholder/example-user.jpg","last_name":"Martin","ceo_rating":67,"first_name":"Alex","designation":"President & CEO"},"headquarters":{"city":"Arlington","state":"US-VA","country":"USA","state_display_name":"Virginia"},"revenue_range":"$50B - 100B","total_funding":45000000000,"employee_count":156000,"employee_range":"100,000 - 9,999,999","industry_sectors":["Defense","Aviation"],"formatted_funding":"45B","formatted_revenue":"69.4B","company_basic_info":{"logo":"https://image4.owler.com/logo/boeing_owler_20190615_044954_small.png","cp_link":"https://www.owler.com/company/boeing","website":"https://www.boeing.com/","team_name":"boeing","company_id":124397,"short_name":"Boeing"},"formatted_employee_count":"156,000"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/indeed/company/info":{"get":{"summary":"Indeed Company Info","description":"Indeed Company Info API. Full employer profile by slug or URL. Browser rendering returns headcount, revenue, industry and FAQ or review blocks.\n\n**Credit cost:** 2 credits per call","operationId":"get-indeed-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Indeed company slug or full `/cmp/` URL.\n\n**Examples:**\n\n```\nProman-1\n```\n\n```\nhttps://fr.indeed.com/cmp/Proman-1\n```\n\nDiscover slugs with [Indeed Company Search](https://www.piloterr.com/library/indeed-company-search).","schema":{"type":"string","description":"Indeed company slug or full `/cmp/` URL.\n\n**Examples:**\n\n```\nProman-1\n```\n\n```\nhttps://fr.indeed.com/cmp/Proman-1\n```\n\nDiscover slugs with [Indeed Company Search](https://www.piloterr.com/library/indeed-company-search)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"founded":{"nullable":true},"revenue":{"type":"string"},"website":{"type":"string"},"industry":{"type":"string"},"logo_url":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"headquarter":{"type":"string"},"staff_range":{"type":"string"},"company_name":{"type":"string"},"dynamic_sections":{"type":"object","properties":{"faq":{"type":"object","properties":{"faqs":{"type":"array","items":{"type":"object","properties":{"answer_text":{"type":"string"},"answer_links":{"type":"array","items":{}},"question_text":{"type":"string"},"special_markup":{"type":"boolean"}}}}}}}}}},"examples":{"Get Indeed company info for PROMAN (Proman-1)":{"value":{"founded":null,"revenue":"$5B-$10B (USD)","website":"https://www.proman.group/","industry":"Ressources humaines et recrutement","logo_url":"https://d2q79iu7y748jz.cloudfront.net/s/_squarelogo/96x96/298681ef47f10ca72cd94a73fdf47032","company_url":"https://fr.indeed.com/cmp/Proman-1","description":"Fondé à Manosque en 1990, PROMAN est aujourd’hui le 4ème acteur européen sur le marché du travail temporaire, du recrutement CDD/CDI et le 1er acteur 100% familial et indépendant en France. Avec 1 370 agences dont 426 en France et 110 000 collaborateurs intérimaires en mission chaque jour, PROMAN est le partenaire privilégié de plus de 65 000 entreprises des secteurs du BTP, de l’industrie, de la …","headquarter":"PROMAN – Siège social,\r\nZI Saint-Maurice\r\n04100 Manosque\r\n","staff_range":"5001-10000","company_name":"PROMAN","dynamic_sections":{"faq":{"faqs":[{"answer_text":"Oui, PROMAN a 3,972 emplois ouverts. Avant de postuler chez PROMAN, il est conseillé de faire des recherches sur l'entreprise et de lire les avis des employés qui y travaillent.","answer_links":[],"question_text":"PROMAN recrute-t-elle dans le pays suivant : France ?","special_markup":true},{"answer_text":"Des personnes ont déclaré que les entretiens chez PROMAN étaient faciles. Le processus d'entretien prend environ une semaine. Des personnes ont évalué l'expérience globale d'entretien comme positive.","answer_links":[],"question_text":"Est-il difficile de décrocher un travail chez PROMAN dans le pays suivant : France ?","special_markup":true}]}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Indeed Company Info","description":"Indeed Company Info API. Full employer profile by slug or URL. Browser rendering returns headcount, revenue, industry and FAQ or review blocks.\n\n**Credit cost:** 2 credits per call","operationId":"post-indeed-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Indeed company slug or full `/cmp/` URL.\n\n**Examples:**\n\n```\nProman-1\n```\n\n```\nhttps://fr.indeed.com/cmp/Proman-1\n```\n\nDiscover slugs with [Indeed Company Search](https://www.piloterr.com/library/indeed-company-search).","schema":{"type":"string","description":"Indeed company slug or full `/cmp/` URL.\n\n**Examples:**\n\n```\nProman-1\n```\n\n```\nhttps://fr.indeed.com/cmp/Proman-1\n```\n\nDiscover slugs with [Indeed Company Search](https://www.piloterr.com/library/indeed-company-search)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"founded":{"nullable":true},"revenue":{"type":"string"},"website":{"type":"string"},"industry":{"type":"string"},"logo_url":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"headquarter":{"type":"string"},"staff_range":{"type":"string"},"company_name":{"type":"string"},"dynamic_sections":{"type":"object","properties":{"faq":{"type":"object","properties":{"faqs":{"type":"array","items":{"type":"object","properties":{"answer_text":{"type":"string"},"answer_links":{"type":"array","items":{}},"question_text":{"type":"string"},"special_markup":{"type":"boolean"}}}}}}}}}},"examples":{"Get Indeed company info for PROMAN (Proman-1)":{"value":{"founded":null,"revenue":"$5B-$10B (USD)","website":"https://www.proman.group/","industry":"Ressources humaines et recrutement","logo_url":"https://d2q79iu7y748jz.cloudfront.net/s/_squarelogo/96x96/298681ef47f10ca72cd94a73fdf47032","company_url":"https://fr.indeed.com/cmp/Proman-1","description":"Fondé à Manosque en 1990, PROMAN est aujourd’hui le 4ème acteur européen sur le marché du travail temporaire, du recrutement CDD/CDI et le 1er acteur 100% familial et indépendant en France. Avec 1 370 agences dont 426 en France et 110 000 collaborateurs intérimaires en mission chaque jour, PROMAN est le partenaire privilégié de plus de 65 000 entreprises des secteurs du BTP, de l’industrie, de la …","headquarter":"PROMAN – Siège social,\r\nZI Saint-Maurice\r\n04100 Manosque\r\n","staff_range":"5001-10000","company_name":"PROMAN","dynamic_sections":{"faq":{"faqs":[{"answer_text":"Oui, PROMAN a 3,972 emplois ouverts. Avant de postuler chez PROMAN, il est conseillé de faire des recherches sur l'entreprise et de lire les avis des employés qui y travaillent.","answer_links":[],"question_text":"PROMAN recrute-t-elle dans le pays suivant : France ?","special_markup":true},{"answer_text":"Des personnes ont déclaré que les entretiens chez PROMAN étaient faciles. Le processus d'entretien prend environ une semaine. Des personnes ont évalué l'expérience globale d'entretien comme positive.","answer_links":[],"question_text":"Est-il difficile de décrocher un travail chez PROMAN dans le pays suivant : France ?","special_markup":true}]}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/homestra/search":{"get":{"summary":"Homestra Search","description":"Search Homestra property listings using a direct search URL with filters, returning structured results with prices, sizes, locations, and photos.\n\n**Credit cost:** 1 credit per call","operationId":"get-homestra-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid Homestra search URL with optional filters.\n\n**Example:**\n\n    https://homestra.com/list/houses-for-sale/?maximum-price=900000&minimum-price=75000&page=1\n\nYou can customize filters directly in the URL, including price range, property type, location, and page number.\n\n**Notes:**\n- URL-encode `&` as `%26` when passing the query in a GET request parameter.\n- Use `page=N` to paginate through results.","schema":{"type":"string","description":"A valid Homestra search URL with optional filters.\n\n**Example:**\n\n    https://homestra.com/list/houses-for-sale/?maximum-price=900000&minimum-price=75000&page=1\n\nYou can customize filters directly in the URL, including price range, property type, location, and page number.\n\n**Notes:**\n- URL-encode `&` as `%26` when passing the query in a GET request parameter.\n- Use `page=N` to paginate through results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"size":{"type":"integer"},"slug":{"type":"string"},"type":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"location":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"lot_size":{"type":"integer"},"photo_url":{"type":"string"},"country_code":{"type":"string"},"listing_date":{"type":"string"}}}},"examples":{"Search houses for sale within price range":{"value":[{"id":"0d45a754-0e49-4c35-b0b6-bf1dba0d47cd","city":"Valderice","size":114,"slug":"spacious-3-bed-detached-home-with-sea-views-and-guest-studio-in-valderice-trapani","type":"house","price":250000,"title":"Spacious 3-Bed Detached Home with Sea Views and Guest Studio in Valderice, Trapani","status":"for_sale","address":"Valderice, Trapani, Sicily, Italy","location":{"type":"Point","coordinates":[38.04061,12.62553]},"lot_size":800,"photo_url":"https://storage.googleapis.com/homestra-images/property-image-e4e958d4-fdc4-430c-a6e3-aee2cd7b6fd0-1721847180.jpg","country_code":"it","listing_date":"2024-07-25T22:26:03.577Z"},{"id":"41d7f3ef-6d42-4fb2-9ddf-1d07ea0d683f","city":"Carvoeiro","size":330,"slug":"peaceful-3-bedroom-villa-with-panoramic-views-in-barroselas-portugal","type":"house","price":349000,"title":"Peaceful 3-Bedroom Villa with Panoramic Views in Barroselas, Portugal","status":"for_sale","address":"Minho, Barroselas, Portugal","location":{"type":"Point","coordinates":[41.65043,-8.67458]},"lot_size":1673,"photo_url":"https://storage.googleapis.com/homestra-images/property-image-e4e958d4-fdc4-430c-a6e3-aee2cd7b6fd0-1721847180.jpg","country_code":"pt","listing_date":"2024-07-25T21:30:10.404Z"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Homestra Search","description":"Search Homestra property listings using a direct search URL with filters, returning structured results with prices, sizes, locations, and photos.\n\n**Credit cost:** 1 credit per call","operationId":"post-homestra-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid Homestra search URL with optional filters.\n\n**Example:**\n\n    https://homestra.com/list/houses-for-sale/?maximum-price=900000&minimum-price=75000&page=1\n\nYou can customize filters directly in the URL, including price range, property type, location, and page number.\n\n**Notes:**\n- URL-encode `&` as `%26` when passing the query in a GET request parameter.\n- Use `page=N` to paginate through results.","schema":{"type":"string","description":"A valid Homestra search URL with optional filters.\n\n**Example:**\n\n    https://homestra.com/list/houses-for-sale/?maximum-price=900000&minimum-price=75000&page=1\n\nYou can customize filters directly in the URL, including price range, property type, location, and page number.\n\n**Notes:**\n- URL-encode `&` as `%26` when passing the query in a GET request parameter.\n- Use `page=N` to paginate through results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"size":{"type":"integer"},"slug":{"type":"string"},"type":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"location":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"lot_size":{"type":"integer"},"photo_url":{"type":"string"},"country_code":{"type":"string"},"listing_date":{"type":"string"}}}},"examples":{"Search houses for sale within price range":{"value":[{"id":"0d45a754-0e49-4c35-b0b6-bf1dba0d47cd","city":"Valderice","size":114,"slug":"spacious-3-bed-detached-home-with-sea-views-and-guest-studio-in-valderice-trapani","type":"house","price":250000,"title":"Spacious 3-Bed Detached Home with Sea Views and Guest Studio in Valderice, Trapani","status":"for_sale","address":"Valderice, Trapani, Sicily, Italy","location":{"type":"Point","coordinates":[38.04061,12.62553]},"lot_size":800,"photo_url":"https://storage.googleapis.com/homestra-images/property-image-e4e958d4-fdc4-430c-a6e3-aee2cd7b6fd0-1721847180.jpg","country_code":"it","listing_date":"2024-07-25T22:26:03.577Z"},{"id":"41d7f3ef-6d42-4fb2-9ddf-1d07ea0d683f","city":"Carvoeiro","size":330,"slug":"peaceful-3-bedroom-villa-with-panoramic-views-in-barroselas-portugal","type":"house","price":349000,"title":"Peaceful 3-Bedroom Villa with Panoramic Views in Barroselas, Portugal","status":"for_sale","address":"Minho, Barroselas, Portugal","location":{"type":"Point","coordinates":[41.65043,-8.67458]},"lot_size":1673,"photo_url":"https://storage.googleapis.com/homestra-images/property-image-e4e958d4-fdc4-430c-a6e3-aee2cd7b6fd0-1721847180.jpg","country_code":"pt","listing_date":"2024-07-25T21:30:10.404Z"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/homestra/ad":{"get":{"summary":"Homestra Ad","description":"Retrieve detailed property listing data from Homestra, including price, size, location, features, photos, and nearby properties.\n\n**Credit cost:** 1 credit per call","operationId":"get-homestra-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Homestra property URL or slug.\n\n**Examples:**\n\n    https://homestra.com/property/charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village/\n\nBoth the full URL and the slug (the last part of the URL path) are accepted.","schema":{"type":"string","description":"A Homestra property URL or slug.\n\n**Examples:**\n\n    https://homestra.com/property/charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village/\n\nBoth the full URL and the slug (the last part of the URL path) are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"size":{"type":"integer"},"slug":{"type":"string"},"type":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"garden":{"type":"boolean"},"region":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"parking":{"type":"boolean"},"basement":{"type":"boolean"},"location":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"lot_size":{"type":"integer"},"condition":{"type":"string"},"furnished":{"type":"boolean"},"created_at":{"type":"string"},"country_code":{"type":"string"},"swimming_pool":{"type":"boolean"},"nearby_properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"}}}},"amount_of_bedrooms":{"type":"integer"},"featured_photo_url":{"type":"string"},"amount_of_bathrooms":{"type":"integer"}}},"examples":{"Get chateau listing in Civray, France":{"value":{"id":"c6ff90a7-d152-42c9-a1a3-ff0b5cbbcdaf","city":"Civray","size":240,"slug":"charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village","type":"chateau","price":474500,"title":"Charming 4-Bedroom Stone House with Historic Towers in Idyllic French Village","garden":true,"region":"Cher","status":"for_sale","address":"France","parking":true,"basement":true,"location":{"type":"Point","coordinates":[46.94515,2.17684]},"lot_size":3933,"condition":"good","furnished":false,"created_at":"2024-06-01T17:43:55.361Z","country_code":"fr","swimming_pool":false,"nearby_properties":[{"id":"a08d69ea-888e-4ed2-8bbd-6a731efd1bd5","slug":"charming-3-bedroom-home-in-aquitaine-france","price":275000,"title":"Charming 3 Bedroom Home in Aquitaine, France"}],"amount_of_bedrooms":4,"featured_photo_url":"https://storage.googleapis.com/homestra-images/property-image-cab7dff4-ce7b-4f20-9d35-2df09ae9d283-1717266265.jpg","amount_of_bathrooms":1}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Homestra Ad","description":"Retrieve detailed property listing data from Homestra, including price, size, location, features, photos, and nearby properties.\n\n**Credit cost:** 1 credit per call","operationId":"post-homestra-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Homestra property URL or slug.\n\n**Examples:**\n\n    https://homestra.com/property/charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village/\n\nBoth the full URL and the slug (the last part of the URL path) are accepted.","schema":{"type":"string","description":"A Homestra property URL or slug.\n\n**Examples:**\n\n    https://homestra.com/property/charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village/\n\nBoth the full URL and the slug (the last part of the URL path) are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"size":{"type":"integer"},"slug":{"type":"string"},"type":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"garden":{"type":"boolean"},"region":{"type":"string"},"status":{"type":"string"},"address":{"type":"string"},"parking":{"type":"boolean"},"basement":{"type":"boolean"},"location":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"number"}}}},"lot_size":{"type":"integer"},"condition":{"type":"string"},"furnished":{"type":"boolean"},"created_at":{"type":"string"},"country_code":{"type":"string"},"swimming_pool":{"type":"boolean"},"nearby_properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"}}}},"amount_of_bedrooms":{"type":"integer"},"featured_photo_url":{"type":"string"},"amount_of_bathrooms":{"type":"integer"}}},"examples":{"Get chateau listing in Civray, France":{"value":{"id":"c6ff90a7-d152-42c9-a1a3-ff0b5cbbcdaf","city":"Civray","size":240,"slug":"charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village","type":"chateau","price":474500,"title":"Charming 4-Bedroom Stone House with Historic Towers in Idyllic French Village","garden":true,"region":"Cher","status":"for_sale","address":"France","parking":true,"basement":true,"location":{"type":"Point","coordinates":[46.94515,2.17684]},"lot_size":3933,"condition":"good","furnished":false,"created_at":"2024-06-01T17:43:55.361Z","country_code":"fr","swimming_pool":false,"nearby_properties":[{"id":"a08d69ea-888e-4ed2-8bbd-6a731efd1bd5","slug":"charming-3-bedroom-home-in-aquitaine-france","price":275000,"title":"Charming 3 Bedroom Home in Aquitaine, France"}],"amount_of_bedrooms":4,"featured_photo_url":"https://storage.googleapis.com/homestra-images/property-image-cab7dff4-ce7b-4f20-9d35-2df09ae9d283-1717266265.jpg","amount_of_bathrooms":1}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/github/user/info":{"get":{"summary":"GitHub User Info","description":"Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses.\n\n**Credit cost:** 1 credit per call","operationId":"get-github-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A GitHub user identifier. Multiple formats are accepted:\n\n- **GitHub profile URL:** `https://github.com/example-user`\n- **Username:** `example-user`\n- **Email address:** `name@company.com`\n\n**Examples:**\n\n    https://github.com/example-user\n\n**Note:** When using an email address, the lookup resolves the associated GitHub account if one is linked publicly.","schema":{"type":"string","description":"A GitHub user identifier. Multiple formats are accepted:\n\n- **GitHub profile URL:** `https://github.com/example-user`\n- **Username:** `example-user`\n- **Email address:** `name@company.com`\n\n**Examples:**\n\n    https://github.com/example-user\n\n**Note:** When using an email address, the lookup resolves the associated GitHub account if one is linked publicly."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"array","items":{"type":"string"}},"login":{"type":"string"},"company":{"type":"string"},"gist_url":{"type":"string"},"gpg_keys":{"type":"string"},"location":{"type":"string"},"ssh_keys":{"type":"string"},"followers":{"type":"integer"},"following":{"type":"integer"},"avatar_url":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"public_gists":{"type":"integer"},"public_repos":{"type":"integer"}}},"examples":{"Lookup example-user GitHub profile":{"value":{"id":1024025,"name":"Alex Martin","email":["name@example.com"],"login":"example-user","company":"Linux Foundation","gist_url":"https://gist.github.com/example-user","gpg_keys":"https://github.com/example-user.gpg","location":"Portland, OR","ssh_keys":"https://github.com/example-user.keys","followers":329840,"following":0,"avatar_url":"https://avatars.githubusercontent.com/placeholder/example-user.jpg","created_at":"2011-09-03T15:26:22Z","updated_at":"2026-10-16T15:33:53Z","public_gists":1,"public_repos":12}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"GitHub User Info","description":"Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses.\n\n**Credit cost:** 1 credit per call","operationId":"post-github-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A GitHub user identifier. Multiple formats are accepted:\n\n- **GitHub profile URL:** `https://github.com/example-user`\n- **Username:** `example-user`\n- **Email address:** `name@company.com`\n\n**Examples:**\n\n    https://github.com/example-user\n\n**Note:** When using an email address, the lookup resolves the associated GitHub account if one is linked publicly.","schema":{"type":"string","description":"A GitHub user identifier. Multiple formats are accepted:\n\n- **GitHub profile URL:** `https://github.com/example-user`\n- **Username:** `example-user`\n- **Email address:** `name@company.com`\n\n**Examples:**\n\n    https://github.com/example-user\n\n**Note:** When using an email address, the lookup resolves the associated GitHub account if one is linked publicly."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"array","items":{"type":"string"}},"login":{"type":"string"},"company":{"type":"string"},"gist_url":{"type":"string"},"gpg_keys":{"type":"string"},"location":{"type":"string"},"ssh_keys":{"type":"string"},"followers":{"type":"integer"},"following":{"type":"integer"},"avatar_url":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"public_gists":{"type":"integer"},"public_repos":{"type":"integer"}}},"examples":{"Lookup example-user GitHub profile":{"value":{"id":1024025,"name":"Alex Martin","email":["name@example.com"],"login":"example-user","company":"Linux Foundation","gist_url":"https://gist.github.com/example-user","gpg_keys":"https://github.com/example-user.gpg","location":"Portland, OR","ssh_keys":"https://github.com/example-user.keys","followers":329840,"following":0,"avatar_url":"https://avatars.githubusercontent.com/placeholder/example-user.jpg","created_at":"2011-09-03T15:26:22Z","updated_at":"2026-10-16T15:33:53Z","public_gists":1,"public_repos":12}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/g2/product/info":{"get":{"summary":"G2 Product Info","description":"Read a G2 product reviews page: rating, pricing, categories, alternatives, screenshots, and the reviews shown on the page.\n\n**Credit cost:** 2 credits per call","operationId":"get-g2-product-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product slug or a www.g2.com product URL.\n\n**Examples:**\n\n    postman\n    https://www.g2.com/products/postman\n\nBoth the slug and the full product URL are accepted.","schema":{"type":"string","description":"Product slug or a www.g2.com product URL.\n\n**Examples:**\n\n    postman\n    https://www.g2.com/products/postman\n\nBoth the slug and the full product URL are accepted."}},{"name":"nps_score","in":"query","required":false,"description":"Keep reviews of one star rating, from 1 to 5. Omit it to read the unfiltered reviews page.","schema":{"type":"number","description":"Keep reviews of one star rating, from 1 to 5. Omit it to read the unfiltered reviews page."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of the parsed product.","schema":{"type":"boolean","description":"Return the rendered HTML instead of the parsed product."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"rating":{"type":"number"},"reviews":{"type":"array","items":{"type":"object","properties":{"reviewer":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"industry":{"type":"string"},"job_title":{"type":"string"},"company_size":{"type":"string"}}},"review_id":{"type":"integer"},"review_link":{"type":"string"},"publish_date":{"type":"string"},"review_title":{"type":"string"},"review_rating":{"type":"integer"},"review_question_answers":{"type":"array","items":{"type":"object","properties":{"answer":{"type":"string"},"question":{"type":"string"}}}}}}},"what_is":{"type":"string"},"category":{"type":"string"},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}}}},"categories":{"type":"array","items":{"type":"string"}},"company_id":{"type":"integer"},"is_claimed":{"type":"boolean"},"product_id":{"type":"integer"},"screenshots":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}}},"alternatives":{"type":"array","items":{"type":"object","properties":{"rating":{"type":"number"},"product_link":{"type":"string"},"product_name":{"type":"string"},"reviews_count":{"type":"integer"}}}},"product_link":{"type":"string"},"product_logo":{"type":"string"},"product_name":{"type":"string"},"product_slug":{"type":"string"},"product_type":{"type":"string"},"pricing_plans":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"nullable":true},"price_display":{"type":"string"}}}},"reviews_count":{"type":"integer"},"discussions_link":{"type":"string"},"star_distribution":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}},"product_description":{"type":"string"}}},"examples":{"Get G2 info for Postman":{"value":{"rating":4.6,"reviews":[{"reviewer":{"link":"https://www.g2.com/users/example-user","name":"Alex Martin","industry":"Computer Software","job_title":"Software developer","company_size":"Small-Business (50 or fewer emp.)"},"review_id":13694235,"review_link":"https://www.g2.com/products/postman/reviews#postman-review-13694235","publish_date":"2026-10-04","review_title":"Effortless API Testing with Team Collaboration","review_rating":4,"review_question_answers":[{"answer":"I really like how Postman supports teamwork. I can share an API request, and the backend team that builds the API can work on it and provide the endpoints we need.","question":"What do you like best about Postman?"}]}],"what_is":"Postman is the world’s leading API platform, used by more than 40 million developers and 500,000 organizations to build, test, and manage APIs at scale.","category":"API Platforms","breadcrumb":[{"url":"https://www.g2.com/","name":"Home","position":1},{"url":"https://www.g2.com/categories/api-platforms","name":"API Platforms","position":2},{"url":"https://www.g2.com/products/postman/reviews","name":"Postman","position":3},{"url":"https://www.g2.com/products/postman/reviews#details","name":"Postman Reviews","position":4}],"categories":["Service Virtualization","API Platforms","API Development","API Security","API Management","Software Testing","Build Automation","AI Agent Builders"],"company_id":16505,"is_claimed":true,"product_id":20238,"screenshots":[{"url":"https://images.g2crowd.com/cdn-cgi/image/width=1200,height=1200,fit=scale-down,format=auto,onerror=redirect,/https://images.g2crowd.com/uploads/attachment/file/194029/api-design-postman-screenshot-illustration.png","title":"Postman Demo - API Design","description":"You can design your API specifications in Postman using OpenAPI, RAML, GraphQL, or SOAP formats."}],"alternatives":[{"rating":4.4,"product_link":"https://www.g2.com/products/mulesoft-anypoint-platform/reviews","product_name":"MuleSoft Anypoint Platform","reviews_count":894},{"rating":4.7,"product_link":"https://www.g2.com/products/workato/reviews","product_name":"Workato","reviews_count":858}],"product_link":"https://www.g2.com/products/postman/reviews","product_logo":"https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_fd527e1fc777d9e31b2a28e8d3c959a4/postman.jpg","product_name":"Postman","product_slug":"postman","product_type":"Software","pricing_plans":[{"name":"Free Plan","price":null,"price_display":"Free"},{"name":"Basic Plan","price":14,"price_display":"$14.00"},{"name":"Professional Plan","price":29,"price_display":"$29.00"}],"reviews_count":1795,"discussions_link":"https://www.g2.com/products/postman/discuss","star_distribution":{"1":0,"2":0,"3":0,"4":16,"5":82},"product_description":"Postman is the world’s leading API platform, used by more than 40 million developers and 500,000 organizations to build, test, and manage APIs at scale.\n\nWith Postman, teams collaborate efficiently across the entire API lifecycle, including design, development, testing, security, documentation, and governance. The platform helps ensure consistency, quality, and enterprise-grade control."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"G2 Product Info","description":"Read a G2 product reviews page: rating, pricing, categories, alternatives, screenshots, and the reviews shown on the page.\n\n**Credit cost:** 2 credits per call","operationId":"post-g2-product-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product slug or a www.g2.com product URL.\n\n**Examples:**\n\n    postman\n    https://www.g2.com/products/postman\n\nBoth the slug and the full product URL are accepted.","schema":{"type":"string","description":"Product slug or a www.g2.com product URL.\n\n**Examples:**\n\n    postman\n    https://www.g2.com/products/postman\n\nBoth the slug and the full product URL are accepted."}},{"name":"nps_score","in":"query","required":false,"description":"Keep reviews of one star rating, from 1 to 5. Omit it to read the unfiltered reviews page.","schema":{"type":"number","description":"Keep reviews of one star rating, from 1 to 5. Omit it to read the unfiltered reviews page."}},{"name":"return_page_source","in":"query","required":false,"description":"Return the rendered HTML instead of the parsed product.","schema":{"type":"boolean","description":"Return the rendered HTML instead of the parsed product."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"rating":{"type":"number"},"reviews":{"type":"array","items":{"type":"object","properties":{"reviewer":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"industry":{"type":"string"},"job_title":{"type":"string"},"company_size":{"type":"string"}}},"review_id":{"type":"integer"},"review_link":{"type":"string"},"publish_date":{"type":"string"},"review_title":{"type":"string"},"review_rating":{"type":"integer"},"review_question_answers":{"type":"array","items":{"type":"object","properties":{"answer":{"type":"string"},"question":{"type":"string"}}}}}}},"what_is":{"type":"string"},"category":{"type":"string"},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}}}},"categories":{"type":"array","items":{"type":"string"}},"company_id":{"type":"integer"},"is_claimed":{"type":"boolean"},"product_id":{"type":"integer"},"screenshots":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}}},"alternatives":{"type":"array","items":{"type":"object","properties":{"rating":{"type":"number"},"product_link":{"type":"string"},"product_name":{"type":"string"},"reviews_count":{"type":"integer"}}}},"product_link":{"type":"string"},"product_logo":{"type":"string"},"product_name":{"type":"string"},"product_slug":{"type":"string"},"product_type":{"type":"string"},"pricing_plans":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"nullable":true},"price_display":{"type":"string"}}}},"reviews_count":{"type":"integer"},"discussions_link":{"type":"string"},"star_distribution":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}},"product_description":{"type":"string"}}},"examples":{"Get G2 info for Postman":{"value":{"rating":4.6,"reviews":[{"reviewer":{"link":"https://www.g2.com/users/example-user","name":"Alex Martin","industry":"Computer Software","job_title":"Software developer","company_size":"Small-Business (50 or fewer emp.)"},"review_id":13694235,"review_link":"https://www.g2.com/products/postman/reviews#postman-review-13694235","publish_date":"2026-10-04","review_title":"Effortless API Testing with Team Collaboration","review_rating":4,"review_question_answers":[{"answer":"I really like how Postman supports teamwork. I can share an API request, and the backend team that builds the API can work on it and provide the endpoints we need.","question":"What do you like best about Postman?"}]}],"what_is":"Postman is the world’s leading API platform, used by more than 40 million developers and 500,000 organizations to build, test, and manage APIs at scale.","category":"API Platforms","breadcrumb":[{"url":"https://www.g2.com/","name":"Home","position":1},{"url":"https://www.g2.com/categories/api-platforms","name":"API Platforms","position":2},{"url":"https://www.g2.com/products/postman/reviews","name":"Postman","position":3},{"url":"https://www.g2.com/products/postman/reviews#details","name":"Postman Reviews","position":4}],"categories":["Service Virtualization","API Platforms","API Development","API Security","API Management","Software Testing","Build Automation","AI Agent Builders"],"company_id":16505,"is_claimed":true,"product_id":20238,"screenshots":[{"url":"https://images.g2crowd.com/cdn-cgi/image/width=1200,height=1200,fit=scale-down,format=auto,onerror=redirect,/https://images.g2crowd.com/uploads/attachment/file/194029/api-design-postman-screenshot-illustration.png","title":"Postman Demo - API Design","description":"You can design your API specifications in Postman using OpenAPI, RAML, GraphQL, or SOAP formats."}],"alternatives":[{"rating":4.4,"product_link":"https://www.g2.com/products/mulesoft-anypoint-platform/reviews","product_name":"MuleSoft Anypoint Platform","reviews_count":894},{"rating":4.7,"product_link":"https://www.g2.com/products/workato/reviews","product_name":"Workato","reviews_count":858}],"product_link":"https://www.g2.com/products/postman/reviews","product_logo":"https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_fd527e1fc777d9e31b2a28e8d3c959a4/postman.jpg","product_name":"Postman","product_slug":"postman","product_type":"Software","pricing_plans":[{"name":"Free Plan","price":null,"price_display":"Free"},{"name":"Basic Plan","price":14,"price_display":"$14.00"},{"name":"Professional Plan","price":29,"price_display":"$29.00"}],"reviews_count":1795,"discussions_link":"https://www.g2.com/products/postman/discuss","star_distribution":{"1":0,"2":0,"3":0,"4":16,"5":82},"product_description":"Postman is the world’s leading API platform, used by more than 40 million developers and 500,000 organizations to build, test, and manage APIs at scale.\n\nWith Postman, teams collaborate efficiently across the entire API lifecycle, including design, development, testing, security, documentation, and governance. The platform helps ensure consistency, quality, and enterprise-grade control."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fiverr/search":{"get":{"summary":"Fiverr Search","description":"Search Fiverr gigs using a direct search URL and receive paginated listings with seller information, gig titles, images, and seller levels.\n\n**Credit cost:** 1 credit per call","operationId":"get-fiverr-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Fiverr search URL for gigs.\n\n**Example:**\n\n    https://www.fiverr.com/search/gigs?query=website+development\n\nThe API returns paginated gig listings including seller information, images, gig URLs, and seller levels.\n\n**Notes:**\n- Use a valid Fiverr gig search URL (starting with `https://www.fiverr.com/search/gigs?query=`)\n- You can append additional Fiverr filters to the URL (e.g. `&filter=rating`, `&delivery_time=1`) before submitting.","schema":{"type":"string","description":"A Fiverr search URL for gigs.\n\n**Example:**\n\n    https://www.fiverr.com/search/gigs?query=website+development\n\nThe API returns paginated gig listings including seller information, images, gig URLs, and seller levels.\n\n**Notes:**\n- Use a valid Fiverr gig search URL (starting with `https://www.fiverr.com/search/gigs?query=`)\n- You can append additional Fiverr filters to the URL (e.g. `&filter=rating`, `&delivery_time=1`) before submitting."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"gig_url":{"type":"string"},"position":{"type":"integer"},"seller_id":{"type":"integer"},"seller_name":{"type":"string"},"seller_image":{"type":"string"},"seller_level":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"total":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for website development gigs":{"value":{"results":[{"id":396045309,"type":"promoted_gigs","title":"build a wordpress website with unlimited revisions","images":["https://fiverr-res.cloudinary.com/t_main1,q_auto,f_auto/gigs/396045309/original/67ef8fbbbc1e8e64581059c07b4bf314ebd9f88f.png"],"gig_url":"https://www.fiverr.com/baptiste_le_b/build-a-wordpress-website-with-unlimited-revisions","position":0,"seller_id":183755788,"seller_name":"baptiste_le_b","seller_image":"https://fiverr-res.cloudinary.com/t_profile_thumb,q_auto,f_auto/attachments/profile/photo/a766b04276bcb7460b1154fa16a9c02c-1837557881743234687.314392/16FFDDA9-C673-44AC-8563-F95713D92A1E","seller_level":"level_one_seller"},{"id":309994815,"type":"fiverr_choice","title":"do wordpress website development, design or redesign wordpress blog","images":["https://fiverr-res.cloudinary.com/t_main1,q_auto,f_auto/gigs/309994815/original/ff1b400db41b15ae7628eb28b8729d0eb83e0eb6.png"],"gig_url":"https://www.fiverr.com/woow_web/design-woocommerce-website-wordpress-ecommerce-website-or-online-store","position":4,"seller_id":136598296,"seller_name":"woow_web","seller_image":"https://fiverr-res.cloudinary.com/t_profile_thumb,q_auto,f_auto/attachments/profile/photo/55e0d23f56c7d328f88611e7a5a03930-1722231743932/2b7efd68-95ec-40e3-b8a8-1a2b4e7eac26.png","seller_level":"level_two_seller"}],"pagination":{"next":2,"total":52533,"current":1,"other_pages":[2,3,4,5],"total_pages":1095,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fiverr Search","description":"Search Fiverr gigs using a direct search URL and receive paginated listings with seller information, gig titles, images, and seller levels.\n\n**Credit cost:** 1 credit per call","operationId":"post-fiverr-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A Fiverr search URL for gigs.\n\n**Example:**\n\n    https://www.fiverr.com/search/gigs?query=website+development\n\nThe API returns paginated gig listings including seller information, images, gig URLs, and seller levels.\n\n**Notes:**\n- Use a valid Fiverr gig search URL (starting with `https://www.fiverr.com/search/gigs?query=`)\n- You can append additional Fiverr filters to the URL (e.g. `&filter=rating`, `&delivery_time=1`) before submitting.","schema":{"type":"string","description":"A Fiverr search URL for gigs.\n\n**Example:**\n\n    https://www.fiverr.com/search/gigs?query=website+development\n\nThe API returns paginated gig listings including seller information, images, gig URLs, and seller levels.\n\n**Notes:**\n- Use a valid Fiverr gig search URL (starting with `https://www.fiverr.com/search/gigs?query=`)\n- You can append additional Fiverr filters to the URL (e.g. `&filter=rating`, `&delivery_time=1`) before submitting."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"gig_url":{"type":"string"},"position":{"type":"integer"},"seller_id":{"type":"integer"},"seller_name":{"type":"string"},"seller_image":{"type":"string"},"seller_level":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"total":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for website development gigs":{"value":{"results":[{"id":396045309,"type":"promoted_gigs","title":"build a wordpress website with unlimited revisions","images":["https://fiverr-res.cloudinary.com/t_main1,q_auto,f_auto/gigs/396045309/original/67ef8fbbbc1e8e64581059c07b4bf314ebd9f88f.png"],"gig_url":"https://www.fiverr.com/baptiste_le_b/build-a-wordpress-website-with-unlimited-revisions","position":0,"seller_id":183755788,"seller_name":"baptiste_le_b","seller_image":"https://fiverr-res.cloudinary.com/t_profile_thumb,q_auto,f_auto/attachments/profile/photo/a766b04276bcb7460b1154fa16a9c02c-1837557881743234687.314392/16FFDDA9-C673-44AC-8563-F95713D92A1E","seller_level":"level_one_seller"},{"id":309994815,"type":"fiverr_choice","title":"do wordpress website development, design or redesign wordpress blog","images":["https://fiverr-res.cloudinary.com/t_main1,q_auto,f_auto/gigs/309994815/original/ff1b400db41b15ae7628eb28b8729d0eb83e0eb6.png"],"gig_url":"https://www.fiverr.com/woow_web/design-woocommerce-website-wordpress-ecommerce-website-or-online-store","position":4,"seller_id":136598296,"seller_name":"woow_web","seller_image":"https://fiverr-res.cloudinary.com/t_profile_thumb,q_auto,f_auto/attachments/profile/photo/55e0d23f56c7d328f88611e7a5a03930-1722231743932/2b7efd68-95ec-40e3-b8a8-1a2b4e7eac26.png","seller_level":"level_two_seller"}],"pagination":{"next":2,"total":52533,"current":1,"other_pages":[2,3,4,5],"total_pages":1095,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/fiverr/profile/info":{"get":{"summary":"Fiverr Profile Info","description":"Extract complete public profile data from any Fiverr seller, including gigs, ratings, reviews, skills, portfolio, and consultation pricing.\n\n**Credit cost:** 1 credit per call","operationId":"get-fiverr-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Fiverr profile URL of the seller you want to extract information from.\n\n**Example:**\n\n    https://www.fiverr.com/example-user\n\nThe API returns the seller's full public profile including their bio, gigs, ratings, reviews, skills, portfolio, and consultation pricing.\n\n**Note:** Only publicly visible seller profiles are supported. The username alone (e.g. `example-user`) without the full URL is not accepted.","schema":{"type":"string","description":"Fiverr profile URL of the seller you want to extract information from.\n\n**Example:**\n\n    https://www.fiverr.com/example-user\n\nThe API returns the seller's full public profile including their bio, gigs, ratings, reviews, skills, portfolio, and consultation pricing.\n\n**Note:** Only publicly visible seller profiles are supported. The username alone (e.g. `example-user`) without the full URL is not accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"country_code":{"type":"string"},"country_name":{"type":"string"}}},"profile":{"type":"object","properties":{"display_name":{"type":"string"}}},"joined_at":{"type":"integer"},"languages":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"level":{"type":"string"}}}},"profile_image_url":{"type":"string"},"is_activation_completed":{"type":"boolean"}}},"is_pro":{"type":"boolean"},"rating":{"type":"object","properties":{"count":{"type":"integer"},"score":{"type":"integer"}}},"gigs_data":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"gig_id":{"type":"integer"},"is_pro":{"type":"boolean"},"status":{"type":"string"},"price_i":{"type":"integer"},"seller_level":{"type":"string"},"seller_rating":{"type":"object","properties":{"count":{"type":"integer"},"score":{"type":"number"}}}}}},"is_active":{"type":"boolean"},"description":{"type":"string"},"hourly_rate":{"type":"object","properties":{"price_in_cents":{"type":"integer"}}},"seller_level":{"type":"string"},"response_time":{"type":"object","properties":{"in_hours":{"type":"integer"}}},"is_on_vacation":{"type":"boolean"},"one_liner_title":{"type":"string"},"achievement_level":{"type":"string"},"approved_gigs_count":{"type":"integer"}}},"examples":{"Fetch profile for example-user":{"value":{"user":{"id":"84160294","name":"Alex Martin","address":{"country_code":"IT","country_name":"Italy"},"profile":{"display_name":"Alex Martin"},"joined_at":1581077239,"languages":[{"code":"EN","level":"FLUENT"},{"code":"DE","level":"FLUENT"},{"code":"IT","level":"FLUENT"}],"profile_image_url":"https://fiverr-res.cloudinary.com/placeholder/example-user.jpg","is_activation_completed":true},"is_pro":true,"rating":{"count":113,"score":5},"gigs_data":[{"title":"shoot studio and lifestyle product photography for website, instagram and amazon","gig_id":149055883,"is_pro":true,"status":"APPROVED","price_i":500,"seller_level":"top_rated_seller","seller_rating":{"count":113,"score":4.990741}}],"is_active":true,"description":"Example seller profile.","hourly_rate":{"price_in_cents":25000},"seller_level":"LEVEL_TRS","response_time":{"in_hours":3},"is_on_vacation":false,"one_liner_title":"Commercial Product Photography and Video","achievement_level":"TOP_RATED_SELLER","approved_gigs_count":3}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Fiverr Profile Info","description":"Extract complete public profile data from any Fiverr seller, including gigs, ratings, reviews, skills, portfolio, and consultation pricing.\n\n**Credit cost:** 1 credit per call","operationId":"post-fiverr-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Fiverr profile URL of the seller you want to extract information from.\n\n**Example:**\n\n    https://www.fiverr.com/example-user\n\nThe API returns the seller's full public profile including their bio, gigs, ratings, reviews, skills, portfolio, and consultation pricing.\n\n**Note:** Only publicly visible seller profiles are supported. The username alone (e.g. `example-user`) without the full URL is not accepted.","schema":{"type":"string","description":"Fiverr profile URL of the seller you want to extract information from.\n\n**Example:**\n\n    https://www.fiverr.com/example-user\n\nThe API returns the seller's full public profile including their bio, gigs, ratings, reviews, skills, portfolio, and consultation pricing.\n\n**Note:** Only publicly visible seller profiles are supported. The username alone (e.g. `example-user`) without the full URL is not accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"country_code":{"type":"string"},"country_name":{"type":"string"}}},"profile":{"type":"object","properties":{"display_name":{"type":"string"}}},"joined_at":{"type":"integer"},"languages":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"level":{"type":"string"}}}},"profile_image_url":{"type":"string"},"is_activation_completed":{"type":"boolean"}}},"is_pro":{"type":"boolean"},"rating":{"type":"object","properties":{"count":{"type":"integer"},"score":{"type":"integer"}}},"gigs_data":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"gig_id":{"type":"integer"},"is_pro":{"type":"boolean"},"status":{"type":"string"},"price_i":{"type":"integer"},"seller_level":{"type":"string"},"seller_rating":{"type":"object","properties":{"count":{"type":"integer"},"score":{"type":"number"}}}}}},"is_active":{"type":"boolean"},"description":{"type":"string"},"hourly_rate":{"type":"object","properties":{"price_in_cents":{"type":"integer"}}},"seller_level":{"type":"string"},"response_time":{"type":"object","properties":{"in_hours":{"type":"integer"}}},"is_on_vacation":{"type":"boolean"},"one_liner_title":{"type":"string"},"achievement_level":{"type":"string"},"approved_gigs_count":{"type":"integer"}}},"examples":{"Fetch profile for example-user":{"value":{"user":{"id":"84160294","name":"Alex Martin","address":{"country_code":"IT","country_name":"Italy"},"profile":{"display_name":"Alex Martin"},"joined_at":1581077239,"languages":[{"code":"EN","level":"FLUENT"},{"code":"DE","level":"FLUENT"},{"code":"IT","level":"FLUENT"}],"profile_image_url":"https://fiverr-res.cloudinary.com/placeholder/example-user.jpg","is_activation_completed":true},"is_pro":true,"rating":{"count":113,"score":5},"gigs_data":[{"title":"shoot studio and lifestyle product photography for website, instagram and amazon","gig_id":149055883,"is_pro":true,"status":"APPROVED","price_i":500,"seller_level":"top_rated_seller","seller_rating":{"count":113,"score":4.990741}}],"is_active":true,"description":"Example seller profile.","hourly_rate":{"price_in_cents":25000},"seller_level":"LEVEL_TRS","response_time":{"in_hours":3},"is_on_vacation":false,"one_liner_title":"Commercial Product Photography and Video","achievement_level":"TOP_RATED_SELLER","approved_gigs_count":3}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/expedia/search":{"get":{"summary":"Expedia Search","description":"Search Expedia hotels by destination and dates, or by a hotel search URL. Each card includes the guest score, nightly price, total price, and property URL.\n\n**Credit cost:** 2 credits per call","operationId":"get-expedia-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A destination, or a full Expedia Hotel-Search URL. Empty or a non-Expedia URL returns 400. A destination is sent as destination=. A full URL is opened as given, so check_in, check_out, adults, and region do not change it. nightly_price and total_price stay the labels on the card. pagination.next is null.\n\nDestination\n\n```\nNew York\n```\n\nFull URL\n\n```\nhttps://www.expedia.com/Hotel-Search?destination=New+York&startDate=2026-11-15&endDate=2026-11-16&adults=2\n```","schema":{"type":"string","description":"A destination, or a full Expedia Hotel-Search URL. Empty or a non-Expedia URL returns 400. A destination is sent as destination=. A full URL is opened as given, so check_in, check_out, adults, and region do not change it. nightly_price and total_price stay the labels on the card. pagination.next is null.\n\nDestination\n\n```\nNew York\n```\n\nFull URL\n\n```\nhttps://www.expedia.com/Hotel-Search?destination=New+York&startDate=2026-11-15&endDate=2026-11-16&adults=2\n```"}},{"name":"check_in","in":"query","required":false,"description":"Check-in as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no startDate. Ignored when query is a full URL.\n\n```\n2026-11-15\n```","schema":{"type":"string","description":"Check-in as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no startDate. Ignored when query is a full URL.\n\n```\n2026-11-15\n```"}},{"name":"check_out","in":"query","required":false,"description":"Check-out as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no endDate. Ignored when query is a full URL.\n\n```\n2026-11-16\n```","schema":{"type":"string","description":"Check-out as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no endDate. Ignored when query is a full URL.\n\n```\n2026-11-16\n```"}},{"name":"adults","in":"query","required":false,"description":"Adult count for a destination. Omit it and the URL has no adults parameter. Ignored when query is a full URL.\n\n```\n2\n```","schema":{"type":"number","description":"Adult count for a destination. Omit it and the URL has no adults parameter. Ignored when query is a full URL.\n\n```\n2\n```"}},{"name":"region","in":"query","required":false,"description":"Host for a destination. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL. The host changes the currency symbol and the review wording.\n\n```\nfr\n```","schema":{"type":"string","description":"Host for a destination. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL. The host changes the currency symbol and the review wording.\n\n```\nfr\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"hotel_id":{"type":"string"},"location":{"type":"string"},"rating_text":{"type":"string"},"star_rating":{"nullable":true},"total_price":{"type":"string"},"review_count":{"type":"integer"},"review_score":{"type":"integer"},"nightly_price":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Hotels in New York for 15-16 Nov 2026":{"value":{"results":[{"url":"https://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information","name":"Hilton New York Fashion District","hotel_id":"3117215","location":"Chelsea","rating_text":"Wonderful","star_rating":null,"total_price":"$235 total","review_count":1186,"review_score":9,"nightly_price":"$202 nightly"}],"pagination":{"next":null,"page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Expedia Search","description":"Search Expedia hotels by destination and dates, or by a hotel search URL. Each card includes the guest score, nightly price, total price, and property URL.\n\n**Credit cost:** 2 credits per call","operationId":"post-expedia-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A destination, or a full Expedia Hotel-Search URL. Empty or a non-Expedia URL returns 400. A destination is sent as destination=. A full URL is opened as given, so check_in, check_out, adults, and region do not change it. nightly_price and total_price stay the labels on the card. pagination.next is null.\n\nDestination\n\n```\nNew York\n```\n\nFull URL\n\n```\nhttps://www.expedia.com/Hotel-Search?destination=New+York&startDate=2026-11-15&endDate=2026-11-16&adults=2\n```","schema":{"type":"string","description":"A destination, or a full Expedia Hotel-Search URL. Empty or a non-Expedia URL returns 400. A destination is sent as destination=. A full URL is opened as given, so check_in, check_out, adults, and region do not change it. nightly_price and total_price stay the labels on the card. pagination.next is null.\n\nDestination\n\n```\nNew York\n```\n\nFull URL\n\n```\nhttps://www.expedia.com/Hotel-Search?destination=New+York&startDate=2026-11-15&endDate=2026-11-16&adults=2\n```"}},{"name":"check_in","in":"query","required":false,"description":"Check-in as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no startDate. Ignored when query is a full URL.\n\n```\n2026-11-15\n```","schema":{"type":"string","description":"Check-in as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no startDate. Ignored when query is a full URL.\n\n```\n2026-11-15\n```"}},{"name":"check_out","in":"query","required":false,"description":"Check-out as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no endDate. Ignored when query is a full URL.\n\n```\n2026-11-16\n```","schema":{"type":"string","description":"Check-out as YYYY-MM-DD when query is a destination. Omit it and the Hotel-Search URL has no endDate. Ignored when query is a full URL.\n\n```\n2026-11-16\n```"}},{"name":"adults","in":"query","required":false,"description":"Adult count for a destination. Omit it and the URL has no adults parameter. Ignored when query is a full URL.\n\n```\n2\n```","schema":{"type":"number","description":"Adult count for a destination. Omit it and the URL has no adults parameter. Ignored when query is a full URL.\n\n```\n2\n```"}},{"name":"region","in":"query","required":false,"description":"Host for a destination. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL. The host changes the currency symbol and the review wording.\n\n```\nfr\n```","schema":{"type":"string","description":"Host for a destination. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL. The host changes the currency symbol and the review wording.\n\n```\nfr\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"hotel_id":{"type":"string"},"location":{"type":"string"},"rating_text":{"type":"string"},"star_rating":{"nullable":true},"total_price":{"type":"string"},"review_count":{"type":"integer"},"review_score":{"type":"integer"},"nightly_price":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"nullable":true}}}}},"examples":{"Hotels in New York for 15-16 Nov 2026":{"value":{"results":[{"url":"https://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information","name":"Hilton New York Fashion District","hotel_id":"3117215","location":"Chelsea","rating_text":"Wonderful","star_rating":null,"total_price":"$235 total","review_count":1186,"review_score":9,"nightly_price":"$202 nightly"}],"pagination":{"next":null,"page":1,"per_page":1,"total_pages":null,"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/email/verify":{"get":{"summary":"Email Verify","description":"Verify whether an email address is valid and deliverable, returning a clear status to prevent bounces and maintain list hygiene.\n\n**Credit cost:** 1 credit per call","operationId":"get-email-verify","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The email address you want to verify.\n\n**Example:**\n\n    name@example.com\n\n**Note:** Provide the full email address including the domain. The API checks deliverability and returns `valid`, `invalid`, or `unknown` as the status.","schema":{"type":"string","description":"The email address you want to verify.\n\n**Example:**\n\n    name@example.com\n\n**Note:** Provide the full email address including the domain. The API checks deliverability and returns `valid`, `invalid`, or `unknown` as the status."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string"}}},"examples":{"Verify example.com email address":{"value":{"email":"name@example.com","status":"invalid"}},"Verify a valid email address":{"value":{"email":"alex.martin@example.com","status":"valid"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Email Verify","description":"Verify whether an email address is valid and deliverable, returning a clear status to prevent bounces and maintain list hygiene.\n\n**Credit cost:** 1 credit per call","operationId":"post-email-verify","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The email address you want to verify.\n\n**Example:**\n\n    name@example.com\n\n**Note:** Provide the full email address including the domain. The API checks deliverability and returns `valid`, `invalid`, or `unknown` as the status.","schema":{"type":"string","description":"The email address you want to verify.\n\n**Example:**\n\n    name@example.com\n\n**Note:** Provide the full email address including the domain. The API checks deliverability and returns `valid`, `invalid`, or `unknown` as the status."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string"}}},"examples":{"Verify example.com email address":{"value":{"email":"name@example.com","status":"invalid"}},"Verify a valid email address":{"value":{"email":"alex.martin@example.com","status":"valid"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/email/finder":{"get":{"summary":"Email Finder","description":"Find verified professional email addresses by combining a person's full name with their company domain or company name.\n\n**Credit cost:** 1 credit per call","operationId":"get-email-finder","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full name of the person whose professional email address you want to find.\n\n**Example:**\n\n    Alex Martin\n\n**Note:** Provide the full name as accurately as possible for the best results. Common name variations are supported.","schema":{"type":"string","description":"Full name of the person whose professional email address you want to find.\n\n**Example:**\n\n    Alex Martin\n\n**Note:** Provide the full name as accurately as possible for the best results. Common name variations are supported."}},{"name":"company_domain","in":"query","required":false,"description":"The company's domain name. Multiple formats are accepted:\n\n- `piloterr.com`: Bare domain (preferred)\n- `https://www.piloterr.com`: Full URL format\n\n**Note:** At least one of `company_domain` or `company_name` is required. If both are omitted, the API returns a `400` error.","schema":{"type":"string","description":"The company's domain name. Multiple formats are accepted:\n\n- `piloterr.com`: Bare domain (preferred)\n- `https://www.piloterr.com`: Full URL format\n\n**Note:** At least one of `company_domain` or `company_name` is required. If both are omitted, the API returns a `400` error."}},{"name":"company_name","in":"query","required":false,"description":"The company name of the person you are looking for.\n\n**Example:**\n\n    Piloterr\n\n**Note:** At least one of `company_domain` or `company_name` is required. `company_domain` is preferred when available as it produces more accurate results.","schema":{"type":"string","description":"The company name of the person you are looking for.\n\n**Example:**\n\n    Piloterr\n\n**Note:** At least one of `company_domain` or `company_name` is required. `company_domain` is preferred when available as it produces more accurate results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"},"company_domain":{"type":"string"}}},"examples":{"Find email for Alex Martin at piloterr.com":{"value":{"email":"name@example.com","status":"valid","last_name":"Martin","first_name":"Alex","company_domain":"piloterr.com"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Email Finder","description":"Find verified professional email addresses by combining a person's full name with their company domain or company name.\n\n**Credit cost:** 1 credit per call","operationId":"post-email-finder","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full name of the person whose professional email address you want to find.\n\n**Example:**\n\n    Alex Martin\n\n**Note:** Provide the full name as accurately as possible for the best results. Common name variations are supported.","schema":{"type":"string","description":"Full name of the person whose professional email address you want to find.\n\n**Example:**\n\n    Alex Martin\n\n**Note:** Provide the full name as accurately as possible for the best results. Common name variations are supported."}},{"name":"company_domain","in":"query","required":false,"description":"The company's domain name. Multiple formats are accepted:\n\n- `piloterr.com`: Bare domain (preferred)\n- `https://www.piloterr.com`: Full URL format\n\n**Note:** At least one of `company_domain` or `company_name` is required. If both are omitted, the API returns a `400` error.","schema":{"type":"string","description":"The company's domain name. Multiple formats are accepted:\n\n- `piloterr.com`: Bare domain (preferred)\n- `https://www.piloterr.com`: Full URL format\n\n**Note:** At least one of `company_domain` or `company_name` is required. If both are omitted, the API returns a `400` error."}},{"name":"company_name","in":"query","required":false,"description":"The company name of the person you are looking for.\n\n**Example:**\n\n    Piloterr\n\n**Note:** At least one of `company_domain` or `company_name` is required. `company_domain` is preferred when available as it produces more accurate results.","schema":{"type":"string","description":"The company name of the person you are looking for.\n\n**Example:**\n\n    Piloterr\n\n**Note:** At least one of `company_domain` or `company_name` is required. `company_domain` is preferred when available as it produces more accurate results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"},"company_domain":{"type":"string"}}},"examples":{"Find email for Alex Martin at piloterr.com":{"value":{"email":"name@example.com","status":"valid","last_name":"Martin","first_name":"Alex","company_domain":"piloterr.com"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/email/analyzes":{"get":{"summary":"Email Analyzes","description":"Analyze a domain to retrieve its email infrastructure. Microsoft 365 and Google Workspace domains, SPF records, and DNS configurations.\n\n**Credit cost:** 1 credit per call","operationId":"get-email-analyzes","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The domain name you want to analyze for email infrastructure.\n\n**Example:**\n\n    airbus.com\n\nThe API will return all associated Microsoft 365 and Google Workspace domains, along with SPF records and DNS configurations.\n\n**Note:** Provide a bare domain (e.g. `airbus.com`), not a full URL.","schema":{"type":"string","description":"The domain name you want to analyze for email infrastructure.\n\n**Example:**\n\n    airbus.com\n\nThe API will return all associated Microsoft 365 and Google Workspace domains, along with SPF records and DNS configurations.\n\n**Note:** Provide a bare domain (e.g. `airbus.com`), not a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"object","properties":{"airbus.com":{"type":"array","items":{"type":"string"}},"apsys-airbus.com":{"type":"array","items":{"type":"string"}},"airbus.onmicrosoft.com":{"type":"array","items":{"type":"string"}},"globalemail.airbus.com":{"type":"array","items":{}},"airbus.mail.onmicrosoft.com":{"type":"array","items":{"type":"string"}}}},"is_microsoft_365":{"type":"boolean"},"is_google_workspace":{"type":"boolean"},"microsoft_365_domains":{"type":"array","items":{"type":"string"}},"google_workspace_domains":{"type":"array","items":{}}}},"examples":{"Analyze email infrastructure for airbus.com":{"value":{"domains":{"airbus.com":["ag.eu.dmarcadvisor.com","airbus.com","group1._spf.airbus.com","zb85545947.zmverify.zoho.eu","group3._spf.airbus.com","group2._spf.airbus.com","dmarc.airbus.com","group4._spf.airbus.com","spf.airbus.com"],"apsys-airbus.com":["ag.eu.dmarcadvisor.com","airbus.com","spf.cloud.vadesecure.com","apsys-airbus.com","report.ssi"],"airbus.onmicrosoft.com":["spf.protection.outlook.com"],"globalemail.airbus.com":[],"airbus.mail.onmicrosoft.com":["outlook.com"]},"is_microsoft_365":true,"is_google_workspace":false,"microsoft_365_domains":["airbus.onmicrosoft.com","airbus.mail.onmicrosoft.com"],"google_workspace_domains":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Email Analyzes","description":"Analyze a domain to retrieve its email infrastructure. Microsoft 365 and Google Workspace domains, SPF records, and DNS configurations.\n\n**Credit cost:** 1 credit per call","operationId":"post-email-analyzes","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The domain name you want to analyze for email infrastructure.\n\n**Example:**\n\n    airbus.com\n\nThe API will return all associated Microsoft 365 and Google Workspace domains, along with SPF records and DNS configurations.\n\n**Note:** Provide a bare domain (e.g. `airbus.com`), not a full URL.","schema":{"type":"string","description":"The domain name you want to analyze for email infrastructure.\n\n**Example:**\n\n    airbus.com\n\nThe API will return all associated Microsoft 365 and Google Workspace domains, along with SPF records and DNS configurations.\n\n**Note:** Provide a bare domain (e.g. `airbus.com`), not a full URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"object","properties":{"airbus.com":{"type":"array","items":{"type":"string"}},"apsys-airbus.com":{"type":"array","items":{"type":"string"}},"airbus.onmicrosoft.com":{"type":"array","items":{"type":"string"}},"globalemail.airbus.com":{"type":"array","items":{}},"airbus.mail.onmicrosoft.com":{"type":"array","items":{"type":"string"}}}},"is_microsoft_365":{"type":"boolean"},"is_google_workspace":{"type":"boolean"},"microsoft_365_domains":{"type":"array","items":{"type":"string"}},"google_workspace_domains":{"type":"array","items":{}}}},"examples":{"Analyze email infrastructure for airbus.com":{"value":{"domains":{"airbus.com":["ag.eu.dmarcadvisor.com","airbus.com","group1._spf.airbus.com","zb85545947.zmverify.zoho.eu","group3._spf.airbus.com","group2._spf.airbus.com","dmarc.airbus.com","group4._spf.airbus.com","spf.airbus.com"],"apsys-airbus.com":["ag.eu.dmarcadvisor.com","airbus.com","spf.cloud.vadesecure.com","apsys-airbus.com","report.ssi"],"airbus.onmicrosoft.com":["spf.protection.outlook.com"],"globalemail.airbus.com":[],"airbus.mail.onmicrosoft.com":["outlook.com"]},"is_microsoft_365":true,"is_google_workspace":false,"microsoft_365_domains":["airbus.onmicrosoft.com","airbus.mail.onmicrosoft.com"],"google_workspace_domains":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/domain/whois":{"get":{"summary":"Domain Whois","description":"Retrieve WHOIS registration data for any domain, including registration dates, registrar details, name servers, and contact information.\n\n**Credit cost:** 1 credit per call","operationId":"get-domain-whois","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name for which you want to retrieve WHOIS registration information.\n\n**Example:**\n\n    piloterr.com\n\nThe API returns full WHOIS data including domain registration dates, registrar details, name servers, and contact information (where not redacted for privacy).\n\n**Note:** Privacy protection (GDPR redaction) may hide registrant details for many domains.","schema":{"type":"string","description":"A domain name for which you want to retrieve WHOIS registration information.\n\n**Example:**\n\n    piloterr.com\n\nThe API returns full WHOIS data including domain registration dates, registrar details, name servers, and contact information (where not redacted for privacy).\n\n**Note:** Privacy protection (GDPR redaction) may hide registrant details for many domains."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"type":"string"},"status":{"type":"array","items":{"type":"string"}},"punycode":{"type":"string"},"extension":{"type":"string"},"created_date":{"type":"string"},"name_servers":{"type":"array","items":{"type":"string"}},"updated_date":{"type":"string"},"whois_server":{"type":"string"},"expiration_date":{"type":"string"},"created_date_in_time":{"type":"string"},"updated_date_in_time":{"type":"string"},"expiration_date_in_time":{"type":"string"}}},"registrar":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"referral_url":{"type":"string"}}},"technical":{"type":"object","properties":{"fax":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"organization":{"type":"string"}}},"registrant":{"type":"object","properties":{"fax":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"}}},"administrative":{"type":"object","properties":{"fax":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"country":{"type":"string"},"organization":{"type":"string"}}}}},"examples":{"WHOIS lookup for piloterr.com":{"value":{"domain":{"id":"2236981934_DOMAIN_COM-VRSN","name":"piloterr","domain":"piloterr.com","status":["clientdeleteprohibited","clienttransferprohibited"],"punycode":"piloterr.com","extension":"com","created_date":"2018-03-08T23:08:14Z","name_servers":["cruz.ns.cloudflare.com","fred.ns.cloudflare.com"],"updated_date":"2023-06-22T07:40:14Z","whois_server":"whois.ovh.com","expiration_date":"2030-03-08T23:08:14Z","created_date_in_time":"2018-03-08T23:08:14Z","updated_date_in_time":"2023-06-22T07:40:14Z","expiration_date_in_time":"2030-03-08T23:08:14Z"},"registrar":{"id":"433","name":"OVH sas","email":"abuse@ovh.net","phone":"+33.972101007","referral_url":"https://www.ovh.com"},"technical":{"fax":"REDACTED FOR PRIVACY","city":"REDACTED FOR PRIVACY","name":"REDACTED FOR PRIVACY","email":"REDACTED FOR PRIVACY","phone":"REDACTED FOR PRIVACY","street":"REDACTED FOR PRIVACY","country":"REDACTED FOR PRIVACY","organization":"REDACTED FOR PRIVACY"},"registrant":{"fax":"REDACTED FOR PRIVACY","city":"REDACTED FOR PRIVACY","name":"REDACTED FOR PRIVACY","email":"REDACTED FOR PRIVACY","phone":"REDACTED FOR PRIVACY","street":"REDACTED FOR PRIVACY","country":"FR"},"administrative":{"fax":"REDACTED FOR PRIVACY","city":"REDACTED FOR PRIVACY","name":"REDACTED FOR PRIVACY","email":"REDACTED FOR PRIVACY","phone":"REDACTED FOR PRIVACY","country":"REDACTED FOR PRIVACY","organization":"REDACTED FOR PRIVACY"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Domain Whois","description":"Retrieve WHOIS registration data for any domain, including registration dates, registrar details, name servers, and contact information.\n\n**Credit cost:** 1 credit per call","operationId":"post-domain-whois","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name for which you want to retrieve WHOIS registration information.\n\n**Example:**\n\n    piloterr.com\n\nThe API returns full WHOIS data including domain registration dates, registrar details, name servers, and contact information (where not redacted for privacy).\n\n**Note:** Privacy protection (GDPR redaction) may hide registrant details for many domains.","schema":{"type":"string","description":"A domain name for which you want to retrieve WHOIS registration information.\n\n**Example:**\n\n    piloterr.com\n\nThe API returns full WHOIS data including domain registration dates, registrar details, name servers, and contact information (where not redacted for privacy).\n\n**Note:** Privacy protection (GDPR redaction) may hide registrant details for many domains."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"type":"string"},"status":{"type":"array","items":{"type":"string"}},"punycode":{"type":"string"},"extension":{"type":"string"},"created_date":{"type":"string"},"name_servers":{"type":"array","items":{"type":"string"}},"updated_date":{"type":"string"},"whois_server":{"type":"string"},"expiration_date":{"type":"string"},"created_date_in_time":{"type":"string"},"updated_date_in_time":{"type":"string"},"expiration_date_in_time":{"type":"string"}}},"registrar":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"referral_url":{"type":"string"}}},"technical":{"type":"object","properties":{"fax":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"organization":{"type":"string"}}},"registrant":{"type":"object","properties":{"fax":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"}}},"administrative":{"type":"object","properties":{"fax":{"type":"string"},"city":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"country":{"type":"string"},"organization":{"type":"string"}}}}},"examples":{"WHOIS lookup for piloterr.com":{"value":{"domain":{"id":"2236981934_DOMAIN_COM-VRSN","name":"piloterr","domain":"piloterr.com","status":["clientdeleteprohibited","clienttransferprohibited"],"punycode":"piloterr.com","extension":"com","created_date":"2018-03-08T23:08:14Z","name_servers":["cruz.ns.cloudflare.com","fred.ns.cloudflare.com"],"updated_date":"2023-06-22T07:40:14Z","whois_server":"whois.ovh.com","expiration_date":"2030-03-08T23:08:14Z","created_date_in_time":"2018-03-08T23:08:14Z","updated_date_in_time":"2023-06-22T07:40:14Z","expiration_date_in_time":"2030-03-08T23:08:14Z"},"registrar":{"id":"433","name":"OVH sas","email":"abuse@ovh.net","phone":"+33.972101007","referral_url":"https://www.ovh.com"},"technical":{"fax":"REDACTED FOR PRIVACY","city":"REDACTED FOR PRIVACY","name":"REDACTED FOR PRIVACY","email":"REDACTED FOR PRIVACY","phone":"REDACTED FOR PRIVACY","street":"REDACTED FOR PRIVACY","country":"REDACTED FOR PRIVACY","organization":"REDACTED FOR PRIVACY"},"registrant":{"fax":"REDACTED FOR PRIVACY","city":"REDACTED FOR PRIVACY","name":"REDACTED FOR PRIVACY","email":"REDACTED FOR PRIVACY","phone":"REDACTED FOR PRIVACY","street":"REDACTED FOR PRIVACY","country":"FR"},"administrative":{"fax":"REDACTED FOR PRIVACY","city":"REDACTED FOR PRIVACY","name":"REDACTED FOR PRIVACY","email":"REDACTED FOR PRIVACY","phone":"REDACTED FOR PRIVACY","country":"REDACTED FOR PRIVACY","organization":"REDACTED FOR PRIVACY"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/domain/malicious":{"get":{"summary":"Domain Malicious","description":"Check if a domain or IP address has been flagged as malicious across multiple threat intelligence feeds, with source attribution.\n\n**Credit cost:** 1 credit per call","operationId":"get-domain-malicious","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name or IP address to check for malicious activity across multiple threat intelligence sources.\n\n**Examples:**\n\n    197.33.189.70\n\n    malicious-domain.com\n\nThe API cross-references the input against community-curated threat feeds and returns whether it has been flagged as malicious, along with the specific sources that reported it.\n\n**Note:** Both IPv4 addresses and domain names are accepted.","schema":{"type":"string","description":"A domain name or IP address to check for malicious activity across multiple threat intelligence sources.\n\n**Examples:**\n\n    197.33.189.70\n\n    malicious-domain.com\n\nThe API cross-references the input against community-curated threat feeds and returns whether it has been flagged as malicious, along with the specific sources that reported it.\n\n**Note:** Both IPv4 addresses and domain names are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"malicious":{"type":"boolean"}}},"examples":{"Check malicious IP address":{"value":{"sources":[{"url":"https://raw.githubusercontent.com/duggytuxy/malicious_ip_addresses/main/blacklist_ips_for_fortinet_firewall_ab.txt","name":"Fortinet Firewall AB","type":"ip"},{"url":"https://raw.githubusercontent.com/duggytuxy/malicious_ip_addresses/main/botnets_zombies_scanner_spam_ips.txt","name":"Botnets, Zombies, Scanner, Spam IPs","type":"ip"}],"malicious":true}},"Check clean domain":{"value":{"sources":[],"malicious":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Domain Malicious","description":"Check if a domain or IP address has been flagged as malicious across multiple threat intelligence feeds, with source attribution.\n\n**Credit cost:** 1 credit per call","operationId":"post-domain-malicious","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name or IP address to check for malicious activity across multiple threat intelligence sources.\n\n**Examples:**\n\n    197.33.189.70\n\n    malicious-domain.com\n\nThe API cross-references the input against community-curated threat feeds and returns whether it has been flagged as malicious, along with the specific sources that reported it.\n\n**Note:** Both IPv4 addresses and domain names are accepted.","schema":{"type":"string","description":"A domain name or IP address to check for malicious activity across multiple threat intelligence sources.\n\n**Examples:**\n\n    197.33.189.70\n\n    malicious-domain.com\n\nThe API cross-references the input against community-curated threat feeds and returns whether it has been flagged as malicious, along with the specific sources that reported it.\n\n**Note:** Both IPv4 addresses and domain names are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"malicious":{"type":"boolean"}}},"examples":{"Check malicious IP address":{"value":{"sources":[{"url":"https://raw.githubusercontent.com/duggytuxy/malicious_ip_addresses/main/blacklist_ips_for_fortinet_firewall_ab.txt","name":"Fortinet Firewall AB","type":"ip"},{"url":"https://raw.githubusercontent.com/duggytuxy/malicious_ip_addresses/main/botnets_zombies_scanner_spam_ips.txt","name":"Botnets, Zombies, Scanner, Spam IPs","type":"ip"}],"malicious":true}},"Check clean domain":{"value":{"sources":[],"malicious":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/domain/dnsbl":{"get":{"summary":"Domain DNSBL","description":"Check if a domain or IP address is listed in DNS-based blacklists (DNSBL), with detailed provider-level detection and category information.\n\n**Credit cost:** 1 credit per call","operationId":"get-domain-dnsbl","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name or IP address to check against DNS-based blacklists (DNSBL).\n\n**Examples:**\n\n    185.122.10.10\n\nThe API checks the input against hundreds of DNSBL providers and returns whether it has been blacklisted, along with the list of detecting providers and their categories.\n\n**Note:** Both IPv4 addresses and domain names are accepted.","schema":{"type":"string","description":"A domain name or IP address to check against DNS-based blacklists (DNSBL).\n\n**Examples:**\n\n    185.122.10.10\n\nThe API checks the input against hundreds of DNSBL providers and returns whether it has been blacklisted, along with the list of detecting providers and their categories.\n\n**Note:** Both IPv4 addresses and domain names are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"},"detected":{"type":"object","properties":{"count":{"type":"integer"},"providers":{"type":"array","items":{"type":"string"}},"categories":{"type":"object","properties":{"dbl.spamhaus.org":{"type":"array","items":{"type":"string"}},"peer.asn.cymru.com":{"type":"array","items":{"type":"string"}},"origin.asn.cymru.com":{"type":"array","items":{"type":"string"}},"spambot.bls.digibase.ca":{"type":"array","items":{"type":"string"}},"abuse-contacts.abusix.org":{"type":"array","items":{"type":"string"}}}}}},"providers":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"string"}},"domains":{"type":"array","items":{"type":"string"}},"failed_count":{"type":"integer"},"domains_count":{"type":"integer"}}},"blacklisted":{"type":"boolean"}}},"examples":{"Check blacklisted IP address":{"value":{"address":"185.122.xx.xx","detected":{"count":5,"providers":["dbl.spamhaus.org","spambot.bls.digibase.ca","abuse-contacts.abusix.org","origin.asn.cymru.com","peer.asn.cymru.com"],"categories":{"dbl.spamhaus.org":["unknown"],"peer.asn.cymru.com":["unknown"],"origin.asn.cymru.com":["unknown"],"spambot.bls.digibase.ca":["unknown"],"abuse-contacts.abusix.org":["unknown"]}},"providers":{"failed":["list.bbfh.org","dnsbl.darklist.de","dnsbl.isx.fr"],"domains":["dbl.spamhaus.org","spambot.bls.digibase.ca","zen.spamhaus.org"],"failed_count":23,"domains_count":271},"blacklisted":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Domain DNSBL","description":"Check if a domain or IP address is listed in DNS-based blacklists (DNSBL), with detailed provider-level detection and category information.\n\n**Credit cost:** 1 credit per call","operationId":"post-domain-dnsbl","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A domain name or IP address to check against DNS-based blacklists (DNSBL).\n\n**Examples:**\n\n    185.122.10.10\n\nThe API checks the input against hundreds of DNSBL providers and returns whether it has been blacklisted, along with the list of detecting providers and their categories.\n\n**Note:** Both IPv4 addresses and domain names are accepted.","schema":{"type":"string","description":"A domain name or IP address to check against DNS-based blacklists (DNSBL).\n\n**Examples:**\n\n    185.122.10.10\n\nThe API checks the input against hundreds of DNSBL providers and returns whether it has been blacklisted, along with the list of detecting providers and their categories.\n\n**Note:** Both IPv4 addresses and domain names are accepted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"},"detected":{"type":"object","properties":{"count":{"type":"integer"},"providers":{"type":"array","items":{"type":"string"}},"categories":{"type":"object","properties":{"dbl.spamhaus.org":{"type":"array","items":{"type":"string"}},"peer.asn.cymru.com":{"type":"array","items":{"type":"string"}},"origin.asn.cymru.com":{"type":"array","items":{"type":"string"}},"spambot.bls.digibase.ca":{"type":"array","items":{"type":"string"}},"abuse-contacts.abusix.org":{"type":"array","items":{"type":"string"}}}}}},"providers":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"string"}},"domains":{"type":"array","items":{"type":"string"}},"failed_count":{"type":"integer"},"domains_count":{"type":"integer"}}},"blacklisted":{"type":"boolean"}}},"examples":{"Check blacklisted IP address":{"value":{"address":"185.122.xx.xx","detected":{"count":5,"providers":["dbl.spamhaus.org","spambot.bls.digibase.ca","abuse-contacts.abusix.org","origin.asn.cymru.com","peer.asn.cymru.com"],"categories":{"dbl.spamhaus.org":["unknown"],"peer.asn.cymru.com":["unknown"],"origin.asn.cymru.com":["unknown"],"spambot.bls.digibase.ca":["unknown"],"abuse-contacts.abusix.org":["unknown"]}},"providers":{"failed":["list.bbfh.org","dnsbl.darklist.de","dnsbl.isx.fr"],"domains":["dbl.spamhaus.org","spambot.bls.digibase.ca","zen.spamhaus.org"],"failed_count":23,"domains_count":271},"blacklisted":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/website/rendering":{"post":{"summary":"Website Rendering Instructions (POST)","description":"Execute browser automation instructions (scroll, scroll_to_bottom) during headless rendering to trigger lazy-loaded content, bypass anti-bot detection, and scrape dynamically loaded pages.\n\n**Credit cost:** 2 credits per call","operationId":"post-website-rendering","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A website URL to render using a headless browser. Must include the `http` or `https` protocol.\n\n**Example:**\n\n    https://www.comparably.com/companies/airbus\n\n**Notes:**\n- For security and ethical reasons, Piloterr applies domain filtering. Contact support to whitelist your target domain if needed.\n- Use this endpoint for JavaScript-heavy pages that require client-side rendering and advanced browser interactions.","schema":{"type":"string","description":"A website URL to render using a headless browser. Must include the `http` or `https` protocol.\n\n**Example:**\n\n    https://www.comparably.com/companies/airbus\n\n**Notes:**\n- For security and ethical reasons, Piloterr applies domain filtering. Contact support to whitelist your target domain if needed.\n- Use this endpoint for JavaScript-heavy pages that require client-side rendering and advanced browser interactions."}},{"name":"wait_in_seconds","in":"query","required":false,"description":"Number of seconds to wait after page load before returning the rendered HTML. Useful for pages with delayed rendering or animations.\n\n**Notes:**\n- Increasing this value adds latency to every request. Use only when a page's content loads after a delay.\n- If using `browser_instructions` with significant durations, consider increasing this value accordingly.","schema":{"type":"number","minimum":0,"maximum":30,"default":"0","description":"Number of seconds to wait after page load before returning the rendered HTML. Useful for pages with delayed rendering or animations.\n\n**Notes:**\n- Increasing this value adds latency to every request. Use only when a page's content loads after a delay.\n- If using `browser_instructions` with significant durations, consider increasing this value accordingly."}},{"name":"wait_for","in":"query","required":false,"description":"A CSS or XPath selector to wait for before returning the rendered HTML. The headless browser will hold the response until the specified element appears in the DOM.\n\nSupported selector types:\n- **ID selector:** `#ng-state`\n- **Class selector:** `.content-loaded`\n- **Combined selector:** `div.main-content#user-profile`\n\n**Example:**\n\n    wait_for=#ng-state\n\n**Notes:**\n- If the element never appears, the request will time out according to the `timeout` parameter.\n- Combine with `browser_instructions` to wait for elements that only appear after scrolling or interaction.","schema":{"type":"string","description":"A CSS or XPath selector to wait for before returning the rendered HTML. The headless browser will hold the response until the specified element appears in the DOM.\n\nSupported selector types:\n- **ID selector:** `#ng-state`\n- **Class selector:** `.content-loaded`\n- **Combined selector:** `div.main-content#user-profile`\n\n**Example:**\n\n    wait_for=#ng-state\n\n**Notes:**\n- If the element never appears, the request will time out according to the `timeout` parameter.\n- Combine with `browser_instructions` to wait for elements that only appear after scrolling or interaction."}},{"name":"block_ads","in":"query","required":false,"description":"Controls whether the headless browser should block ad requests during rendering.\n\n- `false`: Ads are loaded normally (**default**)\n- `true`: Ad network requests are blocked, resulting in cleaner HTML and faster rendering\n\n**Notes:**\n- Blocking ads can speed up rendering on ad-heavy pages and reduce noise in the extracted HTML.","schema":{"type":"boolean","default":"false","description":"Controls whether the headless browser should block ad requests during rendering.\n\n- `false`: Ads are loaded normally (**default**)\n- `true`: Ad network requests are blocked, resulting in cleaner HTML and faster rendering\n\n**Notes:**\n- Blocking ads can speed up rendering on ad-heavy pages and reduce noise in the extracted HTML."}},{"name":"timeout","in":"query","required":false,"description":"Maximum number of seconds to wait for the page to fully load before returning whatever has been rendered so far.\n\n**Notes:**\n- Setting a lower timeout may result in incomplete HTML for slow-loading pages.\n- **When using `browser_instructions` with durations**, increase this value to avoid premature timeouts. For example, if your instructions total 15 seconds of scrolling plus waits, set `timeout` to at least `45`.","schema":{"type":"number","default":"30","description":"Maximum number of seconds to wait for the page to fully load before returning whatever has been rendered so far.\n\n**Notes:**\n- Setting a lower timeout may result in incomplete HTML for slow-loading pages.\n- **When using `browser_instructions` with durations**, increase this value to avoid premature timeouts. For example, if your instructions total 15 seconds of scrolling plus waits, set `timeout` to at least `45`."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"browser_instructions":{"type":"array","items":{"type":"string"},"description":"JSON **array** sent in the **POST body** (not a query string, not a stringified JSON string).\n\nstatus.computer browser workers only execute instructions when this field is a real array (`browser_instructions` / `browserInstructions`).\n\nA JSON array of browser navigation instructions to execute sequentially during page rendering. Allows controlling scrolling and other browser actions to trigger dynamic content loading or simulate human behavior.\n\nCurrently supports two instruction types:\n\n- `scroll`: Scrolls the page by a precise number of pixels (horizontally and/or vertically)\n- `scroll_to_bottom`: Automatically scrolls to the bottom of the page\n\n---\n\n**Instruction type: `scroll`**\n\nParameters:\n- `type`: `\"scroll\"`\n- `x`: Pixels to scroll horizontally (positive = right, negative = left)\n- `y`: Pixels to scroll vertically (positive = down, negative = up)\n- `duration` *(optional)*: Duration in seconds for smooth scrolling. Default: `0` (instant)\n- `wait_time_s` *(optional)*: Seconds to wait after the instruction completes. Default: `0`\n\n**Example payload:**\n```json\n{\n    \"type\": \"scroll\",\n    \"x\": 0,\n    \"y\": 4115,\n    \"duration\": 5,\n    \"wait_time_s\": 2\n}\n```\n\n---\n\n**Instruction type: `scroll_to_bottom`**\n\nParameters:\n- `type`: `\"scroll_to_bottom\"`\n- `duration` *(optional)*: Duration in seconds for smooth scrolling. Default: `0` (instant)\n- `wait_time_s` *(optional)*: Seconds to wait after the instruction completes. Default: `0`\n\n**Example payload:**\n```json\n{\n    \"type\": \"scroll_to_bottom\",\n    \"duration\": 3,\n    \"wait_time_s\": 2\n}\n```\n\n---\n\n**Full request example (multiple instructions):**\n```json\n{\n    \"query\": \"https://www.comparably.com/companies/airbus\",\n    \"wait_for\": \"#ng-state\",\n    \"browser_instructions\": [\n        {\"type\": \"scroll\", \"x\": 0, \"y\": 1000, \"duration\": 2, \"wait_time_s\": 1},\n        {\"type\": \"scroll\", \"x\": 0, \"y\": 2000, \"duration\": 3, \"wait_time_s\": 1},\n        {\"type\": \"scroll_to_bottom\", \"duration\": 4, \"wait_time_s\": 2}\n    ]\n}\n```\n\n**Notes:**\n- **Execution order:** Instructions are executed sequentially in the specified order\n- **Error handling:** If one instruction fails, subsequent ones continue to execute\n- **Smooth scrolling (`duration > 0`)** takes more time but better simulates human behavior and avoids bot detection\n- **Increase `timeout`** when using instructions with significant cumulative durations"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"Scroll by pixels on Comparably (Airbus)":{"value":"<!DOCTYPE html><html lang=\"en\" data-critters-container=\"\"><head>\n     <!-- OneTrust Cookies Consent Notice start for http://www.comparably.com  -->\n     <script type=\"text/javascript\" async=\"\" src=\"https://assets.zoominfo.co/ux-track/master/ux-track/latest/analytics.js\"></script>\n     <script type=\"text/javascript\" src=\"https://cdn.cookielaw.org/consent/0197f029-2495-7a37-a669-7741ca3f3738/OtAutoBlock.js\"></script>\n     <script src=\"https://cdn.cookielaw.org/scripttemplates/otSDKStub.js\" type=\"text/javascript\" charset=\"UTF-8\" data-domain-script=\"0197f029-2495-7a37-a669-7741ca3f3738\"></script>\n     <script type=\"text/javascript\">function OptanonWrapper() {}</script>\n    <meta charset=\"utf-8\">\n    <title>Airbus Culture | Comparably</title>\n    <base href=\"/\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n    <link rel=\"icon\" type=\"image/x-icon\" href=\"favicon.ico\">\n    <link rel=\"preconnect\" href=\"https://fonts.googleapis.com\">\n    <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin=\"\">\n    <!-- ... full rendered HTML with dynamic content loaded after scroll ... -->\n</head><body>...</body></html>"},"Scroll to bottom on Comparably (Airbus)":{"value":"<!DOCTYPE html><html lang=\"en\" data-critters-container=\"\"><head>\n     <!-- OneTrust Cookies Consent Notice start for http://www.comparably.com  -->\n     <script type=\"text/javascript\" async=\"\" src=\"https://assets.zoominfo.co/ux-track/master/ux-track/latest/analytics.js\"></script>\n     <script type=\"text/javascript\" src=\"https://cdn.cookielaw.org/consent/0197f029-2495-7a37-a669-7741ca3f3738/OtAutoBlock.js\"></script>\n    <meta charset=\"utf-8\">\n    <title>Airbus Culture | Comparably</title>\n    <base href=\"/\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n    <!-- ... full rendered HTML with all lazy-loaded content triggered by scroll_to_bottom ... -->\n</head><body>...</body></html>"}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"get":{"summary":"Website Rendering","description":"Render JavaScript-heavy pages in a headless browser and return post-render HTML. Use when Crawler returns empty DOM; escalate to WebUnlocker if bot protection blocks the session.\n\n**Credit cost:** 2 credits per call","operationId":"get-website-rendering","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A public website URL to render in a headless browser. Must include `http://` or `https://`.\n\n**Example:**\n\n    https://example.com\n\n**Choosing the right engine:**\n- Static HTML already in the page? Try [Website Crawler](https://www.piloterr.com/library/website-crawler) first (1 credit, faster).\n- This endpoint ([Website Rendering](https://www.piloterr.com/library/website-rendering)) runs JavaScript and returns post-render HTML.\n- Still blocked after rendering? Escalate to [Website WebUnlocker](https://www.piloterr.com/library/website-webunlocker) if the domain is whitelisted.\n\nSee [Website Scraping guide](https://www.piloterr.com/blog/website-crawler-vs-rendering-vs-webunlocker) for a full comparison.","schema":{"type":"string","description":"A public website URL to render in a headless browser. Must include `http://` or `https://`.\n\n**Example:**\n\n    https://example.com\n\n**Choosing the right engine:**\n- Static HTML already in the page? Try [Website Crawler](https://www.piloterr.com/library/website-crawler) first (1 credit, faster).\n- This endpoint ([Website Rendering](https://www.piloterr.com/library/website-rendering)) runs JavaScript and returns post-render HTML.\n- Still blocked after rendering? Escalate to [Website WebUnlocker](https://www.piloterr.com/library/website-webunlocker) if the domain is whitelisted.\n\nSee [Website Scraping guide](https://www.piloterr.com/blog/website-crawler-vs-rendering-vs-webunlocker) for a full comparison."}},{"name":"wait_in_seconds","in":"query","required":false,"description":"Number of seconds to wait after page load before returning the rendered HTML. Useful for pages with delayed rendering or animations.\n\n**Notes:**\n- Increasing this value adds latency to every request. Use only when a page's content loads after a delay.","schema":{"type":"number","minimum":0,"maximum":30,"default":"0","description":"Number of seconds to wait after page load before returning the rendered HTML. Useful for pages with delayed rendering or animations.\n\n**Notes:**\n- Increasing this value adds latency to every request. Use only when a page's content loads after a delay."}},{"name":"wait_for","in":"query","required":false,"description":"A CSS or XPath selector to wait for before returning the rendered HTML. The headless browser will hold the response until the specified element appears in the DOM.\n\nSupported selector types:\n- **ID selector:** `#loading-container`\n- **Class selector:** `.content-loaded`\n- **Combined selector:** `div.main-content#user-profile`\n\n**Example:**\n\n    wait_for=#loading-container\n\n**Notes:**\n- If the element never appears, the request will time out according to the `timeout` parameter.","schema":{"type":"string","description":"A CSS or XPath selector to wait for before returning the rendered HTML. The headless browser will hold the response until the specified element appears in the DOM.\n\nSupported selector types:\n- **ID selector:** `#loading-container`\n- **Class selector:** `.content-loaded`\n- **Combined selector:** `div.main-content#user-profile`\n\n**Example:**\n\n    wait_for=#loading-container\n\n**Notes:**\n- If the element never appears, the request will time out according to the `timeout` parameter."}},{"name":"block_ads","in":"query","required":false,"description":"Controls whether the headless browser should block ad requests during rendering.\n\n- `false`: Ads are loaded normally (**default**)\n- `true`: Ad network requests are blocked, resulting in cleaner HTML and faster rendering\n\n**Notes:**\n- Blocking ads can speed up rendering on ad-heavy pages and reduce noise in the extracted HTML.","schema":{"type":"boolean","default":"false","description":"Controls whether the headless browser should block ad requests during rendering.\n\n- `false`: Ads are loaded normally (**default**)\n- `true`: Ad network requests are blocked, resulting in cleaner HTML and faster rendering\n\n**Notes:**\n- Blocking ads can speed up rendering on ad-heavy pages and reduce noise in the extracted HTML."}},{"name":"timeout","in":"query","required":false,"description":"Maximum number of seconds to wait for the page to fully load before returning whatever has been rendered so far.\n\n- Accepts integer values representing seconds\n\n**Notes:**\n- Setting a lower timeout may result in incomplete HTML for slow-loading pages.\n- Combine with `wait_for` to ensure critical elements are present before the timeout fires.","schema":{"type":"number","default":"30","description":"Maximum number of seconds to wait for the page to fully load before returning whatever has been rendered so far.\n\n- Accepts integer values representing seconds\n\n**Notes:**\n- Setting a lower timeout may result in incomplete HTML for slow-loading pages.\n- Combine with `wait_for` to ensure critical elements are present before the timeout fires."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"Render example.com":{"value":"<!DOCTYPE html><html lang=\"en\"><head><title>Example Domain</title><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"><style>body{background:#eee;width:60vw;margin:15vh auto;font-family:system-ui,sans-serif}h1{font-size:1.5em}div{opacity:0.8}a:link,a:visited{color:#348}</style></head><body><div><h1>Example Domain</h1><p>This domain is for use in documentation examples without needing permission. Avoid use in operations.</p><p><a href=\"https://iana.org/domains/example\">Learn more</a></p></div>\n</body></html>"}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/website/technology":{"get":{"summary":"Website Technology","description":"Identify the technologies behind any website CMS, frameworks, analytics, CDN, hosting, and more, for competitive market analysis and technological insight.\n\n**Credit cost:** 1 credit per call","operationId":"get-website-technology","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A website URL to analyze for technology stack detection. Must include the `http://` or `https://` protocol.\n\n**Example:**\n\n    https://example.com\n\n**Notes:**\n- Response time is typically between 10 and 15 seconds due to deep technology fingerprinting.\n- Works with any public-facing website URL.","schema":{"type":"string","description":"A website URL to analyze for technology stack detection. Must include the `http://` or `https://` protocol.\n\n**Example:**\n\n    https://example.com\n\n**Notes:**\n- Response time is typically between 10 and 15 seconds due to deep technology fingerprinting.\n- Works with any public-facing website URL."}},{"name":"mode","in":"query","required":false,"description":"Controls the level of detail returned in the technology detection response.\n\n- `expert`: Returns comprehensive technical details including confidence scores, version numbers, CPE identifiers, category metadata, and technology descriptions. **Default.**\n- `simple`: Returns a lightweight summary with the CMS name, URL status codes, and a flat list of technology names\n\n**Notes:**\n- Use `simple` mode for quick stack overviews or when building dashboards that only need technology names.\n- Use `expert` mode when you need confidence scores, categorization, or version information for deep analysis.","schema":{"type":"string","default":"expert","description":"Controls the level of detail returned in the technology detection response.\n\n- `expert`: Returns comprehensive technical details including confidence scores, version numbers, CPE identifiers, category metadata, and technology descriptions. **Default.**\n- `simple`: Returns a lightweight summary with the CMS name, URL status codes, and a flat list of technology names\n\n**Notes:**\n- Use `simple` mode for quick stack overviews or when building dashboards that only need technology names.\n- Use `expert` mode when you need confidence scores, categorization, or version information for deep analysis."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cms":{"type":"string"},"urls":{"type":"object","properties":{"https://piloterr.com/":{"type":"object","properties":{"status":{"type":"integer"}}},"https://www.piloterr.com/":{"type":"object","properties":{"status":{"type":"integer"}}}}},"technologies":{"type":"array","items":{"type":"string"}}}},"examples":{"Technology lookup for piloterr.com (simple mode)":{"value":{"cms":"Webflow","urls":{"https://piloterr.com/":{"status":301},"https://www.piloterr.com/":{"status":200}},"technologies":["Webflow","jsDelivr","Google Tag Manager","Google Hosted Libraries","Customer.io","reCAPTCHA","jQuery","HubSpot Chat","HubSpot","Google Analytics","Cloudflare Turnstile","Google Font API","HSTS","Cloudflare","Webpack","Open Graph","HTTP/3"]}},"Technology lookup for leroymerlin.fr (expert mode)":{"value":{"urls":{"https://leroymerlin.fr/":{"status":301},"https://www.leroymerlin.fr/":{"status":403}},"technologies":[{"cpe":null,"icon":"default.svg","name":"HSTS","slug":"hsts","version":null,"website":"https://www.rfc-editor.org/rfc/rfc6797#section-6.1","rootPath":true,"categories":[{"id":16,"name":"Security","slug":"security"}],"confidence":100,"description":"HTTP Strict Transport Security (HSTS) informs browsers that the site should only be accessed using HTTPS."},{"cpe":null,"icon":"DataDome.svg","name":"DataDome","slug":"datadome","version":null,"website":"https://datadome.co","rootPath":true,"categories":[{"id":16,"name":"Security","slug":"security"}],"confidence":100,"description":"DataDome is a cybersecurity platform that specialises in bot protection and mitigation, offering advanced solutions to safeguard websites and mobile applications against malicious bot traffic."}]}},"Technology lookup for github.com (simple mode)":{"value":{"cms":"Contentful","urls":{"https://github.com/":{"status":200}},"technologies":["Contentful","Three.js","Amazon Web Services","React","GSAP","GitHub Pages","Turbo","lit-html","Sectigo","HSTS","Amazon S3","PWA","Open Graph"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Website Technology","description":"Identify the technologies behind any website CMS, frameworks, analytics, CDN, hosting, and more, for competitive market analysis and technological insight.\n\n**Credit cost:** 1 credit per call","operationId":"post-website-technology","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A website URL to analyze for technology stack detection. Must include the `http://` or `https://` protocol.\n\n**Example:**\n\n    https://example.com\n\n**Notes:**\n- Response time is typically between 10 and 15 seconds due to deep technology fingerprinting.\n- Works with any public-facing website URL.","schema":{"type":"string","description":"A website URL to analyze for technology stack detection. Must include the `http://` or `https://` protocol.\n\n**Example:**\n\n    https://example.com\n\n**Notes:**\n- Response time is typically between 10 and 15 seconds due to deep technology fingerprinting.\n- Works with any public-facing website URL."}},{"name":"mode","in":"query","required":false,"description":"Controls the level of detail returned in the technology detection response.\n\n- `expert`: Returns comprehensive technical details including confidence scores, version numbers, CPE identifiers, category metadata, and technology descriptions. **Default.**\n- `simple`: Returns a lightweight summary with the CMS name, URL status codes, and a flat list of technology names\n\n**Notes:**\n- Use `simple` mode for quick stack overviews or when building dashboards that only need technology names.\n- Use `expert` mode when you need confidence scores, categorization, or version information for deep analysis.","schema":{"type":"string","default":"expert","description":"Controls the level of detail returned in the technology detection response.\n\n- `expert`: Returns comprehensive technical details including confidence scores, version numbers, CPE identifiers, category metadata, and technology descriptions. **Default.**\n- `simple`: Returns a lightweight summary with the CMS name, URL status codes, and a flat list of technology names\n\n**Notes:**\n- Use `simple` mode for quick stack overviews or when building dashboards that only need technology names.\n- Use `expert` mode when you need confidence scores, categorization, or version information for deep analysis."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cms":{"type":"string"},"urls":{"type":"object","properties":{"https://piloterr.com/":{"type":"object","properties":{"status":{"type":"integer"}}},"https://www.piloterr.com/":{"type":"object","properties":{"status":{"type":"integer"}}}}},"technologies":{"type":"array","items":{"type":"string"}}}},"examples":{"Technology lookup for piloterr.com (simple mode)":{"value":{"cms":"Webflow","urls":{"https://piloterr.com/":{"status":301},"https://www.piloterr.com/":{"status":200}},"technologies":["Webflow","jsDelivr","Google Tag Manager","Google Hosted Libraries","Customer.io","reCAPTCHA","jQuery","HubSpot Chat","HubSpot","Google Analytics","Cloudflare Turnstile","Google Font API","HSTS","Cloudflare","Webpack","Open Graph","HTTP/3"]}},"Technology lookup for leroymerlin.fr (expert mode)":{"value":{"urls":{"https://leroymerlin.fr/":{"status":301},"https://www.leroymerlin.fr/":{"status":403}},"technologies":[{"cpe":null,"icon":"default.svg","name":"HSTS","slug":"hsts","version":null,"website":"https://www.rfc-editor.org/rfc/rfc6797#section-6.1","rootPath":true,"categories":[{"id":16,"name":"Security","slug":"security"}],"confidence":100,"description":"HTTP Strict Transport Security (HSTS) informs browsers that the site should only be accessed using HTTPS."},{"cpe":null,"icon":"DataDome.svg","name":"DataDome","slug":"datadome","version":null,"website":"https://datadome.co","rootPath":true,"categories":[{"id":16,"name":"Security","slug":"security"}],"confidence":100,"description":"DataDome is a cybersecurity platform that specialises in bot protection and mitigation, offering advanced solutions to safeguard websites and mobile applications against malicious bot traffic."}]}},"Technology lookup for github.com (simple mode)":{"value":{"cms":"Contentful","urls":{"https://github.com/":{"status":200}},"technologies":["Contentful","Three.js","Amazon Web Services","React","GSAP","GitHub Pages","Turbo","lit-html","Sectigo","HSTS","Amazon S3","PWA","Open Graph"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/website/email_phone_extractor":{"get":{"summary":"Website Email Phone Extractor","description":"Extract emails and phone numbers from websites for comprehensive contact details, including social media profiles across 12+ platforms.\n\n**Credit cost:** 1 credit per call","operationId":"get-website-email-phone-extractor","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A website URL to crawl for contact information. Must include the `http://` or `https://` protocol. The crawler will follow internal links (\"a\" anchors) to find contact details across the site.\n\n**Example:**\n\n    https://www.hexa.cc\n\n**Notes:**\n- **GDPR:** Results may contain personal data. Ensure you have a legitimate reason for collection under applicable regulations.","schema":{"type":"string","description":"A website URL to crawl for contact information. Must include the `http://` or `https://` protocol. The crawler will follow internal links (\"a\" anchors) to find contact details across the site.\n\n**Example:**\n\n    https://www.hexa.cc\n\n**Notes:**\n- **GDPR:** Results may contain personal data. Ensure you have a legitimate reason for collection under applicable regulations."}},{"name":"country_code","in":"query","required":false,"description":"An ISO 3166-1 alpha-2 country code used to improve the accuracy of phone number validation and parsing.\n\n- `FR`: France\n- `US`: United States\n- `DE`: Germany\n- `GB`: United Kingdom\n- (any valid ISO country code)\n\n**Notes:**\n- Without a country code, phone numbers may not be validated accurately across different regional formats.\n- **Recommended** when the target site is country-specific.\n\n**Example:**\n\n    country_code=FR","schema":{"type":"string","description":"An ISO 3166-1 alpha-2 country code used to improve the accuracy of phone number validation and parsing.\n\n- `FR`: France\n- `US`: United States\n- `DE`: Germany\n- `GB`: United Kingdom\n- (any valid ISO country code)\n\n**Notes:**\n- Without a country code, phone numbers may not be validated accurately across different regional formats.\n- **Recommended** when the target site is country-specific.\n\n**Example:**\n\n    country_code=FR"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}},"contact_pages":{"type":"array","items":{}},"phone_numbers":{"type":"array","items":{}},"reddit_profiles":{"type":"array","items":{}},"tiktok_profiles":{"type":"array","items":{}},"twitter_profiles":{"type":"array","items":{"type":"string"}},"youtube_channels":{"type":"array","items":{}},"facebook_profiles":{"type":"array","items":{}},"linkedin_profiles":{"type":"array","items":{"type":"string"}},"snapchat_profiles":{"type":"array","items":{}},"telegram_channels":{"type":"array","items":{}},"instagram_profiles":{"type":"array","items":{"type":"string"}},"pinterest_profiles":{"type":"array","items":{}},"crunchbase_profiles":{"type":"array","items":{}}}},"examples":{"Extract contacts from hexa.cc":{"value":{"emails":["love@hexa.com"],"contact_pages":[],"phone_numbers":[],"reddit_profiles":[],"tiktok_profiles":[],"twitter_profiles":["https://x.com/joinhexa"],"youtube_channels":[],"facebook_profiles":[],"linkedin_profiles":["https://www.linkedin.com/company/joinhexa/"],"snapchat_profiles":[],"telegram_channels":[],"instagram_profiles":["https://www.instagram.com/joinhexa/"],"pinterest_profiles":[],"crunchbase_profiles":[]}},"Extract contacts from piloterr.com (country_code=FR)":{"value":{"emails":[],"contact_pages":["https://www.piloterr.com/contact"],"phone_numbers":[],"reddit_profiles":[],"tiktok_profiles":[],"twitter_profiles":[],"youtube_channels":[],"facebook_profiles":[],"linkedin_profiles":[],"snapchat_profiles":[],"telegram_channels":[],"instagram_profiles":[],"pinterest_profiles":[],"crunchbase_profiles":[]}},"Extract contacts from stripe.com (country_code=US)":{"value":{"emails":[],"contact_pages":["https://stripe.com/en-fr/contact/sales"],"phone_numbers":[],"reddit_profiles":[],"tiktok_profiles":[],"twitter_profiles":[],"youtube_channels":[],"facebook_profiles":[],"linkedin_profiles":[],"snapchat_profiles":[],"telegram_channels":[],"instagram_profiles":[],"pinterest_profiles":[],"crunchbase_profiles":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Website Email Phone Extractor","description":"Extract emails and phone numbers from websites for comprehensive contact details, including social media profiles across 12+ platforms.\n\n**Credit cost:** 1 credit per call","operationId":"post-website-email-phone-extractor","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A website URL to crawl for contact information. Must include the `http://` or `https://` protocol. The crawler will follow internal links (\"a\" anchors) to find contact details across the site.\n\n**Example:**\n\n    https://www.hexa.cc\n\n**Notes:**\n- **GDPR:** Results may contain personal data. Ensure you have a legitimate reason for collection under applicable regulations.","schema":{"type":"string","description":"A website URL to crawl for contact information. Must include the `http://` or `https://` protocol. The crawler will follow internal links (\"a\" anchors) to find contact details across the site.\n\n**Example:**\n\n    https://www.hexa.cc\n\n**Notes:**\n- **GDPR:** Results may contain personal data. Ensure you have a legitimate reason for collection under applicable regulations."}},{"name":"country_code","in":"query","required":false,"description":"An ISO 3166-1 alpha-2 country code used to improve the accuracy of phone number validation and parsing.\n\n- `FR`: France\n- `US`: United States\n- `DE`: Germany\n- `GB`: United Kingdom\n- (any valid ISO country code)\n\n**Notes:**\n- Without a country code, phone numbers may not be validated accurately across different regional formats.\n- **Recommended** when the target site is country-specific.\n\n**Example:**\n\n    country_code=FR","schema":{"type":"string","description":"An ISO 3166-1 alpha-2 country code used to improve the accuracy of phone number validation and parsing.\n\n- `FR`: France\n- `US`: United States\n- `DE`: Germany\n- `GB`: United Kingdom\n- (any valid ISO country code)\n\n**Notes:**\n- Without a country code, phone numbers may not be validated accurately across different regional formats.\n- **Recommended** when the target site is country-specific.\n\n**Example:**\n\n    country_code=FR"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}},"contact_pages":{"type":"array","items":{}},"phone_numbers":{"type":"array","items":{}},"reddit_profiles":{"type":"array","items":{}},"tiktok_profiles":{"type":"array","items":{}},"twitter_profiles":{"type":"array","items":{"type":"string"}},"youtube_channels":{"type":"array","items":{}},"facebook_profiles":{"type":"array","items":{}},"linkedin_profiles":{"type":"array","items":{"type":"string"}},"snapchat_profiles":{"type":"array","items":{}},"telegram_channels":{"type":"array","items":{}},"instagram_profiles":{"type":"array","items":{"type":"string"}},"pinterest_profiles":{"type":"array","items":{}},"crunchbase_profiles":{"type":"array","items":{}}}},"examples":{"Extract contacts from hexa.cc":{"value":{"emails":["love@hexa.com"],"contact_pages":[],"phone_numbers":[],"reddit_profiles":[],"tiktok_profiles":[],"twitter_profiles":["https://x.com/joinhexa"],"youtube_channels":[],"facebook_profiles":[],"linkedin_profiles":["https://www.linkedin.com/company/joinhexa/"],"snapchat_profiles":[],"telegram_channels":[],"instagram_profiles":["https://www.instagram.com/joinhexa/"],"pinterest_profiles":[],"crunchbase_profiles":[]}},"Extract contacts from piloterr.com (country_code=FR)":{"value":{"emails":[],"contact_pages":["https://www.piloterr.com/contact"],"phone_numbers":[],"reddit_profiles":[],"tiktok_profiles":[],"twitter_profiles":[],"youtube_channels":[],"facebook_profiles":[],"linkedin_profiles":[],"snapchat_profiles":[],"telegram_channels":[],"instagram_profiles":[],"pinterest_profiles":[],"crunchbase_profiles":[]}},"Extract contacts from stripe.com (country_code=US)":{"value":{"emails":[],"contact_pages":["https://stripe.com/en-fr/contact/sales"],"phone_numbers":[],"reddit_profiles":[],"tiktok_profiles":[],"twitter_profiles":[],"youtube_channels":[],"facebook_profiles":[],"linkedin_profiles":[],"snapchat_profiles":[],"telegram_channels":[],"instagram_profiles":[],"pinterest_profiles":[],"crunchbase_profiles":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/website/crawler":{"get":{"summary":"Website Crawler","description":"Fetch public pages with fast HTTP crawling (no JavaScript). Best first choice for static or server-rendered HTML; use Rendering or WebUnlocker when JS or anti-bot blocks you.\n\n**Credit cost:** 1 credit per call","operationId":"get-website-crawler","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A public website URL to fetch with the Crawler engine (HTTP only, no JavaScript). Must include `http://` or `https://`.\n\n**Example:**\n\n    https://example.com\n\n**Choosing the right engine:**\n- Start here for static or server-rendered HTML ([Website Crawler](https://www.piloterr.com/library/website-crawler)).\n- Need JavaScript execution? Use [Website Rendering](https://www.piloterr.com/library/website-rendering) instead.\n- Blocked by Cloudflare/DataDome on a whitelisted domain? Use [Website WebUnlocker](https://www.piloterr.com/library/website-webunlocker).\n\nSee [Website Scraping guide](https://www.piloterr.com/blog/website-crawler-vs-rendering-vs-webunlocker) for a full comparison.","schema":{"type":"string","description":"A public website URL to fetch with the Crawler engine (HTTP only, no JavaScript). Must include `http://` or `https://`.\n\n**Example:**\n\n    https://example.com\n\n**Choosing the right engine:**\n- Start here for static or server-rendered HTML ([Website Crawler](https://www.piloterr.com/library/website-crawler)).\n- Need JavaScript execution? Use [Website Rendering](https://www.piloterr.com/library/website-rendering) instead.\n- Blocked by Cloudflare/DataDome on a whitelisted domain? Use [Website WebUnlocker](https://www.piloterr.com/library/website-webunlocker).\n\nSee [Website Scraping guide](https://www.piloterr.com/blog/website-crawler-vs-rendering-vs-webunlocker) for a full comparison."}},{"name":"allow_redirects","in":"query","required":false,"description":"Controls whether the crawler should follow HTTP redirects.\n\n- `true`: Follow redirects automatically (**default**)\n- `false`: Stop at the first HTTP response without following any redirect\n\n**Notes:**\n- **Set to `false`** when you need to inspect the redirect chain itself (e.g. detecting 301 vs 302 codes).","schema":{"type":"boolean","default":"true","description":"Controls whether the crawler should follow HTTP redirects.\n\n- `true`: Follow redirects automatically (**default**)\n- `false`: Stop at the first HTTP response without following any redirect\n\n**Notes:**\n- **Set to `false`** when you need to inspect the redirect chain itself (e.g. detecting 301 vs 302 codes)."}},{"name":"return_page_source","in":"query","required":false,"description":"Controls whether the response returns the raw, unprocessed HTML source of the page.\n\n- `false`: Return processed/parsed content (**default**)\n- `true`: Return the exact HTML source as delivered by the web server\n\n**Notes:**\n- Useful for debugging or when you need the precise markup before any transformation.","schema":{"type":"boolean","default":"false","description":"Controls whether the response returns the raw, unprocessed HTML source of the page.\n\n- `false`: Return processed/parsed content (**default**)\n- `true`: Return the exact HTML source as delivered by the web server\n\n**Notes:**\n- Useful for debugging or when you need the precise markup before any transformation."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"Crawl example.com":{"value":"<!doctype html><html lang=\"en\"><head><title>Example Domain</title><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"><style>body{background:#eee;width:60vw;margin:15vh auto;font-family:system-ui,sans-serif}h1{font-size:1.5em}div{opacity:0.8}a:link,a:visited{color:#348}</style></head><body><div><h1>Example Domain</h1><p>This domain is for use in documentation examples without needing permission. Avoid use in operations.</p><p><a href=\"https://iana.org/domains/example\">Learn more</a></p></div></body></html>"},"Crawl wikipedia.org with page source":{"value":"<!DOCTYPE html><html lang=\"en\" class=\"no-js\"><head><meta charset=\"utf-8\"><title>Wikipedia</title><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"><link rel=\"stylesheet\" href=\"portal/wikipedia.org/assets/css/index-ltr.css\"></head><body class=\"no-js\"><div id=\"www-wikipedia-org\"><div class=\"central-featured\"><div class=\"central-featured-logo\"></div><div id=\"searchInput\"><form id=\"search-form\"><input id=\"searchInput\" name=\"search\" type=\"search\" placeholder=\"Search Wikipedia\"><button type=\"submit\">Search</button></form></div></div></div></body></html>"},"Crawl github.com without redirects":{"value":"<!DOCTYPE html><html lang=\"en\" data-color-mode=\"auto\" data-light-theme=\"light\" data-dark-theme=\"dark\"><head><meta charset=\"utf-8\"><title>GitHub: Let’s build from here</title><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"><link rel=\"stylesheet\" href=\"/assets/app.css\"></head><body><div class=\"logged-out env-production intent-mouse\"><header class=\"p-3 px-md-4\"><a href=\"/\" class=\"mr-4\">GitHub</a></div></body></html>"}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Website Crawler (POST)","description":"A robust solution for efficiently extracting a wide range of data from web pages.\n\n**Credit cost:** 1 credit per call","operationId":"post-website-crawler","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"Example":{"value":"{\"autocompleteLocalites\":[{\"localisationType\":4,\"queryKey\":\"departement\",\"value\":\"75\",\"label\":\"PARIS (75)\",\"tracking\":{\"region\":\"Île-de-France\",\"department\":\"75\"}}],\"autocompleteAgences\":[],\"counters\":{\"total\":1145,\"idTypeTransaction\":{\"1\":5060,\"10\":2303,\"2\":1145}},\"classifieds\":[{\"id\":\"234275997\",\"idAnnonce\":234275997,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-8eme/234275997\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"OPPORTUNITÉ EXCEPTIONNELLE – MURS COMMERCIAUX À VENDRE DANS LE PRESTIGIEUX 8ÈME ARRONDISSEMENT DE PARIS\\r\\n\\r\\nEMPLACEMENT PRIME – AVENUE DES CHAMPS-ÉLYSÉES\\r\\n\\r\\nQUARTIER : GALERIE 66 – À DEUX PAS DES STATIONS...\",\"description\":\"OPPORTUNITÉ EXCEPTIONNELLE – MURS COMMERCIAUX À VENDRE DANS LE PRESTIGIEUX 8ÈME ARRONDISSEMENT DE PARIS\\r\\n\\r\\nEMPLACEMENT PRIME – AVENUE DES CHAMPS-ÉLYSÉES\\r\\n\\r\\nQUARTIER : GALERIE 66 – À DEUX PAS DES STATIONS DE MÉTRO GEORGE V ET FRANKLIN D. ROOSEVELT, CET EMPLACEMENT RARE OFFRE UNE VISIBILITÉ ET UN PRESTIGE INCOMPARABLES DANS L'UN DES QUARTIERS LES PLUS EMBLÉMATIQUES DE PARIS.\\r\\n\\r\\nUNE OPPORTUNITÉ RARE AU CŒUR D'UN QUARTIER ICONIQUE\\r\\n\\r\\nNOUS SOMMES RAVIS DE VOUS PRÉSENTER UNE OPPORTUNITÉ STRATÉGIQUE D'ACQUÉRIR DES MURS COMMERCIAUX LIBRES SITUÉS SUR L'AVENUE DES CHAMPS-ÉLYSÉES. CE BIEN EXCEPTIONNEL REPRÉSENTE UNE OCCASION UNIQUE DE DEVENIR PROPRIÉTAIRE DANS UNE ZONE À FORTE NOTORIÉTÉ, AVEC UN POTENTIEL DE DÉVELOPPEMENT COMMERCIAL EXCEPTIONNEL.\\r\\n\\r\\nCARACTÉRISTIQUES DU BIEN :\\r\\n\\r\\nTYPE DE TRANSACTION : VENTE DE MURS COMMERCIAUX LIBRES\\r\\n\\r\\nFAÇADE LINÉAIRE : FAÇADE DE 10 MÈTRES, GARANTISSANT UNE VISIBILITÉ OPTIMALE ET UNE FORTE ATTRACTIVITÉ POUR VOTRE ACTIVITÉ\\r\\n\\r\\nSURFACE :\\r\\n\\r\\nREZ-DE-CHAUSSÉE : 30 M² D'ESPACE LUMINEUX ET OPTIMISÉ POUR LE COMMERCE\\r\\n\\r\\nSOUS-SOL : 15 M², ACCESSIBLE PAR UN ESCALIER INTÉRIEUR\\r\\n\\r\\n\\r\\nCONDITIONS FINANCIÈRES :\\r\\n\\r\\nPRIX DE VENTE : 2 700 000 euros (NET VENDEUR)\\r\\n\\r\\nHONORAIRES D'AGENCE : 5 % HT, À LA CHARGE DE L'ACQUÉREUR\\r\\n\\r\\n\\r\\nENVIRONNEMENT COMMERCIAL DYNAMIQUE :\\r\\n\\r\\nPROFITEZ D'UN EMPLACEMENT DANS UNE ZONE COMMERÇANTE PRESTIGIEUSE ET ANIMÉE, ENTOURÉE DE MARQUES INTERNATIONALES ET D'ENSEIGNES DE RENOM TELLES QUE : SEPHORA, GUERLAIN, BURGER KING, NIKE, MONOPRIX, TIFFANY & CO.\\r\\nCE FLUX CONSTANT DE VISITEURS, LOCAUX ET INTERNATIONAUX, GARANTIT UN FORT POTENTIEL POUR DÉVELOPPER VOTRE ACTIVITÉ.\\r\\n\\r\\nPOTENTIEL D'UTILISATION :\\r\\n\\r\\nCE BIEN EST IDÉAL POUR DES ACTIVITÉS DE PRÊT-À-PORTER, MAIS PEUT ÉGALEMENT CONVENIR À D'AUTRES COMMERCES COMPATIBLES AVEC CETTE LOCALISATION D'EXCEPTION.\\r\\n\\r\\nNE MANQUEZ PAS CETTE OCCASION UNIQUE\\r\\n\\r\\nCONTACTEZ-NOUS DÈS MAINTENANT POUR PLUS D'INFORMATIONS OU POUR ORGANISER UNE VISITE. CE BIEN REPRÉSENTE UNE OPPORTUNITÉ RARE DANS L'UN DES QUARTIERS LES PLUS RECHERCHÉS DE PARIS.\\r\\n\\r\\nGROUPE CAPITAL TRANSACTION\\r\\n290 RUE DE CHARENTON\\r\\n75012 PARIS\\r\\n\\r\\nNOTRE ÉQUIPE SE TIENT À VOTRE DISPOSITION POUR RÉPONDRE À VOS QUESTIONS ET VOUS ACCOMPAGNER DANS VOTRE PROJET IMMOBILIER.\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750108,\"codePostal\":\"75008\",\"nomVille\":\"Paris 8ème\",\"idQuartier\":133081,\"nomQuartier\":\"Saint Philippe du Roule\",\"idIris\":271500,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.87184,\"longitude\":2.30588}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"CAPITAL TRANSACTION\",\"idAgence\":444366,\"idRcu\":\"RC-1073308\",\"idTiers\":534123,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/f/2/a/1f2aqum8gjm4irz83k0sc43j1e7wtpsi9mgk6usj8.jpg\",\"websiteUrl\":\"https://capitaltransaction.fr/\",\"codePostal\":\"75008\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/2/2/j/2/22j20vf2dvcuswxfss1ibtlocrojocl3tve8b3aoi.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/e/b/1/1eb1eweil11tqchopvyhgushtmj13umfycjdpgjk0.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/a/n/q/2anqj0ct7xleervhy9tvzcze0wgi8k8cfwioawmio.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/k/n/4/0kn4k713xoc8v7t1t17214180zrqcupz79pojb2f4.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/6/2/a/162a6k13nrounmz3al085dkjw13ng18xtw9hyqxvk.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":2862000},\"priceBySquareMeter\":{\"type\":1,\"value\":63600}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-20T00:00:00\",\"publicationDateTime\":\"2025-01-20T12:25:00\",\"lastUpdateDateTime\":\"2025-01-20T12:31:00\",\"qualityIndex\":96,\"refAnnonce\":\"CA13-2776\",\"space\":45},{\"id\":\"232148927\",\"idAnnonce\":232148927,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-10eme/232148927\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"Prix hors honoraires : 790 000 €\\r\\n\\r\\nA 200m des métros Temple et République, un local situé au calme sur cour dans une rue recherchée. Beaucoup de charme et excellent potentiel. 95,5m² répartis sur deux...\",\"description\":\"Prix hors honoraires : 790 000 €\\r\\n\\r\\nA 200m des métros Temple et République, un local situé au calme sur cour dans une rue recherchée. Beaucoup de charme et excellent potentiel. 95,5m² répartis sur deux niveaux. A refaire.\\r\\n\\r\\nLa propriété dispose de plusieurs destinations : un atelier, un local professionnel, et un appartement, offrant une combinaison idéale pour un usage mixte habitation et activité professionnelle.\\r\\n\\r\\nHonoraires : 5% du prix HT\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750110,\"codePostal\":\"75010\",\"nomVille\":\"Paris 10ème\",\"idQuartier\":133095,\"nomQuartier\":\"Chateau d'Eau-Lancry\",\"idIris\":271575,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.87132,\"longitude\":2.36289}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"BUREAUX ATYPIQUES\",\"idAgence\":271629,\"idRcu\":\"RC-042708\",\"idTiers\":295447,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"75006\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/i/l/r/1ilrle78z5zhueyuf24rr9yfrps14gnidub7omu6s.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/4/a/q/24aqzel7mps6u0l35edln33q2n16uhpqiwwjadfmc.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/1/6/k/016k7xw7mxq0kylbsbwyxsr6vbrbc9dp2o5zy6w5w.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/n/n/3/1nn3lqbefg2y9nqhxc8v0r5h2mytdumy59g37926s.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/s/7/m/0s7m5drzdpx5yeo5s73g6ejtdsr96v3ojpbdn4ml0.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":790000},\"priceBySquareMeter\":{\"type\":1,\"value\":8229.166666666666}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-12-10T00:00:00\",\"publicationDateTime\":\"2024-12-10T15:42:00\",\"lastUpdateDateTime\":\"2025-01-20T15:41:00\",\"qualityIndex\":94,\"refAnnonce\":\"85492316\",\"space\":95.5},{\"id\":\"233922493\",\"idAnnonce\":233922493,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-19eme/233922493\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"75019 PARIS. Buttes Chaumont. Rue Rébeval. Dans un Immeuble Ancien bien tenu. Local Commercial  de 52m2 au sol en bon état. Actuellement studio de Musique. Entièrement insonorisé (Traitement acoustique)....\",\"description\":\"75019 PARIS. Buttes Chaumont. Rue Rébeval. Dans un Immeuble Ancien bien tenu. Local Commercial  de 52m2 au sol en bon état. Actuellement studio de Musique. Entièrement insonorisé (Traitement acoustique). Traversant. Une entrée sur Rue et hall d'immeuble\\n3 fenêtres opacifiées sur rue, dont une ouvrante.  Un coin cuisine avec une grande fenêtre donnant sur l'arrière  du bâtiment. Un wc. Une Cave. BENOIT MENARD (EI) Agent Commercial - Numéro RSAC :  - .\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750119,\"codePostal\":\"75019\",\"nomVille\":\"Paris 19ème\",\"idQuartier\":133160,\"nomQuartier\":\"Bas Belleville\",\"idIris\":272236,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.8757019,\"longitude\":2.381619}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"PROCITY IMMOBILIER\",\"idAgence\":90750,\"idRcu\":\"RC-117095\",\"idTiers\":139067,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"75018\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/6/q/h/16qhyba0kf5es2wdwuorvrv7nefeu8sb2e9ayzcm7.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/h/o/l/1holjn8k1ned9jxbi3ux75kisgen03l8adwbwc2ex.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/b/1/9/0b195ewb7tfilbzcjeb63e5ud83r44fop6nv2cl11.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/7/n/7/07n7573yr49vroinhhovp408zdh9dkos87h39j4or.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/e/l/q/0elq0q8n7m0bqy4p9liglb3etrluqwj4zeemooigx.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":349000},\"priceBySquareMeter\":{\"type\":1,\"value\":6711.538461538462}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-14T00:00:00\",\"publicationDateTime\":\"2025-01-14T18:33:00\",\"lastUpdateDateTime\":\"2025-01-14T19:01:00\",\"qualityIndex\":91,\"refAnnonce\":\"10544\",\"space\":52},{\"id\":\"233899029\",\"idAnnonce\":233899029,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-19eme/233899029\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"75019 PARIS. MOUZAÏA. Rue de la Mouzaïa. Affectation Commerciale. Dans un Immeuble Bel immeuble Ancien.  Appartement de 22m2 refait à Neuf au Rez-de-Chaussée. Belle Hauteur sous Plafond. Séjour avec ...\",\"description\":\"75019 PARIS. MOUZAÏA. Rue de la Mouzaïa. Affectation Commerciale. Dans un Immeuble Bel immeuble Ancien.  Appartement de 22m2 refait à Neuf au Rez-de-Chaussée. Belle Hauteur sous Plafond. Séjour avec  Cuisine Ouverte. Salle d'eau et w.c. Sans aucune Perte de Place. Idéal 1er Achat, Investissement locatif. BENOIT MENARD (EI) Agent Commercial - Numéro RSAC :  - .\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750119,\"codePostal\":\"75019\",\"nomVille\":\"Paris 19ème\",\"idQuartier\":133157,\"nomQuartier\":\"Danube-Porte des Lilas\",\"idIris\":272221,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.8802376,\"longitude\":2.395323}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"PROCITY IMMOBILIER\",\"idAgence\":90750,\"idRcu\":\"RC-117095\",\"idTiers\":139067,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"75018\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/6/4/q/164qljdndyekr1d4ov4mce1hck37xzeazgagws4lw.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/p/c/9/0pc9g6vk1968y3dw7hd6k6x7cvnjm412akwtzohn8.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/8/q/3/28q3u695zmb0c0zrcplshyj6f6brv05d1jmzrn68k.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/l/d/v/0ldvnalmpuj9nre6f4pa7w5r6ncljmzsfla8wjivo.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/2/d/5/02d5sg52bn2ueetqri17nl9swghfwqkhu4s9qihck.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":189000},\"priceBySquareMeter\":{\"type\":1,\"value\":8590.90909090909}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-14T00:00:00\",\"publicationDateTime\":\"2025-01-14T15:01:00\",\"lastUpdateDateTime\":\"2025-01-14T16:30:00\",\"qualityIndex\":91,\"refAnnonce\":\"10537\",\"space\":22},{\"id\":\"233665281\",\"idAnnonce\":233665281,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-12eme/233665281\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"LA TOUR IMMO vous propose une boutique d'une surface totale de 55.48 m² Carrez en rez-de-chaussée avec une façade linéaire de 5 m située dans le quartier de Daumesnil.\\r\\n\\r\\nCe local dispose de sanitaires...\",\"description\":\"LA TOUR IMMO vous propose une boutique d'une surface totale de 55.48 m² Carrez en rez-de-chaussée avec une façade linéaire de 5 m située dans le quartier de Daumesnil.\\r\\n\\r\\nCe local dispose de sanitaires et points d'eau.\\r\\nIl est équipé d'un chauffage chaudière individuelle, électrique \\r\\n\\r\\n\\r\\nLA TOUR IMMO spécialisé en immobilier commercial depuis 1990, accompagne également les entreprises dans la cession de leurs fonds de commerce, et leurs droits au bail et vous conseille également dans le cadre de vos négociations (location, cession, murs, expertise).\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750112,\"codePostal\":\"75012\",\"nomVille\":\"Paris 12ème\",\"idQuartier\":133107,\"nomQuartier\":\"Bel-Air Sud\",\"idIris\":271682,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.83867,\"longitude\":2.39907}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"LA TOUR IMMO\",\"idAgence\":53962,\"idRcu\":\"RC-021968\",\"idTiers\":4409,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/4/h/x/14hxle9pvxsp34at0y09qi80x3g6yf1mv7wz6tl5a.jpg\",\"websiteUrl\":\"http://www.latourimmo.com\",\"codePostal\":\"75011\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/q/1/o/0q1o1ma9e4i3xg3fmds44aaowyf5b93i0yru4l7ky.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/9/m/z/19mzu3twyiz28yy0ujapa4n1x7bh2nl7lvht77cez.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/t/2/k/1t2kenwjahozj06zorprmfmye3w5p91yn1ek8uz6o.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/o/z/e/0oze9zeg4ux0ig2y9p9xwfludcpst86prjof01msg.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":455000},\"priceBySquareMeter\":{\"type\":1,\"value\":8272.727272727272}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-10T00:00:00\",\"publicationDateTime\":\"2025-01-10T11:25:00\",\"lastUpdateDateTime\":\"2025-01-10T11:31:00\",\"qualityIndex\":90,\"refAnnonce\":\"LTI-20291\",\"space\":55.48},{\"id\":\"233665105\",\"idAnnonce\":233665105,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-17eme/233665105\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"LA TOUR IMMO vous propose une boutique /restaurant Boulevard Berthier - Rue Alfred Roll - 75017 PARIS d'une surface totale d'environ 160,20 m² comprenant : \\r\\n-> un Rez-de-chaussée d'une surface totale...\",\"description\":\"LA TOUR IMMO vous propose une boutique /restaurant Boulevard Berthier - Rue Alfred Roll - 75017 PARIS d'une surface totale d'environ 160,20 m² comprenant : \\r\\n-> un Rez-de-chaussée d'une surface totale d'environ 35,79 m² à usage commercial comprenant une salle de restaurant.\\r\\n-> un 1er étage d'une surface totale d'environ 71,48 m² à usage commercial comprenant deux salles de restaurants.\\r\\n-> un Sous-sol d'une surface totale d'environ 52,93 m² à usage de réserve comprenant une cuisine, une chambre froide ainsi que WC. \\r\\n\\r\\n-> La superficie des annexes est de 27,28 m² comprenant : SAS, emprises et terrasses couverte.\\r\\n\\r\\n-\\r\\nTOUTES ACTIVITÉS AUTORISÉES DANS LA BOUTIQUE. \\r\\nConduit de cheminée existant de 400 mm.\",\"leaseTypes\":[],\"equipments\":[2],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750117,\"codePostal\":\"75017\",\"nomVille\":\"Paris 17ème\",\"idQuartier\":133142,\"nomQuartier\":\"Pereire-Malesherbes\",\"idIris\":272065,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.88992,\"longitude\":2.30328}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"LA TOUR IMMO\",\"idAgence\":53962,\"idRcu\":\"RC-021968\",\"idTiers\":4409,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/4/h/x/14hxle9pvxsp34at0y09qi80x3g6yf1mv7wz6tl5a.jpg\",\"websiteUrl\":\"http://www.latourimmo.com\",\"codePostal\":\"75011\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/j/c/r/0jcrl5w8c4g00we8wudrt65v5qvha93okqdh0t8ua.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/5/s/y/25sy29fi7f1h9otip394sny302azfu48tjwgmh4ao.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/c/y/d/0cydke8ylxiyc8ugen9zk26vml71osp0cqy9a7hty.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/4/v/b/04vb5vinxic4437b1tsulqs2m01g5i3iwdt2z7xx4.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":1360000},\"priceBySquareMeter\":{\"type\":1,\"value\":8500}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-10T00:00:00\",\"publicationDateTime\":\"2025-01-10T11:25:00\",\"lastUpdateDateTime\":\"2025-01-10T11:31:00\",\"qualityIndex\":90,\"refAnnonce\":\"LTI-19684\",\"space\":160.2},{\"id\":\"226935211\",\"idAnnonce\":226935211,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-9eme/226935211\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":true,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"Locaux professionnels à vendre au coeur du 9ème arrondissement de Paris. \\r\\n(pas de commercialité mais autorisation dans le RCP)\\r\\n \\r\\nConstruction : Copropriété très calme, de bon standing\\r\\nImmeuble mixtes...\",\"description\":\"Locaux professionnels à vendre au coeur du 9ème arrondissement de Paris. \\r\\n(pas de commercialité mais autorisation dans le RCP)\\r\\n \\r\\nConstruction : Copropriété très calme, de bon standing\\r\\nImmeuble mixtes avec présence d'un grand nombre de professions libérales\\r\\nPrestations : Immeuble bien entretenu\\r\\nDigicode, Ascenseur\\r\\nParties communes, les paliers d'étage, le hall d'entrée ont été rénovés il y a moins de 2 ans.\\r\\n \\r\\n1er étage : RENOVE\\r\\nDouble fenêtres sur rue et double vitrage sur cour, Chauffage électrique NEUFS, Câblage informatique , Électricité NEUVE\\r\\nUne belle entrée avec fenêtre, 1 beau bureau d'associé sur rue avec cheminée et parquet, 1 beau bureau avec cheminée sur cour, et 1 bureau plus moderne sur cour. 1 sanitaire.\\r\\n\\r\\n2ème étage : A RENOVER, en l'état\\r\\n2 portes palières avec possibilité de diviser le lot en 2. \\r\\n1 cave saine de 12 m2.\\r\\n \\r\\n \\r\\n\\r\\nHonoraires: 5 % HT du prix de vente HD À la charge de l'acquéreur\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750109,\"codePostal\":\"75009\",\"nomVille\":\"Paris 9ème\",\"idQuartier\":133088,\"nomQuartier\":\"Clichy-Trinité\",\"idIris\":271524,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.87918,\"longitude\":2.33377}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"NCV CONSEIL\",\"idAgence\":428566,\"idRcu\":\"RC-786817\",\"idTiers\":515396,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/r/8/a/1r8a7z765p266gcy4sk168wgfwmj4qp5utwmxnrdv.jpg\",\"websiteUrl\":\"\",\"codePostal\":\"75017\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/r/c/1/0rc1bwfcn2onpa8px9g7k7233xop4tzkg2alm3n4q.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/q/b/p/1qbphcy36d2xls1h5wk0qx3zpf8d64032h4puudmi.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/k/o/5/0ko5m28h93sbh9akt3ou4rthv7pboimmlfpigbdnf.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/z/b/0/1zb0n23ygimakt27cpo3mgx32tie75r53yl0clzei.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/5/8/9/1589107mjr6th0fq6oesxz1zd7elhixnglvbg3t21.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":1945000},\"priceBySquareMeter\":{\"type\":1,\"value\":11114.285714285714}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-09-12T00:00:00\",\"publicationDateTime\":\"2024-09-12T20:32:00\",\"lastUpdateDateTime\":\"2024-09-19T20:36:00\",\"qualityIndex\":90,\"refAnnonce\":\"695262\",\"space\":175.3,\"divisibility\":{\"range\":{\"min\":70,\"max\":175},\"spaceMaximum\":175,\"spaceMinimum\":70}},{\"id\":\"233665295\",\"idAnnonce\":233665295,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-17eme/233665295\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"LA TOUR IMMO vous propose une boutique Rue des Moines - 75017 PARIS dans le quartier des Batignolles d'une surface totale d'environ 130 m².\\r\\n\\r\\nComprenant : \\r\\n- un Rez-de-chaussée d'environ 102 m² \\r\\n-...\",\"description\":\"LA TOUR IMMO vous propose une boutique Rue des Moines - 75017 PARIS dans le quartier des Batignolles d'une surface totale d'environ 130 m².\\r\\n\\r\\nComprenant : \\r\\n- un Rez-de-chaussée d'environ 102 m² \\r\\n- un sous-sol d'environ 28 m².\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750117,\"codePostal\":\"75017\",\"nomVille\":\"Paris 17ème\",\"idQuartier\":133140,\"nomQuartier\":\"Epinettes-Bessières\",\"idIris\":272088,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.89313,\"longitude\":2.31463}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"LA TOUR IMMO\",\"idAgence\":53962,\"idRcu\":\"RC-021968\",\"idTiers\":4409,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/4/h/x/14hxle9pvxsp34at0y09qi80x3g6yf1mv7wz6tl5a.jpg\",\"websiteUrl\":\"http://www.latourimmo.com\",\"codePostal\":\"75011\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/l/d/e/0lde5ba53u4ngevdjsssi6i2sjstt7wndiotsqgdy.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/b/0/f/1b0fzh7h760s92n0ube2xk2jwmbynkg6iolyhjzx8.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/7/c/w/07cw9a7o072u84xf8bfhykxl5hqwwmcea5xbifxkf.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/z/p/z/0zpz2fqffx2arbsjacgk82gk342cgpl6trf7zt9r0.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":1440000},\"priceBySquareMeter\":{\"type\":1,\"value\":11076.923076923076}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-10T00:00:00\",\"publicationDateTime\":\"2025-01-10T11:25:00\",\"lastUpdateDateTime\":\"2025-01-10T11:31:00\",\"qualityIndex\":85,\"refAnnonce\":\"LTI-20319\",\"space\":130},{\"id\":\"219831575\",\"idAnnonce\":219831575,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-2eme/219831575\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":true,\"isBoostSuggestion\":true,\"isBoostHighlight\":true,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"Construction : \\r\\nPrestations : \\r\\nÉtat des locaux : Très bon état\\r\\nLocaux loués à usage de Data center rue des jeuneurs. \\r\\nLes locaux sont fonctionnels (avec monte-charges et escalier intérieur), très...\",\"description\":\"Construction : \\r\\nPrestations : \\r\\nÉtat des locaux : Très bon état\\r\\nLocaux loués à usage de Data center rue des jeuneurs. \\r\\nLes locaux sont fonctionnels (avec monte-charges et escalier intérieur), très bien équipés (climatisation, insonorisation, extraction, SSI à l'azote, groupe électrogène, ..) et aménagés pour l'activité exercée, le tout en très bon état d'entretien.\\r\\nLoué 115 000 EUR HT HC annuel\\r\\n\\r\\n \\r\\n \\r\\n\\r\\nHonoraires / Caract. : honoraires inclus charge vendeur\",\"leaseTypes\":[],\"equipments\":[7],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750102,\"codePostal\":\"75002\",\"nomVille\":\"Paris 2ème\",\"idQuartier\":133058,\"nomQuartier\":\"Sentier-Bonne Nouvelle\",\"idIris\":271356,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.869408,\"longitude\":2.345351}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"OPTIREAL\",\"idAgence\":67948,\"idRcu\":\"RC-059218\",\"idTiers\":89286,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/height/150/logos/0/x/h/q/0xhqi9q0h0biacjuw80t5ar03m55f014ns9gxbvaw.jpg\",\"websiteUrl\":\"http://www.optireal-corporate.fr\",\"codePostal\":\"75008\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/g/8/h/0g8hwmt3ko177sp72afn6rwst3cuwct4eddjksdue.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/4/h/4/04h4arxafbvj58zj6rcjcpuen15rhwqoq2hcl7snw.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":1995000},\"priceBySquareMeter\":{\"type\":1,\"value\":5990.990990990991}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-11-08T00:00:00\",\"publicationDateTime\":\"2024-11-08T20:25:00\",\"lastUpdateDateTime\":\"2024-11-08T20:31:00\",\"qualityIndex\":83,\"refAnnonce\":\"692895\",\"space\":333},{\"id\":\"231944097\",\"idAnnonce\":231944097,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-2eme/231944097\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"*EXCLUSIVITE*\\r\\n\\r\\nLOCAL COMMERCIAL & BUREAUX / 153m² / 3 NIVEAUX / DEVANTURE / ACCES DEPUIS RUE & PARTIE COMMUNE\\r\\n\\r\\nDavid Cote (Architecte & Agent Immobilier) & effiCity, l'agence qui estime votre bien...\",\"description\":\"*EXCLUSIVITE*\\r\\n\\r\\nLOCAL COMMERCIAL & BUREAUX / 153m² / 3 NIVEAUX / DEVANTURE / ACCES DEPUIS RUE & PARTIE COMMUNE\\r\\n\\r\\nDavid Cote (Architecte & Agent Immobilier) & effiCity, l'agence qui estime votre bien en ligne, vous proposent en exclusivité ce superbe local commercial / bureaux / situé au cœur de Paris dans un quartier très recherché et très prisé de la Capitale .\\r\\n\\r\\n_\\r\\n\\r\\nActuellement utilisé par une agence d'Architecture, ce local se compose sur 3 niveaux et propose de nombreux usages possibles :\\r\\n\\r\\nRDC | 93.54 m²\\r\\n. Accès depuis rue (rideaux de fer électrique) et depuis partie commune\\r\\n. 4 espaces différenciables dont un espace avec verrière zénithale\\r\\n. Coin cuisine\\r\\n. Escaliers vers R+1 et R-1\\r\\n. Watercloset séparés\\r\\n\\r\\nR+1 | 45.92 m²\\r\\n. Bel espace entièrement rénové avec fenêtres donnant sur rue mais également sur cour proposant de nombreux usage (bureaux / salle de réunion / espace coworking / logement possible /..)\\r\\n. Coin cuisine avec verrière sur pièce principale donnant sur la rue.\\r\\n. Salle de douche avec watercloset\\r\\n. Poutres apparentes (Hauteur sous poutres 2.20m)\\r\\n\\r\\nR-1 | 12.75 m²\\r\\n. Espace entièrement voûté & insonorisé\\r\\n. Actuellement salle de réunion et salle d'archives\\r\\n\\r\\n_\\r\\n\\r\\nLa situation, l'emplacement proche de tous commerces ainsi que les volumes de ce bien, sauront vous séduire et vous faire succomber.\\r\\nBien rare sur ce secteur et très recherché pour ses atouts.\\r\\n\\r\\nTANTIEME | 170 / 1006èmes\\r\\nTAXE FONCIERE | 2 000 euros\\r\\nCHARGES DE COPRPRIETE | 385 euros / MOIS\\r\\nLOYER ACTUEL DES LOCATAIRE | 5 500 euros / mois (Vendu libre ou occupé)\\r\\n\\r\\n_\\r\\n\\r\\nToutes les visites s'effectuent dans le respect des règles sanitaires (masques, gel et gestes barrières).\\r\\n\\r\\n_\\r\\n\\r\\nVISITES\\r\\nSur rendez-vous.\\r\\n\\r\\nCONTACT\\r\\nDavid Cote | / \\r\\n\\r\\nPour + d'informations & de photos / plans\\r\\n\\r\\n_\\r\\n\\r\\nEfficity & DC | ARCHI_IMMO : Expertise - Vente - Achat - Rénovation\\r\\n\\r\\n> L'EQUIPE et MOI-MEME restons à votre disposition pour toutes ESTIMATIONS et VENTES de BIENS IMMOBILIERS partout en FRANCE.\\r\\n> Nous sommes également à la RECHERCHE de DEUX nouveaux CONSULTANTS afin de RENFORCER L' EQUIPE sur ce secteur.\\r\\n Les informations sur les risques auxquels ce bien est exposé sont disponibles sur le site Georisque : georisques. gouv. fr\\r\\n David Cote - EI - est Agent Commercial mandataire en immobilier, immatriculé au Registre Spécial des Agents Commerciaux du Tribunal de Commerce de PARIS sous le n°892171000.\\r\\nSiège social du mandant : effiCity, 48 avenue de Villiers - 75017 PARIS - Société par Actions Simplifiée, société au capital de 132 373,05 euros, immatriculée au RCS Paris 497 617 746 et titulaire de la Carte professionnelle CPI 7501 2015 000 002 025 - CCI Paris IDF - Caisse de Garantie : GALIAN Assurances 89 rue de la Boétie 75008 Paris\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750102,\"codePostal\":\"75002\",\"nomVille\":\"Paris 2ème\",\"idQuartier\":133057,\"nomQuartier\":\"Montorgueil-Saint Denis\",\"idIris\":271358,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.8656653,\"longitude\":2.347548}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"efficity   David Cote\",\"idAgence\":450184,\"idRcu\":\"RC-1237468\",\"idTiers\":541580,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/4/j/a/14ja3kszehojmxnyffr177bs4fhlanaaepmsjbxov.jpg\",\"websiteUrl\":\"\",\"codePostal\":\"75011\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/2/7/f/b/27fbmzzmhmxu1nq8szd38sd51bpk85qgcr9nszmei.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/6/k/h/26khid16eoy9uw8m1z79lbah8gd84r41gtk1w3v3e.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/4/1/7/2417z42n4slkh3kl5xu1om11nfuzvivrdlwj9z0ve.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/b/1/d/1b1ddr8pg7koecnuuubih2msvf9y4vjws6ga3v7sa.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/j/m/u/1jmut7ossh5sirddu39e0wrif7dj2gr40qxtviskq.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":1620000},\"priceBySquareMeter\":{\"type\":1,\"value\":10657.894736842105}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-12-06T00:00:00\",\"publicationDateTime\":\"2024-12-06T17:24:00\",\"lastUpdateDateTime\":\"2025-01-23T16:37:00\",\"qualityIndex\":100,\"refAnnonce\":\"171642\",\"space\":152},{\"id\":\"217902651\",\"idAnnonce\":217902651,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-2eme/217902651\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"| DC ARCHI_IMMO - EXCLUSIVITE\\r\\n\\r\\nLOCAL COMMERCIAL / 99m² / 2 NIVEAUX / RDC & R-1 VOUTE / DEVANTURE / ACCES DEPUIS RUE / ACTUELLEMENT RESTAURANT\\r\\n\\r\\nDavid Cote (Architecte & Agent Immobilier) & effiCity,...\",\"description\":\"| DC ARCHI_IMMO - EXCLUSIVITE\\r\\n\\r\\nLOCAL COMMERCIAL / 99m² / 2 NIVEAUX / RDC & R-1 VOUTE / DEVANTURE / ACCES DEPUIS RUE / ACTUELLEMENT RESTAURANT\\r\\n\\r\\nDavid Cote (Architecte & Agent Immobilier) & effiCity, l'agence qui estime votre bien en ligne, vous proposent en exclusivité ce superbe local commercial situé au cœur de Paris dans un quartier très recherché et très prisé de la Capitale .\\r\\n\\r\\n_\\r\\n\\r\\nActuellement utilisé par un restaurant avec un bail commercial, ce local se compose sur 2 niveaux avec terrasse :\\r\\n\\r\\nRDC | 48.88 m²\\r\\n. Accès depuis rue (rideaux de fer)\\r\\n. 1 grande salle actuellement de restaurant\\r\\n. Escaliers descendant vers le sous-sol\\r\\n. Watercloset séparés + cagibi\\r\\n\\r\\nR-1 | 45.34 m²\\r\\n. grande salle voutée\\r\\n. cuisine professionnelle et extraction\\r\\n\\r\\n_\\r\\n\\r\\nLa situation, l'emplacement proche de tous commerces ainsi que les volumes de ce bien, sauront vous séduire et vous faire succomber.\\r\\nBien rare sur ce secteur et très recherché pour ses atouts.\\r\\n\\r\\nTANTIEMES | 205 / 1 000èmes\\r\\nTAXE FONCIERES | 1 063 euros\\r\\nCHARGES MENSUELLES | 384.38 euros dont 181.42 euros de charges locatives (récupérables)\\r\\nLOYER MENSUEL ACTUEL | 5 396 euros CC (Bail commercial en cours jusqu'au 20 décembre 2025 / Restaurant)\\r\\nDPE | Actualisation en cours\\r\\n\\r\\n_\\r\\n\\r\\nToutes les visites s'effectuent dans le respect des règles sanitaires (masques, gel et gestes barrières).\\r\\n\\r\\n_\\r\\n\\r\\nVISITES\\r\\nSur rendez-vous.\\r\\n\\r\\nCONTACT\\r\\nDavid Cote | / \\r\\nPour + d'informations & de photos / plans\\r\\n\\r\\n_\\r\\n\\r\\nEfficity & DC | ARCHI_IMMO : Expertise - Vente - Achat - Rénovation\\r\\n\\r\\n> L'EQUIPE et MOI-MEME restons à votre disposition pour toutes ESTIMATIONS et VENTES de BIENS IMMOBILIERS partout en FRANCE.\\r\\n> Nous sommes également à la RECHERCHE de DEUX nouveaux CONSULTANTS afin de RENFORCER L'EQUIPE sur ce secteur.\\r\\n Les informations sur les risques auxquels ce bien est exposé sont disponibles sur le site Georisque : georisques. gouv. fr\\r\\n David Cote - EI - est Agent Commercial mandataire en immobilier, immatriculé au Registre Spécial des Agents Commerciaux du Tribunal de Commerce de PARIS sous le n°892171000.\\r\\nSiège social du mandant : effiCity, 48 avenue de Villiers - 75017 PARIS - Société par Actions Simplifiée, société au capital de 132 373,05 euros, immatriculée au RCS Paris 497 617 746 et titulaire de la Carte professionnelle CPI 7501 2015 000 002 025 - CCI Paris IDF - Caisse de Garantie : GALIAN Assurances 89 rue de la Boétie 75008 Paris\",\"leaseTypes\":[],\"equipments\":[2,8],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750102,\"codePostal\":\"75002\",\"nomVille\":\"Paris 2ème\",\"idQuartier\":133057,\"nomQuartier\":\"Montorgueil-Saint Denis\",\"idIris\":271354,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.8675641,\"longitude\":2.34399}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"efficity   David Cote\",\"idAgence\":450184,\"idRcu\":\"RC-1237468\",\"idTiers\":541580,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/4/j/a/14ja3kszehojmxnyffr177bs4fhlanaaepmsjbxov.jpg\",\"websiteUrl\":\"\",\"codePostal\":\"75011\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/b/3/j/1b3jz89tr3d7fyz9gzr5a00t8u5uhq41sdet8poh6.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/6/s/7/16s7s1p43rejj13hl4l3m78jy8ogkom27fxpjcz6y.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/d/p/l/1dplqco6kkgs1xqih2ceyjje5jgtee6jtlppc7x9m.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/s/b/q/0sbqqkdxz117bjxu84g0al4clm4siclwukad05pgq.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/4/s/8/14s8dc7z5ue8dd40c4l6lhaue0gu72ayjwocyhhd6.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":1180000},\"priceBySquareMeter\":{\"type\":1,\"value\":12040.816326530612}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-03-27T00:00:00\",\"publicationDateTime\":\"2024-03-27T19:38:00\",\"lastUpdateDateTime\":\"2024-11-27T14:45:00\",\"qualityIndex\":100,\"refAnnonce\":\"154453\",\"space\":98},{\"id\":\"220972655\",\"idAnnonce\":220972655,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-20eme/220972655\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"Votre agence Laforet a le plaisir de vous présenter ce local commercial de 58.11m2 distribué de la manière suivante : RDC , 34.67m2 et un premier étage de 23.44m2. Anciennement occupé par un restaurant...\",\"description\":\"Votre agence Laforet a le plaisir de vous présenter ce local commercial de 58.11m2 distribué de la manière suivante : RDC , 34.67m2 et un premier étage de 23.44m2. Anciennement occupé par un restaurant \\\" Chez Ramona \\\" une institution depuis 1970!\\nExposition plein Sud.\\nPossibilité de faire des bureaux ou un espace de co working.\\n\\nVitrine et entrée principale donnant sur la rue Ramponneau.\\nUne entrée est également possible par la cour de l'immeuble.\\n\\nPoint d'eau et WC.\\nExtraction\\nCe bien comporte une cave.\\n\\nVendu libre de toute occupation \\nCharges copropriété : 163 €/mois\\n\\nLien de la visite virtuelle : ?m=Sn714vnZok4\\nCopropriété de 33 lots (Pas de procédure en cours).\\n\\rCharges annuelles : 1964.00 euros.\",\"leaseTypes\":[],\"equipments\":[3],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750120,\"codePostal\":\"75020\",\"nomVille\":\"Paris 20ème\",\"idQuartier\":133163,\"nomQuartier\":\"Belleville\",\"idIris\":272258,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.87167,\"longitude\":2.38012}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"LAFORÊT IMMOBILIER\",\"idAgence\":91414,\"idRcu\":\"RC-117415\",\"idTiers\":139848,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"75010\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/2/5/e/g/25egesm4c90f7kqwc38g4jesyk2fgyeri49l5yxkw.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/o/f/k/0ofkuldf0dlme2tgzwd0c5rlekfem7u2sx3esjon4.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/z/2/z/0z2z79v0gkpuioz9szrsl94p8267maexhhazz6mps.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/m/b/8/1mb8hyaazyjmazyybd3yp6kie6iveqed7p1ugn340.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/e/y/r/0eyrwpoubex9enk43eqrqeyo22scn640stxuy9zsw.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":400000},\"priceBySquareMeter\":{\"type\":1,\"value\":6896.551724137931}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-05-22T00:00:00\",\"publicationDateTime\":\"2024-05-22T10:40:00\",\"lastUpdateDateTime\":\"2025-01-26T09:06:00\",\"qualityIndex\":99,\"refAnnonce\":\"7905\",\"space\":58},{\"id\":\"227147843\",\"idAnnonce\":227147843,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/local-commercial/paris-18eme/227147843\",\"codeTypeBien\":700,\"idTypeTransaction\":2,\"idTypeBien\":7,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Local commercial\",\"cardDescription\":\"Murs occupés Angle Championnet / 147 rue de Clignancourt 75018 Paris\\r\\n\\r\\nOpportunité - A vendre : un local d'angle d'une surface totale de 124 m² .\\r\\n\\r\\nComprenant au rez-de-chaussée 88 m2 \\r\\n un sous-sol...\",\"description\":\"Murs occupés Angle Championnet / 147 rue de Clignancourt 75018 Paris\\r\\n\\r\\nOpportunité - A vendre : un local d'angle d'une surface totale de 124 m² .\\r\\n\\r\\nComprenant au rez-de-chaussée 88 m2 \\r\\n un sous-sol 36 m2 accessible par la boutique. \\r\\nCuisine, sanitaire et point d'eau.\\r\\n\\r\\nLe local est actuellement occupé par une enseigne disposant de plusieurs boutiques.\\r\\nEnseigne : DOGAN VOYAGES - \\r\\n\\r\\nVitrine de plus de 15 mètres\\r\\n\\r\\nLes charges et la taxe foncière sont supportées par le locataire.\\r\\n\\r\\nPrix : 600 000 euros\\r\\nLoyer : 39 600 euros /HC /HT /AN\\r\\n\\r\\nDans une copropriété de 20 lots. Aucune procédure n'est en cours. DPE en cours. Les informations sur les risques auxquels ce bien est exposé sont disponibles sur le site Géorisques : georisques.gouv.fr.\",\"leaseTypes\":[],\"equipments\":[3],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750118,\"codePostal\":\"75018\",\"nomVille\":\"Paris 18ème\",\"idQuartier\":133147,\"nomQuartier\":\"Grandes Carrières-Clichy\",\"idIris\":272121,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.89454,\"longitude\":2.3336}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"GROUPE TRADE\",\"idAgence\":87256,\"idRcu\":\"RC-021971\",\"idTiers\":4415,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/1/w/0/i/1w0i6a5zn5zuumlfdgdec0apwgb9hkgjrqu92yk65.jpg\",\"websiteUrl\":\"\",\"codePostal\":\"92100\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/8/6/m/186m5pntbcguqzjgz0lzfh85j8uf5w44s5362n4to.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/s/4/7/1s47zd9g1x18ra9dtng43j7k5ga6h0fuf6911xa2o.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/i/r/y/0iryemlwamo7hc43fylvmxxusb6bi7boqmtwlz4g0.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/z/w/n/1zwnoe6p96kj7g0o6k1663qrdl0d3r5kh7g0ud7e8.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/4/k/o/14koi2zrmhmy15jobbaloon1hv5fkb4ypoavfbdxc.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":600000},\"priceBySquareMeter\":{\"type\":1,\"value\":4838.709677419355}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":false}},\"publicationDateOnly\":\"2024-09-17T00:00:00\",\"publicationDateTime\":\"2024-09-17T13:24:00\",\"lastUpdateDateTime\":\"2025-01-26T13:37:00\",\"qualityIndex\":98,\"refAnnonce\":\"VP068-COMPANY39867BF\",\"space\":124},{\"id\":\"226214155\",\"idAnnonce\":226214155,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-12eme/226214155\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"Métro Bel Air, à toute proximité de la place Felix Eboué, local commercial de 55 m² vendu occupéCARACTERISTIQUES DE L'OFFRE\\r\\n\\r\\nBail en cours :\\r\\n\\r\\nDérogatoire 36 mois, signé en août 2022\\r\\n\\r\\nLoyer : 18...\",\"description\":\"Métro Bel Air, à toute proximité de la place Felix Eboué, local commercial de 55 m² vendu occupéCARACTERISTIQUES DE L'OFFRE\\r\\n\\r\\nBail en cours :\\r\\n\\r\\nDérogatoire 36 mois, signé en août 2022\\r\\n\\r\\nLoyer : 18 600 euros/an HT HC\\r\\n\\r\\nUn espace ouvert en open space de 39 m²\\r\\n\\r\\nSanitaire\\r\\n\\r\\nCuisine\\r\\n\\r\\nUn espace de stockage en sous sol de 16 m²\\r\\n\\r\\nActivité : tertiaire\\r\\n\\r\\nLien de la visite virtuelle : ?m=ZsNmLQJaWLv\\r\\n\\r\\nCONDITIONS FINANCIERES Rentabilité brut : 5%Taxe foncière :à la charge du preneur\\r\\n\\r\\nPrix de vente HONORAIRES INCLUS 393 750 euros soit 375 000 euros Net vendeur\\r\\n\\r\\n5% HT d'honoraires du prix net vendeur à la charge de l'acquéreur soit 18 750 euros HT\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750112,\"codePostal\":\"75012\",\"nomVille\":\"Paris 12ème\",\"idQuartier\":133759,\"nomQuartier\":\"Bois de Vincennes\",\"idIris\":271675,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.84091,\"longitude\":2.434}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"CONSULT'IM\",\"idAgence\":40402,\"idRcu\":\"RC-060947\",\"idTiers\":90425,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/2/1/c/i/21cibs3dw4pw1aypbc4e2k9z0yaue2b13663fnk88.jpg\",\"websiteUrl\":\"http://www.consult-im.com\",\"codePostal\":\"75008\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/f/l/9/1fl94z2lijiyd5qdgd8momordcbiog3ls78an8a2o.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/2/g/r/22grbouyj5eyhcnm1fimmp8vwimt60l9iyc7i45q8.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/y/b/z/0ybzlfz3waqr1zr3uh5vvmxhfmgb6b3gxe6ek28lc.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/3/z/3/13z3o3kf1fto3ecnoxz6kvjku1wssb8ue9vpzumf4.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/l/e/o/1leoep4n9h2k4t3o5rqc123cgeur8g9jadn1ibr40.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":400001},\"priceBySquareMeter\":{\"type\":1,\"value\":7272.745454545455}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-08-30T00:00:00\",\"publicationDateTime\":\"2024-08-30T00:59:00\",\"lastUpdateDateTime\":\"2024-12-12T13:36:00\",\"qualityIndex\":98,\"refAnnonce\":\"10316223\",\"space\":55},{\"id\":\"234559067\",\"idAnnonce\":234559067,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-17eme/234559067\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"A deux pas de la rue de la Jonquière et à proximité du métro Guy-Môquet, L'IMMOBILIERE Bernard LACOSTE vous propose ce local commercial de 107 m². \\r\\n\\r\\nLocal bénéficiant de trois entrées indépendantes....\",\"description\":\"A deux pas de la rue de la Jonquière et à proximité du métro Guy-Môquet, L'IMMOBILIERE Bernard LACOSTE vous propose ce local commercial de 107 m². \\r\\n\\r\\nLocal bénéficiant de trois entrées indépendantes. Deux vitrines. Plan modulable. Local en bon état.\\r\\n\\r\\nBien soumis au statut de la copropriété. Nombre de lots : 20. Quote part du budget prévisionnel annuel : 3167,08 Euros. Honoraires TTC inclus à la charge de l'acquéreur : 4,74 %. Pour toute demande d'informations et organiser une visite, contactez Adrien \",\"leaseTypes\":[],\"equipments\":[3,8],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750117,\"codePostal\":\"75017\",\"nomVille\":\"Paris 17ème\",\"idQuartier\":133139,\"nomQuartier\":\"La Fourche-Guy Môquet\",\"idIris\":272093,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.89508,\"longitude\":2.32143}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"L IMMOBILIERE Bernard LACOSTE\",\"idAgence\":522052,\"idRcu\":\"RC-089874\",\"idTiers\":111501,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"75011\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/5/u/c/15uc7hnpkzl7fshvuw6r00jtm2ig433t72ryeh728.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/k/9/c/1k9cc09aib0rsrwkw2y668b3new9kkublytmafwg0.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/e/g/e/0egeyjgrcsfqqxhs3fsd7n5fquztd6by2b96mz5ds.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/a/a/w/0aawhzf26zuzpcxtp1uzsu8c4r70kc8tzqisctd6o.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/u/f/8/1uf8jcbor0y503ocftgqherc7c120tlb4alok7dhc.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":995000},\"priceBySquareMeter\":{\"type\":1,\"value\":9299.065420560748}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-24T00:00:00\",\"publicationDateTime\":\"2025-01-24T09:26:00\",\"lastUpdateDateTime\":\"2025-01-24T09:36:00\",\"qualityIndex\":96,\"refAnnonce\":\"UW137-1862J\",\"space\":107},{\"id\":\"234423383\",\"idAnnonce\":234423383,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-9eme/234423383\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"NEXT RETAIL vous propose un local commercial en plein coeur de la rue des Martyrs, d'une surface totale d'environ 80m2 comprenant un rez-de-chaussée d'environ 53m2 et un sous-sol communiquant d'environ...\",\"description\":\"NEXT RETAIL vous propose un local commercial en plein coeur de la rue des Martyrs, d'une surface totale d'environ 80m2 comprenant un rez-de-chaussée d'environ 53m2 et un sous-sol communiquant d'environ 27m2, sanitaires et points d'eau, nombreuses enseignes à proximité. Opportunité à saisir !\\r\\nNEXT RETAIL est un cabinet spécialisé en immobilier commercial et vous accompagne dans toutes vos recherches de fonds de commerce, locations pures, murs de boutiques, bureaux.\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750109,\"codePostal\":\"75009\",\"nomVille\":\"Paris 9ème\",\"idQuartier\":133090,\"nomQuartier\":\"Trudaine-Maubeuge\",\"idIris\":271554,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.88264,\"longitude\":2.34555}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"NEXT RETAIL\",\"idAgence\":533389,\"idRcu\":\"RC-1892530\",\"idTiers\":1036020,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/2/9/p/m/29pmm6e8cxi9u1n8duvvmqcgqosq45tcpxsvbwmry.jpg\",\"websiteUrl\":\"\",\"codePostal\":\"75016\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/z/r/l/0zrlp2mwt9bx0ni915u2d4b1t9lm5gwgoq1337xfk.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/q/z/a/0qzawymkmh3oudattbtkri0e47tfthqj8ytgckxs0.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/3/c/o/03co9x80hm9308koil6e1cfr5tuvhu2tlkcu0xs00.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/u/1/l/0u1lkdivca5izpa9uu9a1qsgb0d2b4c9mq68mwk5c.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/b/7/2/1b72kvh0fj9dbx75xh1xcllcg89wimtt6clbnh4hs.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":636000},\"priceBySquareMeter\":{\"type\":1,\"value\":7950}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-22T00:00:00\",\"publicationDateTime\":\"2025-01-22T12:00:00\",\"lastUpdateDateTime\":\"2025-01-22T12:05:00\",\"qualityIndex\":96,\"refAnnonce\":\"NR1-462\",\"space\":80},{\"id\":\"234302577\",\"idAnnonce\":234302577,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-10eme/234302577\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"WALL PARTNERS vous propose un local commercial en fond de cour à proximité immédiate de Bonne Nouvelle, d'une surface totale d'environ 120 m2 comprenant un rez-de-chaussée d'environ 80 m2 et un sous-sol...\",\"description\":\"WALL PARTNERS vous propose un local commercial en fond de cour à proximité immédiate de Bonne Nouvelle, d'une surface totale d'environ 120 m2 comprenant un rez-de-chaussée d'environ 80 m2 et un sous-sol d'environ 40 m2 le sous-sol est accessible par le local, sanitaire et point d'eau, excellent emplacement pour une activité de type tertiaire ou du pilate, nombreuses enseignes à proximité.\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750110,\"codePostal\":\"75010\",\"nomVille\":\"Paris 10ème\",\"idQuartier\":133096,\"nomQuartier\":\"Porte Saint Denis-Paradis\",\"idIris\":271571,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.87283,\"longitude\":2.3524}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"WALL PARTNERS\",\"idAgence\":446887,\"idRcu\":\"RC-094899\",\"idTiers\":272283,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/0/j/v/v/0jvvmzn8efyx230efayw5btm9c8ys7yi3ttc7mahs.jpg\",\"websiteUrl\":\"http://www.wallpartners.fr\",\"codePostal\":\"75116\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/i/n/w/1inwvnkr0rgsq3i3vu1pnbi1j10cy0smbgld4i29s.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/z/f/v/0zfvg12e9y4j8je58fcy5uatxpvp6fgp0doywbqps.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/7/7/7/17779bx2ul3letvq51uc469gwxpenyr8lvzz9wav4.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/j/6/g/1j6glcmf6hmomv6pu6ecfyromn0ckri3wjnk377cw.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":997500},\"priceBySquareMeter\":{\"type\":1,\"value\":8312.5}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-20T00:00:00\",\"publicationDateTime\":\"2025-01-20T17:41:00\",\"lastUpdateDateTime\":\"2025-01-20T17:46:00\",\"qualityIndex\":96,\"refAnnonce\":\"VL2-4215\",\"space\":120},{\"id\":\"223981191\",\"idAnnonce\":223981191,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-3eme/223981191\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"Le cabinet Realty'z, vous propose un local commercial fond de cour d'une superficie totale de 51m2 sur deux niveaux. Rez-de-chaussée d'une superficie totale de 39,9m2. Le-sous-sol accessible depuis un...\",\"description\":\"Le cabinet Realty'z, vous propose un local commercial fond de cour d'une superficie totale de 51m2 sur deux niveaux. Rez-de-chaussée d'une superficie totale de 39,9m2. Le-sous-sol accessible depuis un escalier intérieur possède une superficie de 11,1m2. Le local est équipé de sanitaires et d'un point d'eau. Ce local est idéal pour une activité de bureaux, show-room, cabinet d'architecte, etc ..\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750103,\"codePostal\":\"75003\",\"nomVille\":\"Paris 3ème\",\"idQuartier\":133060,\"nomQuartier\":\"Arts et Métiers\",\"idIris\":271364,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.8666916,\"longitude\":2.358147}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"REALTY'Z\",\"idAgence\":246789,\"idRcu\":\"RC-095242\",\"idTiers\":272534,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/2/6/c/n/26cn2629w7ejd1qeimqdotc74tsrn0mn7zhk3byci.jpg\",\"websiteUrl\":\"http://www.realtyz.fr\",\"codePostal\":\"75008\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/6/m/7/06m71zdrn258c427wy8wecs2u6qyvwsc6dw9svg8w.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/s/c/4/0sc439y3yodjmthdjkief1f5gadzcenznt9k7mghs.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/3/t/x/13txvtluthtjepxg3ues6psmxh0ek9ghys2pcvd34.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/l/1/i/0l1iwkw4hm3pwaaj61v3c618voblvnjvuo3mbru2o.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/9/k/p/19kpljoj13svd8v5ql876u80vik01j0wxj3o62pkw.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":402800},\"priceBySquareMeter\":{\"type\":1,\"value\":7898.0392156862745}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-15T00:00:00\",\"publicationDateTime\":\"2025-01-15T01:40:00\",\"lastUpdateDateTime\":\"2025-01-15T02:41:00\",\"qualityIndex\":96,\"refAnnonce\":\"MZ1-5570\",\"space\":51},{\"id\":\"233876999\",\"idAnnonce\":233876999,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-5eme/233876999\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":3,\"subBusinessType\":21,\"businessTypeList\":[3],\"subBusinessTypeList\":[21]},\"cardTitle\":\"Boutique\",\"cardDescription\":\"RESTAURANT D'EXCEPTION À VENDRE – 89 m² – PARIS 5ÈME, FACE À NOTRE-DAME\\r\\n\\r\\nImaginez : un restaurant chargé d’histoire, en activité depuis les années 90, niché au cœur du 5ème arrondissement de Paris....\",\"description\":\"RESTAURANT D'EXCEPTION À VENDRE – 89 m² – PARIS 5ÈME, FACE À NOTRE-DAME\\r\\n\\r\\nImaginez : un restaurant chargé d’histoire, en activité depuis les années 90, niché au cœur du 5ème arrondissement de Paris. Face à l’iconique Notre-Dame, à deux pas de l’Île Saint-Louis et de l’Île de la Cité, cet établissement est une véritable pépite pour les amoureux de gastronomie et d’authenticité.\\r\\n\\r\\nUn cadre qui ne laisse personne indifférent, un emplacement qui attire les foules.\\r\\n\\r\\n- CE QUI VOUS ATTEND :\\r\\nUn espace de 89 m² parfaitement agencé, réparti sur deux niveaux :\\r\\n\\r\\n- Rez-de-chaussée : Salle lumineuse avec bar sur mesure en zinc et bois, cuisine semi-ouverte ultra fonctionnelle, et sanitaires.\\r\\nSous-sol climatisé : Salle voûtée en pierres apparentes pour une ambiance intimiste, avec espaces techniques (chambre froide, réserve, vestiaire).\\r\\n- LES PLUS QUI FONT TOUTE LA DIFFÉRENCE :\\r\\nCuisine clé en main : Équipements aux normes, entretien irréprochable, tout est prêt pour continuer l’activité.\\r\\nÉquipe déjà en place : 6 pros expérimentés (3 en salle, 3 en cuisine).\\r\\n- Licence grande restauration : Exploitation immédiate.\\r\\nVisibilité  : Pas de droit de terrasse, mais un passage touristique constant.\\r\\n\\r\\n- POURQUOI SAUTER SUR CETTE OPPORTUNITÉ ?\\r\\nUn spot unique face à Notre-Dame : Vous êtes littéralement au cœur de Paris, là où tout se passe.\\r\\nUn charme fou : Entre pierres apparentes et ambiance cosy, l’adresse respire l’authenticité.\\r\\nZéro temps mort : Pas besoin de travaux, tout est prêt pour reprendre les rênes.\\r\\nUne clientèle assurée : Un flux constant de touristes et de locaux depuis plus de 30 ans.\\r\\n- INFOS PRATIQUES :\\r\\nLoyer annuel : 43 000 € HT/HC.\\r\\nVisites sur rendez-vous uniquement.\\r\\nC’est le moment de concrétiser vos projets !\\r\\nContactez-nous dès maintenant et venez découvrir ce lieu unique avec notre conseillère en immobilier commercial.\\r\\n\\r\\nÀ voir sans tarder!\\r\\n\\r\\nPour plus d’infos sur les risques liés au bien, rendez-vous sur : georisques.gouv.fr.\",\"leaseTypes\":[],\"equipments\":[2],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750105,\"codePostal\":\"75005\",\"nomVille\":\"Paris 5ème\",\"idQuartier\":133067,\"nomQuartier\":\"Sorbonne\",\"idIris\":271425,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.84635,\"longitude\":2.34708}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"EXP REALTY\",\"idAgence\":446379,\"idRcu\":\"RC-1144999\",\"idTiers\":536602,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"34000\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/2/7/e/2/27e2rit4m6vz78cthmr37laqsju4j8rq74krnuwqg.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/w/d/l/1wdlck9so3vdl827hsrxd6vevob3qvrqi34p5886d.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/9/s/7/09s7h7n9xz6vejt8s7bu57w9eyly1sajq1ofvihhf.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/3/z/y/13zyc23zjzrmfvpshhqpefbr52h9cphozehk3m4s0.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/2/n/c/22nc70j2riih8gsf7f619sls53n2wsri9wfnwh5x4.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":440000},\"priceBySquareMeter\":{\"type\":1,\"value\":4943.820224719101}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-14T00:00:00\",\"publicationDateTime\":\"2025-01-14T10:48:00\",\"lastUpdateDateTime\":\"2025-01-15T03:06:00\",\"qualityIndex\":96,\"refAnnonce\":\"83419707\",\"space\":89},{\"id\":\"233877013\",\"idAnnonce\":233877013,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-17eme/233877013\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":3,\"subBusinessType\":21,\"businessTypeList\":[3],\"subBusinessTypeList\":[21]},\"cardTitle\":\"Boutique\",\"cardDescription\":\"À Vendre – Fonds de Commerce Restaurant avec Appartement T2 de Fonction – Paris 17ème\\r\\n\\r\\nUne belle opportunité dans le 17ème arrondissement de Paris, quartier prisé et animé, idéal pour les restaurateurs...\",\"description\":\"À Vendre – Fonds de Commerce Restaurant avec Appartement T2 de Fonction – Paris 17ème\\r\\n\\r\\nUne belle opportunité dans le 17ème arrondissement de Paris, quartier prisé et animé, idéal pour les restaurateurs souhaitant s'installer dans un lieu clé en main. Ce restaurant rénové avec soin, mêle authenticité et modernité, offrant un cadre parfait pour accueillir vos projets.\\r\\n\\r\\n- Caractéristiques du Restaurant\\r\\nSurface commerciale : 130 m², incluant un bar convivial et de grandes vitrines qui apportent une très belle luminosité.\\r\\nSous-sol voûté en pierre sain et atypique: 33 m², un espace unique et chaleureux, parfait pour créer une ambiance intimiste et offrir un espace d'évènementiel .\\r\\nCuisine équipée : 20 m² avec extraction T500, conduit neuf, piano 6 feux et plaques à snacker,  et bien plus..conçue pour répondre aux besoins des professionnels les plus exigeants.\\r\\nRéserve fonctionnelle : 25 m² avec trois frigos positifs pour un stockage optimal.\\r\\n\\r\\n- Un Appartement de Fonction Inclus:\\r\\nCe bien comprend également un appartement T2 de 49 m², idéal pour un couple ou pour loger du personnel. Un avantage rare dans ce secteur de Paris.\\r\\n\\r\\n- Un Emplacement Idéal\\r\\nSitué dans un quartier vivant et recherché, bénéficiant d'un fort passage.\\r\\nProximité des commerces, bureaux et résidences, offrant une clientèle variée et fidèle.\\r\\n\\r\\nLes Atouts de Cet Investissement\\r\\nRénovation complète : Aucun travaux à prévoir, le lieu est prêt à être exploité.\\r\\nPolyvalence des espaces : Une configuration idéale pour tous types de moments, des repas d'affaires aux dîners plus intimes.\\r\\n- Valeur ajoutée : Un lieu prêt à vous accueillir et à donner vie à vos projets culinaires. La présence d'un appartement de fonction, un atout précieux dans la capitale. Zone très dynamique = Bureaux et résidents.\\r\\n\\r\\nUne Belle Opportunité à Ne Pas Manquer\\r\\nSi vous recherchez un lieu alliant praticité, charme et emplacement stratégique, ce fonds de commerce est fait pour vous.\\r\\n\\r\\n?? Pour plus d'informations ou pour organiser une visite, contactez  spécialisée en immobilier commercial & résidentiel sur Paris et île de France.\",\"leaseTypes\":[],\"equipments\":[3,8],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750117,\"codePostal\":\"75017\",\"nomVille\":\"Paris 17ème\",\"idQuartier\":133144,\"nomQuartier\":\"Ternes-Maillot\",\"idIris\":272038,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.8796,\"longitude\":2.28829}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"EXP REALTY\",\"idAgence\":446379,\"idRcu\":\"RC-1144999\",\"idTiers\":536602,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"34000\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/a/e/1/0ae1h8b1d7f09zt89glxbir5xh6jqnczwwjk6a6jk.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/x/e/c/1xeccvr0cwswxz62zv713e195275a2fwuitetbxy8.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/7/r/d/17rd8kdl1ivxfhjn4cvglh1z3y5txtq0hhmzh1sww.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/f/h/k/0fhky8622a6by7m6xctcl394v19zqabqptazmfan4.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/d/5/o/0d5otw26k5zc80quvx227lskds099sq2gpx095ork.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":390000},\"priceBySquareMeter\":{\"type\":1,\"value\":2977.0992366412215}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":false,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-14T00:00:00\",\"publicationDateTime\":\"2025-01-14T10:48:00\",\"lastUpdateDateTime\":\"2025-01-15T03:06:00\",\"qualityIndex\":96,\"refAnnonce\":\"84381889\",\"space\":131},{\"id\":\"233691629\",\"idAnnonce\":233691629,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-15eme/233691629\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":3,\"subBusinessType\":21,\"businessTypeList\":[3],\"subBusinessTypeList\":[21]},\"cardTitle\":\"Boutique\",\"cardDescription\":\"PARIS 15E - Nous vous proposons en exclusivité la vente des murs de boutique occupée par un restaurant, idéalement située dans le 15ème arrondissement de Paris, rue Mademoiselle, à deux pas de l'Église...\",\"description\":\"PARIS 15E - Nous vous proposons en exclusivité la vente des murs de boutique occupée par un restaurant, idéalement située dans le 15ème arrondissement de Paris, rue Mademoiselle, à deux pas de l'Église Saint-Jean-Baptiste de Grenelle. Ce bien offre un investissement de qualité, bénéficiant d'une bonne rentabilité locative grâce à un locataire stable dans un secteur recherché.\\n\\nCaractéristiques du bien :\\nLocal commercial en rez-de-chaussée, sur rue, d'une superficie de 46,81 m² (loi Carrez), comprenant :\\n\\nUne boutique avec vitrine en parfait état avec WC \\nUne arrière-boutique située entre le bâtiment sur rue et celui sur cour\\nCave privative \\n\\nBail commercial de 9 ans signé le 1er juillet 2020, avec un locataire exploitant un restaurant. Le bail est en cours et offre ainsi une rente locative stable et sécurisée pour l'investisseur.\\n\\nLocalisation : Le bien se situe dans un quartier dynamique et commerçant, bénéficiant d'une excellente visibilité et d'un passage régulier. Le secteur est bien desservi par les transports en commun (250m station métro Commerce ligne 8), avec de nombreux commerces et services à proximité.\\n\\nPoints forts :\\nRentabilité locative assurée par un bail commercial 9 ans avec locataire stable.\\nExcellente visibilité et attractivité du secteur.\\nSecteur recherché du 15ème arrondissement, proche des principaux axes commerciaux.\\n\\nExtraction 300/400mm\\n\\nPour toute information complémentaire ou pour organiser une visite, veuillez nous contacter \\nMandat exclusif n°2940 - Honoraires agence à la charge du vendeur.\",\"leaseTypes\":[],\"equipments\":[3,7],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750115,\"codePostal\":\"75015\",\"nomVille\":\"Paris 15ème\",\"idQuartier\":133130,\"nomQuartier\":\"Violet Commerce\",\"idIris\":271908,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.84403,\"longitude\":2.29509}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"I P H CONSEIL\",\"idAgence\":7686,\"idRcu\":\"RC-009359\",\"idTiers\":98,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"92200\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/j/m/g/0jmg8rrkt35muegd4aupw1pb2axkgcy37vudrcrkw.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/6/4/x/164xt1ke9nl5o92ibuhd2fqeiqd9g1vf8on80kb6o.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/u/b/4/1ub4kewa6t222guhnf52v87fcohv8sgkcg6pcxtmg.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/u/i/h/1uih4dvvm6qrbh1pjfk8y5gantdonqkoytbztaffk.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/z/w/e/0zwetpxqx08wvhi3bf1ybzri2k3i95t5dvem5080w.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":520000},\"priceBySquareMeter\":{\"type\":1,\"value\":11063.829787234043}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-10T00:00:00\",\"publicationDateTime\":\"2025-01-10T15:49:00\",\"lastUpdateDateTime\":\"2025-01-13T05:35:00\",\"qualityIndex\":96,\"refAnnonce\":\"85425725\",\"space\":46.81},{\"id\":\"233649959\",\"idAnnonce\":233649959,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-13eme/233649959\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":true,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"Le cabinet Realty'z vous propose à la vente une boutique occupé plus un appartement deux pièces libre à la vente. La façade du commerce possède un linéaire d'une superficie de 7,5m2. Le boutique possède...\",\"description\":\"Le cabinet Realty'z vous propose à la vente une boutique occupé plus un appartement deux pièces libre à la vente. La façade du commerce possède un linéaire d'une superficie de 7,5m2. Le boutique possède une superficie totale de 77m2 sur deux niveaux dont 62m2 au rez-de-chaussée (surface de vente totale) et 15m2 en sous-sol. L'appartement deux pièces actuellement libre d'une superficie totale de 40m2 est dissocié de la boutique, il est accessible depuis les parties communes. Cette actif est idéale pour un investissement.\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750113,\"codePostal\":\"75013\",\"nomVille\":\"Paris 13ème\",\"idQuartier\":133109,\"nomQuartier\":\"Salpêtrière-Austerlitz\",\"idIris\":271728,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.8332793,\"longitude\":2.3548147}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"REALTY'Z\",\"idAgence\":246789,\"idRcu\":\"RC-095242\",\"idTiers\":272534,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/2/6/c/n/26cn2629w7ejd1qeimqdotc74tsrn0mn7zhk3byci.jpg\",\"websiteUrl\":\"http://www.realtyz.fr\",\"codePostal\":\"75008\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/x/d/t/0xdtyizq5vh60vjwdmkfjanmoca6idbmps55k9q0w.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/i/d/u/1idu47lw949ifhfc2pu8l66dtb6tq9xl8j0mds35s.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/7/6/f/076fqet8bl4rq2028o0shvzzslj6pt4fd34t4gqv4.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/d/p/p/1dpplyf6at9sjnjsrwsdmbsgi2546ckjvgerkblz4.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/l/4/f/1l4fnt06gpmmg23c2bt84k7kw67k967yp76cpvksg.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":1049400},\"priceBySquareMeter\":{\"type\":1,\"value\":8969.23076923077}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-10T00:00:00\",\"publicationDateTime\":\"2025-01-10T02:28:00\",\"lastUpdateDateTime\":\"2025-01-10T02:36:00\",\"qualityIndex\":96,\"refAnnonce\":\"MZ1-6605\",\"space\":117},{\"id\":\"233519031\",\"idAnnonce\":233519031,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-8eme/233519031\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"REALTY'Z vous propose à la vente les murs libres d'un local commercial faisant office de bureaux, d'une surface totale de 70 m2 tout en rez-de-chaussée ainsi qu'une cave de 9,88 m2 accessible directement...\",\"description\":\"REALTY'Z vous propose à la vente les murs libres d'un local commercial faisant office de bureaux, d'une surface totale de 70 m2 tout en rez-de-chaussée ainsi qu'une cave de 9,88 m2 accessible directement par les parties communes. Situé à proximité de la place Saint Augustin, ce local est idéal pour une activité de bureaux, profession libérale.. Pour plus d'informations, n'hésitez pas à prendre contact avec notre équipe. Référence : MZ1 : 6593\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750108,\"codePostal\":\"75008\",\"nomVille\":\"Paris 8ème\",\"idQuartier\":133084,\"nomQuartier\":\"Mairie\",\"idIris\":271512,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.8766943,\"longitude\":2.3200823}},\"mandat\":{\"isCoex\":false,\"isExclusive\":false,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"REALTY'Z\",\"idAgence\":246789,\"idRcu\":\"RC-095242\",\"idTiers\":272534,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/2/6/c/n/26cn2629w7ejd1qeimqdotc74tsrn0mn7zhk3byci.jpg\",\"websiteUrl\":\"http://www.realtyz.fr\",\"codePostal\":\"75008\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/9/s/b/09sb47xggr1acc24ldnerse44np19qw6cn3zn09og.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/s/z/a/0szamsc8hq0lujwc30gnocf545mneqn77abjtbtog.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/n/8/4/1n84uxt0qifapx6apuryki4uf3lcuxj8gkpb7mha8.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/0/j/y/00jy750fkiocnf9afcu2b41amtyu8e8rxfwmq5d6o.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":985800},\"priceBySquareMeter\":{\"type\":1,\"value\":14082.857142857143}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-08T00:00:00\",\"publicationDateTime\":\"2025-01-08T03:26:00\",\"lastUpdateDateTime\":\"2025-01-08T03:31:00\",\"qualityIndex\":96,\"refAnnonce\":\"MZ1-6593\",\"space\":70},{\"id\":\"233472947\",\"idAnnonce\":233472947,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-4eme/233472947\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"Local commercial sur rue. Toute activité sauf restauration avec nuisance olfactive et sonore. Répartis sur 65.45 m2, au RDC comprenant W.C, chaudière récente espace cuisine. Entrée par la cour de cette...\",\"description\":\"Local commercial sur rue. Toute activité sauf restauration avec nuisance olfactive et sonore. Répartis sur 65.45 m2, au RDC comprenant W.C, chaudière récente espace cuisine. Entrée par la cour de cette charmante copropriété ancienne ainsi que par la rue Charles V. Local à réaménager et rénover complètement.\\nTransformable en habitation.\",\"leaseTypes\":[],\"equipments\":[3],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750104,\"codePostal\":\"75004\",\"nomVille\":\"Paris 4ème\",\"idQuartier\":133065,\"nomQuartier\":\"Arsenal\",\"idIris\":271391,\"adresse\":\"\",\"localisationPrecision\":1,\"geoLocation\":{\"latitude\":48.852793,\"longitude\":2.363409}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"SARL AGENCE ARAGO\",\"idAgence\":98681,\"idRcu\":\"RC-121718\",\"idTiers\":147816,\"isPrincipal\":true,\"logoUrl\":\"\",\"websiteUrl\":\"\",\"codePostal\":\"75014\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/0/q/3/8/0q38q3qbfjzrbjdyi8xac3kzt98axgok4oqk9qkoo.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/t/7/u/1t7ujx5r1mjfu8ey4m9byvtt753omm3u87su1ug0w.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/t/u/q/0tuqxamjetoix6pjdf6o92ivcylpiqfejq9d8galc.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/5/6/2/2562ybd1vtm38th76lk98hfkhlwp4bywuvnhsr5pc.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":874820},\"priceBySquareMeter\":{\"type\":1,\"value\":13458.76923076923}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2025-01-07T00:00:00\",\"publicationDateTime\":\"2025-01-07T15:37:00\",\"lastUpdateDateTime\":\"2025-01-08T02:46:00\",\"qualityIndex\":96,\"refAnnonce\":\"177\",\"space\":65.45},{\"id\":\"232557901\",\"idAnnonce\":232557901,\"idSourceCouplage\":10,\"detailUrl\":\"/annonces/achat/boutique/paris-5eme/232557901\",\"codeTypeBien\":600,\"idTypeTransaction\":2,\"idTypeBien\":6,\"idSousTypeBien\":0,\"isAnnonceOr\":false,\"isBoostSuggestion\":false,\"isBoostHighlight\":false,\"isDivisible\":false,\"isImmediatelyAvailable\":true,\"businessSold\":{\"isWallsIncluded\":true,\"businessType\":0,\"subBusinessType\":0},\"cardTitle\":\"Boutique\",\"cardDescription\":\"EXCLUSIVITE MARCITY vous propose à vendre des murs de restaurant avec vraie extraction de 400mm de diamètre occupés situés rue Gay Lussac Paris 5e d'une surface de 58m2 comprenant 52 m2 en Rdc et 6m2...\",\"description\":\"EXCLUSIVITE MARCITY vous propose à vendre des murs de restaurant avec vraie extraction de 400mm de diamètre occupés situés rue Gay Lussac Paris 5e d'une surface de 58m2 comprenant 52 m2 en Rdc et 6m2 en sous-sol (cave) non relié. Valeur locative: 42 000 Euros/an HC HT. Prix des murs : 634 000 euros FAI\",\"leaseTypes\":[],\"equipments\":[],\"localisation\":{\"codeRegion\":2238,\"codeDepartement\":\"75\",\"idSubDivision\":17649,\"fakeCityCodeInsee\":750056,\"isArrondissement\":true,\"codeInsee\":750105,\"codePostal\":\"75005\",\"nomVille\":\"Paris 5ème\",\"idQuartier\":133068,\"nomQuartier\":\"Val de Grace\",\"idIris\":271422,\"adresse\":\"\",\"localisationPrecision\":2,\"geoLocation\":{\"latitude\":48.84228,\"longitude\":2.34384}},\"mandat\":{\"isCoex\":false,\"isExclusive\":true,\"hasEmail\":true,\"hasTel\":true,\"mandataires\":[{\"name\":\"MARCITY VALUE GESTION E.M\",\"idAgence\":329535,\"idRcu\":\"RC-005144\",\"idTiers\":285419,\"isPrincipal\":true,\"logoUrl\":\"https://v.seloger.com/s/width/150/logos/2/1/x/l/21xlk2w2ah82y3jceck27cockm7rtl2bywlj9w58g.jpg\",\"websiteUrl\":\"https://www.marcity.fr\",\"codePostal\":\"75010\"}]},\"photos\":[\"https://v.seloger.com/s/crop/500x240/visuels/1/v/w/1/1vw1g8c7vp0uf441onsuehqto49kd0k4vum6m92io.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/1/1/h/d/11hdjt2k2dkshaqabs21l4j6gv6yaf9shzziaim80.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/2/7/f/s/27fs97md8gffu9l97l27hji5evpwfhw0hi5fu3tog.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/5/i/b/05ibnmi0jxj6hfjts06u3tfcsrq0zrzbk40aj7y0w.jpg\",\"https://v.seloger.com/s/crop/500x240/visuels/0/7/n/m/07nm3fkkyr1yoveapmcabm7aecswau6wf8d6zej28.jpg\"],\"price\":{\"buy\":{\"price\":{\"type\":1,\"value\":634000},\"priceBySquareMeter\":{\"type\":1,\"value\":10931.034482758621}},\"additionalCharges\":{\"isLeaseBack\":false,\"hasAgencyFeesIncluded\":true,\"hasOperatingCostIncluded\":false,\"hasTaxIncluded\":true}},\"publicationDateOnly\":\"2024-12-17T00:00:00\",\"publicationDateTime\":\"2024-12-17T19:44:00\",\"lastUpdateDateTime\":\"2024-12-17T19:51:00\",\"qualityIndex\":96,\"refAnnonce\":\"MA9-183\",\"space\":58}],\"extendedClassifieds\":[],\"pagination\":{\"classifiedCount\":1145,\"currentPage\":1,\"resultPerPage\":25,\"maxPage\":400},\"searchCriteria\":{\"codeTypeBiens\":[600,700],\"idTypeTransactions\":[2],\"localisations\":[{\"type\":5,\"code\":\"75\"}],\"keywords\":[],\"equipments\":[],\"idAgences\":[],\"idClassifieds\":[],\"idClassifiedsExcluded\":[],\"sort\":0,\"trading\":{\"excludeLeaseBack\":false,\"excludeAccessPrice\":false,\"excludeWallsRent\":false,\"excludeWallsBuy\":false,\"businessType\":[]},\"size\":25,\"page\":1},\"listingSeoModel\":{\"metaDescription\":\"Découvrez toutes nos annonces immobilières d'achat de locaux commerciaux et boutiques à Paris (75) à un prix attractif grâce au n°1 des locaux professionnels.\",\"metaTitle\":\"1145  locaux commerciaux et boutiques à vendre à Paris (75) | SeLoger bureaux & commerces\",\"resultTitleLeftPart\":\"1145  locaux commerciaux et boutiques\",\"resultTitleRightPart\":\"à l'achat à Paris (75)\",\"metaCanonicalUrl\":\"/achat/boutique/ile-de-france/paris\",\"breadcrumb\":[{\"label\":\"Accueil\",\"links\":[{\"label\":\"Immobilier d’entreprise\",\"link\":\"/\",\"isSeparated\":false}]},{\"label\":\"Commerce\",\"links\":[{\"label\":\"Reprendre / Ouvrir un commerce\",\"link\":\"/commerce\",\"isSeparated\":false}]},{\"label\":\"France\",\"links\":[{\"label\":\"Location local commercial et boutique\",\"labelZone\":\"\",\"link\":\"/location/boutique\",\"isSeparated\":false},{\"label\":\"Achat local commercial et boutique\",\"labelZone\":\"\",\"link\":\"/achat/boutique\",\"isSeparated\":false},{\"label\":\"Location local commercial et boutique avec Vitrine\",\"labelZone\":\"\",\"link\":\"/location/boutique/vitrine\",\"isSeparated\":false},{\"label\":\"Achat local commercial et boutique avec Vitrine\",\"labelZone\":\"\",\"link\":\"/achat/boutique/vitrine\",\"isSeparated\":false},{\"label\":\"Tous nos locaux professionnels à la location\",\"labelZone\":\"\",\"link\":\"/location/local-professionnel\",\"isSeparated\":true},{\"label\":\"Tous nos locaux professionnels à l'achat\",\"labelZone\":\"\",\"link\":\"/achat/local-professionnel\",\"isSeparated\":true}]},{\"label\":\"Île-de-France\",\"links\":[{\"label\":\"Location local commercial et boutique\",\"labelZone\":\"Île-de-France\",\"link\":\"/location/boutique/ile-de-france\",\"isSeparated\":false},{\"label\":\"Achat local commercial et boutique\",\"labelZone\":\"Île-de-France\",\"link\":\"/achat/boutique/ile-de-france\",\"isSeparated\":false},{\"label\":\"Location local commercial et boutique avec Vitrine\",\"labelZone\":\"Île-de-France\",\"link\":\"/location/boutique/vitrine/ile-de-france\",\"isSeparated\":false},{\"label\":\"Achat local commercial et boutique avec Vitrine\",\"labelZone\":\"Île-de-France\",\"link\":\"/achat/boutique/vitrine/ile-de-france\",\"isSeparated\":false},{\"label\":\"Tous nos locaux professionnels à la location\",\"labelZone\":\"Île-de-France\",\"link\":\"/location/local-professionnel/ile-de-france\",\"isSeparated\":true},{\"label\":\"Tous nos locaux professionnels à l'achat\",\"labelZone\":\"Île-de-France\",\"link\":\"/achat/local-professionnel/ile-de-france\",\"isSeparated\":true}]},{\"label\":\"Paris\",\"links\":[{\"label\":\"Location local commercial et boutique\",\"labelZone\":\"Paris\",\"link\":\"/location/boutique/ile-de-france/paris\",\"isSeparated\":false},{\"label\":\"Location local commercial et boutique avec Vitrine\",\"labelZone\":\"Paris\",\"link\":\"/location/boutique/vitrine/ile-de-france/paris\",\"isSeparated\":false},{\"label\":\"Achat local commercial et boutique avec Vitrine\",\"labelZone\":\"Paris\",\"link\":\"/achat/boutique/vitrine/ile-de-france/paris\",\"isSeparated\":false},{\"label\":\"Tous nos locaux professionnels à la location\",\"labelZone\":\"Paris\",\"link\":\"/location/local-professionnel/ile-de-france/paris\",\"isSeparated\":true},{\"label\":\"Tous nos locaux professionnels à l'achat\",\"labelZone\":\"Paris\",\"link\":\"/achat/local-professionnel/ile-de-france/paris\",\"isSeparated\":true}]}],\"linkingBox\":[{\"label\":\"Nos annonces d'achat local commercial et boutique dans les villes de Paris (75)\",\"links\":[{\"label\":\"achat local commercial et boutique à Paris 11ème (75011)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-11eme\"},{\"label\":\"achat local commercial et boutique à Paris 17ème (75017)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-17eme\"},{\"label\":\"achat local commercial et boutique à Paris 15ème (75015)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-15eme\"},{\"label\":\"achat local commercial et boutique à Paris 18ème (75018)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-18eme\"},{\"label\":\"achat local commercial et boutique à Paris 12ème (75012)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-12eme\"},{\"label\":\"achat local commercial et boutique à Paris 10ème (75010)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-10eme\"},{\"label\":\"achat local commercial et boutique à Paris 9ème (75009)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-9eme\"},{\"label\":\"achat local commercial et boutique à Paris 3ème (75003)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-3eme\"},{\"label\":\"achat local commercial et boutique à Paris 6ème (75006)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-6eme\"},{\"label\":\"achat local commercial et boutique à Paris 20ème (75020)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-20eme\"},{\"label\":\"achat local commercial et boutique à Paris 16ème (75016)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-16eme\"},{\"label\":\"achat local commercial et boutique à Paris 2ème (75002)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-2eme\"},{\"label\":\"achat local commercial et boutique à Paris 5ème (75005)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-5eme\"},{\"label\":\"achat local commercial et boutique à Paris 14ème (75014)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-14eme\"},{\"label\":\"achat local commercial et boutique à Paris 13ème (75013)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-13eme\"},{\"label\":\"achat local commercial et boutique à Paris 4ème (75004)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-4eme\"},{\"label\":\"achat local commercial et boutique à Paris 19ème (75019)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-19eme\"},{\"label\":\"achat local commercial et boutique à Paris 7ème (75007)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-7eme\"},{\"label\":\"achat local commercial et boutique à Paris 8ème (75008)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-8eme\"},{\"label\":\"achat local commercial et boutique à Paris 1er (75001)\",\"url\":\"/achat/boutique/ile-de-france/paris/paris-1er\"}],\"isEmpty\":false}]}}"}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/vinted/user/info":{"get":{"summary":"Vinted User Info","description":"Retrieve public Vinted seller profile by member URL or user ID. Returns the raw `/api/v2/users/{id}` object: login, photo, feedback stats, followers, verification, bundle discounts, and listing counts.\n\n**Credit cost:** 1 credit per call","operationId":"get-vinted-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Vinted member profile URL, direct API URL, or numeric user ID.\n\n**Examples (profile URL):**\n\n    https://www.vinted.fr/member/example-user\n\n**Example (API URL):**\n\n    https://www.vinted.fr/api/v2/users/272737992\n\n**Example (ID only):**\n\n    272737992\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- Accepts `/member/{id}`, `/member/{id}-{login}`, `/users/{id}`, or a bare numeric ID.\n- Returns the raw Vinted user object from `/api/v2/users/{id}`.","schema":{"type":"string","description":"Vinted member profile URL, direct API URL, or numeric user ID.\n\n**Examples (profile URL):**\n\n    https://www.vinted.fr/member/example-user\n\n**Example (API URL):**\n\n    https://www.vinted.fr/api/v2/users/272737992\n\n**Example (ID only):**\n\n    272737992\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- Accepts `/member/{id}`, `/member/{id}-{login}`, `/users/{id}`, or a bare numeric ID.\n- Returns the raw Vinted user object from `/api/v2/users/{id}`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"city":{"type":"string"},"path":{"type":"string"},"about":{"type":"string"},"email":{"nullable":true},"login":{"type":"string"},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"extra":{"type":"object","properties":{}},"width":{"type":"integer"},"height":{"type":"integer"},"is_hidden":{"type":"boolean"},"temp_uuid":{"nullable":true},"thumbnails":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"original_size":{"nullable":true}}}},"orientation":{"nullable":true},"full_size_url":{"type":"string"},"is_suspicious":{"type":"boolean"},"dominant_color":{"type":"string"},"high_resolution":{"type":"object","properties":{"id":{"type":"string"},"timestamp":{"type":"integer"},"orientation":{"nullable":true}}},"dominant_color_opaque":{"type":"string"}}},"locale":{"type":"string"},"anon_id":{"type":"string"},"city_id":{"nullable":true},"birthday":{"nullable":true},"business":{"type":"boolean"},"contacts":{"nullable":true},"currency":{"type":"string"},"is_hated":{"type":"boolean"},"hates_you":{"type":"boolean"},"is_online":{"type":"boolean"},"moderator":{"type":"boolean"},"real_name":{"nullable":true},"can_bundle":{"type":"boolean"},"country_id":{"type":"integer"},"fundraiser":{"type":"object","properties":{"id":{"nullable":true},"active":{"type":"boolean"},"currency":{"type":"string"},"percentage":{"type":"integer"},"feature_disabled":{"type":"boolean"}}},"item_count":{"type":"integer"},"updated_on":{"type":"integer"},"profile_url":{"type":"string"},"country_code":{"type":"string"},"is_favourite":{"type":"boolean"},"localization":{"type":"string"},"verification":{"type":"object","properties":{"email":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"}}},"google":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"},"verified_at":{"type":"string"}}},"facebook":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"},"verified_at":{"nullable":true}}}}},"country_title":{"type":"string"},"hide_feedback":{"type":"boolean"},"is_on_holiday":{"type":"boolean"},"last_loged_on":{"type":"string"},"account_status":{"type":"integer"},"feedback_count":{"type":"integer"},"bundle_discount":{"type":"object","properties":{"id":{"type":"integer"},"enabled":{"type":"boolean"},"user_id":{"type":"integer"},"fraction":{"type":"string"},"discounts":{"type":"array","items":{"type":"object","properties":{"fraction":{"type":"string"},"minimal_item_count":{"type":"integer"}}}},"minimal_item_count":{"type":"integer"}}},"default_address":{"nullable":true},"expose_location":{"type":"boolean"},"followers_count":{"type":"integer"},"following_count":{"type":"integer"},"iso_locale_code":{"type":"string"},"account_ban_date":{"nullable":true},"business_account":{"nullable":true},"can_view_profile":{"type":"boolean"},"country_iso_code":{"type":"string"},"facebook_user_id":{"nullable":true},"given_item_count":{"type":"integer"},"last_loged_on_ts":{"type":"string"},"taken_item_count":{"type":"integer"},"avg_response_time":{"nullable":true},"is_account_banned":{"type":"boolean"},"share_profile_url":{"type":"string"},"total_items_count":{"type":"integer"},"action_restriction":{"nullable":true},"msg_template_count":{"type":"integer"},"business_account_id":{"nullable":true},"contacts_permission":{"nullable":true},"country_title_local":{"type":"string"},"feedback_reputation":{"type":"integer"},"is_catalog_moderator":{"type":"boolean"},"location_description":{"nullable":true},"third_party_tracking":{"type":"boolean"},"allow_direct_messaging":{"type":"boolean"},"following_brands_count":{"type":"integer"},"neutral_feedback_count":{"type":"integer"},"negative_feedback_count":{"type":"integer"},"positive_feedback_count":{"type":"integer"},"is_publish_photos_agreed":{"type":"boolean"},"is_bpf_price_prominence_applied":{"type":"boolean"},"is_catalog_role_marketing_photos":{"type":"boolean"}}},"examples":{"Seller on vinted.fr (example-user)":{"value":{"id":272737992,"city":"","path":"/member/272737992-example-user","about":"Vendo articoli in ottimo stato per liberare spazio e dargli una seconda vita 🩷\n\nNON ACCETTO RESI ma sono disponibile a fornire tutte le misure e dettagli dei capi prima dell'acquisto 🤗","email":null,"login":"example-user","photo":{"id":246663068,"url":"https://images1.vinted.net/placeholder/example-user.jpg","extra":{},"width":96,"height":96,"is_hidden":false,"temp_uuid":null,"thumbnails":[{"url":"https://images1.vinted.net/placeholder/example-user.jpg","type":"thumb310","width":310,"height":310,"original_size":null},{"url":"https://images1.vinted.net/placeholder/example-user.jpg","type":"thumb150","width":150,"height":150,"original_size":null}],"orientation":null,"full_size_url":"https://images1.vinted.net/placeholder/example-user.jpg","is_suspicious":false,"dominant_color":"#31abc2","high_resolution":{"id":"01_0261e_RfD5M3mu4vbrTuNyhdvBT9A3","timestamp":1748634598,"orientation":null},"dominant_color_opaque":"#C1E6ED"},"locale":"it-fr","anon_id":"9c8cb2ee-2b7d-4390-88ca-7e9d23360a93","city_id":null,"birthday":null,"business":false,"contacts":null,"currency":"EUR","is_hated":false,"hates_you":false,"is_online":false,"moderator":false,"real_name":null,"can_bundle":true,"country_id":18,"fundraiser":{"id":null,"active":false,"currency":"EUR","percentage":0,"feature_disabled":false},"item_count":117,"updated_on":1757843003,"profile_url":"https://www.vinted.fr/member/example-user","country_code":"IT","is_favourite":false,"localization":"none","verification":{"email":{"valid":true,"available":true},"google":{"valid":true,"available":true,"verified_at":"2025-05-30T21:49:58+02:00"},"facebook":{"valid":false,"available":true,"verified_at":null}},"country_title":"Italie","hide_feedback":false,"is_on_holiday":false,"last_loged_on":"aujourd'hui 16 h 53","account_status":0,"feedback_count":250,"bundle_discount":{"id":39006917,"enabled":true,"user_id":272737992,"fraction":"0.1","discounts":[{"fraction":"0.1","minimal_item_count":2},{"fraction":"0.15","minimal_item_count":3},{"fraction":"0.2","minimal_item_count":5}],"minimal_item_count":2},"default_address":null,"expose_location":false,"followers_count":266,"following_count":0,"iso_locale_code":"it-IT","account_ban_date":null,"business_account":null,"can_view_profile":true,"country_iso_code":"IT","facebook_user_id":null,"given_item_count":262,"last_loged_on_ts":"2026-07-19T16:53:41+02:00","taken_item_count":5,"avg_response_time":null,"is_account_banned":false,"share_profile_url":"https://www.vinted.fr/member/example-user","total_items_count":379,"action_restriction":null,"msg_template_count":0,"business_account_id":null,"contacts_permission":null,"country_title_local":"Italie","feedback_reputation":1,"is_catalog_moderator":false,"location_description":null,"third_party_tracking":false,"allow_direct_messaging":true,"following_brands_count":0,"neutral_feedback_count":1,"negative_feedback_count":1,"positive_feedback_count":248,"is_publish_photos_agreed":true,"is_bpf_price_prominence_applied":false,"is_catalog_role_marketing_photos":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Vinted User Info","description":"Retrieve public Vinted seller profile by member URL or user ID. Returns the raw `/api/v2/users/{id}` object: login, photo, feedback stats, followers, verification, bundle discounts, and listing counts.\n\n**Credit cost:** 1 credit per call","operationId":"post-vinted-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Vinted member profile URL, direct API URL, or numeric user ID.\n\n**Examples (profile URL):**\n\n    https://www.vinted.fr/member/example-user\n\n**Example (API URL):**\n\n    https://www.vinted.fr/api/v2/users/272737992\n\n**Example (ID only):**\n\n    272737992\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- Accepts `/member/{id}`, `/member/{id}-{login}`, `/users/{id}`, or a bare numeric ID.\n- Returns the raw Vinted user object from `/api/v2/users/{id}`.","schema":{"type":"string","description":"Vinted member profile URL, direct API URL, or numeric user ID.\n\n**Examples (profile URL):**\n\n    https://www.vinted.fr/member/example-user\n\n**Example (API URL):**\n\n    https://www.vinted.fr/api/v2/users/272737992\n\n**Example (ID only):**\n\n    272737992\n\n**Notes:**\n- Domain is inferred from the URL (`vinted.fr`, `vinted.com`, …).\n- Accepts `/member/{id}`, `/member/{id}-{login}`, `/users/{id}`, or a bare numeric ID.\n- Returns the raw Vinted user object from `/api/v2/users/{id}`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"city":{"type":"string"},"path":{"type":"string"},"about":{"type":"string"},"email":{"nullable":true},"login":{"type":"string"},"photo":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"extra":{"type":"object","properties":{}},"width":{"type":"integer"},"height":{"type":"integer"},"is_hidden":{"type":"boolean"},"temp_uuid":{"nullable":true},"thumbnails":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"original_size":{"nullable":true}}}},"orientation":{"nullable":true},"full_size_url":{"type":"string"},"is_suspicious":{"type":"boolean"},"dominant_color":{"type":"string"},"high_resolution":{"type":"object","properties":{"id":{"type":"string"},"timestamp":{"type":"integer"},"orientation":{"nullable":true}}},"dominant_color_opaque":{"type":"string"}}},"locale":{"type":"string"},"anon_id":{"type":"string"},"city_id":{"nullable":true},"birthday":{"nullable":true},"business":{"type":"boolean"},"contacts":{"nullable":true},"currency":{"type":"string"},"is_hated":{"type":"boolean"},"hates_you":{"type":"boolean"},"is_online":{"type":"boolean"},"moderator":{"type":"boolean"},"real_name":{"nullable":true},"can_bundle":{"type":"boolean"},"country_id":{"type":"integer"},"fundraiser":{"type":"object","properties":{"id":{"nullable":true},"active":{"type":"boolean"},"currency":{"type":"string"},"percentage":{"type":"integer"},"feature_disabled":{"type":"boolean"}}},"item_count":{"type":"integer"},"updated_on":{"type":"integer"},"profile_url":{"type":"string"},"country_code":{"type":"string"},"is_favourite":{"type":"boolean"},"localization":{"type":"string"},"verification":{"type":"object","properties":{"email":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"}}},"google":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"},"verified_at":{"type":"string"}}},"facebook":{"type":"object","properties":{"valid":{"type":"boolean"},"available":{"type":"boolean"},"verified_at":{"nullable":true}}}}},"country_title":{"type":"string"},"hide_feedback":{"type":"boolean"},"is_on_holiday":{"type":"boolean"},"last_loged_on":{"type":"string"},"account_status":{"type":"integer"},"feedback_count":{"type":"integer"},"bundle_discount":{"type":"object","properties":{"id":{"type":"integer"},"enabled":{"type":"boolean"},"user_id":{"type":"integer"},"fraction":{"type":"string"},"discounts":{"type":"array","items":{"type":"object","properties":{"fraction":{"type":"string"},"minimal_item_count":{"type":"integer"}}}},"minimal_item_count":{"type":"integer"}}},"default_address":{"nullable":true},"expose_location":{"type":"boolean"},"followers_count":{"type":"integer"},"following_count":{"type":"integer"},"iso_locale_code":{"type":"string"},"account_ban_date":{"nullable":true},"business_account":{"nullable":true},"can_view_profile":{"type":"boolean"},"country_iso_code":{"type":"string"},"facebook_user_id":{"nullable":true},"given_item_count":{"type":"integer"},"last_loged_on_ts":{"type":"string"},"taken_item_count":{"type":"integer"},"avg_response_time":{"nullable":true},"is_account_banned":{"type":"boolean"},"share_profile_url":{"type":"string"},"total_items_count":{"type":"integer"},"action_restriction":{"nullable":true},"msg_template_count":{"type":"integer"},"business_account_id":{"nullable":true},"contacts_permission":{"nullable":true},"country_title_local":{"type":"string"},"feedback_reputation":{"type":"integer"},"is_catalog_moderator":{"type":"boolean"},"location_description":{"nullable":true},"third_party_tracking":{"type":"boolean"},"allow_direct_messaging":{"type":"boolean"},"following_brands_count":{"type":"integer"},"neutral_feedback_count":{"type":"integer"},"negative_feedback_count":{"type":"integer"},"positive_feedback_count":{"type":"integer"},"is_publish_photos_agreed":{"type":"boolean"},"is_bpf_price_prominence_applied":{"type":"boolean"},"is_catalog_role_marketing_photos":{"type":"boolean"}}},"examples":{"Seller on vinted.fr (example-user)":{"value":{"id":272737992,"city":"","path":"/member/272737992-example-user","about":"Vendo articoli in ottimo stato per liberare spazio e dargli una seconda vita 🩷\n\nNON ACCETTO RESI ma sono disponibile a fornire tutte le misure e dettagli dei capi prima dell'acquisto 🤗","email":null,"login":"example-user","photo":{"id":246663068,"url":"https://images1.vinted.net/placeholder/example-user.jpg","extra":{},"width":96,"height":96,"is_hidden":false,"temp_uuid":null,"thumbnails":[{"url":"https://images1.vinted.net/placeholder/example-user.jpg","type":"thumb310","width":310,"height":310,"original_size":null},{"url":"https://images1.vinted.net/placeholder/example-user.jpg","type":"thumb150","width":150,"height":150,"original_size":null}],"orientation":null,"full_size_url":"https://images1.vinted.net/placeholder/example-user.jpg","is_suspicious":false,"dominant_color":"#31abc2","high_resolution":{"id":"01_0261e_RfD5M3mu4vbrTuNyhdvBT9A3","timestamp":1748634598,"orientation":null},"dominant_color_opaque":"#C1E6ED"},"locale":"it-fr","anon_id":"9c8cb2ee-2b7d-4390-88ca-7e9d23360a93","city_id":null,"birthday":null,"business":false,"contacts":null,"currency":"EUR","is_hated":false,"hates_you":false,"is_online":false,"moderator":false,"real_name":null,"can_bundle":true,"country_id":18,"fundraiser":{"id":null,"active":false,"currency":"EUR","percentage":0,"feature_disabled":false},"item_count":117,"updated_on":1757843003,"profile_url":"https://www.vinted.fr/member/example-user","country_code":"IT","is_favourite":false,"localization":"none","verification":{"email":{"valid":true,"available":true},"google":{"valid":true,"available":true,"verified_at":"2025-05-30T21:49:58+02:00"},"facebook":{"valid":false,"available":true,"verified_at":null}},"country_title":"Italie","hide_feedback":false,"is_on_holiday":false,"last_loged_on":"aujourd'hui 16 h 53","account_status":0,"feedback_count":250,"bundle_discount":{"id":39006917,"enabled":true,"user_id":272737992,"fraction":"0.1","discounts":[{"fraction":"0.1","minimal_item_count":2},{"fraction":"0.15","minimal_item_count":3},{"fraction":"0.2","minimal_item_count":5}],"minimal_item_count":2},"default_address":null,"expose_location":false,"followers_count":266,"following_count":0,"iso_locale_code":"it-IT","account_ban_date":null,"business_account":null,"can_view_profile":true,"country_iso_code":"IT","facebook_user_id":null,"given_item_count":262,"last_loged_on_ts":"2026-07-19T16:53:41+02:00","taken_item_count":5,"avg_response_time":null,"is_account_banned":false,"share_profile_url":"https://www.vinted.fr/member/example-user","total_items_count":379,"action_restriction":null,"msg_template_count":0,"business_account_id":null,"contacts_permission":null,"country_title_local":"Italie","feedback_reputation":1,"is_catalog_moderator":false,"location_description":null,"third_party_tracking":false,"allow_direct_messaging":true,"following_brands_count":0,"neutral_feedback_count":1,"negative_feedback_count":1,"positive_feedback_count":248,"is_publish_photos_agreed":true,"is_bpf_price_prominence_applied":false,"is_catalog_role_marketing_photos":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/shopify/product":{"get":{"summary":"Shopify Product","description":"Extract full product details from any Shopify store product page, including title, variants, pricing, images, inventory, and options.\n\n**Credit cost:** 1 credit per call","operationId":"get-shopify-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"URL of a Shopify product page to scrape.\n\n**Example:**\n\n    https://www.decathlon.com/products/simond-backpacking-sleeping-bag-mt500-41-f-synthetic-346446\n\n**Notes:**\n- The URL must point to a product page on any Shopify-powered store (not limited to a single domain).\n- The API works with any public Shopify storefront that exposes the standard `products.json` endpoint.\n- The response includes full product details: title, vendor, variants, images, options, pricing, and inventory.","schema":{"type":"string","description":"URL of a Shopify product page to scrape.\n\n**Example:**\n\n    https://www.decathlon.com/products/simond-backpacking-sleeping-bag-mt500-41-f-synthetic-346446\n\n**Notes:**\n- The URL must point to a product page on any Shopify-powered store (not limited to a single domain).\n- The API works with any public Shopify storefront that exposes the standard `products.json` endpoint.\n- The response includes full product details: title, vendor, variants, images, options, pricing, and inventory."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"tags":{"type":"string"},"image":{"type":"object","properties":{"id":{"type":"integer"},"alt":{"type":"string"},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"}}},"title":{"type":"string"},"handle":{"type":"string"},"vendor":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"},"product_id":{"type":"integer"}}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"grams":{"type":"integer"},"price":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"},"barcode":{"type":"string"},"option1":{"type":"string"},"option2":{"type":"string"},"taxable":{"type":"boolean"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"weight_unit":{"type":"string"},"compare_at_price":{"type":"string"},"inventory_policy":{"type":"string"},"requires_shipping":{"type":"boolean"},"inventory_quantity":{"type":"integer"},"fulfillment_service":{"type":"string"},"inventory_management":{"type":"string"}}}},"body_html":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"},"published_scope":{"type":"string"},"template_suffix":{"type":"string"}}},"examples":{"Lookup Decathlon Easybreath Mask product":{"value":{"id":7017883533374,"tags":"Adult, Boy's, DEAL, FAMILY: 10645, Gift_Ideas, Holiday Product List, Kids, mask-snorkel-fins-set, Men's, WATER_SPORTS, Women's","image":{"id":30763514069054,"alt":"{*blue-8732687*}","src":"https://cdn.shopify.com/s/files/1/1330/6287/files/8732687-product_image-p2143297.jpg?v=1700515471","width":2000,"height":2000,"position":1,"created_at":"2023-11-15T10:22:37-08:00","product_id":7017883533374,"updated_at":"2023-11-20T13:24:31-08:00"},"title":"Adult's Easybreath Surface Mask Acoustic Valve - 540 Freetalk Jungle","handle":"adults-easybreath-surface-mask-acoustic-valve-540-freetalk-blue-330093","vendor":"Subea","options":[{"id":9022772510782,"name":"Color","values":["Royal Blue","Blue"],"position":1,"product_id":7017883533374},{"id":9022772543550,"name":"Size","values":["S/M","ML","M /L"],"position":2,"product_id":7017883533374}],"variants":[{"id":40088252186686,"sku":"4200766","grams":639,"price":"30.00","title":"Royal Blue / S/M / 8613126","weight":0.639,"barcode":"3608390035854","option1":"Royal Blue","option2":"S/M","taxable":true,"position":1,"created_at":"2023-06-05T04:22:25-07:00","product_id":7017883533374,"updated_at":"2024-01-07T11:17:33-08:00","weight_unit":"kg","compare_at_price":"49.99","inventory_policy":"deny","requires_shipping":true,"inventory_quantity":0,"fulfillment_service":"manual","inventory_management":"shopify"}],"body_html":"<h4>Description</h4><p>The Easybreath 540 full-face snorkel mask is designed for use by adults and teens. The mask comes in two different sizes (S/M and M/L) and fits snug to your head while still allowing you to easily communicate with your snorkeling partner.</p>","created_at":"2022-07-11T23:04:31-07:00","updated_at":"2024-01-07T11:17:33-08:00","product_type":"Diving mask","published_at":"2022-07-12T10:15:36-07:00","published_scope":"web","template_suffix":""}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Shopify Product","description":"Extract full product details from any Shopify store product page, including title, variants, pricing, images, inventory, and options.\n\n**Credit cost:** 1 credit per call","operationId":"post-shopify-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"URL of a Shopify product page to scrape.\n\n**Example:**\n\n    https://www.decathlon.com/products/simond-backpacking-sleeping-bag-mt500-41-f-synthetic-346446\n\n**Notes:**\n- The URL must point to a product page on any Shopify-powered store (not limited to a single domain).\n- The API works with any public Shopify storefront that exposes the standard `products.json` endpoint.\n- The response includes full product details: title, vendor, variants, images, options, pricing, and inventory.","schema":{"type":"string","description":"URL of a Shopify product page to scrape.\n\n**Example:**\n\n    https://www.decathlon.com/products/simond-backpacking-sleeping-bag-mt500-41-f-synthetic-346446\n\n**Notes:**\n- The URL must point to a product page on any Shopify-powered store (not limited to a single domain).\n- The API works with any public Shopify storefront that exposes the standard `products.json` endpoint.\n- The response includes full product details: title, vendor, variants, images, options, pricing, and inventory."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"tags":{"type":"string"},"image":{"type":"object","properties":{"id":{"type":"integer"},"alt":{"type":"string"},"src":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"}}},"title":{"type":"string"},"handle":{"type":"string"},"vendor":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"position":{"type":"integer"},"product_id":{"type":"integer"}}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"sku":{"type":"string"},"grams":{"type":"integer"},"price":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"},"barcode":{"type":"string"},"option1":{"type":"string"},"option2":{"type":"string"},"taxable":{"type":"boolean"},"position":{"type":"integer"},"created_at":{"type":"string"},"product_id":{"type":"integer"},"updated_at":{"type":"string"},"weight_unit":{"type":"string"},"compare_at_price":{"type":"string"},"inventory_policy":{"type":"string"},"requires_shipping":{"type":"boolean"},"inventory_quantity":{"type":"integer"},"fulfillment_service":{"type":"string"},"inventory_management":{"type":"string"}}}},"body_html":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"product_type":{"type":"string"},"published_at":{"type":"string"},"published_scope":{"type":"string"},"template_suffix":{"type":"string"}}},"examples":{"Lookup Decathlon Easybreath Mask product":{"value":{"id":7017883533374,"tags":"Adult, Boy's, DEAL, FAMILY: 10645, Gift_Ideas, Holiday Product List, Kids, mask-snorkel-fins-set, Men's, WATER_SPORTS, Women's","image":{"id":30763514069054,"alt":"{*blue-8732687*}","src":"https://cdn.shopify.com/s/files/1/1330/6287/files/8732687-product_image-p2143297.jpg?v=1700515471","width":2000,"height":2000,"position":1,"created_at":"2023-11-15T10:22:37-08:00","product_id":7017883533374,"updated_at":"2023-11-20T13:24:31-08:00"},"title":"Adult's Easybreath Surface Mask Acoustic Valve - 540 Freetalk Jungle","handle":"adults-easybreath-surface-mask-acoustic-valve-540-freetalk-blue-330093","vendor":"Subea","options":[{"id":9022772510782,"name":"Color","values":["Royal Blue","Blue"],"position":1,"product_id":7017883533374},{"id":9022772543550,"name":"Size","values":["S/M","ML","M /L"],"position":2,"product_id":7017883533374}],"variants":[{"id":40088252186686,"sku":"4200766","grams":639,"price":"30.00","title":"Royal Blue / S/M / 8613126","weight":0.639,"barcode":"3608390035854","option1":"Royal Blue","option2":"S/M","taxable":true,"position":1,"created_at":"2023-06-05T04:22:25-07:00","product_id":7017883533374,"updated_at":"2024-01-07T11:17:33-08:00","weight_unit":"kg","compare_at_price":"49.99","inventory_policy":"deny","requires_shipping":true,"inventory_quantity":0,"fulfillment_service":"manual","inventory_management":"shopify"}],"body_html":"<h4>Description</h4><p>The Easybreath 540 full-face snorkel mask is designed for use by adults and teens. The mask comes in two different sizes (S/M and M/L) and fits snug to your head while still allowing you to easily communicate with your snorkeling partner.</p>","created_at":"2022-07-11T23:04:31-07:00","updated_at":"2024-01-07T11:17:33-08:00","product_type":"Diving mask","published_at":"2022-07-12T10:15:36-07:00","published_scope":"web","template_suffix":""}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/shopify/apps":{"get":{"summary":"Shopify Apps","description":"Retrieve structured details about any Shopify App Store listing, including title, logo, screenshots, pricing plans, categories, and description.\n\n**Credit cost:** 1 credit per call","operationId":"get-shopify-apps","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"URL of the Shopify App Store listing to scrape.\n\n**Example:**\n\n    https://apps.shopify.com/judgeme\n\n**Notes:**\n- The URL must point to a valid listing on `apps.shopify.com`.\n- The API returns the app title, handle, logo, screenshots, description, pricing plans, and categories.\n- The app handle is the slug at the end of the URL (e.g. `judgeme` in `https://apps.shopify.com/judgeme`).","schema":{"type":"string","description":"URL of the Shopify App Store listing to scrape.\n\n**Example:**\n\n    https://apps.shopify.com/judgeme\n\n**Notes:**\n- The URL must point to a valid listing on `apps.shopify.com`.\n- The API returns the app title, handle, logo, screenshots, description, pricing plans, and categories.\n- The app handle is the slug at the end of the URL (e.g. `judgeme` in `https://apps.shopify.com/judgeme`)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"}}}},"pricing":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"string"},"features":{"type":"array","items":{"type":"string"}}}}},"categories":{"type":"array","items":{}},"description":{"type":"string"}}},"examples":{"Lookup Judge.me app":{"value":{"url":"https://apps.shopify.com/judgeme","logo":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/icon/CIfp9fWd34sDEAE=.png","title":"Judge.me Product Reviews App","handle":"judgeme","images":[{"url":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/desktop_screenshot/CJ3w-uC_140DEAE=.png?height=360&width=640","description":"Collect unlimited reviews automatically from email, SMS, QR code"},{"url":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/desktop_screenshot/CPWYhuG_140DEAE=.png?height=360&width=640","description":"Display reviews with Star Rating, Review Widget, Carousel & more"},{"url":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/desktop_screenshot/COzMkOG_140DEAE=.png?height=360&width=640","description":"Collect and display reviews in customers' language automatically"}],"pricing":[{"name":"Forever Free","price":"Free","features":["Google rich snippets & Google MyBusiness","Carousels (Video, Cards, Testimonials)","Unlimited product and store reviews","Sync with Shop App, Etsy, Amazon","Unlimited visual reviews (photos/videos)","Review widget & star rating badge","Trust badge and medals","Reviews importer & AliExpress sync"]},{"name":"Awesome","price":"$15/month","features":["Meta & TikTokShop sync, SocialMedia push","Coupons & Referrals","Google Shopping","AI (replies, summary, translations)","Full customization","Advanced collection (auto-reminder, etc)","130+ integrations, inc. Klaviyo, Gorgias","16 widgets (Snippets, Q&A, Reviews Page)"]}],"categories":[],"description":"Sell more with unlimited product reviews, UGC, star ratings, and testimonials. Judge.me boosts conversion rate with unlimited product reviews, star ratings, and UGC (photo/video). Automate review requests after fulfillment or delivery, launch review widgets and testimonial sliders, boost visibility with Google reviews & SEO page."}},"Lookup Yotpo Reviews app":{"value":{"url":"https://apps.shopify.com/yotpo-social-reviews","logo":"https://cdn.shopify.com/app-store/listing_images/yotpo-reviews-icon.png","title":"Yotpo Product Reviews & Photos","handle":"yotpo-social-reviews","images":[],"pricing":[{"name":"Free","price":"Free","features":["Up to 50 Monthly Orders","Sentiment and Profanity Check","Automatic Review Requests","Email Support","Email Templates Library","Display Reviews On-Site"]},{"name":"Starter","price":"$15/month","features":["Collect Photos/Video","Reviews Carousel","Google Shopping Ads","Live Chat Support","Google Rich Snippets","Pricing changes based on order volume"]},{"name":"Pro","price":"$119/month","features":["Custom Questions","AI Reviews Summary","Smart Sorting","Google Seller Rating","Pricing changes based on order volume","24/7 Technical Support"]}],"categories":[],"description":"Collect and display product reviews and ratings to showcase social proof and build trust. Yotpo product reviews and ratings drive sales and help you better understand your customers."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Shopify Apps","description":"Retrieve structured details about any Shopify App Store listing, including title, logo, screenshots, pricing plans, categories, and description.\n\n**Credit cost:** 1 credit per call","operationId":"post-shopify-apps","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"URL of the Shopify App Store listing to scrape.\n\n**Example:**\n\n    https://apps.shopify.com/judgeme\n\n**Notes:**\n- The URL must point to a valid listing on `apps.shopify.com`.\n- The API returns the app title, handle, logo, screenshots, description, pricing plans, and categories.\n- The app handle is the slug at the end of the URL (e.g. `judgeme` in `https://apps.shopify.com/judgeme`).","schema":{"type":"string","description":"URL of the Shopify App Store listing to scrape.\n\n**Example:**\n\n    https://apps.shopify.com/judgeme\n\n**Notes:**\n- The URL must point to a valid listing on `apps.shopify.com`.\n- The API returns the app title, handle, logo, screenshots, description, pricing plans, and categories.\n- The app handle is the slug at the end of the URL (e.g. `judgeme` in `https://apps.shopify.com/judgeme`)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"title":{"type":"string"},"handle":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"}}}},"pricing":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"string"},"features":{"type":"array","items":{"type":"string"}}}}},"categories":{"type":"array","items":{}},"description":{"type":"string"}}},"examples":{"Lookup Judge.me app":{"value":{"url":"https://apps.shopify.com/judgeme","logo":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/icon/CIfp9fWd34sDEAE=.png","title":"Judge.me Product Reviews App","handle":"judgeme","images":[{"url":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/desktop_screenshot/CJ3w-uC_140DEAE=.png?height=360&width=640","description":"Collect unlimited reviews automatically from email, SMS, QR code"},{"url":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/desktop_screenshot/CPWYhuG_140DEAE=.png?height=360&width=640","description":"Display reviews with Star Rating, Review Widget, Carousel & more"},{"url":"https://cdn.shopify.com/app-store/listing_images/8cada0f5da411a64e756606bb036f1ed/desktop_screenshot/COzMkOG_140DEAE=.png?height=360&width=640","description":"Collect and display reviews in customers' language automatically"}],"pricing":[{"name":"Forever Free","price":"Free","features":["Google rich snippets & Google MyBusiness","Carousels (Video, Cards, Testimonials)","Unlimited product and store reviews","Sync with Shop App, Etsy, Amazon","Unlimited visual reviews (photos/videos)","Review widget & star rating badge","Trust badge and medals","Reviews importer & AliExpress sync"]},{"name":"Awesome","price":"$15/month","features":["Meta & TikTokShop sync, SocialMedia push","Coupons & Referrals","Google Shopping","AI (replies, summary, translations)","Full customization","Advanced collection (auto-reminder, etc)","130+ integrations, inc. Klaviyo, Gorgias","16 widgets (Snippets, Q&A, Reviews Page)"]}],"categories":[],"description":"Sell more with unlimited product reviews, UGC, star ratings, and testimonials. Judge.me boosts conversion rate with unlimited product reviews, star ratings, and UGC (photo/video). Automate review requests after fulfillment or delivery, launch review widgets and testimonial sliders, boost visibility with Google reviews & SEO page."}},"Lookup Yotpo Reviews app":{"value":{"url":"https://apps.shopify.com/yotpo-social-reviews","logo":"https://cdn.shopify.com/app-store/listing_images/yotpo-reviews-icon.png","title":"Yotpo Product Reviews & Photos","handle":"yotpo-social-reviews","images":[],"pricing":[{"name":"Free","price":"Free","features":["Up to 50 Monthly Orders","Sentiment and Profanity Check","Automatic Review Requests","Email Support","Email Templates Library","Display Reviews On-Site"]},{"name":"Starter","price":"$15/month","features":["Collect Photos/Video","Reviews Carousel","Google Shopping Ads","Live Chat Support","Google Rich Snippets","Pricing changes based on order volume"]},{"name":"Pro","price":"$119/month","features":["Custom Questions","AI Reviews Summary","Smart Sorting","Google Seller Rating","Pricing changes based on order volume","24/7 Technical Support"]}],"categories":[],"description":"Collect and display product reviews and ratings to showcase social proof and build trust. Yotpo product reviews and ratings drive sales and help you better understand your customers."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/eleclerc/suggest":{"get":{"summary":"E.Leclerc Suggest","description":"Get instant product autocomplete suggestions from E.Leclerc for a given keyword or EAN.\n\n**Credit cost:** 1 credit per call","operationId":"get-eleclerc-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search term or EAN to get product suggestions for.\n\nAccepted input types:\n- `keyword`: partial product name or category (e.g. `pomme`)\n- `EAN`: full product barcode (e.g. `9782330149635`)\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Returns up to 6 autocomplete suggestions matching the query.\n- Each suggestion includes the product URL, slug, title, subtitle (author/brand), and image URL.\n- This endpoint mirrors the E.Leclerc website autocomplete search box.","schema":{"type":"string","description":"Search term or EAN to get product suggestions for.\n\nAccepted input types:\n- `keyword`: partial product name or category (e.g. `pomme`)\n- `EAN`: full product barcode (e.g. `9782330149635`)\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Returns up to 6 autocomplete suggestions matching the query.\n- Each suggestion includes the product URL, slug, title, subtitle (author/brand), and image URL.\n- This endpoint mirrors the E.Leclerc website autocomplete search box."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"type":"string"},"image_url":{"type":"string"}}}}}},"examples":{"Suggest for 'pomme'":{"value":{"results":[{"url":"https://www.e.leclerc/fp/la-pomme-et-d-autres-fruits-jeunesse-9782070616480","slug":"/fp/la-pomme-et-d-autres-fruits-jeunesse-9782070616480","title":"La pomme et d'autres fruits (Jeunesse)","subtitle":"Pierre-Marie Valat, Pascale de Bourgoing","image_url":"https://media.e.leclerc/LEN/fp/9782070616480_1?vh=e07014"},{"url":"https://www.e.leclerc/fp/la-pomme-relie-9782925347477","slug":"/fp/la-pomme-relie-9782925347477","title":"La pomme (Relié)","subtitle":"Anne Derenne","image_url":"https://media.e.leclerc/LEN/fp/9782925347477_1?vh=0796ab"},{"url":"https://www.e.leclerc/fp/la-pomme-jeunesse-9782408007973","slug":"/fp/la-pomme-jeunesse-9782408007973","title":"La pomme (Jeunesse)","subtitle":"Charlotte Ameling, Paule Battault","image_url":"https://fgellaobb.filerobot.com/LEN/fp/9782408007973_1?vh=c622ce"}]}},"Suggest for EAN 3760256510568":{"value":{"results":[{"url":"https://www.e.leclerc/fp/mixeur-plongeant-presse-puree-mix-mash-3760256510568","slug":"/fp/mixeur-plongeant-presse-puree-mix-mash-3760256510568","title":"Mixeur plongeant presse purée Mix&Mash","subtitle":"Senya","image_url":"https://fgellaobb.filerobot.com/LEN/fp/3760256510568_1?vh=66437a"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"E.Leclerc Suggest","description":"Get instant product autocomplete suggestions from E.Leclerc for a given keyword or EAN.\n\n**Credit cost:** 1 credit per call","operationId":"post-eleclerc-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search term or EAN to get product suggestions for.\n\nAccepted input types:\n- `keyword`: partial product name or category (e.g. `pomme`)\n- `EAN`: full product barcode (e.g. `9782330149635`)\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Returns up to 6 autocomplete suggestions matching the query.\n- Each suggestion includes the product URL, slug, title, subtitle (author/brand), and image URL.\n- This endpoint mirrors the E.Leclerc website autocomplete search box.","schema":{"type":"string","description":"Search term or EAN to get product suggestions for.\n\nAccepted input types:\n- `keyword`: partial product name or category (e.g. `pomme`)\n- `EAN`: full product barcode (e.g. `9782330149635`)\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Returns up to 6 autocomplete suggestions matching the query.\n- Each suggestion includes the product URL, slug, title, subtitle (author/brand), and image URL.\n- This endpoint mirrors the E.Leclerc website autocomplete search box."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"type":"string"},"image_url":{"type":"string"}}}}}},"examples":{"Suggest for 'pomme'":{"value":{"results":[{"url":"https://www.e.leclerc/fp/la-pomme-et-d-autres-fruits-jeunesse-9782070616480","slug":"/fp/la-pomme-et-d-autres-fruits-jeunesse-9782070616480","title":"La pomme et d'autres fruits (Jeunesse)","subtitle":"Pierre-Marie Valat, Pascale de Bourgoing","image_url":"https://media.e.leclerc/LEN/fp/9782070616480_1?vh=e07014"},{"url":"https://www.e.leclerc/fp/la-pomme-relie-9782925347477","slug":"/fp/la-pomme-relie-9782925347477","title":"La pomme (Relié)","subtitle":"Anne Derenne","image_url":"https://media.e.leclerc/LEN/fp/9782925347477_1?vh=0796ab"},{"url":"https://www.e.leclerc/fp/la-pomme-jeunesse-9782408007973","slug":"/fp/la-pomme-jeunesse-9782408007973","title":"La pomme (Jeunesse)","subtitle":"Charlotte Ameling, Paule Battault","image_url":"https://fgellaobb.filerobot.com/LEN/fp/9782408007973_1?vh=c622ce"}]}},"Suggest for EAN 3760256510568":{"value":{"results":[{"url":"https://www.e.leclerc/fp/mixeur-plongeant-presse-puree-mix-mash-3760256510568","slug":"/fp/mixeur-plongeant-presse-puree-mix-mash-3760256510568","title":"Mixeur plongeant presse purée Mix&Mash","subtitle":"Senya","image_url":"https://fgellaobb.filerobot.com/LEN/fp/3760256510568_1?vh=66437a"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/eleclerc/search":{"get":{"summary":"E.Leclerc Search","description":"Search for products on E.Leclerc by keyword with optional store-specific filtering and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-eleclerc-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or phrase to query on E.Leclerc.\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Supports any keyword, brand name, or product category (in French).\n- Results are paginated; use the `page` parameter to navigate through pages.","schema":{"type":"string","description":"Search keyword or phrase to query on E.Leclerc.\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Supports any keyword, brand name, or product category (in French).\n- Results are paginated; use the `page` parameter to navigate through pages."}},{"name":"store_id","in":"query","required":false,"description":"ID of a specific E.Leclerc store to search in.\n\nGet the `store_id` from the [E.Leclerc Stores](https://docs.piloterr.com/finder-eleclerc-stores) API.\n\n**Example:**\n\n    1631\n\n**Notes:**\n- If omitted, the search is performed on the national online store.\n- Use a store ID to get local product availability and pricing.","schema":{"type":"string","description":"ID of a specific E.Leclerc store to search in.\n\nGet the `store_id` from the [E.Leclerc Stores](https://docs.piloterr.com/finder-eleclerc-stores) API.\n\n**Example:**\n\n    1631\n\n**Notes:**\n- If omitted, the search is performed on the national online store.\n- Use a store ID to get local product availability and pricing."}},{"name":"page","in":"query","required":false,"description":"Page number for paginated results.\n\n**Notes:**\n- Use the `pagination.next` field in the response to determine if additional pages are available.\n- Increment this value to retrieve subsequent result pages.","schema":{"type":"number","default":"1","description":"Page number for paginated results.\n\n**Notes:**\n- Use the `pagination.next` field in the response to determine if additional pages are available.\n- Increment this value to retrieve subsequent result pages."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"family":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"logistic_class_code":{"type":"string"}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shop":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"sign_code":{"type":"string"}}},"stock":{"type":"integer"},"currency":{"type":"object","properties":{"code":{"type":"string"},"symbol":{"type":"string"}}},"base_price":{"type":"object","properties":{"price":{"type":"object","properties":{"price":{"type":"integer"},"price_with_all_taxes":{"type":"integer"}}},"threshold":{"type":"integer"},"min_shipping_price":{"type":"object","properties":{"price":{"type":"integer"}}}}},"is_default":{"type":"boolean"},"external_id":{"type":"string"}}}},"offers_total":{"type":"integer"}}}},"cnc_offers_count":{"type":"integer"},"last_update_date":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search 'pomme' on national store":{"value":{"total":2265,"results":[{"id":"3760256510568","sku":"3760256510568","slug":"mixeur-plongeant-presse-puree-mix-mash","label":"Mixeur plongeant presse purée Mix&Mash","family":{"code":"pied_mixeur","label":"Pied-mixeur","logistic_class_code":"TARIF2"},"variants":[{"id":"3760256510568","sku":"3760256510568","slug":"mixeur-plongeant-presse-puree-mix-mash","label":"Mixeur plongeant presse purée Mix&Mash","offers":[{"id":"2036056","shop":{"id":"2114","label":"2KINGS","sign_code":"0000"},"stock":3,"currency":{"code":"EUR","symbol":"€"},"base_price":{"price":{"price":6197,"price_with_all_taxes":6197},"threshold":1,"min_shipping_price":{"price":499}},"is_default":true,"external_id":"2023001"}],"offers_total":5}],"cnc_offers_count":0,"last_update_date":"2026-08-27T15:31:02.082376Z"}],"pagination":{"next":2,"current":1,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"E.Leclerc Search","description":"Search for products on E.Leclerc by keyword with optional store-specific filtering and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-eleclerc-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or phrase to query on E.Leclerc.\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Supports any keyword, brand name, or product category (in French).\n- Results are paginated; use the `page` parameter to navigate through pages.","schema":{"type":"string","description":"Search keyword or phrase to query on E.Leclerc.\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- Supports any keyword, brand name, or product category (in French).\n- Results are paginated; use the `page` parameter to navigate through pages."}},{"name":"store_id","in":"query","required":false,"description":"ID of a specific E.Leclerc store to search in.\n\nGet the `store_id` from the [E.Leclerc Stores](https://docs.piloterr.com/finder-eleclerc-stores) API.\n\n**Example:**\n\n    1631\n\n**Notes:**\n- If omitted, the search is performed on the national online store.\n- Use a store ID to get local product availability and pricing.","schema":{"type":"string","description":"ID of a specific E.Leclerc store to search in.\n\nGet the `store_id` from the [E.Leclerc Stores](https://docs.piloterr.com/finder-eleclerc-stores) API.\n\n**Example:**\n\n    1631\n\n**Notes:**\n- If omitted, the search is performed on the national online store.\n- Use a store ID to get local product availability and pricing."}},{"name":"page","in":"query","required":false,"description":"Page number for paginated results.\n\n**Notes:**\n- Use the `pagination.next` field in the response to determine if additional pages are available.\n- Increment this value to retrieve subsequent result pages.","schema":{"type":"number","default":"1","description":"Page number for paginated results.\n\n**Notes:**\n- Use the `pagination.next` field in the response to determine if additional pages are available.\n- Increment this value to retrieve subsequent result pages."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"family":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"logistic_class_code":{"type":"string"}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shop":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"sign_code":{"type":"string"}}},"stock":{"type":"integer"},"currency":{"type":"object","properties":{"code":{"type":"string"},"symbol":{"type":"string"}}},"base_price":{"type":"object","properties":{"price":{"type":"object","properties":{"price":{"type":"integer"},"price_with_all_taxes":{"type":"integer"}}},"threshold":{"type":"integer"},"min_shipping_price":{"type":"object","properties":{"price":{"type":"integer"}}}}},"is_default":{"type":"boolean"},"external_id":{"type":"string"}}}},"offers_total":{"type":"integer"}}}},"cnc_offers_count":{"type":"integer"},"last_update_date":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search 'pomme' on national store":{"value":{"total":2265,"results":[{"id":"3760256510568","sku":"3760256510568","slug":"mixeur-plongeant-presse-puree-mix-mash","label":"Mixeur plongeant presse purée Mix&Mash","family":{"code":"pied_mixeur","label":"Pied-mixeur","logistic_class_code":"TARIF2"},"variants":[{"id":"3760256510568","sku":"3760256510568","slug":"mixeur-plongeant-presse-puree-mix-mash","label":"Mixeur plongeant presse purée Mix&Mash","offers":[{"id":"2036056","shop":{"id":"2114","label":"2KINGS","sign_code":"0000"},"stock":3,"currency":{"code":"EUR","symbol":"€"},"base_price":{"price":{"price":6197,"price_with_all_taxes":6197},"threshold":1,"min_shipping_price":{"price":499}},"is_default":true,"external_id":"2023001"}],"offers_total":5}],"cnc_offers_count":0,"last_update_date":"2026-08-27T15:31:02.082376Z"}],"pagination":{"next":2,"current":1,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/eleclerc/product":{"get":{"summary":"E.Leclerc Product","description":"Read one E.Leclerc product by EAN or product URL. Pass store_id to get that store's price and stock. Another store returns a different price and stock.\n\n**Credit cost:** 1 credit per call","operationId":"get-eleclerc-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"E.Leclerc product EAN or product page URL.\n\n**Examples:**\n\n    3564700201442\n\n    https://www.e.leclerc/fp/jus-de-citron-de-sicile-2-x-125-ml-rustica-3564700201442\n\n**Notes:**\n- Accepts a 13-digit EAN or a full `www.e.leclerc/fp/...` URL. Extra query params (`srsltid`, `offerId`) are ignored.\n- If no `store_id` is provided, the product is looked up on the national online store.\n- When available, `environmental_cost` returns ADEME impact points (Coût environnemental).","schema":{"type":"string","description":"E.Leclerc product EAN or product page URL.\n\n**Examples:**\n\n    3564700201442\n\n    https://www.e.leclerc/fp/jus-de-citron-de-sicile-2-x-125-ml-rustica-3564700201442\n\n**Notes:**\n- Accepts a 13-digit EAN or a full `www.e.leclerc/fp/...` URL. Extra query params (`srsltid`, `offerId`) are ignored.\n- If no `store_id` is provided, the product is looked up on the national online store.\n- When available, `environmental_cost` returns ADEME impact points (Coût environnemental)."}},{"name":"store_id","in":"query","required":false,"description":"E.Leclerc store sign code. This selects that store's price and stock.\n\n**Examples:**\n\n```\n1017\n```\n\n```\n1833\n```\n\n`1017` is Marennes. `1833` is Coutras. The same EAN can be in stock in one store and unavailable in the other.","schema":{"type":"string","description":"E.Leclerc store sign code. This selects that store's price and stock.\n\n**Examples:**\n\n```\n1017\n```\n\n```\n1833\n```\n\n`1017` is Marennes. `1833` is Coutras. The same EAN can be in stock in one store and unavailable in the other."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"offer":{"type":"object","properties":{"price":{"type":"object","properties":{"price":{"type":"number"},"availability_status":{"type":"string"},"offer_availability_status":{"type":"string"}}},"elected_offer":{"type":"object","properties":{"slug":{"type":"string"},"stock":{"type":"integer"},"shop_id":{"type":"string"},"shop_name":{"type":"string"},"offer_type":{"type":"string"},"national_offer_id":{"type":"string"}}},"cnc_offers_count":{"type":"integer"}}},"title":{"type":"string"},"data_layer":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"name":{"type":"string"},"price":{"type":"string"},"vendor":{"type":"string"},"in_stock":{"type":"boolean"}}},"rating_count":{"type":"integer"},"rating_average":{"type":"integer"}}},"examples":{"LEGO Duplo at Marennes, store 1017, in stock":{"value":{"ean":"5702016367676","brand":"Lego®","image":"https://media.e.leclerc/5702016367676_1","offer":{"price":{"price":39.9,"availability_status":"En stock","offer_availability_status":"in-stock"},"elected_offer":{"slug":"fp/lego-duplo-rescue-la-caserne-de-pompiers-10903-5702016367676?offerId=m-5702016367676-1017","stock":1,"shop_id":"10171011","shop_name":"E.Leclerc MARENNES","offer_type":"leclerc_store","national_offer_id":"m-5702016367676-1017"},"cnc_offers_count":1},"title":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","data_layer":{"id":"5702016367676","ean":"5702016367676","name":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","price":"39.90","vendor":"E.Leclerc MARENNES","in_stock":true},"rating_count":3,"rating_average":5}},"LEGO Duplo at Coutras, store 1833, no local offer":{"value":{"ean":"5702016367676","brand":"Lego®","image":"https://media.e.leclerc/5702016367676_1","offer":{"price":{"price":null,"availability_status":"Indisponible","offer_availability_status":"unavailable"},"elected_offer":{"slug":"fp/lego-duplo-rescue-la-caserne-de-pompiers-10903-5702016367676?offerId=m-5702016367676-1833","stock":0,"shop_id":"1833","shop_name":null,"offer_type":null,"national_offer_id":"m-5702016367676-1833"},"cnc_offers_count":1},"title":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","data_layer":{"id":"5702016367676","ean":"5702016367676","name":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","price":null,"vendor":"Leclerc","in_stock":false},"rating_count":3,"rating_average":5}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"E.Leclerc Product","description":"Read one E.Leclerc product by EAN or product URL. Pass store_id to get that store's price and stock. Another store returns a different price and stock.\n\n**Credit cost:** 1 credit per call","operationId":"post-eleclerc-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"E.Leclerc product EAN or product page URL.\n\n**Examples:**\n\n    3564700201442\n\n    https://www.e.leclerc/fp/jus-de-citron-de-sicile-2-x-125-ml-rustica-3564700201442\n\n**Notes:**\n- Accepts a 13-digit EAN or a full `www.e.leclerc/fp/...` URL. Extra query params (`srsltid`, `offerId`) are ignored.\n- If no `store_id` is provided, the product is looked up on the national online store.\n- When available, `environmental_cost` returns ADEME impact points (Coût environnemental).","schema":{"type":"string","description":"E.Leclerc product EAN or product page URL.\n\n**Examples:**\n\n    3564700201442\n\n    https://www.e.leclerc/fp/jus-de-citron-de-sicile-2-x-125-ml-rustica-3564700201442\n\n**Notes:**\n- Accepts a 13-digit EAN or a full `www.e.leclerc/fp/...` URL. Extra query params (`srsltid`, `offerId`) are ignored.\n- If no `store_id` is provided, the product is looked up on the national online store.\n- When available, `environmental_cost` returns ADEME impact points (Coût environnemental)."}},{"name":"store_id","in":"query","required":false,"description":"E.Leclerc store sign code. This selects that store's price and stock.\n\n**Examples:**\n\n```\n1017\n```\n\n```\n1833\n```\n\n`1017` is Marennes. `1833` is Coutras. The same EAN can be in stock in one store and unavailable in the other.","schema":{"type":"string","description":"E.Leclerc store sign code. This selects that store's price and stock.\n\n**Examples:**\n\n```\n1017\n```\n\n```\n1833\n```\n\n`1017` is Marennes. `1833` is Coutras. The same EAN can be in stock in one store and unavailable in the other."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"offer":{"type":"object","properties":{"price":{"type":"object","properties":{"price":{"type":"number"},"availability_status":{"type":"string"},"offer_availability_status":{"type":"string"}}},"elected_offer":{"type":"object","properties":{"slug":{"type":"string"},"stock":{"type":"integer"},"shop_id":{"type":"string"},"shop_name":{"type":"string"},"offer_type":{"type":"string"},"national_offer_id":{"type":"string"}}},"cnc_offers_count":{"type":"integer"}}},"title":{"type":"string"},"data_layer":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"name":{"type":"string"},"price":{"type":"string"},"vendor":{"type":"string"},"in_stock":{"type":"boolean"}}},"rating_count":{"type":"integer"},"rating_average":{"type":"integer"}}},"examples":{"LEGO Duplo at Marennes, store 1017, in stock":{"value":{"ean":"5702016367676","brand":"Lego®","image":"https://media.e.leclerc/5702016367676_1","offer":{"price":{"price":39.9,"availability_status":"En stock","offer_availability_status":"in-stock"},"elected_offer":{"slug":"fp/lego-duplo-rescue-la-caserne-de-pompiers-10903-5702016367676?offerId=m-5702016367676-1017","stock":1,"shop_id":"10171011","shop_name":"E.Leclerc MARENNES","offer_type":"leclerc_store","national_offer_id":"m-5702016367676-1017"},"cnc_offers_count":1},"title":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","data_layer":{"id":"5702016367676","ean":"5702016367676","name":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","price":"39.90","vendor":"E.Leclerc MARENNES","in_stock":true},"rating_count":3,"rating_average":5}},"LEGO Duplo at Coutras, store 1833, no local offer":{"value":{"ean":"5702016367676","brand":"Lego®","image":"https://media.e.leclerc/5702016367676_1","offer":{"price":{"price":null,"availability_status":"Indisponible","offer_availability_status":"unavailable"},"elected_offer":{"slug":"fp/lego-duplo-rescue-la-caserne-de-pompiers-10903-5702016367676?offerId=m-5702016367676-1833","stock":0,"shop_id":"1833","shop_name":null,"offer_type":null,"national_offer_id":"m-5702016367676-1833"},"cnc_offers_count":1},"title":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","data_layer":{"id":"5702016367676","ean":"5702016367676","name":"Lego® Duplo® Rescue - La Caserne De Pompiers - 10903","price":null,"vendor":"Leclerc","in_stock":false},"rating_count":3,"rating_average":5}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/chewy/search":{"get":{"summary":"Chewy Search","description":"Search Chewy by keyword or listing URL. The default mode is expert and returns the historical listing objects. simple returns short snake_case cards.\n\n**Credit cost:** 3 credits per call","operationId":"get-chewy-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to search for. A keyword such as salmon kibble, or a Chewy search or category link such as https://www.chewy.com/s?query=dog+food. A product link (a URL that contains /dp/) returns 400. Another website returns 400.","schema":{"type":"string","description":"What to search for. A keyword such as salmon kibble, or a Chewy search or category link such as https://www.chewy.com/s?query=dog+food. A product link (a URL that contains /dp/) returns 400. Another website returns 400."}},{"name":"page","in":"query","required":false,"description":"Which page to fetch, starting at 1. Leave this empty for page 1. If query is a listing link that already has page=2, this value replaces that page. In simple mode, pagination.page is this page and pagination.next is the next page URL or null.","schema":{"type":"number","minimum":1,"description":"Which page to fetch, starting at 1. Leave this empty for page 1. If query is a listing link that already has page=2, this value replaces that page. In simple mode, pagination.page is this page and pagination.next is the next page URL or null."}},{"name":"mode","in":"query","required":false,"description":"Which JSON to return. Default expert.\n\nexpert: the historical payload. { results } of Chewy listing fields in snake_case (catalog_entry_id, name, href, advertised_price). No pagination object.\n\nsimple: the short card. { results, pagination }. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash.\n\nUse simple for a short listing. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400.","schema":{"type":"string","default":"expert","description":"Which JSON to return. Default expert.\n\nexpert: the historical payload. { results } of Chewy listing fields in snake_case (catalog_entry_id, name, href, advertised_price). No pagination object.\n\nsimple: the short card. { results, pagination }. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash.\n\nUse simple for a short listing. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON.","schema":{"type":"boolean","description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ppu":{"type":"string"},"href":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"is_ad":{"type":"boolean"},"is_atf":{"type":"boolean"},"is_btf":{"type":"boolean"},"is_new":{"type":"boolean"},"rating":{"type":"number"},"is_deal":{"type":"boolean"},"in_stock":{"type":"boolean"},"is_fresh":{"type":"boolean"},"is_bundle":{"type":"boolean"},"is_frozen":{"type":"boolean"},"is_pb_fresh":{"type":"boolean"},"offer_price":{"type":"string"},"part_number":{"type":"string"},"ad_placement":{"type":"integer"},"bundle_title":{"nullable":true},"is_gift_card":{"type":"boolean"},"is_live_feed":{"type":"boolean"},"is_smart_pak":{"type":"boolean"},"key_benefits":{"type":"array","items":{}},"manufacturer":{"type":"string"},"rating_count":{"type":"integer"},"strike_price":{"type":"string"},"click_tracker":{"nullable":true},"display_price":{"type":"string"},"is_hard_goods":{"type":"boolean"},"is_live_plant":{"type":"boolean"},"autoship_price":{"type":"string"},"is_dropshipped":{"type":"boolean"},"is_enhanced_pb":{"type":"boolean"},"is_rx_vet_diet":{"type":"boolean"},"item_analytics":{"type":"object","properties":{"data-id":{"type":"string"},"data-name":{"type":"string"},"data-brand":{"type":"string"},"data-price":{"type":"string"},"data-on-sale":{"type":"string"},"data-variant":{"nullable":true},"data-category":{"type":"string"},"data-page-num":{"type":"string"},"data-deal-text":{"nullable":true},"data-widget-id":{"nullable":true},"data-creative-id":{"nullable":true},"data-input-query":{"type":"string"},"data-widget-type":{"nullable":true},"data-is-monetized":{"type":"string"},"data-output-query":{"type":"string"},"data-result-count":{"type":"string"},"data-in-stock-flag":{"type":"string"},"data-price-per-unit":{"type":"string"},"data-experience-type":{"nullable":true},"data-is-customizable":{"type":"string"},"data-widget-type-value":{"nullable":true},"data-impression-tracker":{"type":"string"},"data-new-cat-entry-type":{"type":"string"},"data-analytics-ads-origin":{"type":"string"},"data-analytics-ad-request-time":{"type":"string"},"data-analytics-alternative-rank":{"type":"string"},"data-analytics-piq-impression-id":{"type":"string"},"data-analytics-piq-impression-payload":{"nullable":true}}},"is_customizable":{"type":"boolean"},"is_discontinued":{"type":"boolean"},"is_map_enforced":{"nullable":true},"is_prescription":{"type":"boolean"},"is_refrigerated":{"type":"boolean"},"options_message":{"nullable":true},"advertised_price":{"type":"string"},"catalog_entry_id":{"type":"integer"},"has_more_choices":{"type":"boolean"},"is_autoship_deal":{"type":"boolean"},"max_arrival_date":{"nullable":true},"min_arrival_date":{"nullable":true},"ft_autoship_price":{"type":"string"},"strike_price_type":{"type":"string"},"impression_tracker":{"nullable":true},"is_chewy_exclusive":{"type":"boolean"},"parent_part_number":{"type":"string"},"strike_savings_pct":{"type":"string"},"bundle_part_numbers":{"type":"array","items":{}},"is_autoship_allowed":{"type":"boolean"},"autoship_discount_pct":{"type":"string"},"ensemble_part_numbers":{"type":"array","items":{}},"ft_autoship_max_amount":{"type":"string"},"validated_strike_price":{"type":"string"},"parent_catalog_entry_id":{"nullable":true},"ft_autoship_discount_pct":{"type":"integer"},"minimum_advertised_price":{"nullable":true},"is_canadian_national_brand":{"type":"boolean"},"is_private_brand_from_spiq":{"type":"boolean"},"new_user_other_cta_display":{"type":"string"},"show_promo_carousel_post_atc":{"type":"boolean"},"supplemental_thumbnail_assets":{"type":"array","items":{"type":"string"}},"existing_user_other_cta_display":{"type":"string"},"should_display_atc_to_new_users":{"type":"boolean"},"should_display_atc_to_existing_users":{"type":"boolean"},"should_display_atc_to_new_users_below_min_ios":{"type":"boolean"}}}}}},"examples":{"expert (default): Purina Pro Plan 30-lb salmon kibble":{"value":{"results":[{"ppu":"$2.59/lb","href":"https://www.chewy.com/api/event/p/sar/click?adsOrigin=aspen2&id=238a99cdbce84f4a97e766531a139158&x=H4sIAAAAAAAA_6VYWZOiyhL-Lzw7PVCASr-ccGuFIzgiyhI34gZbK6sEoAgT57_fLLCV7tG2-9wnICv58sullqzfhOnwDvFMkX2q12M4RHYIO3XN3Du6WM6RbLfPdTnUIV5Db7vLsbDH9HtMj0MU6JpRYnrbGItZpkshjiN7HQA9umnuZW6KB2iK6wJOh0hSb596eYmFiOlyLEYIPTtYpyHxTOzyPMmef_50f1AU2-8-mU7lpsFT7OY_07_c_xxIknbcUkC8v_fEFXOSRnzGRy_4uxKVAInjNZqPhJ0z4ruiolfw7tXvo8LTEekt_DUp-ZNyoQSFVGLZFmR6KVbLAnR9s-S7Lk0CplQCJovxFuMALRRsR06wXUNdV7oqhaKyJA1lQkpjOdKVLZIUkV4odiFGk8IYLxmx4j3ADEyvsW-qgbfweLC12y2U0Demgm8oW9LwZfh2QqnSMcZJVybVQplQi9o3Oce-AU6kl9inASMqNi2NgxJjGlEB_G1yMbZJqQLZCuxoA2ynmvv8SRxBjKrJQfRFlvdgjLZhTAD-p9xCzNZEoadHp3A-zRM9EjJjNXwby2z0klkqd-Cn8tEoh6mpCp41Xd-Tb42IOxqj0wXbmHIxPzWOFlpe7cyknTWljpbX-u-q18Yu3dXVpo5eSP5zjm39zzADC9lnrnd9iizEBS2ugR0Hf_jnoF3iTDeRqUn7T2L0wWYrPjOBvWevxRHbztqxfMOet_4927nE5SM2f8E-nfm-xfLKp4lxE7NrXdS4vq5dc3jFGpaGKiU2-HsZO_9f27_pz-36wO92ear1btRKLbfUzc6aia3YUqGuFu9y3fKhFadL3bzFCuJy-rRWLv9oYnazjlu8b8Wy_Y-uypQ1WzY41zxcdGu_Rk2MzzF6F4cLt5kQWmpIWathYdES1F74DudNX6NxXqjEUcmtPeUqU5MTXBN_5C_kCjva5Ka2yfnZ8GijkDSx7x_i_gj30_Xg5Ws23s_HzetXfW3X-Bf4tdaIuzZu1_oXYoXXiP-D17-Kw7XO5Me69ZrwNd37a9sXOH1Ye77t__dqBuIe3uPU1jvzY7-iW-fyjd89_nfX2Hu1MjUSG22_MZ8kOMd8HsNHWA3HGucyLy_4EAcdhYWxucf3_br5qY1buflmHi3kVHdttNfZe3xv7hfSw3o9r7-Pebfy8TjXN_Yc6qHu12P3yK521-_vrDOt_fLfrElve9_d9abm8miefdzvr3v857jv98-7ur4YGZUe26yjhrEzG7KWmlRuPOF-rfD5m6Xh_H0SlTUjwfnZnoq4hziIlQ5jXAFj9Ny3T4vxEr6pD98y_oYzOcNI1bY69xCHG7L4T9nGxzLJY1jRn9BwtgeZg3sB3KeENvQ0VrzJLOgB7BkPnHjoawIKn__teAnfYsbHQgX6lDgewLu0q3smZVDgPsBGPO4DkrkyKKXIiEQk-OI4gL5lAH2U2OjQ0Ef4ASMpA9x_VE1PxUNfM6EXYNdRM9xn5BhT9MhSUnkkVbJneMA_Tg5NT7auFmOIVSxjLtCLBJVYbQvAhN5qSQFuYUF_hHsrxx_gfinGfY4zEygDfDFIiHcsl466xv5jDM-KuINR50bGMTrBP6SLMYKX3NCEREeToxJtaI0Kj3aUYUzPWkFfVwq5rsm-OarfU0MLaYsWAox56_yvUcOVvKaEzZrcriecstrIgkIy3ivwsrRNBvVTWNMwtHF_t2JIaQZ9Yzws7QYf5icXOKpErtRlHWvYT3NjynfnZf9cT_Aci0eIH3wvqzrmM-FozDa-M6F2psqOgW9oIK5012HNU9z0cZ5rDva0kcE8gbqWwUYfsKBvHOsYs5pXkwK-SbGse2TfwvmrBs07xIMPYS1RNyM7ejkYTR9N4lzg2PB-0uPjmreiq1S4jIWdFS1xLLM6r9jXCPrZMAe9ut8EXyYnaSxiHRLzWiPIx2ZYwtyjdHoJnE_vMWEeG6pzhP27xUGssbRqiRZ1jnGd8uxiJXDzWVb38n_yvupoGuZl-M08HRwkiJOjwXjEUtb0xOEbBNTNmouERXe2Kl8Z3VF_qOtX5cfe_u9UNv7-25D3RH1TYXvxlnj-Xb-6xDP7RHfxbYVrpr8aCaKe-r0-je9G3KMb5-IhzL0k9NyUeKY6RIqFB9DrPqEeYnpMn-ohmuN6AJOauauUCQzS8PPolwho3ScOUb0e1yGiveO9eq5zttN76lF9pkPsj26aes5F8g-m6UbeISKe8_Tgdogs3OeAhEiS7RDbdH9I8E0LAf5kXl7f51CoT1O9foeo9rHb3M2wdB8YxW5e7NOg1q9vX-AnO_-V7p2DnTdSkqIYuhbDdhDX10Ycd4PW_wDSwKvDVBIAAA&zip=true&golem=false&adRequestTime=1793380509061&pageNumber=1&pos=0&redirect=https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","image":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c,1","is_ad":true,"is_atf":true,"is_btf":false,"is_new":false,"rating":4.5068,"is_deal":false,"in_stock":true,"is_fresh":false,"is_bundle":false,"is_frozen":false,"is_pb_fresh":false,"offer_price":"77.48","part_number":"101143","ad_placement":0,"bundle_title":null,"is_gift_card":false,"is_live_feed":false,"is_smart_pak":false,"key_benefits":[],"manufacturer":"Purina Pro Plan","rating_count":23711,"strike_price":"$79.99","click_tracker":null,"display_price":"$77.48","is_hard_goods":false,"is_live_plant":false,"autoship_price":"$73.61","is_dropshipped":false,"is_enhanced_pb":false,"is_rx_vet_diet":false,"item_analytics":{"data-id":"101143","data-name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","data-brand":"Purina Pro Plan","data-price":"77.48","data-on-sale":"no","data-variant":null,"data-category":"undefined","data-page-num":"1","data-deal-text":null,"data-widget-id":null,"data-creative-id":null,"data-input-query":"salmon kibble","data-widget-type":null,"data-is-monetized":"true","data-output-query":"salmon kibble","data-result-count":"1153","data-in-stock-flag":"true","data-price-per-unit":"$2.59/lb","data-experience-type":null,"data-is-customizable":"false","data-widget-type-value":null,"data-impression-tracker":"https://www.chewy.com/api/event/p/sar/impression?adsOrigin=aspen2&id=238a99cdbce84f4a97e766531a139158&x=H4sIAAAAAAAA_6VYWZeqRhD-LzybudDgwrzkuI1CBC-KIpy8sI02mwRQhJz891SDo8xcHWeSJ6C6-OqrpZfqvynTERzqmaF7TLfL8YhuUXbimhk-ukTO0-1Oj-_wqEW9Bni7y4iwy_W6XJdHDOiaYWzibUTEba7DIJ6nuy0APbpJhlM3IQMsw3cAp0XFCd4nOCuIEHEdvg0IOIwTN03xPlolAfVM7bIsTp9__HB_Y5h2r_NkOqWb-E-Rm_3AT1v8-rv754GmWcctRCR4eywtuZM8FFIhfCHfpaT6SBqt0Gwo7pyh0JFUvYR3XL0Pc6wjGs-9FS1742Ku-rlcENkWZHohlUoOup5ZCB2XpQFTLgCzTfDmIx_NVWJnERO7hrYqdU0OJFWhDXVMy6NFqKtbJKsSO1ftXArHuTFSOKkUMGD6Jq7tm5qP51gAW7vdXA08YyJ6hrqlDW8B304glzrBOOnquJyrY2Ze-bbIiG-AE-oF8anPSarNyiO_IJhGmAN_m56PbFouQbYEO5s-sVPOPOEkDSFG5fggeVJbwDDG2jAmAv9TZiFua6IA6-EpmE2yWA_F1FgO3sZSG72klsYfhMniaBSDxNREbE1W9-RbI-SPxvB0wTYmfCRMjKOFlKudqbyzJszRwo3_rnpN7MJdXm3q6IUWPufY1P8M07eQfeZ616fQQrzf4Orbkf-Lfw7axc5kHZobef9JjD7YbMRnKrbv2WtwJLbTZizfsGeNf892LnH5iC1csE9nvm-xvPKpY1zH7FoXFa6nb645vGINCkOTYxv8vYyd_6_s3_Tndn2Qd7s4VXo3aqWSW9p6Z02lRmyZQNfyd7lu-NCI06Vu3mIFcTl9WiuXfzZSerOOG7xvxbL5j64tGGuq1DjXPFx0K7-GdYzPMXoXhwu3qRhYWsBYy0FusTLUXvAO501_w5K8MLGj0Vt7wpfmZhGTmvglfwGf2-E6MzfrTJgOjjYKaJP4_iHuj3A_XQ9evmbj_Xxcv37V12aNf4FfY424a-N2rX8hVmSN-B-8_lMcrnW2eKxbrQlf072_tn2B04e159v-f69mIO7BPU5NvTO_9ld0q1y-8bvH_-4ae69WJkZso-035pMM55jPY_gIq-ZY4Vzm5QUf4qCjIDfW9_i-Xzc_tXErN9_Mo4Wc8q6N5jp7j-_N_UJ-WK_n9fcx70Y-Huf6xp7DPNT9euwe2d3c9fs760xjv_wva9Lb3nd3vam4PJpnH_f76x7_Oe77_fOurieFRqlHdtvRgsiZDtqWFpduNOZ_Lsn5u83C-fskqStOhvOzPZFID3GQSh3G-BzG2Jlnn-YjBb6ZD98L8g1nco6Ty2157iEON2TRr7K1R2Qy5tqSN2bhbA8yh_QCpE8JbOhprGidWtAD2FMBOAnQ1_gMOf_bkQLfUipEYgn6jDTqw7u8q3omtZ-TPsBGAukD4pnaL-TQCCUketLIh76lD32UVOuw0Ed4PierfdJ_lHVPJUBfM2bnYNfRUtJnZARTwnQhawKSywU2MPCP4kPdk63K-QhiFS0IF-hF_FIqtzlgQm-lMICbW9Afkd7K8fqkX4pIn-NMRcYAXwwa4h0tCkdbEf8JBrZC_mBUuVmQGJ3gH9olGP5LZmzEWEfjoxqu2Q0THO0wJZjYWkJfV4iZvll45rB6T4xNwFqs6BPMW-f_DTNYLlaMuF7R29WYV5frhajSHH4FXtZmnUL95NYkCGzS3y05Wp5C3xgNCrvGh_nJ-44m00tNqWIN-2lmTITOrOid6wmeI-kI8YNvpaxiPhWPxnTtOWNmZ2rtEfANDMQX7iqoeErrHslzxcGe1DKYJ1DXC7DRAyzoG0c6wSxn5TiHb1oqqh7Zs0j-yn79DvEQAlhLtPXQDl8ORt1H0yQXJDaCF3eFqOKt6hoTKJG4s0KFxDKt8kp8DaGfDTLQq_pN8GV8kkcS0aEJrxWCfKwHBcw9RmcV4Hx6jwnz2NCcI-zfDQ5ShbUpFTSvckzqVGjPlyI_m6ZVL_8r76vOZkN4GV49T_sHGeKkh2MyPwpSs0ZE3sfoVSF3CaiT1lcKcRj-lg-ZwFGUP8RVKMuvOZqMO9u__vKp6vLCxtGWev67enWp5_YT22lRduCayc9agpinXrfHkusS9-hGmXQIMhwH2E2oZ6ZFJUR4AL3OE-oirsv1mC5ieb4LMImZuWoRwyALPw9_SoDWeeIR0-3yLSrcO_gVu87ZTvepy_S4FrU_ukmCnYvkH0LTDfEhpJ6z5OC2qDTYZ4CEaLrdorbJ_hCTyxcK_ElxVl3xMKjHMt1eiyr3kVtf17TZHjCK3CzfJ36lX93FwE929jPZOwc7q6U0w3BsJYaNIapuknj-Bq1_AX5avc1nEgAA&zip=true&golem=false&adRequestTime=1793380509061&pageNumber=1&pos=0","data-new-cat-entry-type":"ITEM","data-analytics-ads-origin":"aspen2","data-analytics-ad-request-time":"1793380509061","data-analytics-alternative-rank":"undefined","data-analytics-piq-impression-id":"238a99cdbce84f4a97e766531a139158","data-analytics-piq-impression-payload":null},"is_customizable":false,"is_discontinued":false,"is_map_enforced":null,"is_prescription":false,"is_refrigerated":false,"options_message":null,"advertised_price":"77.48","catalog_entry_id":128666,"has_more_choices":false,"is_autoship_deal":true,"max_arrival_date":null,"min_arrival_date":null,"ft_autoship_price":"$57.48","strike_price_type":"LIST","impression_tracker":null,"is_chewy_exclusive":false,"parent_part_number":"67742","strike_savings_pct":"3","bundle_part_numbers":[],"is_autoship_allowed":true,"autoship_discount_pct":"5%","ensemble_part_numbers":[],"ft_autoship_max_amount":"$20","validated_strike_price":"$79.99","parent_catalog_entry_id":null,"ft_autoship_discount_pct":35,"minimum_advertised_price":null,"is_canadian_national_brand":false,"is_private_brand_from_spiq":false,"new_user_other_cta_display":"none","show_promo_carousel_post_atc":false,"supplemental_thumbnail_assets":["https://image.chewy.com/catalog/general/images/moe/069fe3d1-df1f-745f-8000-9bb61e099f02,1","https://image.chewy.com/catalog/general/images/moe/0671ffce-aa8a-7b92-8000-55ebf9862cbf,1","https://image.chewy.com/catalog/general/images/moe/0671ffa6-a1b3-75ba-8000-ce3bfaa8b1ed,1","https://image.chewy.com/catalog/general/images/moe/0671ffa6-816c-7aee-8000-e2155ccf0309,1","https://image.chewy.com/catalog/general/images/moe/0671ffa6-5dc2-7bc1-8000-86eef1c91470,1","https://image.chewy.com/catalog/general/images/moe/06835ef4-b5e0-79f8-8000-c6512e0bd24a,1","https://image.chewy.com/catalog/general/images/moe/0671ffa5-ee23-76bb-8000-529371470fee,1","https://image.chewy.com/catalog/general/images/moe/0671ffa5-cd60-7558-8000-33058e4394e6,1"],"existing_user_other_cta_display":"none","should_display_atc_to_new_users":true,"should_display_atc_to_existing_users":true,"should_display_atc_to_new_users_below_min_ios":false}]}},"simple: Purina Pro Plan 30-lb salmon kibble":{"value":{"results":[{"id":"128666","url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","brand":"Purina Pro Plan","image":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg","price":77.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","rating":4.51,"currency":"USD","in_stock":true,"unit_price":2.59,"part_number":"101143","is_sponsored":true,"rating_count":23686,"price_display":"$77.48","autoship_price":73.61,"discount_label":"3%","original_price":79.99,"parent_part_number":"67742","unit_price_display":"$2.59/lb","autoship_price_display":"$73.61","original_price_display":"$79.99"}],"pagination":{"next":"https://www.chewy.com/s?query=salmon+kibble&page=2","page":1,"per_page":40,"total_pages":33,"total_results":1153}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Chewy Search","description":"Search Chewy by keyword or listing URL. The default mode is expert and returns the historical listing objects. simple returns short snake_case cards.\n\n**Credit cost:** 3 credits per call","operationId":"post-chewy-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What to search for. A keyword such as salmon kibble, or a Chewy search or category link such as https://www.chewy.com/s?query=dog+food. A product link (a URL that contains /dp/) returns 400. Another website returns 400.","schema":{"type":"string","description":"What to search for. A keyword such as salmon kibble, or a Chewy search or category link such as https://www.chewy.com/s?query=dog+food. A product link (a URL that contains /dp/) returns 400. Another website returns 400."}},{"name":"page","in":"query","required":false,"description":"Which page to fetch, starting at 1. Leave this empty for page 1. If query is a listing link that already has page=2, this value replaces that page. In simple mode, pagination.page is this page and pagination.next is the next page URL or null.","schema":{"type":"number","minimum":1,"description":"Which page to fetch, starting at 1. Leave this empty for page 1. If query is a listing link that already has page=2, this value replaces that page. In simple mode, pagination.page is this page and pagination.next is the next page URL or null."}},{"name":"mode","in":"query","required":false,"description":"Which JSON to return. Default expert.\n\nexpert: the historical payload. { results } of Chewy listing fields in snake_case (catalog_entry_id, name, href, advertised_price). No pagination object.\n\nsimple: the short card. { results, pagination }. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash.\n\nUse simple for a short listing. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400.","schema":{"type":"string","default":"expert","description":"Which JSON to return. Default expert.\n\nexpert: the historical payload. { results } of Chewy listing fields in snake_case (catalog_entry_id, name, href, advertised_price). No pagination object.\n\nsimple: the short card. { results, pagination }. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash.\n\nUse simple for a short listing. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON.","schema":{"type":"boolean","description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"ppu":{"type":"string"},"href":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"},"is_ad":{"type":"boolean"},"is_atf":{"type":"boolean"},"is_btf":{"type":"boolean"},"is_new":{"type":"boolean"},"rating":{"type":"number"},"is_deal":{"type":"boolean"},"in_stock":{"type":"boolean"},"is_fresh":{"type":"boolean"},"is_bundle":{"type":"boolean"},"is_frozen":{"type":"boolean"},"is_pb_fresh":{"type":"boolean"},"offer_price":{"type":"string"},"part_number":{"type":"string"},"ad_placement":{"type":"integer"},"bundle_title":{"nullable":true},"is_gift_card":{"type":"boolean"},"is_live_feed":{"type":"boolean"},"is_smart_pak":{"type":"boolean"},"key_benefits":{"type":"array","items":{}},"manufacturer":{"type":"string"},"rating_count":{"type":"integer"},"strike_price":{"type":"string"},"click_tracker":{"nullable":true},"display_price":{"type":"string"},"is_hard_goods":{"type":"boolean"},"is_live_plant":{"type":"boolean"},"autoship_price":{"type":"string"},"is_dropshipped":{"type":"boolean"},"is_enhanced_pb":{"type":"boolean"},"is_rx_vet_diet":{"type":"boolean"},"item_analytics":{"type":"object","properties":{"data-id":{"type":"string"},"data-name":{"type":"string"},"data-brand":{"type":"string"},"data-price":{"type":"string"},"data-on-sale":{"type":"string"},"data-variant":{"nullable":true},"data-category":{"type":"string"},"data-page-num":{"type":"string"},"data-deal-text":{"nullable":true},"data-widget-id":{"nullable":true},"data-creative-id":{"nullable":true},"data-input-query":{"type":"string"},"data-widget-type":{"nullable":true},"data-is-monetized":{"type":"string"},"data-output-query":{"type":"string"},"data-result-count":{"type":"string"},"data-in-stock-flag":{"type":"string"},"data-price-per-unit":{"type":"string"},"data-experience-type":{"nullable":true},"data-is-customizable":{"type":"string"},"data-widget-type-value":{"nullable":true},"data-impression-tracker":{"type":"string"},"data-new-cat-entry-type":{"type":"string"},"data-analytics-ads-origin":{"type":"string"},"data-analytics-ad-request-time":{"type":"string"},"data-analytics-alternative-rank":{"type":"string"},"data-analytics-piq-impression-id":{"type":"string"},"data-analytics-piq-impression-payload":{"nullable":true}}},"is_customizable":{"type":"boolean"},"is_discontinued":{"type":"boolean"},"is_map_enforced":{"nullable":true},"is_prescription":{"type":"boolean"},"is_refrigerated":{"type":"boolean"},"options_message":{"nullable":true},"advertised_price":{"type":"string"},"catalog_entry_id":{"type":"integer"},"has_more_choices":{"type":"boolean"},"is_autoship_deal":{"type":"boolean"},"max_arrival_date":{"nullable":true},"min_arrival_date":{"nullable":true},"ft_autoship_price":{"type":"string"},"strike_price_type":{"type":"string"},"impression_tracker":{"nullable":true},"is_chewy_exclusive":{"type":"boolean"},"parent_part_number":{"type":"string"},"strike_savings_pct":{"type":"string"},"bundle_part_numbers":{"type":"array","items":{}},"is_autoship_allowed":{"type":"boolean"},"autoship_discount_pct":{"type":"string"},"ensemble_part_numbers":{"type":"array","items":{}},"ft_autoship_max_amount":{"type":"string"},"validated_strike_price":{"type":"string"},"parent_catalog_entry_id":{"nullable":true},"ft_autoship_discount_pct":{"type":"integer"},"minimum_advertised_price":{"nullable":true},"is_canadian_national_brand":{"type":"boolean"},"is_private_brand_from_spiq":{"type":"boolean"},"new_user_other_cta_display":{"type":"string"},"show_promo_carousel_post_atc":{"type":"boolean"},"supplemental_thumbnail_assets":{"type":"array","items":{"type":"string"}},"existing_user_other_cta_display":{"type":"string"},"should_display_atc_to_new_users":{"type":"boolean"},"should_display_atc_to_existing_users":{"type":"boolean"},"should_display_atc_to_new_users_below_min_ios":{"type":"boolean"}}}}}},"examples":{"expert (default): Purina Pro Plan 30-lb salmon kibble":{"value":{"results":[{"ppu":"$2.59/lb","href":"https://www.chewy.com/api/event/p/sar/click?adsOrigin=aspen2&id=238a99cdbce84f4a97e766531a139158&x=H4sIAAAAAAAA_6VYWZOiyhL-Lzw7PVCASr-ccGuFIzgiyhI34gZbK6sEoAgT57_fLLCV7tG2-9wnICv58sullqzfhOnwDvFMkX2q12M4RHYIO3XN3Du6WM6RbLfPdTnUIV5Db7vLsbDH9HtMj0MU6JpRYnrbGItZpkshjiN7HQA9umnuZW6KB2iK6wJOh0hSb596eYmFiOlyLEYIPTtYpyHxTOzyPMmef_50f1AU2-8-mU7lpsFT7OY_07_c_xxIknbcUkC8v_fEFXOSRnzGRy_4uxKVAInjNZqPhJ0z4ruiolfw7tXvo8LTEekt_DUp-ZNyoQSFVGLZFmR6KVbLAnR9s-S7Lk0CplQCJovxFuMALRRsR06wXUNdV7oqhaKyJA1lQkpjOdKVLZIUkV4odiFGk8IYLxmx4j3ADEyvsW-qgbfweLC12y2U0Demgm8oW9LwZfh2QqnSMcZJVybVQplQi9o3Oce-AU6kl9inASMqNi2NgxJjGlEB_G1yMbZJqQLZCuxoA2ynmvv8SRxBjKrJQfRFlvdgjLZhTAD-p9xCzNZEoadHp3A-zRM9EjJjNXwby2z0klkqd-Cn8tEoh6mpCp41Xd-Tb42IOxqj0wXbmHIxPzWOFlpe7cyknTWljpbX-u-q18Yu3dXVpo5eSP5zjm39zzADC9lnrnd9iizEBS2ugR0Hf_jnoF3iTDeRqUn7T2L0wWYrPjOBvWevxRHbztqxfMOet_4927nE5SM2f8E-nfm-xfLKp4lxE7NrXdS4vq5dc3jFGpaGKiU2-HsZO_9f27_pz-36wO92ear1btRKLbfUzc6aia3YUqGuFu9y3fKhFadL3bzFCuJy-rRWLv9oYnazjlu8b8Wy_Y-uypQ1WzY41zxcdGu_Rk2MzzF6F4cLt5kQWmpIWathYdES1F74DudNX6NxXqjEUcmtPeUqU5MTXBN_5C_kCjva5Ka2yfnZ8GijkDSx7x_i_gj30_Xg5Ws23s_HzetXfW3X-Bf4tdaIuzZu1_oXYoXXiP-D17-Kw7XO5Me69ZrwNd37a9sXOH1Ye77t__dqBuIe3uPU1jvzY7-iW-fyjd89_nfX2Hu1MjUSG22_MZ8kOMd8HsNHWA3HGucyLy_4EAcdhYWxucf3_br5qY1buflmHi3kVHdttNfZe3xv7hfSw3o9r7-Pebfy8TjXN_Yc6qHu12P3yK521-_vrDOt_fLfrElve9_d9abm8miefdzvr3v857jv98-7ur4YGZUe26yjhrEzG7KWmlRuPOF-rfD5m6Xh_H0SlTUjwfnZnoq4hziIlQ5jXAFj9Ny3T4vxEr6pD98y_oYzOcNI1bY69xCHG7L4T9nGxzLJY1jRn9BwtgeZg3sB3KeENvQ0VrzJLOgB7BkPnHjoawIKn__teAnfYsbHQgX6lDgewLu0q3smZVDgPsBGPO4DkrkyKKXIiEQk-OI4gL5lAH2U2OjQ0Ef4ASMpA9x_VE1PxUNfM6EXYNdRM9xn5BhT9MhSUnkkVbJneMA_Tg5NT7auFmOIVSxjLtCLBJVYbQvAhN5qSQFuYUF_hHsrxx_gfinGfY4zEygDfDFIiHcsl466xv5jDM-KuINR50bGMTrBP6SLMYKX3NCEREeToxJtaI0Kj3aUYUzPWkFfVwq5rsm-OarfU0MLaYsWAox56_yvUcOVvKaEzZrcriecstrIgkIy3ivwsrRNBvVTWNMwtHF_t2JIaQZ9Yzws7QYf5icXOKpErtRlHWvYT3NjynfnZf9cT_Aci0eIH3wvqzrmM-FozDa-M6F2psqOgW9oIK5012HNU9z0cZ5rDva0kcE8gbqWwUYfsKBvHOsYs5pXkwK-SbGse2TfwvmrBs07xIMPYS1RNyM7ejkYTR9N4lzg2PB-0uPjmreiq1S4jIWdFS1xLLM6r9jXCPrZMAe9ut8EXyYnaSxiHRLzWiPIx2ZYwtyjdHoJnE_vMWEeG6pzhP27xUGssbRqiRZ1jnGd8uxiJXDzWVb38n_yvupoGuZl-M08HRwkiJOjwXjEUtb0xOEbBNTNmouERXe2Kl8Z3VF_qOtX5cfe_u9UNv7-25D3RH1TYXvxlnj-Xb-6xDP7RHfxbYVrpr8aCaKe-r0-je9G3KMb5-IhzL0k9NyUeKY6RIqFB9DrPqEeYnpMn-ohmuN6AJOauauUCQzS8PPolwho3ScOUb0e1yGiveO9eq5zttN76lF9pkPsj26aes5F8g-m6UbeISKe8_Tgdogs3OeAhEiS7RDbdH9I8E0LAf5kXl7f51CoT1O9foeo9rHb3M2wdB8YxW5e7NOg1q9vX-AnO_-V7p2DnTdSkqIYuhbDdhDX10Ycd4PW_wDSwKvDVBIAAA&zip=true&golem=false&adRequestTime=1793380509061&pageNumber=1&pos=0&redirect=https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","image":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c,1","is_ad":true,"is_atf":true,"is_btf":false,"is_new":false,"rating":4.5068,"is_deal":false,"in_stock":true,"is_fresh":false,"is_bundle":false,"is_frozen":false,"is_pb_fresh":false,"offer_price":"77.48","part_number":"101143","ad_placement":0,"bundle_title":null,"is_gift_card":false,"is_live_feed":false,"is_smart_pak":false,"key_benefits":[],"manufacturer":"Purina Pro Plan","rating_count":23711,"strike_price":"$79.99","click_tracker":null,"display_price":"$77.48","is_hard_goods":false,"is_live_plant":false,"autoship_price":"$73.61","is_dropshipped":false,"is_enhanced_pb":false,"is_rx_vet_diet":false,"item_analytics":{"data-id":"101143","data-name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","data-brand":"Purina Pro Plan","data-price":"77.48","data-on-sale":"no","data-variant":null,"data-category":"undefined","data-page-num":"1","data-deal-text":null,"data-widget-id":null,"data-creative-id":null,"data-input-query":"salmon kibble","data-widget-type":null,"data-is-monetized":"true","data-output-query":"salmon kibble","data-result-count":"1153","data-in-stock-flag":"true","data-price-per-unit":"$2.59/lb","data-experience-type":null,"data-is-customizable":"false","data-widget-type-value":null,"data-impression-tracker":"https://www.chewy.com/api/event/p/sar/impression?adsOrigin=aspen2&id=238a99cdbce84f4a97e766531a139158&x=H4sIAAAAAAAA_6VYWZeqRhD-LzybudDgwrzkuI1CBC-KIpy8sI02mwRQhJz891SDo8xcHWeSJ6C6-OqrpZfqvynTERzqmaF7TLfL8YhuUXbimhk-ukTO0-1Oj-_wqEW9Bni7y4iwy_W6XJdHDOiaYWzibUTEba7DIJ6nuy0APbpJhlM3IQMsw3cAp0XFCd4nOCuIEHEdvg0IOIwTN03xPlolAfVM7bIsTp9__HB_Y5h2r_NkOqWb-E-Rm_3AT1v8-rv754GmWcctRCR4eywtuZM8FFIhfCHfpaT6SBqt0Gwo7pyh0JFUvYR3XL0Pc6wjGs-9FS1742Ku-rlcENkWZHohlUoOup5ZCB2XpQFTLgCzTfDmIx_NVWJnERO7hrYqdU0OJFWhDXVMy6NFqKtbJKsSO1ftXArHuTFSOKkUMGD6Jq7tm5qP51gAW7vdXA08YyJ6hrqlDW8B304glzrBOOnquJyrY2Ze-bbIiG-AE-oF8anPSarNyiO_IJhGmAN_m56PbFouQbYEO5s-sVPOPOEkDSFG5fggeVJbwDDG2jAmAv9TZiFua6IA6-EpmE2yWA_F1FgO3sZSG72klsYfhMniaBSDxNREbE1W9-RbI-SPxvB0wTYmfCRMjKOFlKudqbyzJszRwo3_rnpN7MJdXm3q6IUWPufY1P8M07eQfeZ616fQQrzf4Orbkf-Lfw7axc5kHZobef9JjD7YbMRnKrbv2WtwJLbTZizfsGeNf892LnH5iC1csE9nvm-xvPKpY1zH7FoXFa6nb645vGINCkOTYxv8vYyd_6_s3_Tndn2Qd7s4VXo3aqWSW9p6Z02lRmyZQNfyd7lu-NCI06Vu3mIFcTl9WiuXfzZSerOOG7xvxbL5j64tGGuq1DjXPFx0K7-GdYzPMXoXhwu3qRhYWsBYy0FusTLUXvAO501_w5K8MLGj0Vt7wpfmZhGTmvglfwGf2-E6MzfrTJgOjjYKaJP4_iHuj3A_XQ9evmbj_Xxcv37V12aNf4FfY424a-N2rX8hVmSN-B-8_lMcrnW2eKxbrQlf072_tn2B04e159v-f69mIO7BPU5NvTO_9ld0q1y-8bvH_-4ae69WJkZso-035pMM55jPY_gIq-ZY4Vzm5QUf4qCjIDfW9_i-Xzc_tXErN9_Mo4Wc8q6N5jp7j-_N_UJ-WK_n9fcx70Y-Huf6xp7DPNT9euwe2d3c9fs760xjv_wva9Lb3nd3vam4PJpnH_f76x7_Oe77_fOurieFRqlHdtvRgsiZDtqWFpduNOZ_Lsn5u83C-fskqStOhvOzPZFID3GQSh3G-BzG2Jlnn-YjBb6ZD98L8g1nco6Ty2157iEON2TRr7K1R2Qy5tqSN2bhbA8yh_QCpE8JbOhprGidWtAD2FMBOAnQ1_gMOf_bkQLfUipEYgn6jDTqw7u8q3omtZ-TPsBGAukD4pnaL-TQCCUketLIh76lD32UVOuw0Ed4PierfdJ_lHVPJUBfM2bnYNfRUtJnZARTwnQhawKSywU2MPCP4kPdk63K-QhiFS0IF-hF_FIqtzlgQm-lMICbW9Afkd7K8fqkX4pIn-NMRcYAXwwa4h0tCkdbEf8JBrZC_mBUuVmQGJ3gH9olGP5LZmzEWEfjoxqu2Q0THO0wJZjYWkJfV4iZvll45rB6T4xNwFqs6BPMW-f_DTNYLlaMuF7R29WYV5frhajSHH4FXtZmnUL95NYkCGzS3y05Wp5C3xgNCrvGh_nJ-44m00tNqWIN-2lmTITOrOid6wmeI-kI8YNvpaxiPhWPxnTtOWNmZ2rtEfANDMQX7iqoeErrHslzxcGe1DKYJ1DXC7DRAyzoG0c6wSxn5TiHb1oqqh7Zs0j-yn79DvEQAlhLtPXQDl8ORt1H0yQXJDaCF3eFqOKt6hoTKJG4s0KFxDKt8kp8DaGfDTLQq_pN8GV8kkcS0aEJrxWCfKwHBcw9RmcV4Hx6jwnz2NCcI-zfDQ5ShbUpFTSvckzqVGjPlyI_m6ZVL_8r76vOZkN4GV49T_sHGeKkh2MyPwpSs0ZE3sfoVSF3CaiT1lcKcRj-lg-ZwFGUP8RVKMuvOZqMO9u__vKp6vLCxtGWev67enWp5_YT22lRduCayc9agpinXrfHkusS9-hGmXQIMhwH2E2oZ6ZFJUR4AL3OE-oirsv1mC5ieb4LMImZuWoRwyALPw9_SoDWeeIR0-3yLSrcO_gVu87ZTvepy_S4FrU_ukmCnYvkH0LTDfEhpJ6z5OC2qDTYZ4CEaLrdorbJ_hCTyxcK_ElxVl3xMKjHMt1eiyr3kVtf17TZHjCK3CzfJ36lX93FwE929jPZOwc7q6U0w3BsJYaNIapuknj-Bq1_AX5avc1nEgAA&zip=true&golem=false&adRequestTime=1793380509061&pageNumber=1&pos=0","data-new-cat-entry-type":"ITEM","data-analytics-ads-origin":"aspen2","data-analytics-ad-request-time":"1793380509061","data-analytics-alternative-rank":"undefined","data-analytics-piq-impression-id":"238a99cdbce84f4a97e766531a139158","data-analytics-piq-impression-payload":null},"is_customizable":false,"is_discontinued":false,"is_map_enforced":null,"is_prescription":false,"is_refrigerated":false,"options_message":null,"advertised_price":"77.48","catalog_entry_id":128666,"has_more_choices":false,"is_autoship_deal":true,"max_arrival_date":null,"min_arrival_date":null,"ft_autoship_price":"$57.48","strike_price_type":"LIST","impression_tracker":null,"is_chewy_exclusive":false,"parent_part_number":"67742","strike_savings_pct":"3","bundle_part_numbers":[],"is_autoship_allowed":true,"autoship_discount_pct":"5%","ensemble_part_numbers":[],"ft_autoship_max_amount":"$20","validated_strike_price":"$79.99","parent_catalog_entry_id":null,"ft_autoship_discount_pct":35,"minimum_advertised_price":null,"is_canadian_national_brand":false,"is_private_brand_from_spiq":false,"new_user_other_cta_display":"none","show_promo_carousel_post_atc":false,"supplemental_thumbnail_assets":["https://image.chewy.com/catalog/general/images/moe/069fe3d1-df1f-745f-8000-9bb61e099f02,1","https://image.chewy.com/catalog/general/images/moe/0671ffce-aa8a-7b92-8000-55ebf9862cbf,1","https://image.chewy.com/catalog/general/images/moe/0671ffa6-a1b3-75ba-8000-ce3bfaa8b1ed,1","https://image.chewy.com/catalog/general/images/moe/0671ffa6-816c-7aee-8000-e2155ccf0309,1","https://image.chewy.com/catalog/general/images/moe/0671ffa6-5dc2-7bc1-8000-86eef1c91470,1","https://image.chewy.com/catalog/general/images/moe/06835ef4-b5e0-79f8-8000-c6512e0bd24a,1","https://image.chewy.com/catalog/general/images/moe/0671ffa5-ee23-76bb-8000-529371470fee,1","https://image.chewy.com/catalog/general/images/moe/0671ffa5-cd60-7558-8000-33058e4394e6,1"],"existing_user_other_cta_display":"none","should_display_atc_to_new_users":true,"should_display_atc_to_existing_users":true,"should_display_atc_to_new_users_below_min_ios":false}]}},"simple: Purina Pro Plan 30-lb salmon kibble":{"value":{"results":[{"id":"128666","url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","brand":"Purina Pro Plan","image":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg","price":77.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","rating":4.51,"currency":"USD","in_stock":true,"unit_price":2.59,"part_number":"101143","is_sponsored":true,"rating_count":23686,"price_display":"$77.48","autoship_price":73.61,"discount_label":"3%","original_price":79.99,"parent_part_number":"67742","unit_price_display":"$2.59/lb","autoship_price_display":"$73.61","original_price_display":"$79.99"}],"pagination":{"next":"https://www.chewy.com/s?query=salmon+kibble&page=2","page":1,"per_page":40,"total_pages":33,"total_results":1153}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/chewy/product":{"get":{"summary":"Chewy Product","description":"Read one Chewy product by URL or numeric id. The default mode is expert and returns the historical product cache. simple returns one snake_case product.\n\n**Credit cost:** 3 credits per call","operationId":"get-chewy-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Which product to read. A Chewy product URL such as https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666, or just the numeric id 128666. A search link, a keyword, or another website returns 400.","schema":{"type":"string","description":"Which product to read. A Chewy product URL such as https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666, or just the numeric id 128666. A search link, a keyword, or another website returns 400."}},{"name":"mode","in":"query","required":false,"description":"Which JSON to return. Default expert.\n\nexpert: the historical Apollo cache, with Chewy's own names (Item keys, advertisedPrice, __typename).\n\nsimple: one flat product. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash. variants lists other sizes when the page has them.\n\nUse simple for the short card. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400.","schema":{"type":"string","default":"expert","description":"Which JSON to return. Default expert.\n\nexpert: the historical Apollo cache, with Chewy's own names (Item keys, advertisedPrice, __typename).\n\nsimple: one flat product. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash. variants lists other sizes when the page has them.\n\nUse simple for the short card. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON.","schema":{"type":"boolean","description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"Item:SXRlbToxMjg2NjY=":{"type":"object","properties":{"id":{"type":"string"},"gtin":{"type":"string"},"isRx":{"type":"boolean"},"name":{"type":"string"},"uses":{"nullable":true},"isNew":{"type":"boolean"},"images":{"type":"array","items":{"type":"object","properties":{"__typename":{"type":"string"},"url({\"autoCrop\":true,\"square\":600})":{"type":"string"}}}},"videos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"image":{"type":"string"},"thumbnail":{"type":"string"},"__typename":{"type":"string"}}}},"weight":{"type":"string"},"entryID":{"type":"string"},"inStock":{"type":"boolean"},"isFresh":{"type":"boolean"},"product":{"type":"object","properties":{"slug":{"type":"string"},"__ref":{"type":"string"},"__typename":{"type":"string"}}},"cautions":{"nullable":true},"isBundle":{"type":"boolean"},"isFrozen":{"type":"boolean"},"mapPrice":{"type":"string"},"fullImage":{"type":"object","properties":{"__typename":{"type":"string"},"url({\"autoCrop\":true,\"square\":144})":{"type":"string"},"url({\"autoCrop\":true,\"square\":1800})":{"type":"string"},"url({\"autoCrop\":true,\"maxWidth\":275})":{"type":"string"}}},"isInStock":{"type":"boolean"},"isVetDiet":{"type":"boolean"},"onSpecial":{"type":"boolean"},"__typename":{"type":"string"},"dimensions":{"nullable":true},"infoGroups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"usage":{"type":"string"},"content":{"type":"object","properties":{"content":{"type":"string"},"__typename":{"type":"string"}}},"__typename":{"type":"string"}}}},"__typename":{"type":"string"}}}},"isGiftCard":{"type":"boolean"},"isLiveFeed":{"type":"boolean"},"mapSavings":{"nullable":true},"offerPrice":{"type":"string"},"partNumber":{"type":"string"},"promotions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"__typename":{"type":"string"},"helperText":{"type":"string"},"longDescription":{"type":"string"},"shortDescription":{"type":"string"},"promoHeadlineLong":{"nullable":true},"promoHeadlineShort":{"nullable":true},"isSmartshelfEligible":{"type":"boolean"},"mobilePromoTermDetailsUrl":{"nullable":true},"desktopPromoTermDetailsUrl":{"nullable":true},"accessibilityPromoTermDetails":{"nullable":true}}}},"aboutAuthor":{"nullable":true},"bundleItems":{"nullable":true},"bundleTheme":{"nullable":true},"description":{"type":"string"},"disclaimers":{"nullable":true},"isLivePlant":{"type":"boolean"},"isPublished":{"type":"boolean"},"keyBenefits":{"type":"array","items":{"type":"string"}},"mapEnforced":{"type":"boolean"},"maxQuantity":{"type":"integer"},"seoMetaData":{"nullable":true},"isHealthCare":{"type":"boolean"},"isRestricted":{"type":"boolean"},"isSinglePill":{"type":"boolean"},"pbTransition":{"nullable":true},"perUnitPrice":{"type":"string"},"specialNotes":{"type":"object","properties":{"content":{"nullable":true},"__typename":{"type":"string"}}},"topPromotion":{"type":"object","properties":{"id":{"type":"integer"},"__typename":{"type":"string"},"helperText":{"type":"string"},"longDescription":{"type":"string"},"shortDescription":{"type":"string"},"promoHeadlineLong":{"nullable":true},"promoHeadlineShort":{"nullable":true},"isSmartshelfEligible":{"type":"boolean"},"mobilePromoTermDetailsUrl":{"nullable":true},"desktopPromoTermDetailsUrl":{"nullable":true},"accessibilityPromoTermDetails":{"nullable":true}}},"autoshipPrice":{"type":"string"},"isUnavailable":{"type":"boolean"},"numberOfUnits":{"type":"integer"},"packageInsert":{"nullable":true},"prescriptions":{"nullable":true},"proposition65":{"nullable":true},"unitOfMeasure":{"type":"string"},"whatsIncluded":{"nullable":true},"bundleIncludes":{"nullable":true},"isDiscontinued":{"type":"boolean"},"isPersonalized":{"type":"boolean"},"isPrescription":{"type":"boolean"},"isRefrigerated":{"type":"boolean"},"advertisedPrice":{"type":"string"},"dropshipMessage":{"nullable":true},"enhancedContent":{"nullable":true},"mapEnforcedText":{"nullable":true},"replacementItem":{"nullable":true},"shippingMessage":{"type":"string"},"is3DCustomizable":{"type":"boolean"},"isBundleMultiSku":{"type":"boolean"},"promisedDelivery":{"type":"object","properties":{"zip":{"nullable":true},"city":{"nullable":true},"date":{"nullable":true},"__typename":{"type":"string"},"isSkuEligible":{"type":"boolean"},"deliveryDuration":{"nullable":true},"isCutoffEligible":{"type":"boolean"},"isZipCodeEligible":{"type":"boolean"}}},"activeIngredients":{"nullable":true},"isAutoshipAllowed":{"type":"boolean"},"maximumPetWeights":{"type":"array","items":{}},"minimumPetWeights":{"type":"array","items":{}},"patientInfoSheets":{"nullable":true},"reviewsDisclaimer":{"type":"object","properties":{"showDisclaimer":{"type":"boolean"}}},"rxShippingMessage":{"nullable":true},"shippingTimeframe":{"type":"string"},"availabilityStatus":{"nullable":true},"inSheltersWishList":{"type":"boolean"},"strikeThroughPrice":{"type":"string"},"manufacturerDetails":{"nullable":true},"possibleSideEffects":{"nullable":true},"specialNotesContent":{"nullable":true},"unitOfMeasureString":{"type":"string"},"parentCatalogGroupId":{"type":"array","items":{"type":"integer"}},"strikeThroughSavings":{"type":"string"},"topHeadlinePromotion":{"nullable":true},"defaultPrescribedItem":{"nullable":true},"descriptionAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"isEngraveCustomizable":{"type":"boolean"},"restrictedAvailability":{"type":"array","items":{}},"strikeThroughPriceType":{"type":"string"},"availabilityMessageLong":{"nullable":true},"foodAndDrugInteractions":{"nullable":true},"isEmbroiderCustomizable":{"type":"boolean"},"masterCatalogIdentifier":{"type":"string"},"strikeThroughSavingsPct":{"type":"string"},"availabilityMessageShort":{"nullable":true},"is2DEnhancedCustomizable":{"type":"boolean"},"loyaltyPromotionsMessage":{"nullable":true},"isPermanentlyDiscontinued":{"type":"boolean"},"personalizationAttributes":{"nullable":true},"allowEmailNotificationSignup":{"type":"boolean"},"featuredAttributePercentScores":{"type":"object","properties":{"Palatability":{"type":"integer"},"Digestibility":{"type":"integer"},"Ingredient Quality":{"type":"integer"},"Nutritional Content":{"type":"integer"}}},"attributes({\"identifier\":\"FreshRefrigerated\"})":{"type":"array","items":{}},"clinicOffers({\"offerRankingStrategy\":\"PRICE_PREFERRED\"})":{"nullable":true},"attributes({\"identifier\":\"PetType\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"attributes({\"identifier\":\"pb-fresh\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}},"attributeValues({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"attributes({\"identifier\":\"PrivateLabel\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}},"attributes({\"identifier\":\"b2b-eligible\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}},"attributes({\"identifier\":\"SKUSuppression\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}}}},"Product:UHJvZHVjdDo1MjY3Ng==":{"type":"object","properties":{"id":{"type":"string"},"mda":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"},"isEnsemble":{"type":"boolean"},"manufacturerDetails":{"nullable":true}}}},"name":{"type":"string"},"slug":{"type":"string"},"rating":{"type":"number"},"entryID":{"type":"string"},"brandURL":{"type":"string"},"__typename":{"type":"string"},"isEnsemble":{"type":"boolean"},"partNumber":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"__typename":{"type":"string"}}}},"description":{"type":"string"},"iconography":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"__typename":{"type":"string"}}}},"ratingCount":{"type":"integer"},"questionsCount":{"type":"integer"},"manufacturerName":{"type":"string"},"ratingDistributions":{"type":"array","items":{"type":"object","properties":{"rating":{"type":"integer"},"__typename":{"type":"string"},"ratingCount":{"type":"integer"},"ratingPercent":{"type":"number"}}}},"merchClassIdentifiers":{"type":"array","items":{"type":"string"}},"questions:{\"first\":4}":{"type":"object","properties":{"edges":{"type":"array","items":{"type":"object","properties":{"node":{"type":"object","properties":{"__ref":{"type":"string"}}},"__typename":{"type":"string"}}}},"pageInfo":{"type":"object","properties":{"endCursor":{"type":"string"},"__typename":{"type":"string"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"hasPreviousPage":{"type":"boolean"}}},"__typename":{"type":"string"},"totalCount":{"type":"integer"}}},"items({\"includeEnsemble\":true})":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"attributes({\"identifier\":\"PetType\"})":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"attributes({\"identifier\":\"DrugType\"})":{"type":"array","items":{}},"attributes({\"identifier\":\"ProductCategory\"})":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"attributes({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}}}}}},"examples":{"expert (default): Purina Pro Plan 30-lb salmon and rice":{"value":{"Item:SXRlbToxMjg2NjY=":{"id":"SXRlbToxMjg2NjY=","gtin":"038100175526","isRx":false,"name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","uses":null,"isNew":false,"images":[{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-aa8a-7b92-8000-55ebf9862cbf._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/06835ef1-04a3-7744-8000-b453865202bd._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa6-a1b3-75ba-8000-ce3bfaa8b1ed._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa6-816c-7aee-8000-e2155ccf0309._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa6-5dc2-7bc1-8000-86eef1c91470._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/06835ef4-b5e0-79f8-8000-c6512e0bd24a._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa5-ee23-76bb-8000-529371470fee._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa5-cd60-7558-8000-33058e4394e6._AC_SS600_V1_.jpg"}],"videos":[{"url":"https://fast.wistia.com/medias/ggqjn4l7f3","image":"https://embed-ssl.wistia.com/deliveries/47b887565486f8434309c72dc24488d0.jpg?image_crop_resized=528x297","thumbnail":"https://fast.wistia.com/embed/medias/ggqjn4l7f3/swatch","__typename":"Video"},{"url":"https://fast.wistia.com/medias/mznrapwfi1","image":"https://embed-ssl.wistia.com/deliveries/76c99685dc5c2df732317673e82f6f9c0fb0d930.jpg?image_crop_resized=528x297","thumbnail":"https://fast.wistia.com/embed/medias/mznrapwfi1/swatch","__typename":"Video"}],"weight":"30 pounds","entryID":"128666","inStock":true,"isFresh":false,"product":{"slug":"purina-pro-plan-adult-sensitive-skin","__ref":"Product:UHJvZHVjdDo1MjY3Ng==","__typename":"Product"},"cautions":null,"isBundle":false,"isFrozen":false,"mapPrice":"$77.48","fullImage":{"__typename":"Image","url({\"autoCrop\":true,\"square\":144})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS144_V1_.jpg","url({\"autoCrop\":true,\"square\":1800})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS1800_V1_.jpg","url({\"autoCrop\":true,\"maxWidth\":275})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SX275_V1_.jpg"},"isInStock":true,"isVetDiet":false,"onSpecial":true,"__typename":"Item","dimensions":null,"infoGroups":[{"name":"Nutritional Info","sections":[{"title":"Ingredients","usage":"INGREDIENTS","content":{"content":"Salmon, Rice, Barley, Canola Meal, Oat Meal, Fish Meal, Salmon Meal, Beef Fat Preserved With Mixed-Tocopherols, Dried Yeast, Natural Flavor, Sunflower Oil, Fish Oil, Dried Chicory Root, Calcium Carbonate, Salt, Potassium Chloride, L-Lysine Monohydrochloride, VITAMINS [Vitamin E Supplement, Niacin (Vitamin B-3), Vitamin A Supplement, Calcium Pantothenate (Vitamin B-5), Thiamine Mononitrate (Vitamin B-1), Vitamin B-12 Supplement, Riboflavin Supplement (Vitamin B-2), Pyridoxine Hydrochloride, Folic Acid (Vitamin B-9), Menadione Sodium Bisulfite Complex (Vitamin K), Biotin (Vitamin B-7), Vitamin D-3 Supplement], Taurine, MINERALS [Zinc Sulfate, Ferrous Sulfate, Manganese Sulfate, Copper Sulfate, Calcium Iodate, Sodium Selenite], Dl-Methionine, Choline Chloride, L-Ascorbyl-2-Polyphosphate (Vitamin C). M444922","__typename":"Markdown"},"__typename":"InfoGroupSection"},{"title":"Caloric Content","usage":"CALORIC_CONTENT","content":{"content":"3,903 kcal/kg, 449 kcal/cup","__typename":"Markdown"},"__typename":"InfoGroupSection"},{"title":null,"usage":"GUARANTEED_ANALYSIS","content":{"content":"|Guaranteed Analysis||\n|---|---:|\n|Crude Protein|26.0% min|\n|Crude Fat|16.0% min|\n|Crude Fiber|4.0% max|\n|Moisture|12.0% max|\n|Linoleic Acid|1.5% min|\n|Eicosapentaenoic Acid (EPA)|0.1% min|\n|Docosahexaenoic Acid (DHA)|0.1% min|\n|Calcium (Ca)|1.0% min|\n|Phosphorus (P)|0.8% min|\n|Selenium (Se)|0.35 mg/kg min|\n|Vitamin A|15000 IU/kg min|\n|Vitamin E|460 IU/kg min|\n|Ascorbic Acid (Vitamin C)*|70 mg/kg min|\n|Glucosamine*|350 ppm min|\n|Omega-3 Fatty Acids*|0.75% min|\n|Omega-6 Fatty Acids*|1.6% min|","__typename":"Markdown"},"__typename":"InfoGroupSection"}],"__typename":"InfoGroup"},{"name":"Feeding Instructions","sections":[{"title":null,"usage":"FEEDING_INSTRUCTIONS","content":{"content":"|Weight|Daily Feeding (Cups)|\n|---|---|\n|3 - 12 lbs|1/3 - 1|\n|13 - 20 lbs|1 - 1 1/3|\n|21 - 35 lbs|1 1/3 - 2|\n|36 - 50 lbs|2 - 2 1/2|\n|51 - 75 lbs|2 1/2 - 3 1/4|\n|76 - 100 lbs|3 1/4 - 4|\n|Over 100 lbs|4 + 1/4 cup for each 10 lbs over 100 lbs|\n\nWe recommend that you keep your dog in ideal body condition and not allow your dog to become overweight. The exact amount of food your dog requires will need to be adjusted according to age, activity and environment. But a good place to start is with these guidelines for an average, active, adult dog fed once daily. Provide adequate fresh water in a clean container daily.","__typename":"Markdown"},"__typename":"InfoGroupSection"},{"title":"Transition Instructions","usage":"TRANSITION_INSTRUCTIONS","content":{"content":"Please allow 7-10 days to ease the transition from your dog's current food. Each day, simply feed a little less of the previous food and a little more Pro Plan until you're feeding Pro Plan exclusively. This gradual transition will help avoid dietary upsets.","__typename":"Markdown"},"__typename":"InfoGroupSection"}],"__typename":"InfoGroup"}],"isGiftCard":false,"isLiveFeed":false,"mapSavings":null,"offerPrice":"$77.48","partNumber":"101143","promotions":[{"id":11309,"__typename":"Promotion","helperText":"See Details for instructions to redeem","longDescription":"Offer valid for new Chewy customers only. Must add $49.00 worth of eligible items to cart and enter code WELCOME for discount to apply at checkout. Limit 1 use per order, limit 1 order per customer. Discount applied at checkout with qualifying purchase. Customer must have an account and be logged in to redeem and view all applicable promotions. Brand exclusions apply. Subject to Chewy terms and conditions. Valid while supplies last.","shortDescription":"New Customers Only: Spend $49+, get $20 off + free shipping with code WELCOME","promoHeadlineLong":null,"promoHeadlineShort":null,"isSmartshelfEligible":true,"mobilePromoTermDetailsUrl":null,"desktopPromoTermDetailsUrl":null,"accessibilityPromoTermDetails":null}],"aboutAuthor":null,"bundleItems":null,"bundleTheme":null,"description":"Tend to your furry friend’s skin and digestive health with Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Adult Dry Dog Food Formula. This high-protein dog food for adult dogs is formulated to nurture your sidekick’s sensitive skin and stomach. It features real, nutrient-rich salmon as the very first ingredient in a highly digestible recipe with rice and oatmeal. This dry dog food is fortified with prebiotic fiber for your pal’s digestive and immune health. It also contains omega-6 fatty acids and vitamin A to help nourish your cuddly companion’s skin and coat and omega-3 fatty acids to support healthy joints and mobility. Complete with antioxidants to bolster your dog’s immune system, Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Dry Adult Dog Food Formula has what your dog needs to help their skin and digestive health thrive.","disclaimers":null,"isLivePlant":false,"isPublished":true,"keyBenefits":["This high-protein dog food formula features real salmon as the first ingredient and is made without artificial colors or flavors.","Each serving delivers fish oil that’s rich in omega-3 fatty acids for joint health.","Sunflower oil is rich in omega-6 fatty acids to promote a healthy skin and coat.","Antioxidants bolster your dog’s healthy immune system.","Made with oatmeal, which is easily digestible and gentle on the digestive system, and a natural prebiotic fiber that nourishes specific intestinal bacteria for digestive health."],"mapEnforced":false,"maxQuantity":50,"seoMetaData":null,"isHealthCare":false,"isRestricted":false,"isSinglePill":false,"pbTransition":null,"perUnitPrice":"$2.59","specialNotes":{"content":null,"__typename":"Markdown"},"topPromotion":{"id":11309,"__typename":"Promotion","helperText":"See Details for instructions to redeem","longDescription":"Offer valid for new Chewy customers only. Must add $49.00 worth of eligible items to cart and enter code WELCOME for discount to apply at checkout. Limit 1 use per order, limit 1 order per customer. Discount applied at checkout with qualifying purchase. Customer must have an account and be logged in to redeem and view all applicable promotions. Brand exclusions apply. Subject to Chewy terms and conditions. Valid while supplies last.","shortDescription":"New Customers Only: Spend $49+, get $20 off + free shipping with code WELCOME","promoHeadlineLong":null,"promoHeadlineShort":null,"isSmartshelfEligible":true,"mobilePromoTermDetailsUrl":null,"desktopPromoTermDetailsUrl":null,"accessibilityPromoTermDetails":null},"autoshipPrice":"$73.61","isUnavailable":false,"numberOfUnits":30,"packageInsert":null,"prescriptions":null,"proposition65":null,"unitOfMeasure":"LBR","whatsIncluded":null,"bundleIncludes":null,"isDiscontinued":false,"isPersonalized":false,"isPrescription":false,"isRefrigerated":false,"advertisedPrice":"$77.48","dropshipMessage":null,"enhancedContent":null,"mapEnforcedText":null,"replacementItem":null,"shippingMessage":"**FREE 1-3 day delivery**","is3DCustomizable":false,"isBundleMultiSku":false,"promisedDelivery":{"zip":null,"city":null,"date":null,"__typename":"PromisedDelivery","isSkuEligible":false,"deliveryDuration":null,"isCutoffEligible":false,"isZipCodeEligible":false},"activeIngredients":null,"isAutoshipAllowed":true,"maximumPetWeights":[],"minimumPetWeights":[],"patientInfoSheets":null,"reviewsDisclaimer":{"showDisclaimer":false},"rxShippingMessage":null,"shippingTimeframe":"1-3 day","availabilityStatus":null,"inSheltersWishList":false,"strikeThroughPrice":"$79.99","manufacturerDetails":null,"possibleSideEffects":null,"specialNotesContent":null,"unitOfMeasureString":"lb","parentCatalogGroupId":[5128142,5128134,13321,13322,12811,12812,11728,11729,145046,2159222,11098,132958,11103,129950,12449,294,130214,139758,1838,5128126,100146,139702,122038,9977,8570],"strikeThroughSavings":"$2.51","topHeadlinePromotion":null,"defaultPrescribedItem":null,"descriptionAttributes":[{"name":"Packaging Type","values":[{"__ref":"AttributeValue:{\"id\":702939,\"value\":\"Bag\"}"}],"__typename":"Attribute"},{"name":"Made In","values":[{"__ref":"AttributeValue:{\"id\":733219,\"value\":\"United States\"}"}],"__typename":"Attribute"},{"name":"Sourced From","values":[{"__ref":"AttributeValue:{\"id\":733526,\"value\":\"Various\"}"}],"__typename":"Attribute"},{"name":"Lifestage","values":[{"__ref":"AttributeValue:{\"id\":10866294,\"value\":\"All Lifestages\"}"},{"__ref":"AttributeValue:{\"id\":9060,\"value\":\"Adult\"}"}],"__typename":"Attribute"},{"name":"Breed Size","values":[{"__ref":"AttributeValue:{\"id\":678846,\"value\":\"All Breeds\"}"}],"__typename":"Attribute"},{"name":"Food Form","values":[{"__ref":"AttributeValue:{\"id\":9069,\"value\":\"Dry Food\"}"}],"__typename":"Attribute"},{"name":"Special Diet","values":[{"__ref":"AttributeValue:{\"id\":662647,\"value\":\"Chicken-Free\"}"},{"__ref":"AttributeValue:{\"id\":84890,\"value\":\"High-Protein\"}"},{"__ref":"AttributeValue:{\"id\":9080,\"value\":\"Weight Control\"}"},{"__ref":"AttributeValue:{\"id\":14353,\"value\":\"No Corn No Wheat No Soy\"}"},{"__ref":"AttributeValue:{\"id\":1039619,\"value\":\"With Grain\"}"}],"__typename":"Attribute"}],"isEngraveCustomizable":false,"restrictedAvailability":[],"strikeThroughPriceType":"LIST","availabilityMessageLong":null,"foodAndDrugInteractions":null,"isEmbroiderCustomizable":false,"masterCatalogIdentifier":"m-dog-dry-food","strikeThroughSavingsPct":"3","availabilityMessageShort":null,"is2DEnhancedCustomizable":false,"loyaltyPromotionsMessage":null,"isPermanentlyDiscontinued":false,"personalizationAttributes":null,"allowEmailNotificationSignup":false,"featuredAttributePercentScores":{"Palatability":80,"Digestibility":81,"Ingredient Quality":83,"Nutritional Content":82},"attributes({\"identifier\":\"FreshRefrigerated\"})":[],"clinicOffers({\"offerRankingStrategy\":\"PRICE_PREFERRED\"})":null,"attributes({\"identifier\":\"PetType\",\"usage\":[\"DESCRIPTIVE\"]})":[{"id":382,"values":[{"__ref":"AttributeValue:{\"id\":9066,\"value\":\"Dog\"}"}],"__typename":"Attribute"}],"attributes({\"identifier\":\"pb-fresh\",\"usage\":[\"DESCRIPTIVE\"]})":[],"attributeValues({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":[{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Salmon & Rice\"}"},{"__ref":"AttributeValue:{\"id\":280062,\"value\":\"30-lb bag\"}"}],"attributes({\"identifier\":\"PrivateLabel\",\"usage\":[\"DESCRIPTIVE\"]})":[],"attributes({\"identifier\":\"b2b-eligible\",\"usage\":[\"DESCRIPTIVE\"]})":[],"attributes({\"identifier\":\"SKUSuppression\",\"usage\":[\"DESCRIPTIVE\"]})":[]},"Product:UHJvZHVjdDo1MjY3Ng==":{"id":"UHJvZHVjdDo1MjY3Ng==","mda":[{"id":777,"name":"Flavor","options":[{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Lamb & Oat Meal\"}"},{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Salmon & Rice\"}"},{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Turkey & Oat Meal\"}"}],"__typename":"MDA","isEnsemble":true,"manufacturerDetails":null},{"id":400,"name":"Size","options":[{"__ref":"AttributeValue:{\"id\":60061,\"value\":\"4-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":66258,\"value\":\"16-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":614635,\"value\":\"24-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":280062,\"value\":\"30-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":280050,\"value\":\"40-lb bag\"}"}],"__typename":"MDA","isEnsemble":false,"manufacturerDetails":null}],"name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food","slug":"purina-pro-plan-adult-sensitive-skin","rating":4.5064,"entryID":"52676","brandURL":"https://www.chewy.com/brands/purina-pro-plan-7434","__typename":"Product","isEnsemble":true,"partNumber":"67742","breadcrumbs":[{"id":"288","url":"https://www.chewy.com/b/dog-288","name":"Dog Supplies","__typename":"Breadcrumb"},{"id":"332","url":"https://www.chewy.com/b/food-332","name":"Dog Food","__typename":"Breadcrumb"},{"id":"294","url":"https://www.chewy.com/b/dry-food-294","name":"Dry Dog Food","__typename":"Breadcrumb"},{"id":"139718","url":"https://www.chewy.com/b/natural-dry-dog-food-139718","name":"Shop by Natural Ingredients","__typename":"Breadcrumb"},{"id":"11105","url":"https://www.chewy.com/b/high-protein-11105","name":"High-Protein","__typename":"Breadcrumb"}],"description":"Tend to your furry friend’s skin and digestive health with Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Adult Dry Dog Food Formula. This high-protein dog food for adult dogs is formulated to nurture your sidekick’s sensitive skin and stomach. It features real, nutrient-rich salmon as the very first ingredient in a highly digestible recipe with rice and oatmeal. This dry dog food is fortified with prebiotic fiber for your pal’s digestive and immune health. It also contains omega-6 fatty acids and vitamin A to help nourish your cuddly companion’s skin and coat and omega-3 fatty acids to support healthy joints and mobility. Complete with antioxidants to bolster your dog’s immune system, Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Dry Adult Dog Food Formula has what your dog needs to help their skin and digestive health thrive.","iconography":[{"name":"Chicken-Free","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-754c-776a-8000-a68f9d01b654.svg","__typename":"Icon"},{"name":"High-Protein","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-f906-7389-8000-c8ad6870776e.svg","__typename":"Icon"},{"name":"Weight Control","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792941-be89-7462-8000-89de6ef18766.svg","__typename":"Icon"},{"name":"No Corn No Wheat No Soy","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-7954-77bb-8000-9cbd7f68c457.svg","__typename":"Icon"},{"name":"Sensitive Digestion","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-223a-7281-8000-08d2cb2ac00d.svg","__typename":"Icon"},{"name":"Sensitive Skin","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-07d0-7567-8000-f7fca30026e1.svg","__typename":"Icon"},{"name":"Allergy Relief","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-ccb1-7cce-8000-1cdd6872fbe5.svg","__typename":"Icon"},{"name":"Digestive Health","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-b941-73aa-8000-1299ace3b6f1.svg","__typename":"Icon"},{"name":"Skin & Coat Health","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-151d-7ac7-8000-865513a593e7.svg","__typename":"Icon"},{"name":"Itch & Redness Remedy","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-b962-7d61-8000-c71e4e9752ab.svg","__typename":"Icon"},{"name":"All Lifestages","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-f040-7bde-8000-518bd894d719.svg","__typename":"Icon"},{"name":"All Breeds","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-e2bb-7b12-8000-c72f3477390b.svg","__typename":"Icon"}],"ratingCount":23686,"questionsCount":151,"manufacturerName":"Purina Pro Plan","ratingDistributions":[{"rating":1,"__typename":"RatingDistribution","ratingCount":1654,"ratingPercent":6.983},{"rating":2,"__typename":"RatingDistribution","ratingCount":605,"ratingPercent":2.5543},{"rating":3,"__typename":"RatingDistribution","ratingCount":790,"ratingPercent":3.3353},{"rating":4,"__typename":"RatingDistribution","ratingCount":1679,"ratingPercent":7.0886},{"rating":5,"__typename":"RatingDistribution","ratingCount":18958,"ratingPercent":80.0388}],"merchClassIdentifiers":["f2-science","f2-science-science-food","f2-science-science-food-dry-food"],"questions:{\"first\":4}":{"edges":[{"node":{"__ref":"Question:UXVlc3Rpb246ODcyMDUx"},"__typename":"QuestionEdge"},{"node":{"__ref":"Question:UXVlc3Rpb246OTU3OTAy"},"__typename":"QuestionEdge"},{"node":{"__ref":"Question:UXVlc3Rpb246OTY3NjYx"},"__typename":"QuestionEdge"},{"node":{"__ref":"Question:UXVlc3Rpb246MTEzNjUwNA=="},"cursor":"YXJyYXljb25uZWN0aW9uOjM=","__typename":"QuestionEdge"}],"pageInfo":{"endCursor":"YXJyYXljb25uZWN0aW9uOjM=","__typename":"PageInfo","hasNextPage":true,"startCursor":"","hasPreviousPage":false},"__typename":"QuestionConnection","totalCount":151},"items({\"includeEnsemble\":true})":[{"__ref":"Item:SXRlbToxMjk4MDk="},{"__ref":"Item:SXRlbToxMjk4MTE="},{"__ref":"Item:SXRlbToxMjk4MTA="},{"__ref":"Item:SXRlbTo3Njc3OTg="},{"__ref":"Item:SXRlbTo1MjY3OA=="},{"__ref":"Item:SXRlbTo1MjY3OQ=="},{"__ref":"Item:SXRlbToxMjg2NjY="},{"__ref":"Item:SXRlbToxODIwMDM="},{"__ref":"Item:SXRlbTo1MjY3Nw=="},{"__ref":"Item:SXRlbToxMjkwNjk="},{"__ref":"Item:SXRlbTozODIwNzA="},{"__ref":"Item:SXRlbToxMjkwNzA="},{"__ref":"Item:SXRlbTozODIwNjk="},{"__ref":"Item:SXRlbTo3Njc4MDY="},{"__ref":"Item:SXRlbToyOTgwNTQ="},{"__ref":"Item:SXRlbToyOTgwNTU="},{"__ref":"Item:SXRlbToyOTgwNTY="}],"attributes({\"identifier\":\"PetType\"})":[{"values":[{"__ref":"AttributeValue:{\"id\":9066,\"value\":\"Dog\"}"}],"__typename":"Attribute"}],"attributes({\"identifier\":\"DrugType\"})":[],"attributes({\"identifier\":\"ProductCategory\"})":[{"values":[{"__ref":"AttributeValue:{\"id\":775204,\"value\":\"Food\"}"}],"__typename":"Attribute"}],"attributes({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":[{"id":777,"name":"Flavor","values":[{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Salmon & Rice\"}"}],"__typename":"Attribute"},{"id":400,"name":"Size","values":[{"__ref":"AttributeValue:{\"id\":65302,\"value\":\"5-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":65303,\"value\":\"6-lb bag (Original)\"}"},{"__ref":"AttributeValue:{\"id\":66258,\"value\":\"16-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":1039560,\"value\":\"16-lb bag, bundle of 2\"}"},{"__ref":"AttributeValue:{\"id\":372372,\"value\":\"18-lb bag (Original)\"}"},{"__ref":"AttributeValue:{\"id\":280062,\"value\":\"30-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":1039548,\"value\":\"30-lb bag, bundle of 2\"}"},{"__ref":"AttributeValue:{\"id\":12926,\"value\":\"33-lb bag (Original)\"}"},{"__ref":"AttributeValue:{\"id\":430390,\"value\":\"41-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":60061,\"value\":\"4-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":280050,\"value\":\"40-lb bag\"}"}],"__typename":"Attribute"}]}}},"simple: Purina Pro Plan 30-lb salmon and rice":{"value":{"id":"128666","url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","gtin":"038100175526","unit":"lb","brand":"Purina Pro Plan","image":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg","price":77.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","images":["https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffce-aa8a-7b92-8000-55ebf9862cbf._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/06835ef1-04a3-7744-8000-b453865202bd._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa6-a1b3-75ba-8000-ce3bfaa8b1ed._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa6-816c-7aee-8000-e2155ccf0309._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa6-5dc2-7bc1-8000-86eef1c91470._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/06835ef4-b5e0-79f8-8000-c6512e0bd24a._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa5-ee23-76bb-8000-529371470fee._AC_SS600_V1_.jpg"],"rating":4.51,"currency":"USD","delivery":"1-3 day","in_stock":true,"variants":[{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129809","price":20.68,"title":"Purina Pro Plan Sensitive Skin & Sensitive Stomach Lamb & Oat Meal Formula Dog Food, 4-lb bag","entry_id":"129809","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Lamb & Oat Meal"},{"name":"Size","value":"4-lb bag"}],"part_number":"102301","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129811","price":77.48,"title":"Purina Pro Plan Sensitive Skin & Sensitive Stomach Lamb & Oat Meal Formula Dog Food, 24-lb bag","entry_id":"129811","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Lamb & Oat Meal"},{"name":"Size","value":"24-lb bag"}],"part_number":"102303","price_display":"$77.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129810","price":54.48,"title":"Purina Pro Plan Sensitive Skin & Sensitive Stomach Lamb & Oat Meal Formula Dog Food, 16-lb bag","entry_id":"129810","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Lamb & Oat Meal"},{"name":"Size","value":"16-lb bag"}],"part_number":"102302","price_display":"$54.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/767798","price":20.68,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 4-lb bag","entry_id":"767798","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"4-lb bag"}],"part_number":"767798","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/52678","price":48.99,"title":"Purina Pro Plan Focus Adult Sensitive Skin & Stomach Formula Dry Dog Food, 18-lb bag","entry_id":"52678","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"18-lb bag (Original)"}],"part_number":"67744","price_display":"$48.99","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/52679","price":73.39,"title":"Purina Pro Plan Focus Adult Sensitive Skin & Stomach Formula Dry Dog Food, 33-lb bag","entry_id":"52679","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"33-lb bag (Original)"}],"part_number":"67745","price_display":"$73.39","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","price":77.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","entry_id":"128666","in_stock":true,"selected":true,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"30-lb bag"}],"part_number":"101143","price_display":"$77.48","original_price":79.99,"original_price_display":"$79.99"},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/182003","price":91.58,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 41-lb bag","entry_id":"182003","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"41-lb bag"}],"part_number":"155239","price_display":"$91.58","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/52677","price":23.99,"title":"Purina Pro Plan Focus Adult Sensitive Skin & Stomach Formula Dry Dog Food, 6-lb bag","entry_id":"52677","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"6-lb bag (Original)"}],"part_number":"67743","price_display":"$23.99","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129069","price":20.68,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 5-lb bag","entry_id":"129069","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"5-lb bag"}],"part_number":"101552","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/382070","price":99.96,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 16-lb bag, bundle of 2","entry_id":"382070","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"16-lb bag, bundle of 2"}],"part_number":"355841","price_display":"$99.96","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129070","price":54.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 16-lb bag","entry_id":"129070","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"16-lb bag"}],"part_number":"101553","price_display":"$54.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/382069","price":131.96,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag, bundle of 2","entry_id":"382069","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"30-lb bag, bundle of 2"}],"part_number":"355840","price_display":"$131.96","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/767806","price":94.98,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 40-lb bag","entry_id":"767806","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"40-lb bag"}],"part_number":"767806","price_display":"$94.98","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/298054","price":20.68,"title":"Purina Pro Plan Sensitive Skin & Stomach Turkey & Oat Meal Dry Dog Food, 4-lb bag","entry_id":"298054","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Turkey & Oat Meal"},{"name":"Size","value":"4-lb bag"}],"part_number":"271633","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/298055","price":54.48,"title":"Purina Pro Plan Sensitive Skin & Stomach Turkey & Oat Meal Dry Dog Food, 16-lb bag","entry_id":"298055","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Turkey & Oat Meal"},{"name":"Size","value":"16-lb bag"}],"part_number":"271634","price_display":"$54.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/298056","price":77.48,"title":"Purina Pro Plan Sensitive Skin & Stomach Turkey & Oat Meal Dry Dog Food, 24-lb bag","entry_id":"298056","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Turkey & Oat Meal"},{"name":"Size","value":"24-lb bag"}],"part_number":"271635","price_display":"$77.48","original_price":null,"original_price_display":null}],"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"30-lb bag"}],"unit_price":2.59,"breadcrumbs":[{"url":"https://www.chewy.com/b/dog-288","name":"Dog Supplies"},{"url":"https://www.chewy.com/b/food-332","name":"Dog Food"},{"url":"https://www.chewy.com/b/dry-food-294","name":"Dry Dog Food"},{"url":"https://www.chewy.com/b/natural-dry-dog-food-139718","name":"Shop by Natural Ingredients"},{"url":"https://www.chewy.com/b/high-protein-11105","name":"High-Protein"}],"description":"Tend to your furry friend’s skin and digestive health with Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Adult Dry Dog Food Formula. This high-protein dog food for adult dogs is formulated to nurture your sidekick’s sensitive skin and stomach. It features real, nutrient-rich salmon as the very first ingredient in a highly digestible recipe with rice and oatmeal. This dry dog food is fortified with prebiotic fiber for your pal’s digestive and immune health. It also contains omega-6 fatty acids and vitamin A to help nourish your cuddly companion’s skin and coat and omega-3 fatty acids to support healthy joints and mobility. Complete with antioxidants to bolster your dog’s immune system, Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Dry Adult Dog Food Formula has what your dog needs to help their skin and digestive health thrive.","part_number":"101143","rating_count":23711,"price_display":"$77.48","product_title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food","autoship_price":73.61,"discount_label":"3%","original_price":79.99,"is_prescription":false,"unit_price_display":"$2.59/lb","autoship_price_display":"$73.61","original_price_display":"$79.99"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Chewy Product","description":"Read one Chewy product by URL or numeric id. The default mode is expert and returns the historical product cache. simple returns one snake_case product.\n\n**Credit cost:** 3 credits per call","operationId":"post-chewy-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Which product to read. A Chewy product URL such as https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666, or just the numeric id 128666. A search link, a keyword, or another website returns 400.","schema":{"type":"string","description":"Which product to read. A Chewy product URL such as https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666, or just the numeric id 128666. A search link, a keyword, or another website returns 400."}},{"name":"mode","in":"query","required":false,"description":"Which JSON to return. Default expert.\n\nexpert: the historical Apollo cache, with Chewy's own names (Item keys, advertisedPrice, __typename).\n\nsimple: one flat product. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash. variants lists other sizes when the page has them.\n\nUse simple for the short card. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400.","schema":{"type":"string","default":"expert","description":"Which JSON to return. Default expert.\n\nexpert: the historical Apollo cache, with Chewy's own names (Item keys, advertisedPrice, __typename).\n\nsimple: one flat product. Every key is lowercase snake_case. price is a number. price_display is that number in dollars, with no trailing dash. variants lists other sizes when the page has them.\n\nUse simple for the short card. Use expert for the full historical detail. Missing, empty, and expert are the same. Case does not matter. Any other value, including false, returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON.","schema":{"type":"boolean","description":"Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"Item:SXRlbToxMjg2NjY=":{"type":"object","properties":{"id":{"type":"string"},"gtin":{"type":"string"},"isRx":{"type":"boolean"},"name":{"type":"string"},"uses":{"nullable":true},"isNew":{"type":"boolean"},"images":{"type":"array","items":{"type":"object","properties":{"__typename":{"type":"string"},"url({\"autoCrop\":true,\"square\":600})":{"type":"string"}}}},"videos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"image":{"type":"string"},"thumbnail":{"type":"string"},"__typename":{"type":"string"}}}},"weight":{"type":"string"},"entryID":{"type":"string"},"inStock":{"type":"boolean"},"isFresh":{"type":"boolean"},"product":{"type":"object","properties":{"slug":{"type":"string"},"__ref":{"type":"string"},"__typename":{"type":"string"}}},"cautions":{"nullable":true},"isBundle":{"type":"boolean"},"isFrozen":{"type":"boolean"},"mapPrice":{"type":"string"},"fullImage":{"type":"object","properties":{"__typename":{"type":"string"},"url({\"autoCrop\":true,\"square\":144})":{"type":"string"},"url({\"autoCrop\":true,\"square\":1800})":{"type":"string"},"url({\"autoCrop\":true,\"maxWidth\":275})":{"type":"string"}}},"isInStock":{"type":"boolean"},"isVetDiet":{"type":"boolean"},"onSpecial":{"type":"boolean"},"__typename":{"type":"string"},"dimensions":{"nullable":true},"infoGroups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"usage":{"type":"string"},"content":{"type":"object","properties":{"content":{"type":"string"},"__typename":{"type":"string"}}},"__typename":{"type":"string"}}}},"__typename":{"type":"string"}}}},"isGiftCard":{"type":"boolean"},"isLiveFeed":{"type":"boolean"},"mapSavings":{"nullable":true},"offerPrice":{"type":"string"},"partNumber":{"type":"string"},"promotions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"__typename":{"type":"string"},"helperText":{"type":"string"},"longDescription":{"type":"string"},"shortDescription":{"type":"string"},"promoHeadlineLong":{"nullable":true},"promoHeadlineShort":{"nullable":true},"isSmartshelfEligible":{"type":"boolean"},"mobilePromoTermDetailsUrl":{"nullable":true},"desktopPromoTermDetailsUrl":{"nullable":true},"accessibilityPromoTermDetails":{"nullable":true}}}},"aboutAuthor":{"nullable":true},"bundleItems":{"nullable":true},"bundleTheme":{"nullable":true},"description":{"type":"string"},"disclaimers":{"nullable":true},"isLivePlant":{"type":"boolean"},"isPublished":{"type":"boolean"},"keyBenefits":{"type":"array","items":{"type":"string"}},"mapEnforced":{"type":"boolean"},"maxQuantity":{"type":"integer"},"seoMetaData":{"nullable":true},"isHealthCare":{"type":"boolean"},"isRestricted":{"type":"boolean"},"isSinglePill":{"type":"boolean"},"pbTransition":{"nullable":true},"perUnitPrice":{"type":"string"},"specialNotes":{"type":"object","properties":{"content":{"nullable":true},"__typename":{"type":"string"}}},"topPromotion":{"type":"object","properties":{"id":{"type":"integer"},"__typename":{"type":"string"},"helperText":{"type":"string"},"longDescription":{"type":"string"},"shortDescription":{"type":"string"},"promoHeadlineLong":{"nullable":true},"promoHeadlineShort":{"nullable":true},"isSmartshelfEligible":{"type":"boolean"},"mobilePromoTermDetailsUrl":{"nullable":true},"desktopPromoTermDetailsUrl":{"nullable":true},"accessibilityPromoTermDetails":{"nullable":true}}},"autoshipPrice":{"type":"string"},"isUnavailable":{"type":"boolean"},"numberOfUnits":{"type":"integer"},"packageInsert":{"nullable":true},"prescriptions":{"nullable":true},"proposition65":{"nullable":true},"unitOfMeasure":{"type":"string"},"whatsIncluded":{"nullable":true},"bundleIncludes":{"nullable":true},"isDiscontinued":{"type":"boolean"},"isPersonalized":{"type":"boolean"},"isPrescription":{"type":"boolean"},"isRefrigerated":{"type":"boolean"},"advertisedPrice":{"type":"string"},"dropshipMessage":{"nullable":true},"enhancedContent":{"nullable":true},"mapEnforcedText":{"nullable":true},"replacementItem":{"nullable":true},"shippingMessage":{"type":"string"},"is3DCustomizable":{"type":"boolean"},"isBundleMultiSku":{"type":"boolean"},"promisedDelivery":{"type":"object","properties":{"zip":{"nullable":true},"city":{"nullable":true},"date":{"nullable":true},"__typename":{"type":"string"},"isSkuEligible":{"type":"boolean"},"deliveryDuration":{"nullable":true},"isCutoffEligible":{"type":"boolean"},"isZipCodeEligible":{"type":"boolean"}}},"activeIngredients":{"nullable":true},"isAutoshipAllowed":{"type":"boolean"},"maximumPetWeights":{"type":"array","items":{}},"minimumPetWeights":{"type":"array","items":{}},"patientInfoSheets":{"nullable":true},"reviewsDisclaimer":{"type":"object","properties":{"showDisclaimer":{"type":"boolean"}}},"rxShippingMessage":{"nullable":true},"shippingTimeframe":{"type":"string"},"availabilityStatus":{"nullable":true},"inSheltersWishList":{"type":"boolean"},"strikeThroughPrice":{"type":"string"},"manufacturerDetails":{"nullable":true},"possibleSideEffects":{"nullable":true},"specialNotesContent":{"nullable":true},"unitOfMeasureString":{"type":"string"},"parentCatalogGroupId":{"type":"array","items":{"type":"integer"}},"strikeThroughSavings":{"type":"string"},"topHeadlinePromotion":{"nullable":true},"defaultPrescribedItem":{"nullable":true},"descriptionAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"isEngraveCustomizable":{"type":"boolean"},"restrictedAvailability":{"type":"array","items":{}},"strikeThroughPriceType":{"type":"string"},"availabilityMessageLong":{"nullable":true},"foodAndDrugInteractions":{"nullable":true},"isEmbroiderCustomizable":{"type":"boolean"},"masterCatalogIdentifier":{"type":"string"},"strikeThroughSavingsPct":{"type":"string"},"availabilityMessageShort":{"nullable":true},"is2DEnhancedCustomizable":{"type":"boolean"},"loyaltyPromotionsMessage":{"nullable":true},"isPermanentlyDiscontinued":{"type":"boolean"},"personalizationAttributes":{"nullable":true},"allowEmailNotificationSignup":{"type":"boolean"},"featuredAttributePercentScores":{"type":"object","properties":{"Palatability":{"type":"integer"},"Digestibility":{"type":"integer"},"Ingredient Quality":{"type":"integer"},"Nutritional Content":{"type":"integer"}}},"attributes({\"identifier\":\"FreshRefrigerated\"})":{"type":"array","items":{}},"clinicOffers({\"offerRankingStrategy\":\"PRICE_PREFERRED\"})":{"nullable":true},"attributes({\"identifier\":\"PetType\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"attributes({\"identifier\":\"pb-fresh\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}},"attributeValues({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"attributes({\"identifier\":\"PrivateLabel\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}},"attributes({\"identifier\":\"b2b-eligible\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}},"attributes({\"identifier\":\"SKUSuppression\",\"usage\":[\"DESCRIPTIVE\"]})":{"type":"array","items":{}}}},"Product:UHJvZHVjdDo1MjY3Ng==":{"type":"object","properties":{"id":{"type":"string"},"mda":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"},"isEnsemble":{"type":"boolean"},"manufacturerDetails":{"nullable":true}}}},"name":{"type":"string"},"slug":{"type":"string"},"rating":{"type":"number"},"entryID":{"type":"string"},"brandURL":{"type":"string"},"__typename":{"type":"string"},"isEnsemble":{"type":"boolean"},"partNumber":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"__typename":{"type":"string"}}}},"description":{"type":"string"},"iconography":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"__typename":{"type":"string"}}}},"ratingCount":{"type":"integer"},"questionsCount":{"type":"integer"},"manufacturerName":{"type":"string"},"ratingDistributions":{"type":"array","items":{"type":"object","properties":{"rating":{"type":"integer"},"__typename":{"type":"string"},"ratingCount":{"type":"integer"},"ratingPercent":{"type":"number"}}}},"merchClassIdentifiers":{"type":"array","items":{"type":"string"}},"questions:{\"first\":4}":{"type":"object","properties":{"edges":{"type":"array","items":{"type":"object","properties":{"node":{"type":"object","properties":{"__ref":{"type":"string"}}},"__typename":{"type":"string"}}}},"pageInfo":{"type":"object","properties":{"endCursor":{"type":"string"},"__typename":{"type":"string"},"hasNextPage":{"type":"boolean"},"startCursor":{"type":"string"},"hasPreviousPage":{"type":"boolean"}}},"__typename":{"type":"string"},"totalCount":{"type":"integer"}}},"items({\"includeEnsemble\":true})":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"attributes({\"identifier\":\"PetType\"})":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"attributes({\"identifier\":\"DrugType\"})":{"type":"array","items":{}},"attributes({\"identifier\":\"ProductCategory\"})":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}},"attributes({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"__ref":{"type":"string"}}}},"__typename":{"type":"string"}}}}}}}},"examples":{"expert (default): Purina Pro Plan 30-lb salmon and rice":{"value":{"Item:SXRlbToxMjg2NjY=":{"id":"SXRlbToxMjg2NjY=","gtin":"038100175526","isRx":false,"name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","uses":null,"isNew":false,"images":[{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-aa8a-7b92-8000-55ebf9862cbf._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/06835ef1-04a3-7744-8000-b453865202bd._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa6-a1b3-75ba-8000-ce3bfaa8b1ed._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa6-816c-7aee-8000-e2155ccf0309._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa6-5dc2-7bc1-8000-86eef1c91470._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/06835ef4-b5e0-79f8-8000-c6512e0bd24a._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa5-ee23-76bb-8000-529371470fee._AC_SS600_V1_.jpg"},{"__typename":"Image","url({\"autoCrop\":true,\"square\":600})":"https://image.chewy.com/catalog/general/images/moe/0671ffa5-cd60-7558-8000-33058e4394e6._AC_SS600_V1_.jpg"}],"videos":[{"url":"https://fast.wistia.com/medias/ggqjn4l7f3","image":"https://embed-ssl.wistia.com/deliveries/47b887565486f8434309c72dc24488d0.jpg?image_crop_resized=528x297","thumbnail":"https://fast.wistia.com/embed/medias/ggqjn4l7f3/swatch","__typename":"Video"},{"url":"https://fast.wistia.com/medias/mznrapwfi1","image":"https://embed-ssl.wistia.com/deliveries/76c99685dc5c2df732317673e82f6f9c0fb0d930.jpg?image_crop_resized=528x297","thumbnail":"https://fast.wistia.com/embed/medias/mznrapwfi1/swatch","__typename":"Video"}],"weight":"30 pounds","entryID":"128666","inStock":true,"isFresh":false,"product":{"slug":"purina-pro-plan-adult-sensitive-skin","__ref":"Product:UHJvZHVjdDo1MjY3Ng==","__typename":"Product"},"cautions":null,"isBundle":false,"isFrozen":false,"mapPrice":"$77.48","fullImage":{"__typename":"Image","url({\"autoCrop\":true,\"square\":144})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS144_V1_.jpg","url({\"autoCrop\":true,\"square\":1800})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS1800_V1_.jpg","url({\"autoCrop\":true,\"maxWidth\":275})":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SX275_V1_.jpg"},"isInStock":true,"isVetDiet":false,"onSpecial":true,"__typename":"Item","dimensions":null,"infoGroups":[{"name":"Nutritional Info","sections":[{"title":"Ingredients","usage":"INGREDIENTS","content":{"content":"Salmon, Rice, Barley, Canola Meal, Oat Meal, Fish Meal, Salmon Meal, Beef Fat Preserved With Mixed-Tocopherols, Dried Yeast, Natural Flavor, Sunflower Oil, Fish Oil, Dried Chicory Root, Calcium Carbonate, Salt, Potassium Chloride, L-Lysine Monohydrochloride, VITAMINS [Vitamin E Supplement, Niacin (Vitamin B-3), Vitamin A Supplement, Calcium Pantothenate (Vitamin B-5), Thiamine Mononitrate (Vitamin B-1), Vitamin B-12 Supplement, Riboflavin Supplement (Vitamin B-2), Pyridoxine Hydrochloride, Folic Acid (Vitamin B-9), Menadione Sodium Bisulfite Complex (Vitamin K), Biotin (Vitamin B-7), Vitamin D-3 Supplement], Taurine, MINERALS [Zinc Sulfate, Ferrous Sulfate, Manganese Sulfate, Copper Sulfate, Calcium Iodate, Sodium Selenite], Dl-Methionine, Choline Chloride, L-Ascorbyl-2-Polyphosphate (Vitamin C). M444922","__typename":"Markdown"},"__typename":"InfoGroupSection"},{"title":"Caloric Content","usage":"CALORIC_CONTENT","content":{"content":"3,903 kcal/kg, 449 kcal/cup","__typename":"Markdown"},"__typename":"InfoGroupSection"},{"title":null,"usage":"GUARANTEED_ANALYSIS","content":{"content":"|Guaranteed Analysis||\n|---|---:|\n|Crude Protein|26.0% min|\n|Crude Fat|16.0% min|\n|Crude Fiber|4.0% max|\n|Moisture|12.0% max|\n|Linoleic Acid|1.5% min|\n|Eicosapentaenoic Acid (EPA)|0.1% min|\n|Docosahexaenoic Acid (DHA)|0.1% min|\n|Calcium (Ca)|1.0% min|\n|Phosphorus (P)|0.8% min|\n|Selenium (Se)|0.35 mg/kg min|\n|Vitamin A|15000 IU/kg min|\n|Vitamin E|460 IU/kg min|\n|Ascorbic Acid (Vitamin C)*|70 mg/kg min|\n|Glucosamine*|350 ppm min|\n|Omega-3 Fatty Acids*|0.75% min|\n|Omega-6 Fatty Acids*|1.6% min|","__typename":"Markdown"},"__typename":"InfoGroupSection"}],"__typename":"InfoGroup"},{"name":"Feeding Instructions","sections":[{"title":null,"usage":"FEEDING_INSTRUCTIONS","content":{"content":"|Weight|Daily Feeding (Cups)|\n|---|---|\n|3 - 12 lbs|1/3 - 1|\n|13 - 20 lbs|1 - 1 1/3|\n|21 - 35 lbs|1 1/3 - 2|\n|36 - 50 lbs|2 - 2 1/2|\n|51 - 75 lbs|2 1/2 - 3 1/4|\n|76 - 100 lbs|3 1/4 - 4|\n|Over 100 lbs|4 + 1/4 cup for each 10 lbs over 100 lbs|\n\nWe recommend that you keep your dog in ideal body condition and not allow your dog to become overweight. The exact amount of food your dog requires will need to be adjusted according to age, activity and environment. But a good place to start is with these guidelines for an average, active, adult dog fed once daily. Provide adequate fresh water in a clean container daily.","__typename":"Markdown"},"__typename":"InfoGroupSection"},{"title":"Transition Instructions","usage":"TRANSITION_INSTRUCTIONS","content":{"content":"Please allow 7-10 days to ease the transition from your dog's current food. Each day, simply feed a little less of the previous food and a little more Pro Plan until you're feeding Pro Plan exclusively. This gradual transition will help avoid dietary upsets.","__typename":"Markdown"},"__typename":"InfoGroupSection"}],"__typename":"InfoGroup"}],"isGiftCard":false,"isLiveFeed":false,"mapSavings":null,"offerPrice":"$77.48","partNumber":"101143","promotions":[{"id":11309,"__typename":"Promotion","helperText":"See Details for instructions to redeem","longDescription":"Offer valid for new Chewy customers only. Must add $49.00 worth of eligible items to cart and enter code WELCOME for discount to apply at checkout. Limit 1 use per order, limit 1 order per customer. Discount applied at checkout with qualifying purchase. Customer must have an account and be logged in to redeem and view all applicable promotions. Brand exclusions apply. Subject to Chewy terms and conditions. Valid while supplies last.","shortDescription":"New Customers Only: Spend $49+, get $20 off + free shipping with code WELCOME","promoHeadlineLong":null,"promoHeadlineShort":null,"isSmartshelfEligible":true,"mobilePromoTermDetailsUrl":null,"desktopPromoTermDetailsUrl":null,"accessibilityPromoTermDetails":null}],"aboutAuthor":null,"bundleItems":null,"bundleTheme":null,"description":"Tend to your furry friend’s skin and digestive health with Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Adult Dry Dog Food Formula. This high-protein dog food for adult dogs is formulated to nurture your sidekick’s sensitive skin and stomach. It features real, nutrient-rich salmon as the very first ingredient in a highly digestible recipe with rice and oatmeal. This dry dog food is fortified with prebiotic fiber for your pal’s digestive and immune health. It also contains omega-6 fatty acids and vitamin A to help nourish your cuddly companion’s skin and coat and omega-3 fatty acids to support healthy joints and mobility. Complete with antioxidants to bolster your dog’s immune system, Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Dry Adult Dog Food Formula has what your dog needs to help their skin and digestive health thrive.","disclaimers":null,"isLivePlant":false,"isPublished":true,"keyBenefits":["This high-protein dog food formula features real salmon as the first ingredient and is made without artificial colors or flavors.","Each serving delivers fish oil that’s rich in omega-3 fatty acids for joint health.","Sunflower oil is rich in omega-6 fatty acids to promote a healthy skin and coat.","Antioxidants bolster your dog’s healthy immune system.","Made with oatmeal, which is easily digestible and gentle on the digestive system, and a natural prebiotic fiber that nourishes specific intestinal bacteria for digestive health."],"mapEnforced":false,"maxQuantity":50,"seoMetaData":null,"isHealthCare":false,"isRestricted":false,"isSinglePill":false,"pbTransition":null,"perUnitPrice":"$2.59","specialNotes":{"content":null,"__typename":"Markdown"},"topPromotion":{"id":11309,"__typename":"Promotion","helperText":"See Details for instructions to redeem","longDescription":"Offer valid for new Chewy customers only. Must add $49.00 worth of eligible items to cart and enter code WELCOME for discount to apply at checkout. Limit 1 use per order, limit 1 order per customer. Discount applied at checkout with qualifying purchase. Customer must have an account and be logged in to redeem and view all applicable promotions. Brand exclusions apply. Subject to Chewy terms and conditions. Valid while supplies last.","shortDescription":"New Customers Only: Spend $49+, get $20 off + free shipping with code WELCOME","promoHeadlineLong":null,"promoHeadlineShort":null,"isSmartshelfEligible":true,"mobilePromoTermDetailsUrl":null,"desktopPromoTermDetailsUrl":null,"accessibilityPromoTermDetails":null},"autoshipPrice":"$73.61","isUnavailable":false,"numberOfUnits":30,"packageInsert":null,"prescriptions":null,"proposition65":null,"unitOfMeasure":"LBR","whatsIncluded":null,"bundleIncludes":null,"isDiscontinued":false,"isPersonalized":false,"isPrescription":false,"isRefrigerated":false,"advertisedPrice":"$77.48","dropshipMessage":null,"enhancedContent":null,"mapEnforcedText":null,"replacementItem":null,"shippingMessage":"**FREE 1-3 day delivery**","is3DCustomizable":false,"isBundleMultiSku":false,"promisedDelivery":{"zip":null,"city":null,"date":null,"__typename":"PromisedDelivery","isSkuEligible":false,"deliveryDuration":null,"isCutoffEligible":false,"isZipCodeEligible":false},"activeIngredients":null,"isAutoshipAllowed":true,"maximumPetWeights":[],"minimumPetWeights":[],"patientInfoSheets":null,"reviewsDisclaimer":{"showDisclaimer":false},"rxShippingMessage":null,"shippingTimeframe":"1-3 day","availabilityStatus":null,"inSheltersWishList":false,"strikeThroughPrice":"$79.99","manufacturerDetails":null,"possibleSideEffects":null,"specialNotesContent":null,"unitOfMeasureString":"lb","parentCatalogGroupId":[5128142,5128134,13321,13322,12811,12812,11728,11729,145046,2159222,11098,132958,11103,129950,12449,294,130214,139758,1838,5128126,100146,139702,122038,9977,8570],"strikeThroughSavings":"$2.51","topHeadlinePromotion":null,"defaultPrescribedItem":null,"descriptionAttributes":[{"name":"Packaging Type","values":[{"__ref":"AttributeValue:{\"id\":702939,\"value\":\"Bag\"}"}],"__typename":"Attribute"},{"name":"Made In","values":[{"__ref":"AttributeValue:{\"id\":733219,\"value\":\"United States\"}"}],"__typename":"Attribute"},{"name":"Sourced From","values":[{"__ref":"AttributeValue:{\"id\":733526,\"value\":\"Various\"}"}],"__typename":"Attribute"},{"name":"Lifestage","values":[{"__ref":"AttributeValue:{\"id\":10866294,\"value\":\"All Lifestages\"}"},{"__ref":"AttributeValue:{\"id\":9060,\"value\":\"Adult\"}"}],"__typename":"Attribute"},{"name":"Breed Size","values":[{"__ref":"AttributeValue:{\"id\":678846,\"value\":\"All Breeds\"}"}],"__typename":"Attribute"},{"name":"Food Form","values":[{"__ref":"AttributeValue:{\"id\":9069,\"value\":\"Dry Food\"}"}],"__typename":"Attribute"},{"name":"Special Diet","values":[{"__ref":"AttributeValue:{\"id\":662647,\"value\":\"Chicken-Free\"}"},{"__ref":"AttributeValue:{\"id\":84890,\"value\":\"High-Protein\"}"},{"__ref":"AttributeValue:{\"id\":9080,\"value\":\"Weight Control\"}"},{"__ref":"AttributeValue:{\"id\":14353,\"value\":\"No Corn No Wheat No Soy\"}"},{"__ref":"AttributeValue:{\"id\":1039619,\"value\":\"With Grain\"}"}],"__typename":"Attribute"}],"isEngraveCustomizable":false,"restrictedAvailability":[],"strikeThroughPriceType":"LIST","availabilityMessageLong":null,"foodAndDrugInteractions":null,"isEmbroiderCustomizable":false,"masterCatalogIdentifier":"m-dog-dry-food","strikeThroughSavingsPct":"3","availabilityMessageShort":null,"is2DEnhancedCustomizable":false,"loyaltyPromotionsMessage":null,"isPermanentlyDiscontinued":false,"personalizationAttributes":null,"allowEmailNotificationSignup":false,"featuredAttributePercentScores":{"Palatability":80,"Digestibility":81,"Ingredient Quality":83,"Nutritional Content":82},"attributes({\"identifier\":\"FreshRefrigerated\"})":[],"clinicOffers({\"offerRankingStrategy\":\"PRICE_PREFERRED\"})":null,"attributes({\"identifier\":\"PetType\",\"usage\":[\"DESCRIPTIVE\"]})":[{"id":382,"values":[{"__ref":"AttributeValue:{\"id\":9066,\"value\":\"Dog\"}"}],"__typename":"Attribute"}],"attributes({\"identifier\":\"pb-fresh\",\"usage\":[\"DESCRIPTIVE\"]})":[],"attributeValues({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":[{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Salmon & Rice\"}"},{"__ref":"AttributeValue:{\"id\":280062,\"value\":\"30-lb bag\"}"}],"attributes({\"identifier\":\"PrivateLabel\",\"usage\":[\"DESCRIPTIVE\"]})":[],"attributes({\"identifier\":\"b2b-eligible\",\"usage\":[\"DESCRIPTIVE\"]})":[],"attributes({\"identifier\":\"SKUSuppression\",\"usage\":[\"DESCRIPTIVE\"]})":[]},"Product:UHJvZHVjdDo1MjY3Ng==":{"id":"UHJvZHVjdDo1MjY3Ng==","mda":[{"id":777,"name":"Flavor","options":[{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Lamb & Oat Meal\"}"},{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Salmon & Rice\"}"},{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Turkey & Oat Meal\"}"}],"__typename":"MDA","isEnsemble":true,"manufacturerDetails":null},{"id":400,"name":"Size","options":[{"__ref":"AttributeValue:{\"id\":60061,\"value\":\"4-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":66258,\"value\":\"16-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":614635,\"value\":\"24-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":280062,\"value\":\"30-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":280050,\"value\":\"40-lb bag\"}"}],"__typename":"MDA","isEnsemble":false,"manufacturerDetails":null}],"name":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food","slug":"purina-pro-plan-adult-sensitive-skin","rating":4.5064,"entryID":"52676","brandURL":"https://www.chewy.com/brands/purina-pro-plan-7434","__typename":"Product","isEnsemble":true,"partNumber":"67742","breadcrumbs":[{"id":"288","url":"https://www.chewy.com/b/dog-288","name":"Dog Supplies","__typename":"Breadcrumb"},{"id":"332","url":"https://www.chewy.com/b/food-332","name":"Dog Food","__typename":"Breadcrumb"},{"id":"294","url":"https://www.chewy.com/b/dry-food-294","name":"Dry Dog Food","__typename":"Breadcrumb"},{"id":"139718","url":"https://www.chewy.com/b/natural-dry-dog-food-139718","name":"Shop by Natural Ingredients","__typename":"Breadcrumb"},{"id":"11105","url":"https://www.chewy.com/b/high-protein-11105","name":"High-Protein","__typename":"Breadcrumb"}],"description":"Tend to your furry friend’s skin and digestive health with Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Adult Dry Dog Food Formula. This high-protein dog food for adult dogs is formulated to nurture your sidekick’s sensitive skin and stomach. It features real, nutrient-rich salmon as the very first ingredient in a highly digestible recipe with rice and oatmeal. This dry dog food is fortified with prebiotic fiber for your pal’s digestive and immune health. It also contains omega-6 fatty acids and vitamin A to help nourish your cuddly companion’s skin and coat and omega-3 fatty acids to support healthy joints and mobility. Complete with antioxidants to bolster your dog’s immune system, Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Dry Adult Dog Food Formula has what your dog needs to help their skin and digestive health thrive.","iconography":[{"name":"Chicken-Free","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-754c-776a-8000-a68f9d01b654.svg","__typename":"Icon"},{"name":"High-Protein","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-f906-7389-8000-c8ad6870776e.svg","__typename":"Icon"},{"name":"Weight Control","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792941-be89-7462-8000-89de6ef18766.svg","__typename":"Icon"},{"name":"No Corn No Wheat No Soy","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-7954-77bb-8000-9cbd7f68c457.svg","__typename":"Icon"},{"name":"Sensitive Digestion","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-223a-7281-8000-08d2cb2ac00d.svg","__typename":"Icon"},{"name":"Sensitive Skin","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-07d0-7567-8000-f7fca30026e1.svg","__typename":"Icon"},{"name":"Allergy Relief","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-ccb1-7cce-8000-1cdd6872fbe5.svg","__typename":"Icon"},{"name":"Digestive Health","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-b941-73aa-8000-1299ace3b6f1.svg","__typename":"Icon"},{"name":"Skin & Coat Health","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-151d-7ac7-8000-865513a593e7.svg","__typename":"Icon"},{"name":"Itch & Redness Remedy","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792942-b962-7d61-8000-c71e4e9752ab.svg","__typename":"Icon"},{"name":"All Lifestages","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-f040-7bde-8000-518bd894d719.svg","__typename":"Icon"},{"name":"All Breeds","image":"https://image.chewy.com/catalog/cms/logos/attribute-icons/06792943-e2bb-7b12-8000-c72f3477390b.svg","__typename":"Icon"}],"ratingCount":23686,"questionsCount":151,"manufacturerName":"Purina Pro Plan","ratingDistributions":[{"rating":1,"__typename":"RatingDistribution","ratingCount":1654,"ratingPercent":6.983},{"rating":2,"__typename":"RatingDistribution","ratingCount":605,"ratingPercent":2.5543},{"rating":3,"__typename":"RatingDistribution","ratingCount":790,"ratingPercent":3.3353},{"rating":4,"__typename":"RatingDistribution","ratingCount":1679,"ratingPercent":7.0886},{"rating":5,"__typename":"RatingDistribution","ratingCount":18958,"ratingPercent":80.0388}],"merchClassIdentifiers":["f2-science","f2-science-science-food","f2-science-science-food-dry-food"],"questions:{\"first\":4}":{"edges":[{"node":{"__ref":"Question:UXVlc3Rpb246ODcyMDUx"},"__typename":"QuestionEdge"},{"node":{"__ref":"Question:UXVlc3Rpb246OTU3OTAy"},"__typename":"QuestionEdge"},{"node":{"__ref":"Question:UXVlc3Rpb246OTY3NjYx"},"__typename":"QuestionEdge"},{"node":{"__ref":"Question:UXVlc3Rpb246MTEzNjUwNA=="},"cursor":"YXJyYXljb25uZWN0aW9uOjM=","__typename":"QuestionEdge"}],"pageInfo":{"endCursor":"YXJyYXljb25uZWN0aW9uOjM=","__typename":"PageInfo","hasNextPage":true,"startCursor":"","hasPreviousPage":false},"__typename":"QuestionConnection","totalCount":151},"items({\"includeEnsemble\":true})":[{"__ref":"Item:SXRlbToxMjk4MDk="},{"__ref":"Item:SXRlbToxMjk4MTE="},{"__ref":"Item:SXRlbToxMjk4MTA="},{"__ref":"Item:SXRlbTo3Njc3OTg="},{"__ref":"Item:SXRlbTo1MjY3OA=="},{"__ref":"Item:SXRlbTo1MjY3OQ=="},{"__ref":"Item:SXRlbToxMjg2NjY="},{"__ref":"Item:SXRlbToxODIwMDM="},{"__ref":"Item:SXRlbTo1MjY3Nw=="},{"__ref":"Item:SXRlbToxMjkwNjk="},{"__ref":"Item:SXRlbTozODIwNzA="},{"__ref":"Item:SXRlbToxMjkwNzA="},{"__ref":"Item:SXRlbTozODIwNjk="},{"__ref":"Item:SXRlbTo3Njc4MDY="},{"__ref":"Item:SXRlbToyOTgwNTQ="},{"__ref":"Item:SXRlbToyOTgwNTU="},{"__ref":"Item:SXRlbToyOTgwNTY="}],"attributes({\"identifier\":\"PetType\"})":[{"values":[{"__ref":"AttributeValue:{\"id\":9066,\"value\":\"Dog\"}"}],"__typename":"Attribute"}],"attributes({\"identifier\":\"DrugType\"})":[],"attributes({\"identifier\":\"ProductCategory\"})":[{"values":[{"__ref":"AttributeValue:{\"id\":775204,\"value\":\"Food\"}"}],"__typename":"Attribute"}],"attributes({\"includeEnsemble\":true,\"usage\":[\"DEFINING\"]})":[{"id":777,"name":"Flavor","values":[{"__ref":"AttributeValue:{\"id\":null,\"value\":\"Salmon & Rice\"}"}],"__typename":"Attribute"},{"id":400,"name":"Size","values":[{"__ref":"AttributeValue:{\"id\":65302,\"value\":\"5-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":65303,\"value\":\"6-lb bag (Original)\"}"},{"__ref":"AttributeValue:{\"id\":66258,\"value\":\"16-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":1039560,\"value\":\"16-lb bag, bundle of 2\"}"},{"__ref":"AttributeValue:{\"id\":372372,\"value\":\"18-lb bag (Original)\"}"},{"__ref":"AttributeValue:{\"id\":280062,\"value\":\"30-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":1039548,\"value\":\"30-lb bag, bundle of 2\"}"},{"__ref":"AttributeValue:{\"id\":12926,\"value\":\"33-lb bag (Original)\"}"},{"__ref":"AttributeValue:{\"id\":430390,\"value\":\"41-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":60061,\"value\":\"4-lb bag\"}"},{"__ref":"AttributeValue:{\"id\":280050,\"value\":\"40-lb bag\"}"}],"__typename":"Attribute"}]}}},"simple: Purina Pro Plan 30-lb salmon and rice":{"value":{"id":"128666","url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","gtin":"038100175526","unit":"lb","brand":"Purina Pro Plan","image":"https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg","price":77.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","images":["https://image.chewy.com/catalog/general/images/moe/0671ffce-cb9e-7b85-8000-c4f526193d1c._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffce-aa8a-7b92-8000-55ebf9862cbf._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/06835ef1-04a3-7744-8000-b453865202bd._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa6-a1b3-75ba-8000-ce3bfaa8b1ed._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa6-816c-7aee-8000-e2155ccf0309._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa6-5dc2-7bc1-8000-86eef1c91470._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/06835ef4-b5e0-79f8-8000-c6512e0bd24a._AC_SS600_V1_.jpg","https://image.chewy.com/catalog/general/images/moe/0671ffa5-ee23-76bb-8000-529371470fee._AC_SS600_V1_.jpg"],"rating":4.51,"currency":"USD","delivery":"1-3 day","in_stock":true,"variants":[{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129809","price":20.68,"title":"Purina Pro Plan Sensitive Skin & Sensitive Stomach Lamb & Oat Meal Formula Dog Food, 4-lb bag","entry_id":"129809","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Lamb & Oat Meal"},{"name":"Size","value":"4-lb bag"}],"part_number":"102301","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129811","price":77.48,"title":"Purina Pro Plan Sensitive Skin & Sensitive Stomach Lamb & Oat Meal Formula Dog Food, 24-lb bag","entry_id":"129811","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Lamb & Oat Meal"},{"name":"Size","value":"24-lb bag"}],"part_number":"102303","price_display":"$77.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129810","price":54.48,"title":"Purina Pro Plan Sensitive Skin & Sensitive Stomach Lamb & Oat Meal Formula Dog Food, 16-lb bag","entry_id":"129810","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Lamb & Oat Meal"},{"name":"Size","value":"16-lb bag"}],"part_number":"102302","price_display":"$54.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/767798","price":20.68,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 4-lb bag","entry_id":"767798","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"4-lb bag"}],"part_number":"767798","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/52678","price":48.99,"title":"Purina Pro Plan Focus Adult Sensitive Skin & Stomach Formula Dry Dog Food, 18-lb bag","entry_id":"52678","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"18-lb bag (Original)"}],"part_number":"67744","price_display":"$48.99","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/52679","price":73.39,"title":"Purina Pro Plan Focus Adult Sensitive Skin & Stomach Formula Dry Dog Food, 33-lb bag","entry_id":"52679","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"33-lb bag (Original)"}],"part_number":"67745","price_display":"$73.39","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666","price":77.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag","entry_id":"128666","in_stock":true,"selected":true,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"30-lb bag"}],"part_number":"101143","price_display":"$77.48","original_price":79.99,"original_price_display":"$79.99"},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/182003","price":91.58,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 41-lb bag","entry_id":"182003","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"41-lb bag"}],"part_number":"155239","price_display":"$91.58","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/52677","price":23.99,"title":"Purina Pro Plan Focus Adult Sensitive Skin & Stomach Formula Dry Dog Food, 6-lb bag","entry_id":"52677","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"6-lb bag (Original)"}],"part_number":"67743","price_display":"$23.99","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129069","price":20.68,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 5-lb bag","entry_id":"129069","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"5-lb bag"}],"part_number":"101552","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/382070","price":99.96,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 16-lb bag, bundle of 2","entry_id":"382070","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"16-lb bag, bundle of 2"}],"part_number":"355841","price_display":"$99.96","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/129070","price":54.48,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 16-lb bag","entry_id":"129070","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"16-lb bag"}],"part_number":"101553","price_display":"$54.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/382069","price":131.96,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 30-lb bag, bundle of 2","entry_id":"382069","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"30-lb bag, bundle of 2"}],"part_number":"355840","price_display":"$131.96","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/767806","price":94.98,"title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food, 40-lb bag","entry_id":"767806","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"40-lb bag"}],"part_number":"767806","price_display":"$94.98","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/298054","price":20.68,"title":"Purina Pro Plan Sensitive Skin & Stomach Turkey & Oat Meal Dry Dog Food, 4-lb bag","entry_id":"298054","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Turkey & Oat Meal"},{"name":"Size","value":"4-lb bag"}],"part_number":"271633","price_display":"$20.68","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/298055","price":54.48,"title":"Purina Pro Plan Sensitive Skin & Stomach Turkey & Oat Meal Dry Dog Food, 16-lb bag","entry_id":"298055","in_stock":false,"selected":false,"attributes":[{"name":"Flavor","value":"Turkey & Oat Meal"},{"name":"Size","value":"16-lb bag"}],"part_number":"271634","price_display":"$54.48","original_price":null,"original_price_display":null},{"url":"https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/298056","price":77.48,"title":"Purina Pro Plan Sensitive Skin & Stomach Turkey & Oat Meal Dry Dog Food, 24-lb bag","entry_id":"298056","in_stock":true,"selected":false,"attributes":[{"name":"Flavor","value":"Turkey & Oat Meal"},{"name":"Size","value":"24-lb bag"}],"part_number":"271635","price_display":"$77.48","original_price":null,"original_price_display":null}],"attributes":[{"name":"Flavor","value":"Salmon & Rice"},{"name":"Size","value":"30-lb bag"}],"unit_price":2.59,"breadcrumbs":[{"url":"https://www.chewy.com/b/dog-288","name":"Dog Supplies"},{"url":"https://www.chewy.com/b/food-332","name":"Dog Food"},{"url":"https://www.chewy.com/b/dry-food-294","name":"Dry Dog Food"},{"url":"https://www.chewy.com/b/natural-dry-dog-food-139718","name":"Shop by Natural Ingredients"},{"url":"https://www.chewy.com/b/high-protein-11105","name":"High-Protein"}],"description":"Tend to your furry friend’s skin and digestive health with Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Adult Dry Dog Food Formula. This high-protein dog food for adult dogs is formulated to nurture your sidekick’s sensitive skin and stomach. It features real, nutrient-rich salmon as the very first ingredient in a highly digestible recipe with rice and oatmeal. This dry dog food is fortified with prebiotic fiber for your pal’s digestive and immune health. It also contains omega-6 fatty acids and vitamin A to help nourish your cuddly companion’s skin and coat and omega-3 fatty acids to support healthy joints and mobility. Complete with antioxidants to bolster your dog’s immune system, Purina Pro Plan Sensitive Skin and Stomach Salmon and Rice Dry Adult Dog Food Formula has what your dog needs to help their skin and digestive health thrive.","part_number":"101143","rating_count":23711,"price_display":"$77.48","product_title":"Purina Pro Plan Adult Sensitive Skin & Stomach Salmon & Rice Formula Dry Dog Food","autoship_price":73.61,"discount_label":"3%","original_price":79.99,"is_prescription":false,"unit_price_display":"$2.59/lb","autoship_price_display":"$73.61","original_price_display":"$79.99"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/videos":{"get":{"summary":"Google Videos","description":"Scrape video results from Google Videos search including YouTube, Reddit, and other video platforms, with location and language support.\n\n**Credit cost:** 1 credit per call","operationId":"get-google-videos","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The video search query to execute on Google Videos. Supports standard Google search operators.\n\n**Examples:**\n- `paris travel guide`: travel videos about Paris\n- `machine learning tutorial`: educational ML videos\n- `site:youtube.com cooking beginner`: restrict to YouTube results\n\n**Example:**\n\n    paris travel guide","schema":{"type":"string","description":"The video search query to execute on Google Videos. Supports standard Google search operators.\n\n**Examples:**\n- `paris travel guide`: travel videos about Paris\n- `machine learning tutorial`: educational ML videos\n- `site:youtube.com cooking beginner`: restrict to YouTube results\n\n**Example:**\n\n    paris travel guide"}},{"name":"location","in":"query","required":false,"description":"City or region from which the video search should originate.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```","schema":{"type":"string","description":"City or region from which the video search should originate.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google video search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google video search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number of video results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of video results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"num","in":"query","required":false,"description":"Maximum number of video results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results","deprecated":true,"schema":{"type":"number","default":"10","description":"Maximum number of video results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results"}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"organic_results":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"channel":{"type":"string"},"snippet":{"type":"string"},"duration":{"type":"string"},"position":{"type":"integer"},"video_id":{"type":"string"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{"type":"string"}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"num":{"type":"integer"},"page":{"type":"integer"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}}}},"examples":{"Search 'paris travel guide'. YouTube results":{"value":{"organic_results":[{"date":"Jan 23, 2026","link":"https://www.youtube.com/watch?v=pkBQBEtPlHE","title":"The Only Paris Travel Guide You'll Ever Need (2026)","domain":"www.youtube.com","source":"YouTube","channel":"Destination Well Known","snippet":"Don't visit Paris before you've watched this complete Paris travel guide I've created the ultimate Paris guide for first-time visitors ...","duration":"26:20","position":1,"video_id":"pkBQBEtPlHE","displayed_link":"www.youtube.com","snippet_matched":["guide","paris","travel"]},{"date":"May 30, 2025","link":"https://www.youtube.com/watch?v=GLKPfHVdYSU","title":"Paris According to Locals | What to Do, See & Eat in Paris","domain":"www.youtube.com","source":"YouTube","channel":"The Tour Guy","snippet":"Forget the tired advice from travel guides: here's what locals actually recommend.","duration":"14:02","position":2,"video_id":"GLKPfHVdYSU","displayed_link":"www.youtube.com","snippet_matched":["paris","travel"]},{"date":"Mar 7, 2025","link":"https://www.youtube.com/watch?v=63N38fKU3C0","title":"27 Tips I Wish I Knew Before Visiting Paris","domain":"www.youtube.com","source":"YouTube","channel":"Camden David","snippet":"Here's the exact list I share with friends visiting Paris.","duration":"12:00","position":3,"video_id":"63N38fKU3C0","displayed_link":"www.youtube.com","snippet_matched":["guide","paris","travel"]}],"search_parameters":{"q":"paris travel guide","gl":"us","hl":"en","num":10,"page":1,"uule":null,"engine":"google_videos","location":null}}},"Search 'machine learning tutorial': educational content":{"value":{"organic_results":[{"date":"Sep 26, 2022","link":"https://www.youtube.com/watch?v=i_LwzRVP7bg","title":"Machine Learning for Everybody – Full Course","domain":"www.youtube.com","source":"YouTube","channel":"freeCodeCamp.org","snippet":"A professional developer studying Cyber-Sec at the Master's level found the first hour of the tutorial to be incredibly comprehensive.","duration":"3:53:53","position":1,"video_id":"i_LwzRVP7bg","displayed_link":"www.youtube.com","snippet_matched":["tutorial"]},{"date":"Jun 16, 2025","link":"https://www.youtube.com/watch?v=JnxUsIeTJsM","title":"Machine Learning Full Course 2026 | Machine Learning Tutorial","domain":"www.youtube.com","source":"YouTube","channel":"Simplilearn","snippet":"IITK - Professional Certificate Course in Generative AI and Machine Learning.","duration":"11:40:29","position":2,"video_id":"JnxUsIeTJsM","displayed_link":"www.youtube.com","snippet_matched":["machine","learning"]},{"date":"Sep 17, 2020","link":"https://www.youtube.com/watch?v=7eh4d6sabA0","title":"Python Machine Learning Tutorial (Data Science)","domain":"www.youtube.com","source":"YouTube","channel":"Programming with Mosh","snippet":"Foundational machine learning concepts, how to apply algorithms using Python, and working with real-world data.","duration":"49:43","position":3,"video_id":"7eh4d6sabA0","displayed_link":"www.youtube.com","snippet_matched":["machine","learning"]}],"search_parameters":{"q":"machine learning tutorial","gl":"us","hl":"en","num":5,"page":1,"uule":null,"engine":"google_videos","location":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Videos","description":"Scrape video results from Google Videos search including YouTube, Reddit, and other video platforms, with location and language support.\n\n**Credit cost:** 1 credit per call","operationId":"post-google-videos","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The video search query to execute on Google Videos. Supports standard Google search operators.\n\n**Examples:**\n- `paris travel guide`: travel videos about Paris\n- `machine learning tutorial`: educational ML videos\n- `site:youtube.com cooking beginner`: restrict to YouTube results\n\n**Example:**\n\n    paris travel guide","schema":{"type":"string","description":"The video search query to execute on Google Videos. Supports standard Google search operators.\n\n**Examples:**\n- `paris travel guide`: travel videos about Paris\n- `machine learning tutorial`: educational ML videos\n- `site:youtube.com cooking beginner`: restrict to YouTube results\n\n**Example:**\n\n    paris travel guide"}},{"name":"location","in":"query","required":false,"description":"City or region from which the video search should originate.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```","schema":{"type":"string","description":"City or region from which the video search should originate.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google video search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google video search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number of video results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of video results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"num","in":"query","required":false,"description":"Maximum number of video results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results","deprecated":true,"schema":{"type":"number","default":"10","description":"Maximum number of video results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results"}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"organic_results":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"channel":{"type":"string"},"snippet":{"type":"string"},"duration":{"type":"string"},"position":{"type":"integer"},"video_id":{"type":"string"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{"type":"string"}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"num":{"type":"integer"},"page":{"type":"integer"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}}}},"examples":{"Search 'paris travel guide'. YouTube results":{"value":{"organic_results":[{"date":"Jan 23, 2026","link":"https://www.youtube.com/watch?v=pkBQBEtPlHE","title":"The Only Paris Travel Guide You'll Ever Need (2026)","domain":"www.youtube.com","source":"YouTube","channel":"Destination Well Known","snippet":"Don't visit Paris before you've watched this complete Paris travel guide I've created the ultimate Paris guide for first-time visitors ...","duration":"26:20","position":1,"video_id":"pkBQBEtPlHE","displayed_link":"www.youtube.com","snippet_matched":["guide","paris","travel"]},{"date":"May 30, 2025","link":"https://www.youtube.com/watch?v=GLKPfHVdYSU","title":"Paris According to Locals | What to Do, See & Eat in Paris","domain":"www.youtube.com","source":"YouTube","channel":"The Tour Guy","snippet":"Forget the tired advice from travel guides: here's what locals actually recommend.","duration":"14:02","position":2,"video_id":"GLKPfHVdYSU","displayed_link":"www.youtube.com","snippet_matched":["paris","travel"]},{"date":"Mar 7, 2025","link":"https://www.youtube.com/watch?v=63N38fKU3C0","title":"27 Tips I Wish I Knew Before Visiting Paris","domain":"www.youtube.com","source":"YouTube","channel":"Camden David","snippet":"Here's the exact list I share with friends visiting Paris.","duration":"12:00","position":3,"video_id":"63N38fKU3C0","displayed_link":"www.youtube.com","snippet_matched":["guide","paris","travel"]}],"search_parameters":{"q":"paris travel guide","gl":"us","hl":"en","num":10,"page":1,"uule":null,"engine":"google_videos","location":null}}},"Search 'machine learning tutorial': educational content":{"value":{"organic_results":[{"date":"Sep 26, 2022","link":"https://www.youtube.com/watch?v=i_LwzRVP7bg","title":"Machine Learning for Everybody – Full Course","domain":"www.youtube.com","source":"YouTube","channel":"freeCodeCamp.org","snippet":"A professional developer studying Cyber-Sec at the Master's level found the first hour of the tutorial to be incredibly comprehensive.","duration":"3:53:53","position":1,"video_id":"i_LwzRVP7bg","displayed_link":"www.youtube.com","snippet_matched":["tutorial"]},{"date":"Jun 16, 2025","link":"https://www.youtube.com/watch?v=JnxUsIeTJsM","title":"Machine Learning Full Course 2026 | Machine Learning Tutorial","domain":"www.youtube.com","source":"YouTube","channel":"Simplilearn","snippet":"IITK - Professional Certificate Course in Generative AI and Machine Learning.","duration":"11:40:29","position":2,"video_id":"JnxUsIeTJsM","displayed_link":"www.youtube.com","snippet_matched":["machine","learning"]},{"date":"Sep 17, 2020","link":"https://www.youtube.com/watch?v=7eh4d6sabA0","title":"Python Machine Learning Tutorial (Data Science)","domain":"www.youtube.com","source":"YouTube","channel":"Programming with Mosh","snippet":"Foundational machine learning concepts, how to apply algorithms using Python, and working with real-world data.","duration":"49:43","position":3,"video_id":"7eh4d6sabA0","displayed_link":"www.youtube.com","snippet_matched":["machine","learning"]}],"search_parameters":{"q":"machine learning tutorial","gl":"us","hl":"en","num":5,"page":1,"uule":null,"engine":"google_videos","location":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/search/autocomplete":{"get":{"summary":"Google Search Autocomplete","description":"Retrieve real-time Google Search autocomplete suggestions for any query, with support for language and country localization.\n\n**Credit cost:** 1 credit per call","operationId":"get-google-search-autocomplete","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The partial or complete search query for which you want to retrieve autocomplete suggestions from Google.\n\n**Example:**\n\n    coffee","schema":{"type":"string","description":"The partial or complete search query for which you want to retrieve autocomplete suggestions from Google.\n\n**Example:**\n\n    coffee"}},{"name":"cp","in":"query","required":false,"description":"Cursor position in the query string where autocomplete suggestions should be generated. Determines which part of the query is being completed.\n\n- `0`: Suggestions based on the full query (default)\n- `5`: Suggestions based on the first 5 characters of the query","schema":{"type":"number","default":"0","description":"Cursor position in the query string where autocomplete suggestions should be generated. Determines which part of the query is being completed.\n\n- `0`: Suggestions based on the full query (default)\n- `5`: Suggestions based on the first 5 characters of the query"}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google search country context. Defines which regional Google index is used.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google search country context. Defines which regional Google index is used.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language. Controls the language in which suggestions are returned.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language. Controls the language in which suggestions are returned.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"suggestions":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"cp":{"type":"integer"},"gl":{"type":"string"},"hl":{"type":"string"},"engine":{"type":"string"},"google_domain":{"type":"string"}}}}},"examples":{"Autocomplete 'coffee'. US/English":{"value":{"suggestions":[{"value":"ryze mushroom coffee"},{"value":"coffee near me"},{"value":"mushroom coffee"},{"value":"keurig coffee maker"},{"value":"costa coffee"},{"value":"zus coffee"},{"value":"ninja coffee machine"},{"value":"black rifle coffee"},{"value":"delonghi coffee machine"},{"value":"coffee shops near me"}],"search_parameters":{"q":"coffee","cp":0,"gl":"us","hl":"en","engine":"google","google_domain":"google.com"}}},"Autocomplete 'python'. France/French":{"value":{"suggestions":[{"value":"python"},{"value":"monty python"},{"value":"anaconda python"},{"value":"python en ligne"},{"value":"spyder python"},{"value":"google colab python"},{"value":"python online"},{"value":"python download"},{"value":"colt python"},{"value":"python royal"}],"search_parameters":{"q":"python","cp":0,"gl":"fr","hl":"fr","engine":"google","google_domain":"google.com"}}},"Autocomplete 'best laptop'. UK/English with cursor position":{"value":{"suggestions":[{"value":"best laptops"},{"value":"best laptops 2025"},{"value":"best laptops 2026"},{"value":"best laptop for students"},{"value":"best laptop deals"},{"value":"best laptop deals uk"},{"value":"best laptops 2025 uk"},{"value":"best laptops under £500"},{"value":"best laptop for university students"},{"value":"best laptop brands"}],"search_parameters":{"q":"best laptop","cp":10,"gl":"gb","hl":"en","engine":"google","google_domain":"google.com"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Search Autocomplete","description":"Retrieve real-time Google Search autocomplete suggestions for any query, with support for language and country localization.\n\n**Credit cost:** 1 credit per call","operationId":"post-google-search-autocomplete","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The partial or complete search query for which you want to retrieve autocomplete suggestions from Google.\n\n**Example:**\n\n    coffee","schema":{"type":"string","description":"The partial or complete search query for which you want to retrieve autocomplete suggestions from Google.\n\n**Example:**\n\n    coffee"}},{"name":"cp","in":"query","required":false,"description":"Cursor position in the query string where autocomplete suggestions should be generated. Determines which part of the query is being completed.\n\n- `0`: Suggestions based on the full query (default)\n- `5`: Suggestions based on the first 5 characters of the query","schema":{"type":"number","default":"0","description":"Cursor position in the query string where autocomplete suggestions should be generated. Determines which part of the query is being completed.\n\n- `0`: Suggestions based on the full query (default)\n- `5`: Suggestions based on the first 5 characters of the query"}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google search country context. Defines which regional Google index is used.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google search country context. Defines which regional Google index is used.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language. Controls the language in which suggestions are returned.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language. Controls the language in which suggestions are returned.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"suggestions":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"cp":{"type":"integer"},"gl":{"type":"string"},"hl":{"type":"string"},"engine":{"type":"string"},"google_domain":{"type":"string"}}}}},"examples":{"Autocomplete 'coffee'. US/English":{"value":{"suggestions":[{"value":"ryze mushroom coffee"},{"value":"coffee near me"},{"value":"mushroom coffee"},{"value":"keurig coffee maker"},{"value":"costa coffee"},{"value":"zus coffee"},{"value":"ninja coffee machine"},{"value":"black rifle coffee"},{"value":"delonghi coffee machine"},{"value":"coffee shops near me"}],"search_parameters":{"q":"coffee","cp":0,"gl":"us","hl":"en","engine":"google","google_domain":"google.com"}}},"Autocomplete 'python'. France/French":{"value":{"suggestions":[{"value":"python"},{"value":"monty python"},{"value":"anaconda python"},{"value":"python en ligne"},{"value":"spyder python"},{"value":"google colab python"},{"value":"python online"},{"value":"python download"},{"value":"colt python"},{"value":"python royal"}],"search_parameters":{"q":"python","cp":0,"gl":"fr","hl":"fr","engine":"google","google_domain":"google.com"}}},"Autocomplete 'best laptop'. UK/English with cursor position":{"value":{"suggestions":[{"value":"best laptops"},{"value":"best laptops 2025"},{"value":"best laptops 2026"},{"value":"best laptop for students"},{"value":"best laptop deals"},{"value":"best laptop deals uk"},{"value":"best laptops 2025 uk"},{"value":"best laptops under £500"},{"value":"best laptop for university students"},{"value":"best laptop brands"}],"search_parameters":{"q":"best laptop","cp":10,"gl":"gb","hl":"en","engine":"google","google_domain":"google.com"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/search":{"get":{"summary":"Google Search","description":"Scrape real-time Google search results with organic listings, knowledge graph, related searches, and advanced filters.\n\n**Credit cost:** 1 credit per call","operationId":"get-google-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query to execute on Google. Supports all standard Google search operators.\n\n**Examples:**\n- `best electric cars 2024`: standard keyword search\n- `site:linkedin.com Bill Gates`: restrict results to a specific domain\n- `intitle:\"growth hacking\" startup`: match the page title\n- `inurl:blog python tutorial`: match part of the URL\n\n**Example:**\n\n    best electric cars 2024","schema":{"type":"string","description":"The search query to execute on Google. Supports all standard Google search operators.\n\n**Examples:**\n- `best electric cars 2024`: standard keyword search\n- `site:linkedin.com Bill Gates`: restrict results to a specific domain\n- `intitle:\"growth hacking\" startup`: match the page title\n- `inurl:blog python tutorial`: match part of the URL\n\n**Example:**\n\n    best electric cars 2024"}},{"name":"tbs","in":"query","required":false,"description":"Advanced time-range and filter string for Google Search. Used to restrict results by recency.\n\n- `qdr:h`: Last hour\n- `qdr:d`: Last day\n- `qdr:w`: Last week\n- `qdr:m`: Last month\n- `qdr:y`: Last year\n\n**Example:**\n\n    qdr:w","schema":{"type":"string","description":"Advanced time-range and filter string for Google Search. Used to restrict results by recency.\n\n- `qdr:h`: Last hour\n- `qdr:d`: Last day\n- `qdr:w`: Last week\n- `qdr:m`: Last month\n- `qdr:y`: Last year\n\n**Example:**\n\n    qdr:w"}},{"name":"location","in":"query","required":false,"description":"City or region from which the search should originate. Simulates a real user's search from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```","schema":{"type":"string","description":"City or region from which the search should originate. Simulates a real user's search from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number of search results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of search results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"num","in":"query","required":false,"description":"Maximum number of results to return per page (e.g. `10`, `40`, `100`).\n\n**Note:** This parameter is deprecated and may not reliably affect the number of results returned.","deprecated":true,"schema":{"type":"number","default":"10","description":"Maximum number of results to return per page (e.g. `10`, `40`, `100`).\n\n**Note:** This parameter is deprecated and may not reliably affect the number of results returned."}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}},"knowledge_graph":{"nullable":true},"organic_results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"snippet":{"type":"string"},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{"type":"string"}}}}},"related_searches":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"tbs":{"nullable":true},"page":{"type":"integer"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}},"search_information":{"type":"object","properties":{"total_results":{"nullable":true},"time_taken_displayed":{"nullable":true}}}}},"examples":{"Search 'best electric cars 2024'. US/English":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"knowledge_graph":null,"organic_results":[{"link":"https://www.caranddriver.com/rankings/best-electric-cars","title":"Best Electric Vehicles for 2026, Tested","domain":"www.caranddriver.com","source":"Car and Driver","snippet":"We've ranked the best electric cars, trucks, and SUVs based on roughly 200 data points encompassing acceleration, handling, comfort, cargo space, fuel economy, and value.","position":1,"displayed_link":"https://www.caranddriver.com › rankings › best-electric...","snippet_matched":["best","cars","electric"]},{"link":"https://www.edmunds.com/electric-car/","title":"Best Electric Cars of 2026 and 2027 - Expert Reviews and Rankings","domain":"www.edmunds.com","source":"Edmunds","snippet":"Best Electric cars: Tesla Model 3 Long Range, Hyundai IONIQ 6, 2026 Nissan LEAF, 2025 FIAT 500e","position":2,"displayed_link":"https://www.edmunds.com › electric-car","snippet_matched":["best","cars","electric"]},{"link":"https://www.topgear.com/car-news/electric/top-gears-top-20-electric-cars","title":"Best Electric Cars 2026 - Top Gear","domain":"www.topgear.com","source":"Top Gear","snippet":"Mar 10, 2026. Want a good EV? Here are the 20 best electric cars on sale right now: Kia PV5, Volvo EX90, Skoda Enyaq, Polestar 4, Kia EV6, BMW i5 Touring.","position":3,"displayed_link":"https://www.topgear.com › top-gears-top-20-electric-cars","snippet_matched":["best","cars","electric"]}],"related_searches":[{"query":"Best electric cars 2024 hybrid"},{"query":"Best electric cars in the world"},{"query":"Top 10 most reliable electric cars"}],"search_parameters":{"q":"best electric cars 2024","gl":"us","hl":"en","tbs":null,"page":1,"uule":null,"engine":"google","location":null},"search_information":{"total_results":null,"time_taken_displayed":null}}},"Search 'OpenAI ChatGPT' with time filter 'last week'":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"knowledge_graph":null,"organic_results":[{"link":"https://openai.com/index/powering-product-discovery-in-chatgpt/","title":"Powering Product Discovery in ChatGPT","domain":"openai.com","source":"OpenAI","snippet":"4 days ago. ChatGPT introduces richer, visually immersive shopping powered by the Agentic Commerce Protocol.","position":1,"displayed_link":"https://openai.com › index › powering-product-discove...","snippet_matched":["ChatGPT"]},{"link":"https://www.cnbc.com/2026/03/24/openai-revamps-shopping-experience-in-chatgpt-after-instant-checkout.html","title":"OpenAI revamps shopping experience in ChatGPT after Instant Checkout","domain":"www.cnbc.com","source":"CNBC","snippet":"3 days ago. The update comes after OpenAI pivoted away from Instant Checkout, which allowed users to purchase select items from retailers like Etsy, Walmart and Shopify.","position":2,"displayed_link":"https://www.cnbc.com › 2026/03/24 › openai-revamps-...","snippet_matched":["OpenAI"]}],"related_searches":[],"search_parameters":{"q":"OpenAI ChatGPT","gl":"us","hl":"en","tbs":"qdr:w","page":1,"uule":null,"engine":"google","location":null},"search_information":{"total_results":null,"time_taken_displayed":null}}},"Search 'Airbus Company' with Knowledge Graph":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"knowledge_graph":{"type":"Aircraft manufacturing commercial company","title":"Airbus SE","website":"https://www.airbus.com/en","attributes":{"Owner":"SOGEPA (French Government): 10.9%; GZBV(German Government): 10.8%; SEPI (Spanish Government): 4.1%;","Founded":"December 18, 1970","Founder":"Roger Béteille","Revenue":"65.45 billion EUR (2023)","Headquarters":"Leiden, Netherlands"},"description":"Airbus SE is a European aerospace corporation. The company's primary business is the design and manufacturing of commercial aircraft.","description_link":"https://en.wikipedia.org/wiki/Airbus","description_source":"Wikipedia"},"organic_results":[{"link":"https://www.airbus.com/en","title":"Airbus: Pioneering sustainable aerospace","domain":"www.airbus.com","source":"Airbus","snippet":"Airbus designs, manufactures and delivers industry-leading commercial aircraft, helicopters, military transports, satellites, launchers and more.","position":1,"displayed_link":"https://www.airbus.com › ...","snippet_matched":["Airbus"]}],"related_searches":[{"query":"Airbus headquarters"},{"query":"Boeing"},{"query":"Airbus owner"}],"search_parameters":{"q":"Airbus Company","gl":"us","hl":"en","tbs":null,"page":1,"uule":null,"engine":"google","location":null},"search_information":{"total_results":null,"time_taken_displayed":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Search","description":"Scrape real-time Google search results with organic listings, knowledge graph, related searches, and advanced filters.\n\n**Credit cost:** 1 credit per call","operationId":"post-google-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query to execute on Google. Supports all standard Google search operators.\n\n**Examples:**\n- `best electric cars 2024`: standard keyword search\n- `site:linkedin.com Bill Gates`: restrict results to a specific domain\n- `intitle:\"growth hacking\" startup`: match the page title\n- `inurl:blog python tutorial`: match part of the URL\n\n**Example:**\n\n    best electric cars 2024","schema":{"type":"string","description":"The search query to execute on Google. Supports all standard Google search operators.\n\n**Examples:**\n- `best electric cars 2024`: standard keyword search\n- `site:linkedin.com Bill Gates`: restrict results to a specific domain\n- `intitle:\"growth hacking\" startup`: match the page title\n- `inurl:blog python tutorial`: match part of the URL\n\n**Example:**\n\n    best electric cars 2024"}},{"name":"tbs","in":"query","required":false,"description":"Advanced time-range and filter string for Google Search. Used to restrict results by recency.\n\n- `qdr:h`: Last hour\n- `qdr:d`: Last day\n- `qdr:w`: Last week\n- `qdr:m`: Last month\n- `qdr:y`: Last year\n\n**Example:**\n\n    qdr:w","schema":{"type":"string","description":"Advanced time-range and filter string for Google Search. Used to restrict results by recency.\n\n- `qdr:h`: Last hour\n- `qdr:d`: Last day\n- `qdr:w`: Last week\n- `qdr:m`: Last month\n- `qdr:y`: Last year\n\n**Example:**\n\n    qdr:w"}},{"name":"location","in":"query","required":false,"description":"City or region from which the search should originate. Simulates a real user's search from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```","schema":{"type":"string","description":"City or region from which the search should originate. Simulates a real user's search from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google search country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number of search results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of search results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"num","in":"query","required":false,"description":"Maximum number of results to return per page (e.g. `10`, `40`, `100`).\n\n**Note:** This parameter is deprecated and may not reliably affect the number of results returned.","deprecated":true,"schema":{"type":"number","default":"10","description":"Maximum number of results to return per page (e.g. `10`, `40`, `100`).\n\n**Note:** This parameter is deprecated and may not reliably affect the number of results returned."}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}},"knowledge_graph":{"nullable":true},"organic_results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"snippet":{"type":"string"},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{"type":"string"}}}}},"related_searches":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"tbs":{"nullable":true},"page":{"type":"integer"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}},"search_information":{"type":"object","properties":{"total_results":{"nullable":true},"time_taken_displayed":{"nullable":true}}}}},"examples":{"Search 'best electric cars 2024'. US/English":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"knowledge_graph":null,"organic_results":[{"link":"https://www.caranddriver.com/rankings/best-electric-cars","title":"Best Electric Vehicles for 2026, Tested","domain":"www.caranddriver.com","source":"Car and Driver","snippet":"We've ranked the best electric cars, trucks, and SUVs based on roughly 200 data points encompassing acceleration, handling, comfort, cargo space, fuel economy, and value.","position":1,"displayed_link":"https://www.caranddriver.com › rankings › best-electric...","snippet_matched":["best","cars","electric"]},{"link":"https://www.edmunds.com/electric-car/","title":"Best Electric Cars of 2026 and 2027 - Expert Reviews and Rankings","domain":"www.edmunds.com","source":"Edmunds","snippet":"Best Electric cars: Tesla Model 3 Long Range, Hyundai IONIQ 6, 2026 Nissan LEAF, 2025 FIAT 500e","position":2,"displayed_link":"https://www.edmunds.com › electric-car","snippet_matched":["best","cars","electric"]},{"link":"https://www.topgear.com/car-news/electric/top-gears-top-20-electric-cars","title":"Best Electric Cars 2026 - Top Gear","domain":"www.topgear.com","source":"Top Gear","snippet":"Mar 10, 2026. Want a good EV? Here are the 20 best electric cars on sale right now: Kia PV5, Volvo EX90, Skoda Enyaq, Polestar 4, Kia EV6, BMW i5 Touring.","position":3,"displayed_link":"https://www.topgear.com › top-gears-top-20-electric-cars","snippet_matched":["best","cars","electric"]}],"related_searches":[{"query":"Best electric cars 2024 hybrid"},{"query":"Best electric cars in the world"},{"query":"Top 10 most reliable electric cars"}],"search_parameters":{"q":"best electric cars 2024","gl":"us","hl":"en","tbs":null,"page":1,"uule":null,"engine":"google","location":null},"search_information":{"total_results":null,"time_taken_displayed":null}}},"Search 'OpenAI ChatGPT' with time filter 'last week'":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"knowledge_graph":null,"organic_results":[{"link":"https://openai.com/index/powering-product-discovery-in-chatgpt/","title":"Powering Product Discovery in ChatGPT","domain":"openai.com","source":"OpenAI","snippet":"4 days ago. ChatGPT introduces richer, visually immersive shopping powered by the Agentic Commerce Protocol.","position":1,"displayed_link":"https://openai.com › index › powering-product-discove...","snippet_matched":["ChatGPT"]},{"link":"https://www.cnbc.com/2026/03/24/openai-revamps-shopping-experience-in-chatgpt-after-instant-checkout.html","title":"OpenAI revamps shopping experience in ChatGPT after Instant Checkout","domain":"www.cnbc.com","source":"CNBC","snippet":"3 days ago. The update comes after OpenAI pivoted away from Instant Checkout, which allowed users to purchase select items from retailers like Etsy, Walmart and Shopify.","position":2,"displayed_link":"https://www.cnbc.com › 2026/03/24 › openai-revamps-...","snippet_matched":["OpenAI"]}],"related_searches":[],"search_parameters":{"q":"OpenAI ChatGPT","gl":"us","hl":"en","tbs":"qdr:w","page":1,"uule":null,"engine":"google","location":null},"search_information":{"total_results":null,"time_taken_displayed":null}}},"Search 'Airbus Company' with Knowledge Graph":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"knowledge_graph":{"type":"Aircraft manufacturing commercial company","title":"Airbus SE","website":"https://www.airbus.com/en","attributes":{"Owner":"SOGEPA (French Government): 10.9%; GZBV(German Government): 10.8%; SEPI (Spanish Government): 4.1%;","Founded":"December 18, 1970","Founder":"Roger Béteille","Revenue":"65.45 billion EUR (2023)","Headquarters":"Leiden, Netherlands"},"description":"Airbus SE is a European aerospace corporation. The company's primary business is the design and manufacturing of commercial aircraft.","description_link":"https://en.wikipedia.org/wiki/Airbus","description_source":"Wikipedia"},"organic_results":[{"link":"https://www.airbus.com/en","title":"Airbus: Pioneering sustainable aerospace","domain":"www.airbus.com","source":"Airbus","snippet":"Airbus designs, manufactures and delivers industry-leading commercial aircraft, helicopters, military transports, satellites, launchers and more.","position":1,"displayed_link":"https://www.airbus.com › ...","snippet_matched":["Airbus"]}],"related_searches":[{"query":"Airbus headquarters"},{"query":"Boeing"},{"query":"Airbus owner"}],"search_parameters":{"q":"Airbus Company","gl":"us","hl":"en","tbs":null,"page":1,"uule":null,"engine":"google","location":null},"search_information":{"total_results":null,"time_taken_displayed":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/news":{"get":{"summary":"Google News","description":"Extract real-time news articles from Google News with advanced filtering by topic, location, language, and pagination.\n\n**Status:** Maintenance\n\n**Credit cost:** 1 credit per call","operationId":"get-google-news","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The news search query to execute on Google News. Supports standard Google search operators.\n\n**Examples:**\n- `artificial intelligence`: news about AI\n- `site:techcrunch.com startup`: news from a specific domain\n- `\"climate change\" 2024`: exact phrase search\n\n**Example:**\n\n    artificial intelligence news","schema":{"type":"string","description":"The news search query to execute on Google News. Supports standard Google search operators.\n\n**Examples:**\n- `artificial intelligence`: news about AI\n- `site:techcrunch.com startup`: news from a specific domain\n- `\"climate change\" 2024`: exact phrase search\n\n**Example:**\n\n    artificial intelligence news"}},{"name":"location","in":"query","required":false,"description":"City or region from which the news search should originate. Simulates a search performed from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```","schema":{"type":"string","description":"City or region from which the news search should originate. Simulates a search performed from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting. Use this instead of `location` when you need exact control.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting. Use this instead of `location` when you need exact control."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google News country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google News country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google News language context.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google News language context.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number of news results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of news results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"num","in":"query","required":false,"description":"Maximum number of results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results","deprecated":true,"schema":{"type":"number","default":"10","description":"Maximum number of results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}},"organic_results":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"snippet":{"type":"string"},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"num":{"type":"integer"},"page":{"type":"integer"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}}}},"examples":{"Search 'artificial intelligence news'. US/English":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"organic_results":[{"date":"3 hours ago","link":"https://www.theguardian.com/technology/2026/mar/27/number-of-ai-chatbots-ignoring-human-instructions-increasing-study-says","title":"Number of AI chatbots ignoring human instructions increasing, study says","domain":"www.theguardian.com","source":"The Guardian","snippet":"Exclusive: Research finds sharp rise in models evading safeguards and destroying emails without permission.","position":1,"displayed_link":"www.theguardian.com","snippet_matched":[]},{"date":"20 hours ago","link":"https://www.bloomberg.com/news/articles/2026-03-26/apple-plans-to-open-up-siri-to-rival-ai-assistants-beyond-chatgpt-in-ios-27","title":"Apple Plans to Open Up Siri to Rival AI Assistants in iOS 27 Update","domain":"www.bloomberg.com","source":"Bloomberg.com","snippet":"Apple Inc. plans to open Siri to outside artificial intelligence assistants, a major move aimed at bolstering the iPhone as an AI platform.","position":2,"displayed_link":"www.bloomberg.com","snippet_matched":["intelligence","artificial"]},{"date":"1 hour ago","link":"https://www.cnbc.com/2026/03/27/anthropic-cybersecurity-stocks-ai-mythos.html","title":"Cybersecurity stocks fall on report Anthropic is testing a powerful new model","domain":"www.cnbc.com","source":"CNBC","snippet":"The cybersecurity sector has slumped this year on fears that new AI will massively disrupt their business models.","position":3,"displayed_link":"www.cnbc.com","snippet_matched":[]}],"search_parameters":{"q":"artificial intelligence news","gl":"us","hl":"en","num":10,"page":1,"uule":null,"engine":"google_news","location":null}}},"Search 'stock market': page 2":{"value":{"pagination":{"next":3,"current":2,"other_pages":[1,3,4,5,6,7,8,9,10,11],"has_next_page":true},"organic_results":[{"date":"3 hours ago","link":"https://www.fool.com/investing/2026/03/27/stock-market-today-live-coverage/","title":"Stock Market Today (LIVE): Nasdaq Enters Correction as Crude Tops $110","domain":"www.fool.com","source":"The Motley Fool","snippet":"Top insights from the latest market news from Thursday, March 27.","position":1,"displayed_link":"www.fool.com","snippet_matched":["market"]},{"date":"51 minutes ago","link":"https://fortune.com/2026/03/27/trump-taco-iran-war-brent-crude-wti-nasdaq-stock-market-correction/","title":"The big Stock market correction that Trump can't talk his way out of is official","domain":"fortune.com","source":"Fortune","snippet":"TACO is over as the 10 year treasury yield spikes and the Nasdaq sinks over 10% from its peak.","position":2,"displayed_link":"fortune.com","snippet_matched":[]}],"search_parameters":{"q":"stock market","gl":"us","hl":"en","num":10,"page":2,"uule":null,"engine":"google_news","location":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google News","description":"Extract real-time news articles from Google News with advanced filtering by topic, location, language, and pagination.\n\n**Status:** Maintenance\n\n**Credit cost:** 1 credit per call","operationId":"post-google-news","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The news search query to execute on Google News. Supports standard Google search operators.\n\n**Examples:**\n- `artificial intelligence`: news about AI\n- `site:techcrunch.com startup`: news from a specific domain\n- `\"climate change\" 2024`: exact phrase search\n\n**Example:**\n\n    artificial intelligence news","schema":{"type":"string","description":"The news search query to execute on Google News. Supports standard Google search operators.\n\n**Examples:**\n- `artificial intelligence`: news about AI\n- `site:techcrunch.com startup`: news from a specific domain\n- `\"climate change\" 2024`: exact phrase search\n\n**Example:**\n\n    artificial intelligence news"}},{"name":"location","in":"query","required":false,"description":"City or region from which the news search should originate. Simulates a search performed from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```","schema":{"type":"string","description":"City or region from which the news search should originate. Simulates a search performed from the specified location.\n\n**Examples:**\n```\nNew York, NY\n```\n\n```\nParis, France\n```\n\n```\nTokyo, Japan\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string for precise geographic targeting. Use this instead of `location` when you need exact control.","schema":{"type":"string","description":"Google-encoded location string for precise geographic targeting. Use this instead of `location` when you need exact control."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google News country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google News country context.\n\n- `us`: United States\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google News language context.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google News language context.\n\n- `en`: English\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number of news results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of news results to retrieve.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"num","in":"query","required":false,"description":"Maximum number of results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results","deprecated":true,"schema":{"type":"number","default":"10","description":"Maximum number of results to return per page.\n\n- `10`: Default\n- `40`: 40 results\n- `100`: 100 results"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}},"organic_results":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"snippet":{"type":"string"},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"num":{"type":"integer"},"page":{"type":"integer"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}}}},"examples":{"Search 'artificial intelligence news'. US/English":{"value":{"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,7,8,9,10],"has_next_page":true},"organic_results":[{"date":"3 hours ago","link":"https://www.theguardian.com/technology/2026/mar/27/number-of-ai-chatbots-ignoring-human-instructions-increasing-study-says","title":"Number of AI chatbots ignoring human instructions increasing, study says","domain":"www.theguardian.com","source":"The Guardian","snippet":"Exclusive: Research finds sharp rise in models evading safeguards and destroying emails without permission.","position":1,"displayed_link":"www.theguardian.com","snippet_matched":[]},{"date":"20 hours ago","link":"https://www.bloomberg.com/news/articles/2026-03-26/apple-plans-to-open-up-siri-to-rival-ai-assistants-beyond-chatgpt-in-ios-27","title":"Apple Plans to Open Up Siri to Rival AI Assistants in iOS 27 Update","domain":"www.bloomberg.com","source":"Bloomberg.com","snippet":"Apple Inc. plans to open Siri to outside artificial intelligence assistants, a major move aimed at bolstering the iPhone as an AI platform.","position":2,"displayed_link":"www.bloomberg.com","snippet_matched":["intelligence","artificial"]},{"date":"1 hour ago","link":"https://www.cnbc.com/2026/03/27/anthropic-cybersecurity-stocks-ai-mythos.html","title":"Cybersecurity stocks fall on report Anthropic is testing a powerful new model","domain":"www.cnbc.com","source":"CNBC","snippet":"The cybersecurity sector has slumped this year on fears that new AI will massively disrupt their business models.","position":3,"displayed_link":"www.cnbc.com","snippet_matched":[]}],"search_parameters":{"q":"artificial intelligence news","gl":"us","hl":"en","num":10,"page":1,"uule":null,"engine":"google_news","location":null}}},"Search 'stock market': page 2":{"value":{"pagination":{"next":3,"current":2,"other_pages":[1,3,4,5,6,7,8,9,10,11],"has_next_page":true},"organic_results":[{"date":"3 hours ago","link":"https://www.fool.com/investing/2026/03/27/stock-market-today-live-coverage/","title":"Stock Market Today (LIVE): Nasdaq Enters Correction as Crude Tops $110","domain":"www.fool.com","source":"The Motley Fool","snippet":"Top insights from the latest market news from Thursday, March 27.","position":1,"displayed_link":"www.fool.com","snippet_matched":["market"]},{"date":"51 minutes ago","link":"https://fortune.com/2026/03/27/trump-taco-iran-war-brent-crude-wti-nasdaq-stock-market-correction/","title":"The big Stock market correction that Trump can't talk his way out of is official","domain":"fortune.com","source":"Fortune","snippet":"TACO is over as the 10 year treasury yield spikes and the Nasdaq sinks over 10% from its peak.","position":2,"displayed_link":"fortune.com","snippet_matched":[]}],"search_parameters":{"q":"stock market","gl":"us","hl":"en","num":10,"page":2,"uule":null,"engine":"google_news","location":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/images":{"get":{"summary":"Google Images","description":"Google Images Scraper API – bringing the power of visual search to your fingertips.\n\n**Credit cost:** 1 credit per call","operationId":"get-google-images","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The image search query to execute on Google Images.\n\n**Example:**\n\n    mountain landscape","schema":{"type":"string","description":"The image search query to execute on Google Images.\n\n**Example:**\n\n    mountain landscape"}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google image search country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google image search country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language. Controls the language context of the image search.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language. Controls the language context of the image search.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Images are returned in batches of 100 per page.\n\n- `1`: First 100 images (default)\n- `2`: Next 100 images\n- `3`: Next 100 images, etc.\n\n**Note:** To retrieve additional images, increment this parameter with the same query.","schema":{"type":"number","default":"1","description":"Page number for pagination. Images are returned in batches of 100 per page.\n\n- `1`: First 100 images (default)\n- `2`: Next 100 images\n- `3`: Next 100 images, etc.\n\n**Note:** To retrieve additional images, increment this parameter with the same query."}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"position":{"type":"integer"},"image_width":{"type":"integer"},"image_height":{"type":"integer"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"page":{"type":"integer"},"engine":{"type":"string"}}}}},"examples":{"Image search 'mountain landscape'":{"value":{"images":[{"url":"https://thumbs.dreamstime.com/b/stunning-mountain-landscape-crystal-clear-flowing-stream-breathtaking-photo-realistic-scene-majestic-lush-358650506.jpg","link":"https://www.dreamstime.com/stunning-mountain-landscape-crystal-clear-flowing-stream-breathtaking-photo-realistic-scene-majestic-lush-image358650506","title":"Stunning Mountain Landscape with a Crystal Clear Flowing Stream","domain":"www.dreamstime.com","source":"Dreamstime.com","position":1,"image_width":800,"image_height":449},{"url":"https://images.stockcake.com/public/8/8/9/889c1161-ac90-403a-b63f-23d708e67520_large/sunset-mountain-landscape-stockcake.jpg","link":"https://www.pexels.com/photo/mountain-landscape-with-forests-and-a-stream-18682254/","title":"Mountain Landscape with Forests and a Stream","domain":"www.pexels.com","source":"Pexels","position":2,"image_width":728,"image_height":408},{"url":"https://images.pexels.com/photos/18682254/pexels-photo-18682254/free-photo-of-mountain-landscape-with-forests-and-a-stream.jpeg","link":"https://www.dreamstime.com/photos-images/mountain-landscape-canada.html","title":"Mountain Landscape Canada Stock Photos","domain":"www.dreamstime.com","source":"Dreamstime.com","position":3,"image_width":4032,"image_height":3024}],"search_parameters":{"q":"mountain landscape","gl":"us","hl":"en","page":1,"engine":"google"}}},"Image search 'lion'. Wikipedia example":{"value":{"images":[{"url":"https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Lion_waiting_in_Namibia.jpg/1200px-Lion_waiting_in_Namibia.jpg","link":"https://en.wikipedia.org/wiki/Lion","title":"Lion - Wikipedia","domain":"en.wikipedia.org","source":"Wikipedia","position":1,"image_width":1200,"image_height":900},{"url":"https://cdn.britannica.com/30/150930-120-D3D93F1E/lion-Namibia.jpg","link":"https://www.britannica.com/animal/lion","title":"Lion | Characteristics, Habitat ...","domain":"www.britannica.com","source":"Britannica","position":2,"image_width":900,"image_height":675},{"url":"https://c02.purpledshub.com/uploads/sites/62/2019/10/Federico_Veronesi_Lions-cover-image-e359a4e.jpg","link":"https://www.discoverwildlife.com/animal-facts/mammals/facts-about-lions","title":"Lion guide: species facts and where to see lions in the wild","domain":"www.discoverwildlife.com","source":"BBC Wildlife Magazine","position":3,"image_width":3710,"image_height":4000}],"search_parameters":{"q":"lion","gl":"us","hl":"en","page":1,"engine":"google"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Images","description":"Google Images Scraper API – bringing the power of visual search to your fingertips.\n\n**Credit cost:** 1 credit per call","operationId":"post-google-images","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The image search query to execute on Google Images.\n\n**Example:**\n\n    mountain landscape","schema":{"type":"string","description":"The image search query to execute on Google Images.\n\n**Example:**\n\n    mountain landscape"}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google image search country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google image search country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google interface language. Controls the language context of the image search.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google interface language. Controls the language context of the image search.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Images are returned in batches of 100 per page.\n\n- `1`: First 100 images (default)\n- `2`: Next 100 images\n- `3`: Next 100 images, etc.\n\n**Note:** To retrieve additional images, increment this parameter with the same query.","schema":{"type":"number","default":"1","description":"Page number for pagination. Images are returned in batches of 100 per page.\n\n- `1`: First 100 images (default)\n- `2`: Next 100 images\n- `3`: Next 100 images, etc.\n\n**Note:** To retrieve additional images, increment this parameter with the same query."}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"source":{"type":"string"},"position":{"type":"integer"},"image_width":{"type":"integer"},"image_height":{"type":"integer"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"page":{"type":"integer"},"engine":{"type":"string"}}}}},"examples":{"Image search 'mountain landscape'":{"value":{"images":[{"url":"https://thumbs.dreamstime.com/b/stunning-mountain-landscape-crystal-clear-flowing-stream-breathtaking-photo-realistic-scene-majestic-lush-358650506.jpg","link":"https://www.dreamstime.com/stunning-mountain-landscape-crystal-clear-flowing-stream-breathtaking-photo-realistic-scene-majestic-lush-image358650506","title":"Stunning Mountain Landscape with a Crystal Clear Flowing Stream","domain":"www.dreamstime.com","source":"Dreamstime.com","position":1,"image_width":800,"image_height":449},{"url":"https://images.stockcake.com/public/8/8/9/889c1161-ac90-403a-b63f-23d708e67520_large/sunset-mountain-landscape-stockcake.jpg","link":"https://www.pexels.com/photo/mountain-landscape-with-forests-and-a-stream-18682254/","title":"Mountain Landscape with Forests and a Stream","domain":"www.pexels.com","source":"Pexels","position":2,"image_width":728,"image_height":408},{"url":"https://images.pexels.com/photos/18682254/pexels-photo-18682254/free-photo-of-mountain-landscape-with-forests-and-a-stream.jpeg","link":"https://www.dreamstime.com/photos-images/mountain-landscape-canada.html","title":"Mountain Landscape Canada Stock Photos","domain":"www.dreamstime.com","source":"Dreamstime.com","position":3,"image_width":4032,"image_height":3024}],"search_parameters":{"q":"mountain landscape","gl":"us","hl":"en","page":1,"engine":"google"}}},"Image search 'lion'. Wikipedia example":{"value":{"images":[{"url":"https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Lion_waiting_in_Namibia.jpg/1200px-Lion_waiting_in_Namibia.jpg","link":"https://en.wikipedia.org/wiki/Lion","title":"Lion - Wikipedia","domain":"en.wikipedia.org","source":"Wikipedia","position":1,"image_width":1200,"image_height":900},{"url":"https://cdn.britannica.com/30/150930-120-D3D93F1E/lion-Namibia.jpg","link":"https://www.britannica.com/animal/lion","title":"Lion | Characteristics, Habitat ...","domain":"www.britannica.com","source":"Britannica","position":2,"image_width":900,"image_height":675},{"url":"https://c02.purpledshub.com/uploads/sites/62/2019/10/Federico_Veronesi_Lions-cover-image-e359a4e.jpg","link":"https://www.discoverwildlife.com/animal-facts/mammals/facts-about-lions","title":"Lion guide: species facts and where to see lions in the wild","domain":"www.discoverwildlife.com","source":"BBC Wildlife Magazine","position":3,"image_width":3710,"image_height":4000}],"search_parameters":{"q":"lion","gl":"us","hl":"en","page":1,"engine":"google"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/website/screenshot":{"get":{"summary":"Website Screenshot","description":"Browser-like Screenshot API that captures webpages as PNG/JPEG/WebP or PDF for previews, QA, reporting, monitoring, and archiving no headless setup.\n\n**Credit cost:** 2 credits per call","operationId":"get-website-screenshot","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the webpage to capture. Examples:\n```\nhttps://www.amazon.com/s?k=pokemon\n```\n\n```\nhttps://www.cdiscount.com/sante-mieux-vivre/materiel-medical/soin-domicile/l-1650608.html\n```\n\n```\nhttps://github.com/seaweedfs/seaweedfs\n```","schema":{"type":"string","description":"The URL of the webpage to capture. Examples:\n```\nhttps://www.amazon.com/s?k=pokemon\n```\n\n```\nhttps://www.cdiscount.com/sante-mieux-vivre/materiel-medical/soin-domicile/l-1650608.html\n```\n\n```\nhttps://github.com/seaweedfs/seaweedfs\n```"}},{"name":"format","in":"query","required":false,"description":"The output format of the screenshot.\n\nAvailable formats: \n\n- `webp`\n- `jpeg`\n- `jpg`\n- `png`\n- `pdf`","schema":{"type":"string","enum":["jpeg","jpg","pdf","png","webp"],"default":"png","description":"The output format of the screenshot.\n\nAvailable formats: \n\n- `webp`\n- `jpeg`\n- `jpg`\n- `png`\n- `pdf`"}},{"name":"device","in":"query","required":false,"description":"The device type to emulate for the screenshot.\n\nAvailable devices:\n\n- `iphone_14_pro_max`\n- `iphone_14_pro`\n- `iphone_13_pro_max`\n- `iphone_13_mini`\n- `iphone_12`\n- `iphone_x`\n- `ipad`\n- `galaxy_s23_ultra`\n- `galaxy_s23`\n- `galaxy_s8`\n- `galaxy_fold4`\n- `pixel_7_pro`\n- `pixel_6a`\n- `pixel_5`\n- `redmi_note_12_pro`\n- `redmi_note_11`\n- `huawei_p60_pro`\n- `huawei_mate_50_pro`","schema":{"type":"string","enum":["galaxy_fold4","galaxy_s23","galaxy_s23_ultra","galaxy_s8","huawei_mate_50_pro","huawei_p60_pro","ipad","iphone_12","iphone_13_mini","iphone_13_pro_max","iphone_14_pro","iphone_14_pro_max","iphone_x","pixel_5","pixel_6a","pixel_7_pro","redmi_note_11","redmi_note_12_pro"],"description":"The device type to emulate for the screenshot.\n\nAvailable devices:\n\n- `iphone_14_pro_max`\n- `iphone_14_pro`\n- `iphone_13_pro_max`\n- `iphone_13_mini`\n- `iphone_12`\n- `iphone_x`\n- `ipad`\n- `galaxy_s23_ultra`\n- `galaxy_s23`\n- `galaxy_s8`\n- `galaxy_fold4`\n- `pixel_7_pro`\n- `pixel_6a`\n- `pixel_5`\n- `redmi_note_12_pro`\n- `redmi_note_11`\n- `huawei_p60_pro`\n- `huawei_mate_50_pro`"}},{"name":"full_page","in":"query","required":false,"description":"Capture the entire page instead of just the visible viewport.","schema":{"type":"boolean","default":"false","description":"Capture the entire page instead of just the visible viewport."}},{"name":"full_page_scroll","in":"query","required":false,"description":"Scroll the page to fully load lazy-loaded elements before capturing a full-page screenshot.","schema":{"type":"boolean","default":"false","description":"Scroll the page to fully load lazy-loaded elements before capturing a full-page screenshot."}},{"name":"full_page_scroll_duration","in":"query","required":false,"description":"Time in milliseconds for scrolling before capturing the full page.","schema":{"type":"number","default":"400","description":"Time in milliseconds for scrolling before capturing the full page."}},{"name":"viewport_width","in":"query","required":false,"description":"The width of the browser viewport in pixels.","schema":{"type":"number","default":"1280","description":"The width of the browser viewport in pixels."}},{"name":"viewport_height","in":"query","required":false,"description":"The height of the browser viewport in pixels.","schema":{"type":"number","default":"1024","description":"The height of the browser viewport in pixels."}},{"name":"scale_factor","in":"query","required":false,"description":"The scale factor for high-resolution screenshots.","schema":{"type":"number","default":"1","description":"The scale factor for high-resolution screenshots."}},{"name":"image_quality","in":"query","required":false,"description":"Generate images with custom quality settings.\n\nSupported formats include:\n\n```\njpeg\n```\n\n```\nwebp\n```","schema":{"type":"string","default":"80","description":"Generate images with custom quality settings.\n\nSupported formats include:\n\n```\njpeg\n```\n\n```\nwebp\n```"}},{"name":"selector","in":"query","required":false,"description":"Capture a specific element on the page instead of the full viewport.","schema":{"type":"string","description":"Capture a specific element on the page instead of the full viewport."}},{"name":"cache","in":"query","required":false,"description":"Cache the response.","schema":{"type":"boolean","default":"false","description":"Cache the response."}},{"name":"cache_ttl","in":"query","required":false,"description":"Cache the response for a custom TTL (in seconds).","schema":{"type":"number","minimum":3600,"maximum":2592000,"default":"2592000","description":"Cache the response for a custom TTL (in seconds)."}},{"name":"remove_selectors","in":"query","required":false,"description":"A comma-separated list of elements to hide before capturing (e.g., ads, popups).","schema":{"type":"string","description":"A comma-separated list of elements to hide before capturing (e.g., ads, popups)."}},{"name":"remove_cookie_banners","in":"query","required":false,"description":"Automatically remove cookie banners before capturing.","schema":{"type":"boolean","default":"false","description":"Automatically remove cookie banners before capturing."}},{"name":"remove_ads","in":"query","required":false,"description":"Automatically remove ads before capturing.","schema":{"type":"boolean","default":"false","description":"Automatically remove ads before capturing."}},{"name":"block_resources","in":"query","required":false,"description":"Comma-separated list of resource types to block (e.g., “image,stylesheet,font”). \n\nAvailable resource types: \n\n- `document`\n- `stylesheet`\n- `image`\n- `media`\n- `font`\n- `script`\n- `texttrack`\n- `xhr`\n- `fetch`\n- `eventsource`\n- `websocket`\n- `manifest`\n- `other`\n\nUseful for optimizing page loading speed before capturing screenshots.","schema":{"type":"string","enum":["document","eventsource","fetch","font","image","manifest","media","other","script","stylesheet","texttrack","websocket","xhr"],"description":"Comma-separated list of resource types to block (e.g., “image,stylesheet,font”). \n\nAvailable resource types: \n\n- `document`\n- `stylesheet`\n- `image`\n- `media`\n- `font`\n- `script`\n- `texttrack`\n- `xhr`\n- `fetch`\n- `eventsource`\n- `websocket`\n- `manifest`\n- `other`\n\nUseful for optimizing page loading speed before capturing screenshots."}},{"name":"block_urls","in":"query","required":false,"description":"Comma-separated list of URL patterns to block (e.g., “analytics,tracking,advertisement”). \n\nYou can specify URLs, domains, or simple patterns like “.example.com/”.","schema":{"type":"string","description":"Comma-separated list of URL patterns to block (e.g., “analytics,tracking,advertisement”). \n\nYou can specify URLs, domains, or simple patterns like “.example.com/”."}},{"name":"delay","in":"query","required":false,"description":"Delay in seconds before capturing the screenshot.","schema":{"type":"number","minimum":0,"maximum":10,"default":"0","description":"Delay in seconds before capturing the screenshot."}},{"name":"wait_until","in":"query","required":false,"description":"Define when to capture.\n\nAvailable formats:  \n\n- `networkidle2`\n- `load`\n- `domcontentloaded`\n- `networkidle0`","schema":{"type":"array","items":{"type":"string"},"enum":["domcontentloaded","load","networkidle0","networkidle2"],"description":"Define when to capture.\n\nAvailable formats:  \n\n- `networkidle2`\n- `load`\n- `domcontentloaded`\n- `networkidle0`"}},{"name":"wait_for_selector","in":"query","required":false,"description":"Wait for a specific element to appear before taking the screenshot.","schema":{"type":"string","description":"Wait for a specific element to appear before taking the screenshot."}},{"name":"proxy","in":"query","required":false,"description":"Specify a proxy server to route your request through. \n\nSupports `HTTP`, `HTTPS`, and `SOCKS5` proxies. \n\nFormat: http://username:password@proxy.com:PORT. \n\nUseful for bypassing geo-restrictions and rotating IPs.","schema":{"type":"string","description":"Specify a proxy server to route your request through. \n\nSupports `HTTP`, `HTTPS`, and `SOCKS5` proxies. \n\nFormat: http://username:password@proxy.com:PORT. \n\nUseful for bypassing geo-restrictions and rotating IPs."}},{"name":"s3_secret_key","in":"query","required":false,"description":"AWS S3 secret access key.","schema":{"type":"string","description":"AWS S3 secret access key."}},{"name":"s3_access_key_id","in":"query","required":false,"description":"AWS S3 access key ID.","schema":{"type":"string","description":"AWS S3 access key ID."}},{"name":"s3_bucket","in":"query","required":false,"description":"The S3 bucket name where the screenshot will be uploaded.","schema":{"type":"string","description":"The S3 bucket name where the screenshot will be uploaded."}},{"name":"s3_object_key","in":"query","required":false,"description":"The filename for the S3 object (auto-generated if not provided).","schema":{"type":"string","description":"The filename for the S3 object (auto-generated if not provided)."}},{"name":"s3_region","in":"query","required":false,"description":"AWS S3 region for storage.\n\n","schema":{"type":"string","description":"AWS S3 region for storage.\n\n"}},{"name":"storage_endpoint","in":"query","required":false,"description":"Leave this field empty for AWS S3. Only specify a value if required. S3-compatible storage services are supported, for example, use https://<accountId>.r2.cloudflarestorage.com for Cloudflare R2.","schema":{"type":"string","description":"Leave this field empty for AWS S3. Only specify a value if required. S3-compatible storage services are supported, for example, use https://<accountId>.r2.cloudflarestorage.com for Cloudflare R2."}},{"name":"s3_url","in":"query","required":false,"description":"Use S3 storage for screenshots. The S3 URL will be returned in the response.","schema":{"type":"boolean","default":"false","description":"Use S3 storage for screenshots. The S3 URL will be returned in the response."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Website Screenshot","description":"Browser-like Screenshot API that captures webpages as PNG/JPEG/WebP or PDF for previews, QA, reporting, monitoring, and archiving no headless setup.\n\n**Credit cost:** 2 credits per call","operationId":"post-website-screenshot","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the webpage to capture. Examples:\n```\nhttps://www.amazon.com/s?k=pokemon\n```\n\n```\nhttps://www.cdiscount.com/sante-mieux-vivre/materiel-medical/soin-domicile/l-1650608.html\n```\n\n```\nhttps://github.com/seaweedfs/seaweedfs\n```","schema":{"type":"string","description":"The URL of the webpage to capture. Examples:\n```\nhttps://www.amazon.com/s?k=pokemon\n```\n\n```\nhttps://www.cdiscount.com/sante-mieux-vivre/materiel-medical/soin-domicile/l-1650608.html\n```\n\n```\nhttps://github.com/seaweedfs/seaweedfs\n```"}},{"name":"format","in":"query","required":false,"description":"The output format of the screenshot.\n\nAvailable formats: \n\n- `webp`\n- `jpeg`\n- `jpg`\n- `png`\n- `pdf`","schema":{"type":"string","enum":["jpeg","jpg","pdf","png","webp"],"default":"png","description":"The output format of the screenshot.\n\nAvailable formats: \n\n- `webp`\n- `jpeg`\n- `jpg`\n- `png`\n- `pdf`"}},{"name":"device","in":"query","required":false,"description":"The device type to emulate for the screenshot.\n\nAvailable devices:\n\n- `iphone_14_pro_max`\n- `iphone_14_pro`\n- `iphone_13_pro_max`\n- `iphone_13_mini`\n- `iphone_12`\n- `iphone_x`\n- `ipad`\n- `galaxy_s23_ultra`\n- `galaxy_s23`\n- `galaxy_s8`\n- `galaxy_fold4`\n- `pixel_7_pro`\n- `pixel_6a`\n- `pixel_5`\n- `redmi_note_12_pro`\n- `redmi_note_11`\n- `huawei_p60_pro`\n- `huawei_mate_50_pro`","schema":{"type":"string","enum":["galaxy_fold4","galaxy_s23","galaxy_s23_ultra","galaxy_s8","huawei_mate_50_pro","huawei_p60_pro","ipad","iphone_12","iphone_13_mini","iphone_13_pro_max","iphone_14_pro","iphone_14_pro_max","iphone_x","pixel_5","pixel_6a","pixel_7_pro","redmi_note_11","redmi_note_12_pro"],"description":"The device type to emulate for the screenshot.\n\nAvailable devices:\n\n- `iphone_14_pro_max`\n- `iphone_14_pro`\n- `iphone_13_pro_max`\n- `iphone_13_mini`\n- `iphone_12`\n- `iphone_x`\n- `ipad`\n- `galaxy_s23_ultra`\n- `galaxy_s23`\n- `galaxy_s8`\n- `galaxy_fold4`\n- `pixel_7_pro`\n- `pixel_6a`\n- `pixel_5`\n- `redmi_note_12_pro`\n- `redmi_note_11`\n- `huawei_p60_pro`\n- `huawei_mate_50_pro`"}},{"name":"full_page","in":"query","required":false,"description":"Capture the entire page instead of just the visible viewport.","schema":{"type":"boolean","default":"false","description":"Capture the entire page instead of just the visible viewport."}},{"name":"full_page_scroll","in":"query","required":false,"description":"Scroll the page to fully load lazy-loaded elements before capturing a full-page screenshot.","schema":{"type":"boolean","default":"false","description":"Scroll the page to fully load lazy-loaded elements before capturing a full-page screenshot."}},{"name":"full_page_scroll_duration","in":"query","required":false,"description":"Time in milliseconds for scrolling before capturing the full page.","schema":{"type":"number","default":"400","description":"Time in milliseconds for scrolling before capturing the full page."}},{"name":"viewport_width","in":"query","required":false,"description":"The width of the browser viewport in pixels.","schema":{"type":"number","default":"1280","description":"The width of the browser viewport in pixels."}},{"name":"viewport_height","in":"query","required":false,"description":"The height of the browser viewport in pixels.","schema":{"type":"number","default":"1024","description":"The height of the browser viewport in pixels."}},{"name":"scale_factor","in":"query","required":false,"description":"The scale factor for high-resolution screenshots.","schema":{"type":"number","default":"1","description":"The scale factor for high-resolution screenshots."}},{"name":"image_quality","in":"query","required":false,"description":"Generate images with custom quality settings.\n\nSupported formats include:\n\n```\njpeg\n```\n\n```\nwebp\n```","schema":{"type":"string","default":"80","description":"Generate images with custom quality settings.\n\nSupported formats include:\n\n```\njpeg\n```\n\n```\nwebp\n```"}},{"name":"selector","in":"query","required":false,"description":"Capture a specific element on the page instead of the full viewport.","schema":{"type":"string","description":"Capture a specific element on the page instead of the full viewport."}},{"name":"cache","in":"query","required":false,"description":"Cache the response.","schema":{"type":"boolean","default":"false","description":"Cache the response."}},{"name":"cache_ttl","in":"query","required":false,"description":"Cache the response for a custom TTL (in seconds).","schema":{"type":"number","minimum":3600,"maximum":2592000,"default":"2592000","description":"Cache the response for a custom TTL (in seconds)."}},{"name":"remove_selectors","in":"query","required":false,"description":"A comma-separated list of elements to hide before capturing (e.g., ads, popups).","schema":{"type":"string","description":"A comma-separated list of elements to hide before capturing (e.g., ads, popups)."}},{"name":"remove_cookie_banners","in":"query","required":false,"description":"Automatically remove cookie banners before capturing.","schema":{"type":"boolean","default":"false","description":"Automatically remove cookie banners before capturing."}},{"name":"remove_ads","in":"query","required":false,"description":"Automatically remove ads before capturing.","schema":{"type":"boolean","default":"false","description":"Automatically remove ads before capturing."}},{"name":"block_resources","in":"query","required":false,"description":"Comma-separated list of resource types to block (e.g., “image,stylesheet,font”). \n\nAvailable resource types: \n\n- `document`\n- `stylesheet`\n- `image`\n- `media`\n- `font`\n- `script`\n- `texttrack`\n- `xhr`\n- `fetch`\n- `eventsource`\n- `websocket`\n- `manifest`\n- `other`\n\nUseful for optimizing page loading speed before capturing screenshots.","schema":{"type":"string","enum":["document","eventsource","fetch","font","image","manifest","media","other","script","stylesheet","texttrack","websocket","xhr"],"description":"Comma-separated list of resource types to block (e.g., “image,stylesheet,font”). \n\nAvailable resource types: \n\n- `document`\n- `stylesheet`\n- `image`\n- `media`\n- `font`\n- `script`\n- `texttrack`\n- `xhr`\n- `fetch`\n- `eventsource`\n- `websocket`\n- `manifest`\n- `other`\n\nUseful for optimizing page loading speed before capturing screenshots."}},{"name":"block_urls","in":"query","required":false,"description":"Comma-separated list of URL patterns to block (e.g., “analytics,tracking,advertisement”). \n\nYou can specify URLs, domains, or simple patterns like “.example.com/”.","schema":{"type":"string","description":"Comma-separated list of URL patterns to block (e.g., “analytics,tracking,advertisement”). \n\nYou can specify URLs, domains, or simple patterns like “.example.com/”."}},{"name":"delay","in":"query","required":false,"description":"Delay in seconds before capturing the screenshot.","schema":{"type":"number","minimum":0,"maximum":10,"default":"0","description":"Delay in seconds before capturing the screenshot."}},{"name":"wait_until","in":"query","required":false,"description":"Define when to capture.\n\nAvailable formats:  \n\n- `networkidle2`\n- `load`\n- `domcontentloaded`\n- `networkidle0`","schema":{"type":"array","items":{"type":"string"},"enum":["domcontentloaded","load","networkidle0","networkidle2"],"description":"Define when to capture.\n\nAvailable formats:  \n\n- `networkidle2`\n- `load`\n- `domcontentloaded`\n- `networkidle0`"}},{"name":"wait_for_selector","in":"query","required":false,"description":"Wait for a specific element to appear before taking the screenshot.","schema":{"type":"string","description":"Wait for a specific element to appear before taking the screenshot."}},{"name":"proxy","in":"query","required":false,"description":"Specify a proxy server to route your request through. \n\nSupports `HTTP`, `HTTPS`, and `SOCKS5` proxies. \n\nFormat: http://username:password@proxy.com:PORT. \n\nUseful for bypassing geo-restrictions and rotating IPs.","schema":{"type":"string","description":"Specify a proxy server to route your request through. \n\nSupports `HTTP`, `HTTPS`, and `SOCKS5` proxies. \n\nFormat: http://username:password@proxy.com:PORT. \n\nUseful for bypassing geo-restrictions and rotating IPs."}},{"name":"s3_secret_key","in":"query","required":false,"description":"AWS S3 secret access key.","schema":{"type":"string","description":"AWS S3 secret access key."}},{"name":"s3_access_key_id","in":"query","required":false,"description":"AWS S3 access key ID.","schema":{"type":"string","description":"AWS S3 access key ID."}},{"name":"s3_bucket","in":"query","required":false,"description":"The S3 bucket name where the screenshot will be uploaded.","schema":{"type":"string","description":"The S3 bucket name where the screenshot will be uploaded."}},{"name":"s3_object_key","in":"query","required":false,"description":"The filename for the S3 object (auto-generated if not provided).","schema":{"type":"string","description":"The filename for the S3 object (auto-generated if not provided)."}},{"name":"s3_region","in":"query","required":false,"description":"AWS S3 region for storage.\n\n","schema":{"type":"string","description":"AWS S3 region for storage.\n\n"}},{"name":"storage_endpoint","in":"query","required":false,"description":"Leave this field empty for AWS S3. Only specify a value if required. S3-compatible storage services are supported, for example, use https://<accountId>.r2.cloudflarestorage.com for Cloudflare R2.","schema":{"type":"string","description":"Leave this field empty for AWS S3. Only specify a value if required. S3-compatible storage services are supported, for example, use https://<accountId>.r2.cloudflarestorage.com for Cloudflare R2."}},{"name":"s3_url","in":"query","required":false,"description":"Use S3 storage for screenshots. The S3 URL will be returned in the response.","schema":{"type":"boolean","default":"false","description":"Use S3 storage for screenshots. The S3 URL will be returned in the response."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/brave/search":{"get":{"summary":"Brave Search","description":"Access the Brave search engine results directly through our efficient Piloterr service for reliable data scraping.\n\n**Credit cost:** 1 credit per call","operationId":"get-brave-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query to execute on Brave Search. Supports all standard Brave search operators.\n\n**Examples:**\n- `machine learning`: standard keyword search\n- `site:github.com scraper`: restrict results to a specific domain\n- `intitle:\"growth hacking\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    best programming languages 2024","schema":{"type":"string","description":"The search query to execute on Brave Search. Supports all standard Brave search operators.\n\n**Examples:**\n- `machine learning`: standard keyword search\n- `site:github.com scraper`: restrict results to a specific domain\n- `intitle:\"growth hacking\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    best programming languages 2024"}},{"name":"page","in":"query","required":false,"description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc.","schema":{"type":"number","default":"1","description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"organic_results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"snippet":{"type":"string"},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"page":{"type":"integer"},"engine":{"type":"string"}}}}},"examples":{"Search 'best programming languages 2024'":{"value":{"organic_results":[{"link":"https://survey.stackoverflow.co/2024/technology","title":"Technology | 2024 Stack Overflow Developer Survey","domain":"survey.stackoverflow.co","snippet":"JavaScript, Python and SQL are all highly-desired and admired programming languages, but Rust continues to be the most-admired programming language with an 83% score this year.","position":1,"displayed_link":"survey.stackoverflow.co › 2024  › technology","snippet_matched":[]},{"link":"https://www.tiobe.com/tiobe-index/","title":"TIOBE Index - TIOBE","domain":"www.tiobe.com","snippet":"1 day ago - The complete top 50 of programming languages is listed below.","position":2,"displayed_link":"tiobe.com   › home  › tiobe index","snippet_matched":[]},{"link":"https://spectrum.ieee.org/top-programming-languages-2024","title":"Top Programming Languages 2024 - IEEE Spectrum","domain":"spectrum.ieee.org","snippet":"September 3, 2024 - At the top, Python continues to rank first. SQL, Java, C++, Typescript, C, Rust, Swift, PHP...","position":3,"displayed_link":"spectrum.ieee.org › top-programming-languages-2024","snippet_matched":[]}],"search_parameters":{"q":"best programming languages 2024","page":0,"engine":"brave"}}},"Search 'startup funding news' page 2":{"value":{"organic_results":[{"link":"https://techcrunch.com/2026/03/20/ai-startups-are-eating-the-venture-industry-and-the-returns-so-far-are-good/","title":"AI startups are eating the venture industry and the returns, so far, are good | TechCrunch","domain":"techcrunch.com","snippet":"1 week ago - AI startups accounted for 41% of the $128 billion in venture dollars raised by companies on Carta last year: a record-high annual share.","position":1,"displayed_link":"techcrunch.com   › home  › ai startups are eating the venture industry...","snippet_matched":[]},{"link":"https://www.crunchbase.com/","title":"Crunchbase","domain":"www.crunchbase.com","snippet":"Unnatural Products secured multiple significant collaborations and funding rounds, including a partnership with Novartis that provided up to $100 million in upfront payments.","position":2,"displayed_link":"crunchbase.com","snippet_matched":[]},{"link":"https://news.crunchbase.com/venture/kleiner-perkins-raises-ai-focused-funds/","title":"Kleiner Perkins Raises $3.5B For AI-Focused Funds","domain":"news.crunchbase.com","snippet":"3 days ago - Kleiner Perkins' fundraise includes $1 billion for KP22, a fund to back early-stage companies, and $2.5 billion targeted for growth-stage investments.","position":3,"displayed_link":"news.crunchbase.com   › home  › kleiner perkins raises $3.5b for ai-focused funds","snippet_matched":[]}],"search_parameters":{"q":"startup funding news","page":1,"engine":"brave"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Brave Search","description":"Access the Brave search engine results directly through our efficient Piloterr service for reliable data scraping.\n\n**Credit cost:** 1 credit per call","operationId":"post-brave-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query to execute on Brave Search. Supports all standard Brave search operators.\n\n**Examples:**\n- `machine learning`: standard keyword search\n- `site:github.com scraper`: restrict results to a specific domain\n- `intitle:\"growth hacking\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    best programming languages 2024","schema":{"type":"string","description":"The search query to execute on Brave Search. Supports all standard Brave search operators.\n\n**Examples:**\n- `machine learning`: standard keyword search\n- `site:github.com scraper`: restrict results to a specific domain\n- `intitle:\"growth hacking\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    best programming languages 2024"}},{"name":"page","in":"query","required":false,"description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc.","schema":{"type":"number","default":"1","description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"organic_results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"snippet":{"type":"string"},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"page":{"type":"integer"},"engine":{"type":"string"}}}}},"examples":{"Search 'best programming languages 2024'":{"value":{"organic_results":[{"link":"https://survey.stackoverflow.co/2024/technology","title":"Technology | 2024 Stack Overflow Developer Survey","domain":"survey.stackoverflow.co","snippet":"JavaScript, Python and SQL are all highly-desired and admired programming languages, but Rust continues to be the most-admired programming language with an 83% score this year.","position":1,"displayed_link":"survey.stackoverflow.co › 2024  › technology","snippet_matched":[]},{"link":"https://www.tiobe.com/tiobe-index/","title":"TIOBE Index - TIOBE","domain":"www.tiobe.com","snippet":"1 day ago - The complete top 50 of programming languages is listed below.","position":2,"displayed_link":"tiobe.com   › home  › tiobe index","snippet_matched":[]},{"link":"https://spectrum.ieee.org/top-programming-languages-2024","title":"Top Programming Languages 2024 - IEEE Spectrum","domain":"spectrum.ieee.org","snippet":"September 3, 2024 - At the top, Python continues to rank first. SQL, Java, C++, Typescript, C, Rust, Swift, PHP...","position":3,"displayed_link":"spectrum.ieee.org › top-programming-languages-2024","snippet_matched":[]}],"search_parameters":{"q":"best programming languages 2024","page":0,"engine":"brave"}}},"Search 'startup funding news' page 2":{"value":{"organic_results":[{"link":"https://techcrunch.com/2026/03/20/ai-startups-are-eating-the-venture-industry-and-the-returns-so-far-are-good/","title":"AI startups are eating the venture industry and the returns, so far, are good | TechCrunch","domain":"techcrunch.com","snippet":"1 week ago - AI startups accounted for 41% of the $128 billion in venture dollars raised by companies on Carta last year: a record-high annual share.","position":1,"displayed_link":"techcrunch.com   › home  › ai startups are eating the venture industry...","snippet_matched":[]},{"link":"https://www.crunchbase.com/","title":"Crunchbase","domain":"www.crunchbase.com","snippet":"Unnatural Products secured multiple significant collaborations and funding rounds, including a partnership with Novartis that provided up to $100 million in upfront payments.","position":2,"displayed_link":"crunchbase.com","snippet_matched":[]},{"link":"https://news.crunchbase.com/venture/kleiner-perkins-raises-ai-focused-funds/","title":"Kleiner Perkins Raises $3.5B For AI-Focused Funds","domain":"news.crunchbase.com","snippet":"3 days ago - Kleiner Perkins' fundraise includes $1 billion for KP22, a fund to back early-stage companies, and $2.5 billion targeted for growth-stage investments.","position":3,"displayed_link":"news.crunchbase.com   › home  › kleiner perkins raises $3.5b for ai-focused funds","snippet_matched":[]}],"search_parameters":{"q":"startup funding news","page":1,"engine":"brave"}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bing/search":{"get":{"summary":"Bing Search","description":"Scrape real-time Bing search results with full control over location, language, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-bing-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query to execute on Bing. Supports all Bing advanced search operators.\n\n**Examples:**\n- `artificial intelligence`: standard keyword search\n- `site:github.com python scraper`: restrict results to a specific domain\n- `intitle:\"machine learning\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    artificial intelligence news 2024","schema":{"type":"string","description":"The search query to execute on Bing. Supports all Bing advanced search operators.\n\n**Examples:**\n- `artificial intelligence`: standard keyword search\n- `site:github.com python scraper`: restrict results to a specific domain\n- `intitle:\"machine learning\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    artificial intelligence news 2024"}},{"name":"page","in":"query","required":false,"description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc.","schema":{"type":"number","description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc."}},{"name":"num","in":"query","required":false,"description":"Number of results per page. **Minimum:** `10`, **Maximum:** `50`.\n\n**Note:** This parameter is only a suggestion and might not reflect the actual number of results returned.","schema":{"type":"number","description":"Number of results per page. **Minimum:** `10`, **Maximum:** `50`.\n\n**Note:** This parameter is only a suggestion and might not reflect the actual number of results returned."}},{"name":"location","in":"query","required":false,"description":"City or region from which the search should originate. If multiple locations match, the most popular one is selected.\n\n**Note:** Cannot be used together with `lat`/`lon`. It is recommended to specify location at the city level.\n\n**Example:**\n\n    Austin","schema":{"type":"string","description":"City or region from which the search should originate. If multiple locations match, the most popular one is selected.\n\n**Note:** Cannot be used together with `lat`/`lon`. It is recommended to specify location at the city level.\n\n**Example:**\n\n    Austin"}},{"name":"lat","in":"query","required":false,"description":"GPS latitude coordinate for the search origin.\n\n**Example:**\n\n    48.8566","schema":{"type":"number","description":"GPS latitude coordinate for the search origin.\n\n**Example:**\n\n    48.8566"}},{"name":"lon","in":"query","required":false,"description":"GPS longitude coordinate for the search origin.\n\n**Example:**\n\n    2.3522","schema":{"type":"number","description":"GPS longitude coordinate for the search origin.\n\n**Example:**\n\n    2.3522"}},{"name":"mkt","in":"query","required":false,"description":"Market code combining language and country, in the form `<language>-<country>`. Defines where the results come from.\n\n- `en-US`: English, United States (default)\n- `fr-FR`: French, France\n- `de-DE`: German, Germany\n- `es-ES`: Spanish, Spain\n\n**Note:** Cannot be used together with `cc`.","schema":{"type":"string","description":"Market code combining language and country, in the form `<language>-<country>`. Defines where the results come from.\n\n- `en-US`: English, United States (default)\n- `fr-FR`: French, France\n- `de-DE`: German, Germany\n- `es-ES`: Spanish, Spain\n\n**Note:** Cannot be used together with `cc`."}},{"name":"cc","in":"query","required":false,"description":"Two-letter ISO 3166-1 country code defining the country to search from.\n\n- `us`: United States\n- `de`: Germany\n- `gb`: United Kingdom\n- `fr`: France\n\n**Note:** Cannot be used together with `mkt`.","schema":{"type":"string","description":"Two-letter ISO 3166-1 country code defining the country to search from.\n\n- `us`: United States\n- `de`: Germany\n- `gb`: United Kingdom\n- `fr`: France\n\n**Note:** Cannot be used together with `mkt`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"nullable":true},"current":{"type":"integer"},"other_pages":{"type":"array","items":{}},"has_next_page":{"type":"boolean"}}},"organic_results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"snippet":{"nullable":true},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"cc":{"nullable":true},"lat":{"nullable":true},"lon":{"nullable":true},"mkt":{"nullable":true},"num":{"nullable":true},"page":{"type":"integer"},"engine":{"type":"string"},"location":{"nullable":true},"bing_domain":{"type":"string"}}},"search_information":{"type":"object","properties":{"total_results":{"nullable":true}}}}},"examples":{"Search 'artificial intelligence'":{"value":{"pagination":{"next":null,"current":1,"other_pages":[],"has_next_page":false},"organic_results":[{"link":"https://en.m.wikipedia.org/wiki/Artificial_intelligence","title":"Artificial intelligence - Wikipedia","domain":"en.m.wikipedia.org","snippet":null,"position":1,"displayed_link":"https://en.m.wikipedia.org › wiki ›Artificial_intelligence","snippet_matched":[]},{"link":"https://www.britannica.com/technology/artificial-intelligence","title":"Artificial intelligence (AI) | Definition, Examples, Types ...","domain":"britannica.com","snippet":null,"position":2,"displayed_link":"https://www.britannica.com › technology ›artificial-intelligence","snippet_matched":[]},{"link":"https://www.ibm.com/think/topics/artificial-intelligence","title":"What is artificial intelligence (AI)? - IBM","domain":"ibm.com","snippet":"Artificial intelligence (AI) is technology that enables computers and machines to simulate human learning, comprehension, problem solving, decision-making, creativity and autonomy.","position":3,"displayed_link":"https://www.ibm.com › think › topics ›artificial-intelligence","snippet_matched":["artificial intelligence"]}],"search_parameters":{"q":"artificial intelligence","cc":null,"lat":null,"lon":null,"mkt":null,"num":null,"page":1,"engine":"bing","location":null,"bing_domain":"bing.com"},"search_information":{"total_results":null}}},"Search 'python tutorial' with market 'en-US'":{"value":{"pagination":{"next":null,"current":1,"other_pages":[],"has_next_page":false},"organic_results":[{"link":"https://docs.python.org/3/tutorial/index.html","title":"The Python Tutorial. Python 3.14.3 documentation","domain":"docs.python.org","snippet":null,"position":1,"displayed_link":"https://docs.python.org ›tutorial","snippet_matched":[]},{"link":"https://www.tutorialspoint.com/python/index.htm","title":"Python Tutorial","domain":"tutorialspoint.com","snippet":"This Python tutorial gives a complete understanding of Python programming language, starting from basic concepts to advanced concepts.","position":2,"displayed_link":"https://www.tutorialspoint.com ›python","snippet_matched":["python tutorial"]},{"link":"https://www.learnpython.org/","title":"Learn Python - Free Interactive Python Tutorial","domain":"learnpython.org","snippet":"Learn Python for data science, web development, or general programming with this website.","position":3,"displayed_link":"https://www.learnpython.org","snippet_matched":[]},{"link":"https://realpython.com/","title":"Python Tutorials – Real Python","domain":"realpython.com","snippet":"Learn Python online: Python tutorials for developers of all skill levels, Python books and courses, Python news, code examples, articles, and more.","position":4,"displayed_link":"https://realpython.com","snippet_matched":["python tutorial"]}],"search_parameters":{"q":"python tutorial","cc":null,"lat":null,"lon":null,"mkt":"en-US","num":null,"page":1,"engine":"bing","location":null,"bing_domain":"bing.com"},"search_information":{"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Bing Search","description":"Scrape real-time Bing search results with full control over location, language, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-bing-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query to execute on Bing. Supports all Bing advanced search operators.\n\n**Examples:**\n- `artificial intelligence`: standard keyword search\n- `site:github.com python scraper`: restrict results to a specific domain\n- `intitle:\"machine learning\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    artificial intelligence news 2024","schema":{"type":"string","description":"The search query to execute on Bing. Supports all Bing advanced search operators.\n\n**Examples:**\n- `artificial intelligence`: standard keyword search\n- `site:github.com python scraper`: restrict results to a specific domain\n- `intitle:\"machine learning\"`: match the page title\n- `inurl:blog python`: match part of the URL\n\n**Example:**\n\n    artificial intelligence news 2024"}},{"name":"page","in":"query","required":false,"description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc.","schema":{"type":"number","description":"Page number of results to retrieve. Used for pagination.\n\n- `1`: First page (default)\n- `2`: Second page\n- `3`: Third page, etc."}},{"name":"num","in":"query","required":false,"description":"Number of results per page. **Minimum:** `10`, **Maximum:** `50`.\n\n**Note:** This parameter is only a suggestion and might not reflect the actual number of results returned.","schema":{"type":"number","description":"Number of results per page. **Minimum:** `10`, **Maximum:** `50`.\n\n**Note:** This parameter is only a suggestion and might not reflect the actual number of results returned."}},{"name":"location","in":"query","required":false,"description":"City or region from which the search should originate. If multiple locations match, the most popular one is selected.\n\n**Note:** Cannot be used together with `lat`/`lon`. It is recommended to specify location at the city level.\n\n**Example:**\n\n    Austin","schema":{"type":"string","description":"City or region from which the search should originate. If multiple locations match, the most popular one is selected.\n\n**Note:** Cannot be used together with `lat`/`lon`. It is recommended to specify location at the city level.\n\n**Example:**\n\n    Austin"}},{"name":"lat","in":"query","required":false,"description":"GPS latitude coordinate for the search origin.\n\n**Example:**\n\n    48.8566","schema":{"type":"number","description":"GPS latitude coordinate for the search origin.\n\n**Example:**\n\n    48.8566"}},{"name":"lon","in":"query","required":false,"description":"GPS longitude coordinate for the search origin.\n\n**Example:**\n\n    2.3522","schema":{"type":"number","description":"GPS longitude coordinate for the search origin.\n\n**Example:**\n\n    2.3522"}},{"name":"mkt","in":"query","required":false,"description":"Market code combining language and country, in the form `<language>-<country>`. Defines where the results come from.\n\n- `en-US`: English, United States (default)\n- `fr-FR`: French, France\n- `de-DE`: German, Germany\n- `es-ES`: Spanish, Spain\n\n**Note:** Cannot be used together with `cc`.","schema":{"type":"string","description":"Market code combining language and country, in the form `<language>-<country>`. Defines where the results come from.\n\n- `en-US`: English, United States (default)\n- `fr-FR`: French, France\n- `de-DE`: German, Germany\n- `es-ES`: Spanish, Spain\n\n**Note:** Cannot be used together with `cc`."}},{"name":"cc","in":"query","required":false,"description":"Two-letter ISO 3166-1 country code defining the country to search from.\n\n- `us`: United States\n- `de`: Germany\n- `gb`: United Kingdom\n- `fr`: France\n\n**Note:** Cannot be used together with `mkt`.","schema":{"type":"string","description":"Two-letter ISO 3166-1 country code defining the country to search from.\n\n- `us`: United States\n- `de`: Germany\n- `gb`: United Kingdom\n- `fr`: France\n\n**Note:** Cannot be used together with `mkt`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"nullable":true},"current":{"type":"integer"},"other_pages":{"type":"array","items":{}},"has_next_page":{"type":"boolean"}}},"organic_results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"snippet":{"nullable":true},"position":{"type":"integer"},"displayed_link":{"type":"string"},"snippet_matched":{"type":"array","items":{}}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"cc":{"nullable":true},"lat":{"nullable":true},"lon":{"nullable":true},"mkt":{"nullable":true},"num":{"nullable":true},"page":{"type":"integer"},"engine":{"type":"string"},"location":{"nullable":true},"bing_domain":{"type":"string"}}},"search_information":{"type":"object","properties":{"total_results":{"nullable":true}}}}},"examples":{"Search 'artificial intelligence'":{"value":{"pagination":{"next":null,"current":1,"other_pages":[],"has_next_page":false},"organic_results":[{"link":"https://en.m.wikipedia.org/wiki/Artificial_intelligence","title":"Artificial intelligence - Wikipedia","domain":"en.m.wikipedia.org","snippet":null,"position":1,"displayed_link":"https://en.m.wikipedia.org › wiki ›Artificial_intelligence","snippet_matched":[]},{"link":"https://www.britannica.com/technology/artificial-intelligence","title":"Artificial intelligence (AI) | Definition, Examples, Types ...","domain":"britannica.com","snippet":null,"position":2,"displayed_link":"https://www.britannica.com › technology ›artificial-intelligence","snippet_matched":[]},{"link":"https://www.ibm.com/think/topics/artificial-intelligence","title":"What is artificial intelligence (AI)? - IBM","domain":"ibm.com","snippet":"Artificial intelligence (AI) is technology that enables computers and machines to simulate human learning, comprehension, problem solving, decision-making, creativity and autonomy.","position":3,"displayed_link":"https://www.ibm.com › think › topics ›artificial-intelligence","snippet_matched":["artificial intelligence"]}],"search_parameters":{"q":"artificial intelligence","cc":null,"lat":null,"lon":null,"mkt":null,"num":null,"page":1,"engine":"bing","location":null,"bing_domain":"bing.com"},"search_information":{"total_results":null}}},"Search 'python tutorial' with market 'en-US'":{"value":{"pagination":{"next":null,"current":1,"other_pages":[],"has_next_page":false},"organic_results":[{"link":"https://docs.python.org/3/tutorial/index.html","title":"The Python Tutorial. Python 3.14.3 documentation","domain":"docs.python.org","snippet":null,"position":1,"displayed_link":"https://docs.python.org ›tutorial","snippet_matched":[]},{"link":"https://www.tutorialspoint.com/python/index.htm","title":"Python Tutorial","domain":"tutorialspoint.com","snippet":"This Python tutorial gives a complete understanding of Python programming language, starting from basic concepts to advanced concepts.","position":2,"displayed_link":"https://www.tutorialspoint.com ›python","snippet_matched":["python tutorial"]},{"link":"https://www.learnpython.org/","title":"Learn Python - Free Interactive Python Tutorial","domain":"learnpython.org","snippet":"Learn Python for data science, web development, or general programming with this website.","position":3,"displayed_link":"https://www.learnpython.org","snippet_matched":[]},{"link":"https://realpython.com/","title":"Python Tutorials – Real Python","domain":"realpython.com","snippet":"Learn Python online: Python tutorials for developers of all skill levels, Python books and courses, Python news, code examples, articles, and more.","position":4,"displayed_link":"https://realpython.com","snippet_matched":["python tutorial"]}],"search_parameters":{"q":"python tutorial","cc":null,"lat":null,"lon":null,"mkt":"en-US","num":null,"page":1,"engine":"bing","location":null,"bing_domain":"bing.com"},"search_information":{"total_results":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/pinterest/user/info":{"get":{"summary":"Pinterest User Info","description":"Access Pinterest user profiles and analytics for targeted marketing and audience insights.\n\n**Credit cost:** 1 credit per call","operationId":"get-pinterest-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Pinterest profile to retrieve. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.pinterest.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.pinterest.com/example-user/\n\n**Notes:**\n- **Private accounts:** Pinterest does not have private accounts, all public profiles are accessible.\n- **Deactivated accounts:** Returns a not-found error if the account no longer exists.","schema":{"type":"string","description":"The Pinterest profile to retrieve. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.pinterest.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.pinterest.com/example-user/\n\n**Notes:**\n- **Private accounts:** Pinterest does not have private accounts, all public profiles are accessible.\n- **Deactivated accounts:** Returns a not-found error if the account no longer exists."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"avatar":{"type":"string"},"website":{"nullable":true},"pin_count":{"type":"integer"},"created_at":{"type":"string"},"board_count":{"type":"integer"},"description":{"nullable":true},"is_verified":{"type":"boolean"},"profile_cover":{"nullable":true},"follower_count":{"type":"integer"},"domain_verified":{"type":"boolean"}}},"examples":{"Lookup by username: example-user":{"value":{"name":"Alex Martin","avatar":"https://i.pinimg.com/placeholder/example-user.jpg","website":null,"pin_count":117,"created_at":"2012-01-19T22:21:18.000Z","board_count":10,"description":null,"is_verified":false,"profile_cover":null,"follower_count":84,"domain_verified":false}},"Lookup verified creator profile":{"value":{"name":"Jordan Lee","avatar":"https://i.pinimg.com/placeholder/example-user-2.jpg","website":"https://www.example.com","pin_count":4827,"created_at":"2015-06-03T10:00:00.000Z","board_count":47,"description":"Interior design & home decor inspiration.","is_verified":true,"profile_cover":"https://i.pinimg.com/placeholder/example-user-2.jpg","follower_count":125400,"domain_verified":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Pinterest User Info","description":"Access Pinterest user profiles and analytics for targeted marketing and audience insights.\n\n**Credit cost:** 1 credit per call","operationId":"post-pinterest-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Pinterest profile to retrieve. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.pinterest.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.pinterest.com/example-user/\n\n**Notes:**\n- **Private accounts:** Pinterest does not have private accounts, all public profiles are accessible.\n- **Deactivated accounts:** Returns a not-found error if the account no longer exists.","schema":{"type":"string","description":"The Pinterest profile to retrieve. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.pinterest.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.pinterest.com/example-user/\n\n**Notes:**\n- **Private accounts:** Pinterest does not have private accounts, all public profiles are accessible.\n- **Deactivated accounts:** Returns a not-found error if the account no longer exists."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"avatar":{"type":"string"},"website":{"nullable":true},"pin_count":{"type":"integer"},"created_at":{"type":"string"},"board_count":{"type":"integer"},"description":{"nullable":true},"is_verified":{"type":"boolean"},"profile_cover":{"nullable":true},"follower_count":{"type":"integer"},"domain_verified":{"type":"boolean"}}},"examples":{"Lookup by username: example-user":{"value":{"name":"Alex Martin","avatar":"https://i.pinimg.com/placeholder/example-user.jpg","website":null,"pin_count":117,"created_at":"2012-01-19T22:21:18.000Z","board_count":10,"description":null,"is_verified":false,"profile_cover":null,"follower_count":84,"domain_verified":false}},"Lookup verified creator profile":{"value":{"name":"Jordan Lee","avatar":"https://i.pinimg.com/placeholder/example-user-2.jpg","website":"https://www.example.com","pin_count":4827,"created_at":"2015-06-03T10:00:00.000Z","board_count":47,"description":"Interior design & home decor inspiration.","is_verified":true,"profile_cover":"https://i.pinimg.com/placeholder/example-user-2.jpg","follower_count":125400,"domain_verified":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/instagram/post/info":{"get":{"summary":"Instagram Post Info","description":"Monitor competitors and market trends by scraping Instagram posts for valuable data.\n\n**Credit cost:** 1 credit per call","operationId":"get-instagram-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Instagram post or reel to retrieve. Accepts a full URL or a shortcode.\n\n**Accepted formats:**\n- `https://www.instagram.com/p/CshTQQlMGMl`: full post URL\n- `CshTQQlMGMl`: post shortcode only\n\n**Example:**\n\n    https://www.instagram.com/p/CshTQQlMGMl\n\n**Notes:**\n- **Private accounts:** Posts from private accounts cannot be retrieved.\n- **Deleted posts:** Returns a not-found error if the post no longer exists.","schema":{"type":"string","description":"The Instagram post or reel to retrieve. Accepts a full URL or a shortcode.\n\n**Accepted formats:**\n- `https://www.instagram.com/p/CshTQQlMGMl`: full post URL\n- `CshTQQlMGMl`: post shortcode only\n\n**Example:**\n\n    https://www.instagram.com/p/CshTQQlMGMl\n\n**Notes:**\n- **Private accounts:** Posts from private accounts cannot be retrieved.\n- **Deleted posts:** Returns a not-found error if the post no longer exists."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"is_video":{"type":"boolean"},"owner_id":{"type":"string"},"sponsors":{"type":"array","items":{}},"shortcode":{"type":"string"},"text_lang":{"type":"string"},"text_tags":{"type":"array","items":{}},"timestamp":{"type":"integer"},"like_count":{"type":"integer"},"location_id":{"type":"string"},"created_time":{"type":"string"},"product_type":{"nullable":true},"location_name":{"type":"string"},"location_slug":{"type":"string"},"related_posts":{"nullable":true},"comments_count":{"type":"integer"},"paid_partnership":{"type":"boolean"},"text_tagged_users":{"type":"array","items":{}},"video_plays_count":{"nullable":true},"video_views_count":{"nullable":true},"is_comments_disabled":{"type":"boolean"},"attached_media_display_url":{"type":"string"},"attached_media_tagged_users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"}}}},"attached_carousel_media_urls":{"type":"array","items":{"type":"string"}}}},"examples":{"Lookup by post URL":{"value":{"id":"3859342446496501512","text":"🇫🇷","is_video":false,"owner_id":"4213518589","sponsors":[],"shortcode":"DWPI4HmAs8I","text_lang":"fr","text_tags":[],"timestamp":1774289493,"like_count":1337686,"location_id":"375685686285802","created_time":"2026-03-23 18:11:33","product_type":null,"location_name":"Clairefontaine - Centre National Du Football","location_slug":"clairefontaine-centre-national-du-football","related_posts":null,"comments_count":8331,"paid_partnership":false,"text_tagged_users":[],"video_plays_count":null,"video_views_count":null,"is_comments_disabled":false,"attached_media_display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/655936260_18460602253142590_4270314222914824377_n.jpg","attached_media_tagged_users":[{"id":"253982730","username":"example-user"}],"attached_carousel_media_urls":["https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/655936260_18460602253142590_4270314222914824377_n.jpg","https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/658867910_18460602280142590_6337465939339629136_n.jpg","https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/657621742_18460602271142590_1605271971122095294_n.jpg"]}},"Lookup by shortcode":{"value":{"id":"3107849898061488933","text":"🍿","is_video":false,"owner_id":"4213518589","sponsors":[],"shortcode":"CshTQQlMGMl","text_lang":"en","text_tags":[],"timestamp":1684704600,"like_count":2604768,"location_id":"12345912","created_time":"2023-05-21T21:30:00","product_type":null,"location_name":"Auxerre","location_slug":"auxerre","related_posts":null,"comments_count":11566,"paid_partnership":false,"text_tagged_users":[],"video_plays_count":null,"video_views_count":null,"is_comments_disabled":false,"attached_media_display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.2885-15/347861207_1707687973014484_3649610220149539376_n.jpg","attached_media_tagged_users":[],"attached_carousel_media_urls":["https://scontent-cdg4-1.cdninstagram.com/v/t51.2885-15/347861207_1707687973014484_3649610220149539376_n.jpg","https://scontent-cdg4-2.cdninstagram.com/v/t51.2885-15/347832052_2243608469163355_4814444542687724291_n.jpg"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Instagram Post Info","description":"Monitor competitors and market trends by scraping Instagram posts for valuable data.\n\n**Credit cost:** 1 credit per call","operationId":"post-instagram-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Instagram post or reel to retrieve. Accepts a full URL or a shortcode.\n\n**Accepted formats:**\n- `https://www.instagram.com/p/CshTQQlMGMl`: full post URL\n- `CshTQQlMGMl`: post shortcode only\n\n**Example:**\n\n    https://www.instagram.com/p/CshTQQlMGMl\n\n**Notes:**\n- **Private accounts:** Posts from private accounts cannot be retrieved.\n- **Deleted posts:** Returns a not-found error if the post no longer exists.","schema":{"type":"string","description":"The Instagram post or reel to retrieve. Accepts a full URL or a shortcode.\n\n**Accepted formats:**\n- `https://www.instagram.com/p/CshTQQlMGMl`: full post URL\n- `CshTQQlMGMl`: post shortcode only\n\n**Example:**\n\n    https://www.instagram.com/p/CshTQQlMGMl\n\n**Notes:**\n- **Private accounts:** Posts from private accounts cannot be retrieved.\n- **Deleted posts:** Returns a not-found error if the post no longer exists."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"is_video":{"type":"boolean"},"owner_id":{"type":"string"},"sponsors":{"type":"array","items":{}},"shortcode":{"type":"string"},"text_lang":{"type":"string"},"text_tags":{"type":"array","items":{}},"timestamp":{"type":"integer"},"like_count":{"type":"integer"},"location_id":{"type":"string"},"created_time":{"type":"string"},"product_type":{"nullable":true},"location_name":{"type":"string"},"location_slug":{"type":"string"},"related_posts":{"nullable":true},"comments_count":{"type":"integer"},"paid_partnership":{"type":"boolean"},"text_tagged_users":{"type":"array","items":{}},"video_plays_count":{"nullable":true},"video_views_count":{"nullable":true},"is_comments_disabled":{"type":"boolean"},"attached_media_display_url":{"type":"string"},"attached_media_tagged_users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"}}}},"attached_carousel_media_urls":{"type":"array","items":{"type":"string"}}}},"examples":{"Lookup by post URL":{"value":{"id":"3859342446496501512","text":"🇫🇷","is_video":false,"owner_id":"4213518589","sponsors":[],"shortcode":"DWPI4HmAs8I","text_lang":"fr","text_tags":[],"timestamp":1774289493,"like_count":1337686,"location_id":"375685686285802","created_time":"2026-03-23 18:11:33","product_type":null,"location_name":"Clairefontaine - Centre National Du Football","location_slug":"clairefontaine-centre-national-du-football","related_posts":null,"comments_count":8331,"paid_partnership":false,"text_tagged_users":[],"video_plays_count":null,"video_views_count":null,"is_comments_disabled":false,"attached_media_display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/655936260_18460602253142590_4270314222914824377_n.jpg","attached_media_tagged_users":[{"id":"253982730","username":"example-user"}],"attached_carousel_media_urls":["https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/655936260_18460602253142590_4270314222914824377_n.jpg","https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/658867910_18460602280142590_6337465939339629136_n.jpg","https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/657621742_18460602271142590_1605271971122095294_n.jpg"]}},"Lookup by shortcode":{"value":{"id":"3107849898061488933","text":"🍿","is_video":false,"owner_id":"4213518589","sponsors":[],"shortcode":"CshTQQlMGMl","text_lang":"en","text_tags":[],"timestamp":1684704600,"like_count":2604768,"location_id":"12345912","created_time":"2023-05-21T21:30:00","product_type":null,"location_name":"Auxerre","location_slug":"auxerre","related_posts":null,"comments_count":11566,"paid_partnership":false,"text_tagged_users":[],"video_plays_count":null,"video_views_count":null,"is_comments_disabled":false,"attached_media_display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.2885-15/347861207_1707687973014484_3649610220149539376_n.jpg","attached_media_tagged_users":[],"attached_carousel_media_urls":["https://scontent-cdg4-1.cdninstagram.com/v/t51.2885-15/347861207_1707687973014484_3649610220149539376_n.jpg","https://scontent-cdg4-2.cdninstagram.com/v/t51.2885-15/347832052_2243608469163355_4814444542687724291_n.jpg"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/instagram/user/info":{"get":{"summary":"Instagram User Info","description":"Gather user insights efficiently from Instagram for targeted marketing strategies.\n\n**Credit cost:** 1 credit per call","operationId":"get-instagram-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Instagram user to look up. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.instagram.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.instagram.com/example-user/\n\n**Notes:**\n- **Private accounts:** Profile data is returned but posts array will be empty.\n- **Deactivated accounts:** Returns a not-found error.","schema":{"type":"string","description":"The Instagram user to look up. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.instagram.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.instagram.com/example-user/\n\n**Notes:**\n- **Private accounts:** Profile data is returned but posts array will be empty.\n- **Deactivated accounts:** Returns a not-found error."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"likes":{"type":"integer"},"caption":{"type":"string"},"comments":{"type":"integer"},"is_video":{"type":"boolean"},"shortcode":{"type":"string"},"timestamp":{"type":"integer"},"display_url":{"type":"string"}}}},"avatar":{"type":"string"},"gender":{"type":"string"},"private":{"type":"boolean"},"website":{"nullable":true},"username":{"type":"string"},"verified":{"type":"boolean"},"followers":{"type":"integer"},"following":{"type":"integer"},"description":{"type":"string"},"category_name":{"type":"string"},"business_account":{"type":"boolean"},"business_category_name":{"type":"string"}}},"examples":{"Lookup by username. Alex Martin":{"value":{"id":"4213518589","name":"Alex Martin","posts":[{"id":"3859342446496501512","likes":1337767,"caption":"🇫🇷","comments":8331,"is_video":false,"shortcode":"DWPI4HmAs8I","timestamp":1774289493,"display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/655936260_18460602253142590_4270314222914824377_n.jpg"},{"id":"3855144622124864107","likes":1768534,"caption":"nos vemos en cuartos de final ¡HalaMadrid!","comments":10146,"is_video":false,"shortcode":"DWAOZu_gpJr","timestamp":1773789073,"display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/652735959_18458319658142590_2295182466998776037_n.jpg"},{"id":"3854258635190482004","likes":1527854,"caption":"back to business.","comments":12098,"is_video":false,"shortcode":"DV9E87XArRU","timestamp":1773683455,"display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/652806606_18457940533142590_3633003369562801254_n.jpg"}],"avatar":"https://scontent-cdg4-3.cdninstagram.com/placeholder/example-user.jpg","gender":"ambiguous","private":false,"website":null,"username":"example-user","verified":true,"followers":130723780,"following":498,"description":"Example profile.","category_name":"Athlete","business_account":true,"business_category_name":"None"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Instagram User Info","description":"Gather user insights efficiently from Instagram for targeted marketing strategies.\n\n**Credit cost:** 1 credit per call","operationId":"post-instagram-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Instagram user to look up. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.instagram.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.instagram.com/example-user/\n\n**Notes:**\n- **Private accounts:** Profile data is returned but posts array will be empty.\n- **Deactivated accounts:** Returns a not-found error.","schema":{"type":"string","description":"The Instagram user to look up. Accepts a full profile URL or a username.\n\n**Accepted formats:**\n- `https://www.instagram.com/example-user/`: full profile URL\n- `example-user`: username only\n\n**Example:**\n\n    https://www.instagram.com/example-user/\n\n**Notes:**\n- **Private accounts:** Profile data is returned but posts array will be empty.\n- **Deactivated accounts:** Returns a not-found error."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"likes":{"type":"integer"},"caption":{"type":"string"},"comments":{"type":"integer"},"is_video":{"type":"boolean"},"shortcode":{"type":"string"},"timestamp":{"type":"integer"},"display_url":{"type":"string"}}}},"avatar":{"type":"string"},"gender":{"type":"string"},"private":{"type":"boolean"},"website":{"nullable":true},"username":{"type":"string"},"verified":{"type":"boolean"},"followers":{"type":"integer"},"following":{"type":"integer"},"description":{"type":"string"},"category_name":{"type":"string"},"business_account":{"type":"boolean"},"business_category_name":{"type":"string"}}},"examples":{"Lookup by username. Alex Martin":{"value":{"id":"4213518589","name":"Alex Martin","posts":[{"id":"3859342446496501512","likes":1337767,"caption":"🇫🇷","comments":8331,"is_video":false,"shortcode":"DWPI4HmAs8I","timestamp":1774289493,"display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/655936260_18460602253142590_4270314222914824377_n.jpg"},{"id":"3855144622124864107","likes":1768534,"caption":"nos vemos en cuartos de final ¡HalaMadrid!","comments":10146,"is_video":false,"shortcode":"DWAOZu_gpJr","timestamp":1773789073,"display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/652735959_18458319658142590_2295182466998776037_n.jpg"},{"id":"3854258635190482004","likes":1527854,"caption":"back to business.","comments":12098,"is_video":false,"shortcode":"DV9E87XArRU","timestamp":1773683455,"display_url":"https://scontent-cdg4-1.cdninstagram.com/v/t51.82787-15/652806606_18457940533142590_3633003369562801254_n.jpg"}],"avatar":"https://scontent-cdg4-3.cdninstagram.com/placeholder/example-user.jpg","gender":"ambiguous","private":false,"website":null,"username":"example-user","verified":true,"followers":130723780,"following":498,"description":"Example profile.","category_name":"Athlete","business_account":true,"business_category_name":"None"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/kick/user/info":{"get":{"summary":"Kick User Info","description":"Retrieve complete public channel data from Kick including streamer profile, follower count, live status, and recent categories.\n\n**Credit cost:** 1 credit per call","operationId":"get-kick-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Kick channel to look up. Accepts a full channel URL or a username/slug.\n\n**Accepted formats:**\n- `https://kick.com/example-user`: full channel URL\n- `example-user`: channel slug/username only\n\n**Example:**\n\n    https://kick.com/example-user\n\n**Notes:**\n- **Banned channels:** The `is_banned` field will be `true` for banned users but data may still be returned.\n- **Offline streamers:** The `livestream` field will be `null` when the channel is not live.","schema":{"type":"string","description":"The Kick channel to look up. Accepts a full channel URL or a username/slug.\n\n**Accepted formats:**\n- `https://kick.com/example-user`: full channel URL\n- `example-user`: channel slug/username only\n\n**Example:**\n\n    https://kick.com/example-user\n\n**Notes:**\n- **Banned channels:** The `is_banned` field will be `true` for banned users but data may still be returned.\n- **Offline streamers:** The `livestream` field will be `null` when the channel is not live."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"role":{"nullable":true},"slug":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"bio":{"type":"string"},"city":{"nullable":true},"gender":{"nullable":true},"discord":{"type":"string"},"twitter":{"type":"string"},"youtube":{"type":"string"},"username":{"type":"string"},"instagram":{"type":"string"},"profile_pic":{"type":"string"}}},"muted":{"type":"boolean"},"user_id":{"type":"integer"},"verified":{"type":"boolean"},"is_banned":{"type":"boolean"},"livestream":{"nullable":true},"vod_enabled":{"type":"boolean"},"banner_image":{"type":"object","properties":{"url":{"type":"string"}}},"playback_url":{"type":"string"},"follower_badges":{"type":"array","items":{}},"followers_count":{"type":"integer"},"recent_categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"subscription_enabled":{"type":"boolean"}}},"examples":{"Lookup by username: example-user":{"value":{"id":668,"role":null,"slug":"example-user","user":{"id":676,"bio":"Example creator profile.","city":null,"gender":null,"discord":"example-user","twitter":"example-user","youtube":"example-user","username":"example-user","instagram":"example-user","profile_pic":"https://files.kick.com/placeholder/example-user.jpg"},"muted":false,"user_id":676,"verified":true,"is_banned":false,"livestream":null,"vod_enabled":true,"banner_image":{"url":"https://files.kick.com/placeholder/example-user.jpg"},"playback_url":"https://fa723fc1b171.us-west-2.playback.live-video.net/api/video/v1/us-west-2.196233775518.channel.DsuAwCgUc9Bh.m3u8","follower_badges":[],"followers_count":1053235,"recent_categories":[{"id":8549,"name":"IRL","slug":"irl","tags":["IRL","Adventure"]}],"subscription_enabled":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Kick User Info","description":"Retrieve complete public channel data from Kick including streamer profile, follower count, live status, and recent categories.\n\n**Credit cost:** 1 credit per call","operationId":"post-kick-user-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The Kick channel to look up. Accepts a full channel URL or a username/slug.\n\n**Accepted formats:**\n- `https://kick.com/example-user`: full channel URL\n- `example-user`: channel slug/username only\n\n**Example:**\n\n    https://kick.com/example-user\n\n**Notes:**\n- **Banned channels:** The `is_banned` field will be `true` for banned users but data may still be returned.\n- **Offline streamers:** The `livestream` field will be `null` when the channel is not live.","schema":{"type":"string","description":"The Kick channel to look up. Accepts a full channel URL or a username/slug.\n\n**Accepted formats:**\n- `https://kick.com/example-user`: full channel URL\n- `example-user`: channel slug/username only\n\n**Example:**\n\n    https://kick.com/example-user\n\n**Notes:**\n- **Banned channels:** The `is_banned` field will be `true` for banned users but data may still be returned.\n- **Offline streamers:** The `livestream` field will be `null` when the channel is not live."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"role":{"nullable":true},"slug":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"integer"},"bio":{"type":"string"},"city":{"nullable":true},"gender":{"nullable":true},"discord":{"type":"string"},"twitter":{"type":"string"},"youtube":{"type":"string"},"username":{"type":"string"},"instagram":{"type":"string"},"profile_pic":{"type":"string"}}},"muted":{"type":"boolean"},"user_id":{"type":"integer"},"verified":{"type":"boolean"},"is_banned":{"type":"boolean"},"livestream":{"nullable":true},"vod_enabled":{"type":"boolean"},"banner_image":{"type":"object","properties":{"url":{"type":"string"}}},"playback_url":{"type":"string"},"follower_badges":{"type":"array","items":{}},"followers_count":{"type":"integer"},"recent_categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"subscription_enabled":{"type":"boolean"}}},"examples":{"Lookup by username: example-user":{"value":{"id":668,"role":null,"slug":"example-user","user":{"id":676,"bio":"Example creator profile.","city":null,"gender":null,"discord":"example-user","twitter":"example-user","youtube":"example-user","username":"example-user","instagram":"example-user","profile_pic":"https://files.kick.com/placeholder/example-user.jpg"},"muted":false,"user_id":676,"verified":true,"is_banned":false,"livestream":null,"vod_enabled":true,"banner_image":{"url":"https://files.kick.com/placeholder/example-user.jpg"},"playback_url":"https://fa723fc1b171.us-west-2.playback.live-video.net/api/video/v1/us-west-2.196233775518.channel.DsuAwCgUc9Bh.m3u8","follower_badges":[],"followers_count":1053235,"recent_categories":[{"id":8549,"name":"IRL","slug":"irl","tags":["IRL","Adventure"]}],"subscription_enabled":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/company/info":{"get":{"summary":"LinkedIn Company Info","description":"LinkedIn Company Info API. Fetch firmographics by LinkedIn slug, URL, company ID, or reverse domain lookup (`guideflow.com`). Industry, headcount, HQ, posts, and more.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"LinkedIn company identifier when you already know the page.\n\n**Accepted formats:**\n- `ferrari`: LinkedIn slug / universal name\n- `https://www.linkedin.com/company/ferrari`: full company URL\n- `7050`: numeric LinkedIn company ID\n- `https://www.linkedin.com/school/harvard-university/`: school page\n\n**Example:**\n\n    https://www.linkedin.com/company/ferrari\n\n**Notes:**\n- Mutually exclusive with `domain`.\n- Use `domain` instead when you only have a company website.","schema":{"type":"string","description":"LinkedIn company identifier when you already know the page.\n\n**Accepted formats:**\n- `ferrari`: LinkedIn slug / universal name\n- `https://www.linkedin.com/company/ferrari`: full company URL\n- `7050`: numeric LinkedIn company ID\n- `https://www.linkedin.com/school/harvard-university/`: school page\n\n**Example:**\n\n    https://www.linkedin.com/company/ferrari\n\n**Notes:**\n- Mutually exclusive with `domain`.\n- Use `domain` instead when you only have a company website."}},{"name":"domain","in":"query","required":false,"description":"Company website domain for **reverse lookup** when you do not have the LinkedIn URL.\n\n**Accepted formats:**\n- `guideflow.com`: bare domain (preferred)\n- `https://www.guideflow.com`: full URL (domain is extracted)\n\n**Example:**\n\n    guideflow.com\n\n**Notes:**\n- Resolves the domain to a LinkedIn company slug via indexed company data.\n- Mutually exclusive with `query`.\n- Ideal for enriching CRM records that only store `website` or `domain`.","schema":{"type":"string","description":"Company website domain for **reverse lookup** when you do not have the LinkedIn URL.\n\n**Accepted formats:**\n- `guideflow.com`: bare domain (preferred)\n- `https://www.guideflow.com`: full URL (domain is extracted)\n\n**Example:**\n\n    guideflow.com\n\n**Notes:**\n- Resolves the domain to a LinkedIn company slug via indexed company data.\n- Mutually exclusive with `query`.\n- Ideal for enriching CRM records that only store `website` or `domain`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"posts":{"type":"array","items":{"type":"object","properties":{"post_id":{"type":"string"},"post_url":{"type":"string"}}}},"founded":{"type":"integer"},"tagline":{"type":"string"},"website":{"type":"string"},"industry":{"type":"string"},"logo_url":{"type":"string"},"employees":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"profile_url":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"string"}},"company_id":{"type":"integer"},"company_url":{"type":"string"},"description":{"type":"string"},"headquarter":{"type":"object","properties":{"city":{"type":"string"},"line1":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"}}},"staff_count":{"type":"integer"},"staff_range":{"type":"string"},"company_name":{"type":"string"},"specialities":{"type":"array","items":{"type":"string"}},"follower_count":{"type":"integer"}}},"examples":{"Lookup by LinkedIn username - Ferrari":{"value":{"posts":[{"post_id":"7442991179371167745","post_url":"https://www.linkedin.com/posts/ferrari_ferrari12cilindrispider-ferrari-activity-7442991179371167745-iqaJ"},{"post_id":"7442602811004973056","post_url":"https://www.linkedin.com/posts/ferrari_museoenzoferrari-modena-museiferrari-activity-7442602811004973056-L0Lf"}],"founded":1947,"tagline":"Ferrari, Italian excellence that makes the world dream.","website":"http://www.ferrari.com","industry":"Motor Vehicle Manufacturing","logo_url":"https://media.licdn.com/dms/image/v2/C4E0BAQFQWtQAnYFMEA/company-logo_200_200/company-logo_200_200/0/1630655008326/ferrari_logo?e=2147483647&v=beta&t=FZyFfc6-ZOFhE715KLI-YtJBbLwDW3Zb3UYf8rNKrjs","employees":[{"name":"Alex Martin","profile_url":"https://it.linkedin.com/in/example-user-1"},{"name":"Jordan Lee","profile_url":"https://ae.linkedin.com/in/example-user-2"}],"locations":["Abetone inferiore Maranello, MO 41053, IT","via Abetone inferiore n°4 Modena, MO 41100, IT"],"company_id":7050,"company_url":"https://it.linkedin.com/company/ferrari","description":"Ferrari's story officially began in 1947 when its first road car, the 125 S, emerged from the gate of no. 4 Via Abetone Inferiore in Maranello.","headquarter":{"city":"Maranello","line1":"Abetone inferiore","country":"IT","postal_code":"41053"},"staff_count":10951,"staff_range":"over-10k","company_name":"Ferrari","specialities":["automotive","racing","retail","innovation","luxury","italy","exclusivity","design","engineering","Formula 1"],"follower_count":2137342}},"Reverse domain lookup - guideflow.com":{"value":{"founded":null,"funding":null,"tagline":"Guide your users into the flow 🐤","website":"https://guideflow.com","industry":"Software Development","logo_url":"https://media.licdn.com/dms/image/v2/D4E0BAQEi2bj10wgfqA/company-logo_200_200/company-logo_200_200/0/1665984513264/guideflow_logo","locations":["Union St San Francisco, California, US","Avenue de la Grande Armée Paris, Île-de-France, FR"],"company_id":87238155,"company_url":"https://www.linkedin.com/company/guideflow","description":"Create interactive demos & step-by-step guides to boost your productivity & conversion rate with Guideflow.","headquarter":{"city":"San Francisco","line1":"Union St","country":"US","postal_code":null},"staff_count":20,"staff_range":"10-50","company_name":"Guideflow","specialities":null,"follower_count":1832}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Company Info","description":"LinkedIn Company Info API. Fetch firmographics by LinkedIn slug, URL, company ID, or reverse domain lookup (`guideflow.com`). Industry, headcount, HQ, posts, and more.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"LinkedIn company identifier when you already know the page.\n\n**Accepted formats:**\n- `ferrari`: LinkedIn slug / universal name\n- `https://www.linkedin.com/company/ferrari`: full company URL\n- `7050`: numeric LinkedIn company ID\n- `https://www.linkedin.com/school/harvard-university/`: school page\n\n**Example:**\n\n    https://www.linkedin.com/company/ferrari\n\n**Notes:**\n- Mutually exclusive with `domain`.\n- Use `domain` instead when you only have a company website.","schema":{"type":"string","description":"LinkedIn company identifier when you already know the page.\n\n**Accepted formats:**\n- `ferrari`: LinkedIn slug / universal name\n- `https://www.linkedin.com/company/ferrari`: full company URL\n- `7050`: numeric LinkedIn company ID\n- `https://www.linkedin.com/school/harvard-university/`: school page\n\n**Example:**\n\n    https://www.linkedin.com/company/ferrari\n\n**Notes:**\n- Mutually exclusive with `domain`.\n- Use `domain` instead when you only have a company website."}},{"name":"domain","in":"query","required":false,"description":"Company website domain for **reverse lookup** when you do not have the LinkedIn URL.\n\n**Accepted formats:**\n- `guideflow.com`: bare domain (preferred)\n- `https://www.guideflow.com`: full URL (domain is extracted)\n\n**Example:**\n\n    guideflow.com\n\n**Notes:**\n- Resolves the domain to a LinkedIn company slug via indexed company data.\n- Mutually exclusive with `query`.\n- Ideal for enriching CRM records that only store `website` or `domain`.","schema":{"type":"string","description":"Company website domain for **reverse lookup** when you do not have the LinkedIn URL.\n\n**Accepted formats:**\n- `guideflow.com`: bare domain (preferred)\n- `https://www.guideflow.com`: full URL (domain is extracted)\n\n**Example:**\n\n    guideflow.com\n\n**Notes:**\n- Resolves the domain to a LinkedIn company slug via indexed company data.\n- Mutually exclusive with `query`.\n- Ideal for enriching CRM records that only store `website` or `domain`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"posts":{"type":"array","items":{"type":"object","properties":{"post_id":{"type":"string"},"post_url":{"type":"string"}}}},"founded":{"type":"integer"},"tagline":{"type":"string"},"website":{"type":"string"},"industry":{"type":"string"},"logo_url":{"type":"string"},"employees":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"profile_url":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"string"}},"company_id":{"type":"integer"},"company_url":{"type":"string"},"description":{"type":"string"},"headquarter":{"type":"object","properties":{"city":{"type":"string"},"line1":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"}}},"staff_count":{"type":"integer"},"staff_range":{"type":"string"},"company_name":{"type":"string"},"specialities":{"type":"array","items":{"type":"string"}},"follower_count":{"type":"integer"}}},"examples":{"Lookup by LinkedIn username - Ferrari":{"value":{"posts":[{"post_id":"7442991179371167745","post_url":"https://www.linkedin.com/posts/ferrari_ferrari12cilindrispider-ferrari-activity-7442991179371167745-iqaJ"},{"post_id":"7442602811004973056","post_url":"https://www.linkedin.com/posts/ferrari_museoenzoferrari-modena-museiferrari-activity-7442602811004973056-L0Lf"}],"founded":1947,"tagline":"Ferrari, Italian excellence that makes the world dream.","website":"http://www.ferrari.com","industry":"Motor Vehicle Manufacturing","logo_url":"https://media.licdn.com/dms/image/v2/C4E0BAQFQWtQAnYFMEA/company-logo_200_200/company-logo_200_200/0/1630655008326/ferrari_logo?e=2147483647&v=beta&t=FZyFfc6-ZOFhE715KLI-YtJBbLwDW3Zb3UYf8rNKrjs","employees":[{"name":"Alex Martin","profile_url":"https://it.linkedin.com/in/example-user-1"},{"name":"Jordan Lee","profile_url":"https://ae.linkedin.com/in/example-user-2"}],"locations":["Abetone inferiore Maranello, MO 41053, IT","via Abetone inferiore n°4 Modena, MO 41100, IT"],"company_id":7050,"company_url":"https://it.linkedin.com/company/ferrari","description":"Ferrari's story officially began in 1947 when its first road car, the 125 S, emerged from the gate of no. 4 Via Abetone Inferiore in Maranello.","headquarter":{"city":"Maranello","line1":"Abetone inferiore","country":"IT","postal_code":"41053"},"staff_count":10951,"staff_range":"over-10k","company_name":"Ferrari","specialities":["automotive","racing","retail","innovation","luxury","italy","exclusivity","design","engineering","Formula 1"],"follower_count":2137342}},"Reverse domain lookup - guideflow.com":{"value":{"founded":null,"funding":null,"tagline":"Guide your users into the flow 🐤","website":"https://guideflow.com","industry":"Software Development","logo_url":"https://media.licdn.com/dms/image/v2/D4E0BAQEi2bj10wgfqA/company-logo_200_200/company-logo_200_200/0/1665984513264/guideflow_logo","locations":["Union St San Francisco, California, US","Avenue de la Grande Armée Paris, Île-de-France, FR"],"company_id":87238155,"company_url":"https://www.linkedin.com/company/guideflow","description":"Create interactive demos & step-by-step guides to boost your productivity & conversion rate with Guideflow.","headquarter":{"city":"San Francisco","line1":"Union St","country":"US","postal_code":null},"staff_count":20,"staff_range":"10-50","company_name":"Guideflow","specialities":null,"follower_count":1832}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/job/suggest":{"get":{"summary":"LinkedIn Job Suggest","description":"Get personalized job suggestions based on keywords or locations to streamline your job search.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-job-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The keyword prefix to search for job title suggestions or location names.\n\n**Example: keyword suggestions:**\n\n    Air\n\n**Example: location suggestions (when `location=true`):**\n\n    Par\n\n**Notes:**\n- Short prefixes (2–4 characters) generally yield more results.\n- When `location=false`, returns job-related keyword suggestions (titles, companies, schools).\n- When `location=true`, returns geo locations with their `geo_id` values.","schema":{"type":"string","description":"The keyword prefix to search for job title suggestions or location names.\n\n**Example: keyword suggestions:**\n\n    Air\n\n**Example: location suggestions (when `location=true`):**\n\n    Par\n\n**Notes:**\n- Short prefixes (2–4 characters) generally yield more results.\n- When `location=false`, returns job-related keyword suggestions (titles, companies, schools).\n- When `location=true`, returns geo locations with their `geo_id` values."}},{"name":"location","in":"query","required":false,"description":"Set to `true` to receive location (geo) suggestions instead of keyword suggestions.\n\n**Accepted values:**\n- `false` (default): Returns job keyword suggestions (titles, companies, schools)\n- `true`: Returns geographic locations with their `geo_id` for use in Job Count and Job Search filters\n\n**Note:** The returned `geo_id` values can be used directly in the `geo_id` parameter of the LinkedIn Job Search and Job Count endpoints.","schema":{"type":"boolean","default":"false","description":"Set to `true` to receive location (geo) suggestions instead of keyword suggestions.\n\n**Accepted values:**\n- `false` (default): Returns job keyword suggestions (titles, companies, schools)\n- `true`: Returns geographic locations with their `geo_id` for use in Job Count and Job Search filters\n\n**Note:** The returned `geo_id` values can be used directly in the `geo_id` parameter of the LinkedIn Job Search and Job Count endpoints."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"examples":{"Keyword suggestions for 'Air'":{"value":[{"id":"1192656","name":"Toulouse Lautrec","type":"keyword"},{"id":"15095709","name":"Toulouse School of Management","type":"keyword"},{"id":"1611398","name":"Toulouse School of Economics","type":"keyword"},{"id":"10260250","name":"Toulouse Métropole","type":"keyword"},{"id":"23121145","name":"Toulouse","type":"keyword"}]},"Location geo suggestions for 'Air' (location=true)":{"value":[{"id":"90009870","name":"Greater Buenos Aires","type":"geo"},{"id":"100886388","name":"Airdrie, Alberta, Canada","type":"geo"},{"id":"102808620","name":"Partido de General Pueyrredón, Buenos Aires Province, Argentina","type":"geo"},{"id":"105934900","name":"Airdrie, Scotland, United Kingdom","type":"geo"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Job Suggest","description":"Get personalized job suggestions based on keywords or locations to streamline your job search.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-job-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The keyword prefix to search for job title suggestions or location names.\n\n**Example: keyword suggestions:**\n\n    Air\n\n**Example: location suggestions (when `location=true`):**\n\n    Par\n\n**Notes:**\n- Short prefixes (2–4 characters) generally yield more results.\n- When `location=false`, returns job-related keyword suggestions (titles, companies, schools).\n- When `location=true`, returns geo locations with their `geo_id` values.","schema":{"type":"string","description":"The keyword prefix to search for job title suggestions or location names.\n\n**Example: keyword suggestions:**\n\n    Air\n\n**Example: location suggestions (when `location=true`):**\n\n    Par\n\n**Notes:**\n- Short prefixes (2–4 characters) generally yield more results.\n- When `location=false`, returns job-related keyword suggestions (titles, companies, schools).\n- When `location=true`, returns geo locations with their `geo_id` values."}},{"name":"location","in":"query","required":false,"description":"Set to `true` to receive location (geo) suggestions instead of keyword suggestions.\n\n**Accepted values:**\n- `false` (default): Returns job keyword suggestions (titles, companies, schools)\n- `true`: Returns geographic locations with their `geo_id` for use in Job Count and Job Search filters\n\n**Note:** The returned `geo_id` values can be used directly in the `geo_id` parameter of the LinkedIn Job Search and Job Count endpoints.","schema":{"type":"boolean","default":"false","description":"Set to `true` to receive location (geo) suggestions instead of keyword suggestions.\n\n**Accepted values:**\n- `false` (default): Returns job keyword suggestions (titles, companies, schools)\n- `true`: Returns geographic locations with their `geo_id` for use in Job Count and Job Search filters\n\n**Note:** The returned `geo_id` values can be used directly in the `geo_id` parameter of the LinkedIn Job Search and Job Count endpoints."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"examples":{"Keyword suggestions for 'Air'":{"value":[{"id":"1192656","name":"Toulouse Lautrec","type":"keyword"},{"id":"15095709","name":"Toulouse School of Management","type":"keyword"},{"id":"1611398","name":"Toulouse School of Economics","type":"keyword"},{"id":"10260250","name":"Toulouse Métropole","type":"keyword"},{"id":"23121145","name":"Toulouse","type":"keyword"}]},"Location geo suggestions for 'Air' (location=true)":{"value":[{"id":"90009870","name":"Greater Buenos Aires","type":"geo"},{"id":"100886388","name":"Airdrie, Alberta, Canada","type":"geo"},{"id":"102808620","name":"Partido de General Pueyrredón, Buenos Aires Province, Argentina","type":"geo"},{"id":"105934900","name":"Airdrie, Scotland, United Kingdom","type":"geo"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/job/count":{"get":{"summary":"LinkedIn Job Count","description":"Obtain real-time job counts on LinkedIn by industry, region, and role for strategic planning.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-job-count","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"description":"Job title or keyword to count matching postings.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to count all jobs matching the other filters.","schema":{"type":"string","description":"Job title or keyword to count matching postings.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to count all jobs matching the other filters."}},{"name":"experience_level","in":"query","required":false,"description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above","schema":{"type":"string","description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above"}},{"name":"job_type","in":"query","required":false,"description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions","schema":{"type":"string","description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions"}},{"name":"when","in":"query","required":false,"description":"Filter by posting recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days","schema":{"type":"string","description":"Filter by posting recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days"}},{"name":"flexibility","in":"query","required":false,"description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions","schema":{"type":"string","description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions"}},{"name":"distance","in":"query","required":false,"description":"Maximum distance radius (in miles) from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`","schema":{"type":"number","description":"Maximum distance radius (in miles) from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`"}},{"name":"geo_id","in":"query","required":false,"description":"LinkedIn geo ID of the target location.\n\n**Example values:**\n- `92000000`: Worldwide (default)\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location.","schema":{"type":"string","description":"LinkedIn geo ID of the target location.\n\n**Example values:**\n- `92000000`: Worldwide (default)\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location."}},{"name":"company_id","in":"query","required":false,"description":"LinkedIn numeric company ID to restrict the count to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID.","schema":{"type":"string","description":"LinkedIn numeric company ID to restrict the count to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"}}},"examples":{"Job count in France (last 24 hours)":{"value":{"count":1000}},"Remote Data Scientist jobs worldwide":{"value":{"count":48000}},"Software Engineer jobs worldwide":{"value":{"count":299000}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Job Count","description":"Obtain real-time job counts on LinkedIn by industry, region, and role for strategic planning.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-job-count","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"description":"Job title or keyword to count matching postings.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to count all jobs matching the other filters.","schema":{"type":"string","description":"Job title or keyword to count matching postings.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to count all jobs matching the other filters."}},{"name":"experience_level","in":"query","required":false,"description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above","schema":{"type":"string","description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above"}},{"name":"job_type","in":"query","required":false,"description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions","schema":{"type":"string","description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions"}},{"name":"when","in":"query","required":false,"description":"Filter by posting recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days","schema":{"type":"string","description":"Filter by posting recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days"}},{"name":"flexibility","in":"query","required":false,"description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions","schema":{"type":"string","description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions"}},{"name":"distance","in":"query","required":false,"description":"Maximum distance radius (in miles) from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`","schema":{"type":"number","description":"Maximum distance radius (in miles) from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`"}},{"name":"geo_id","in":"query","required":false,"description":"LinkedIn geo ID of the target location.\n\n**Example values:**\n- `92000000`: Worldwide (default)\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location.","schema":{"type":"string","description":"LinkedIn geo ID of the target location.\n\n**Example values:**\n- `92000000`: Worldwide (default)\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location."}},{"name":"company_id","in":"query","required":false,"description":"LinkedIn numeric company ID to restrict the count to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID.","schema":{"type":"string","description":"LinkedIn numeric company ID to restrict the count to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"}}},"examples":{"Job count in France (last 24 hours)":{"value":{"count":1000}},"Remote Data Scientist jobs worldwide":{"value":{"count":48000}},"Software Engineer jobs worldwide":{"value":{"count":299000}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/job/info":{"get":{"summary":"LinkedIn Job Info","description":"Dive into LinkedIn job data and trends for in-depth labor market insights.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-job-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The LinkedIn job posting to retrieve. Accepts a numeric job ID or a full job posting URL.\n\n**Accepted formats:**\n- `4390885746`: LinkedIn numeric job ID\n- `https://www.linkedin.com/jobs/view/4390885746`: full job URL\n\n**Example:**\n\n    https://www.linkedin.com/jobs/view/4390885746\n\n**Notes:**\n- **Expired listings:** Jobs that have been closed or removed will return a not-found error.\n- **Private jobs:** Some employer-direct postings may be restricted.","schema":{"type":"string","description":"The LinkedIn job posting to retrieve. Accepts a numeric job ID or a full job posting URL.\n\n**Accepted formats:**\n- `4390885746`: LinkedIn numeric job ID\n- `https://www.linkedin.com/jobs/view/4390885746`: full job URL\n\n**Example:**\n\n    https://www.linkedin.com/jobs/view/4390885746\n\n**Notes:**\n- **Expired listings:** Jobs that have been closed or removed will return a not-found error.\n- **Private jobs:** Some employer-direct postings may be restricted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"country_code":{"type":"string"}}},"job_url":{"type":"string"},"industry":{"type":"array","items":{"type":"string"}},"location":{"type":"string"},"functions":{"type":"array","items":{"type":"string"}},"list_date":{"type":"string"},"recruiter":{"type":"object","properties":{"headline":{"type":"string"},"full_name":{"type":"string"},"profile_url":{"type":"string"}}},"company_url":{"type":"string"},"company_logo":{"type":"string"},"company_name":{"type":"string"},"employment_type":{"type":"string"},"job_description":{"type":"string"},"seniority_level":{"type":"string"},"total_applicants":{"type":"integer"},"compensation_salary":{"type":"string"}}},"examples":{"Lookup by job ID. Customer Success Manager at Rokt":{"value":{"id":3795872581,"title":"Customer Success Manager","address":{"city":"City of New York","state":"New York","county":null,"country":"United States","country_code":"US"},"job_url":"https://www.linkedin.com/jobs/view/3795872581","industry":["advertising-services","technology","information-and-internet"],"location":"New York, NY","functions":["Customer Service"],"list_date":"4 days ago","recruiter":{"headline":"Talent Acquisition at Rokt","full_name":"Alex Martin","profile_url":"https://www.linkedin.com/in/example-user"},"company_url":"https://www.linkedin.com/company/rokt","company_logo":"https://media.licdn.com/dms/image/D4E0BAQE7AmEYtqhs9g/company-logo_100_100/0/1706546290679/rokt_logo","company_name":"Rokt","employment_type":"Full-time","job_description":"Unlock your inner voice. Join a team of diverse individuals who thrive by conquering new frontiers...","seniority_level":"Mid-Senior level","total_applicants":200,"compensation_salary":"$90,000.00/yr - $110,000.00/yr"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Job Info","description":"Dive into LinkedIn job data and trends for in-depth labor market insights.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-job-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The LinkedIn job posting to retrieve. Accepts a numeric job ID or a full job posting URL.\n\n**Accepted formats:**\n- `4390885746`: LinkedIn numeric job ID\n- `https://www.linkedin.com/jobs/view/4390885746`: full job URL\n\n**Example:**\n\n    https://www.linkedin.com/jobs/view/4390885746\n\n**Notes:**\n- **Expired listings:** Jobs that have been closed or removed will return a not-found error.\n- **Private jobs:** Some employer-direct postings may be restricted.","schema":{"type":"string","description":"The LinkedIn job posting to retrieve. Accepts a numeric job ID or a full job posting URL.\n\n**Accepted formats:**\n- `4390885746`: LinkedIn numeric job ID\n- `https://www.linkedin.com/jobs/view/4390885746`: full job URL\n\n**Example:**\n\n    https://www.linkedin.com/jobs/view/4390885746\n\n**Notes:**\n- **Expired listings:** Jobs that have been closed or removed will return a not-found error.\n- **Private jobs:** Some employer-direct postings may be restricted."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"country_code":{"type":"string"}}},"job_url":{"type":"string"},"industry":{"type":"array","items":{"type":"string"}},"location":{"type":"string"},"functions":{"type":"array","items":{"type":"string"}},"list_date":{"type":"string"},"recruiter":{"type":"object","properties":{"headline":{"type":"string"},"full_name":{"type":"string"},"profile_url":{"type":"string"}}},"company_url":{"type":"string"},"company_logo":{"type":"string"},"company_name":{"type":"string"},"employment_type":{"type":"string"},"job_description":{"type":"string"},"seniority_level":{"type":"string"},"total_applicants":{"type":"integer"},"compensation_salary":{"type":"string"}}},"examples":{"Lookup by job ID. Customer Success Manager at Rokt":{"value":{"id":3795872581,"title":"Customer Success Manager","address":{"city":"City of New York","state":"New York","county":null,"country":"United States","country_code":"US"},"job_url":"https://www.linkedin.com/jobs/view/3795872581","industry":["advertising-services","technology","information-and-internet"],"location":"New York, NY","functions":["Customer Service"],"list_date":"4 days ago","recruiter":{"headline":"Talent Acquisition at Rokt","full_name":"Alex Martin","profile_url":"https://www.linkedin.com/in/example-user"},"company_url":"https://www.linkedin.com/company/rokt","company_logo":"https://media.licdn.com/dms/image/D4E0BAQE7AmEYtqhs9g/company-logo_100_100/0/1706546290679/rokt_logo","company_name":"Rokt","employment_type":"Full-time","job_description":"Unlock your inner voice. Join a team of diverse individuals who thrive by conquering new frontiers...","seniority_level":"Mid-Senior level","total_applicants":200,"compensation_salary":"$90,000.00/yr - $110,000.00/yr"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/job/search":{"get":{"summary":"LinkedIn Job Search","description":"Experience advanced job data extraction from LinkedIn, enhancing your recruitment strategy.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-job-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"description":"Job title or keyword to search for.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to return all jobs matching the other filters.","schema":{"type":"string","description":"Job title or keyword to search for.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to return all jobs matching the other filters."}},{"name":"experience_level","in":"query","required":false,"description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above","schema":{"type":"string","description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above"}},{"name":"job_type","in":"query","required":false,"description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions","schema":{"type":"string","description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions"}},{"name":"when","in":"query","required":false,"description":"Filter by posting date recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days","schema":{"type":"string","description":"Filter by posting date recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days"}},{"name":"flexibility","in":"query","required":false,"description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions","schema":{"type":"string","description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions"}},{"name":"distance","in":"query","required":false,"description":"Maximum radius in miles from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`","schema":{"type":"number","description":"Maximum radius in miles from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`"}},{"name":"geo_id","in":"query","required":false,"description":"LinkedIn geo ID for the target location. Default is `92000000` (worldwide).\n\n**Example values:**\n- `92000000`: Worldwide\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location.","schema":{"type":"string","default":"92000000","description":"LinkedIn geo ID for the target location. Default is `92000000` (worldwide).\n\n**Example values:**\n- `92000000`: Worldwide\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location."}},{"name":"company_id","in":"query","required":false,"description":"LinkedIn numeric company ID to filter results to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID.","schema":{"type":"string","description":"LinkedIn numeric company ID to filter results to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID."}},{"name":"page","in":"query","required":false,"description":"Page number for paginating through results. Default is `1`. Each page returns up to 25 job listings.","schema":{"type":"number","default":"1","description":"Page number for paginating through results. Default is `1`. Each page returns up to 25 job listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"title":{"type":"string"},"location":{"type":"string"},"list_date":{"type":"string"},"company_url":{"type":"string"},"company_name":{"type":"string"}}}},"examples":{"Search by company. TikTok jobs":{"value":[{"id":4388669042,"url":"https://www.linkedin.com/jobs/view/4388669042","title":"Procurement Operations Specialist, AMS","location":"New York, United States","list_date":"2026-03-22 00:00:00","company_url":"https://www.linkedin.com/company/tiktok","company_name":"TikTok"},{"id":4378400293,"url":"https://www.linkedin.com/jobs/view/4378400293","title":"TikTok Shop - Category Manager","location":"New York, United States","list_date":"2026-02-28 00:00:00","company_url":"https://www.linkedin.com/company/tiktok","company_name":"TikTok"},{"id":4387167337,"url":"https://www.linkedin.com/jobs/view/4387167337","title":"Program Manager, TikTok Program Management Office","location":"New York, United States","list_date":"2026-03-18 00:00:00","company_url":"https://www.linkedin.com/company/tiktok","company_name":"TikTok"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Job Search","description":"Experience advanced job data extraction from LinkedIn, enhancing your recruitment strategy.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-job-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"description":"Job title or keyword to search for.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to return all jobs matching the other filters.","schema":{"type":"string","description":"Job title or keyword to search for.\n\n**Example:**\n\n    Software Engineer\n\nLeave empty to return all jobs matching the other filters."}},{"name":"experience_level","in":"query","required":false,"description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above","schema":{"type":"string","description":"Filter by seniority level.\n\n**Accepted values:**\n- `internship`: Internship positions\n- `entry_level`: Entry-level roles\n- `associate`: Associate-level roles\n- `mid_senior`: Mid to senior-level roles\n- `director`: Director-level and above"}},{"name":"job_type","in":"query","required":false,"description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions","schema":{"type":"string","description":"Filter by employment type.\n\n**Accepted values:**\n- `full_time`: Full-time positions\n- `part_time`: Part-time positions\n- `contract`: Contract roles\n- `temporary`: Temporary roles\n- `internship`: Internships\n- `volunteer`: Volunteer positions"}},{"name":"when","in":"query","required":false,"description":"Filter by posting date recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days","schema":{"type":"string","description":"Filter by posting date recency.\n\n**Accepted values:**\n- `day`: Posted in the last 24 hours\n- `week`: Posted in the last 7 days\n- `month`: Posted in the last 30 days"}},{"name":"flexibility","in":"query","required":false,"description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions","schema":{"type":"string","description":"Filter by work arrangement.\n\n**Accepted values:**\n- `remote`: Fully remote positions\n- `flexible`: Hybrid or flexible arrangements\n- `on_site`: On-site only positions"}},{"name":"distance","in":"query","required":false,"description":"Maximum radius in miles from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`","schema":{"type":"number","description":"Maximum radius in miles from the target location (requires `geo_id`).\n\n**Accepted values:** `5`, `10`, `25`, `50`, `100`"}},{"name":"geo_id","in":"query","required":false,"description":"LinkedIn geo ID for the target location. Default is `92000000` (worldwide).\n\n**Example values:**\n- `92000000`: Worldwide\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location.","schema":{"type":"string","default":"92000000","description":"LinkedIn geo ID for the target location. Default is `92000000` (worldwide).\n\n**Example values:**\n- `92000000`: Worldwide\n- `105073465`: France\n- `103644278`: United States\n\nUse the LinkedIn Job Suggest endpoint with `location=true` to find geo IDs for any location."}},{"name":"company_id","in":"query","required":false,"description":"LinkedIn numeric company ID to filter results to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID.","schema":{"type":"string","description":"LinkedIn numeric company ID to filter results to jobs posted by a specific company.\n\n**Example:**\n- `33246798`: TikTok\n\nUse the LinkedIn Company Info endpoint to retrieve a company's ID."}},{"name":"page","in":"query","required":false,"description":"Page number for paginating through results. Default is `1`. Each page returns up to 25 job listings.","schema":{"type":"number","default":"1","description":"Page number for paginating through results. Default is `1`. Each page returns up to 25 job listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"title":{"type":"string"},"location":{"type":"string"},"list_date":{"type":"string"},"company_url":{"type":"string"},"company_name":{"type":"string"}}}},"examples":{"Search by company. TikTok jobs":{"value":[{"id":4388669042,"url":"https://www.linkedin.com/jobs/view/4388669042","title":"Procurement Operations Specialist, AMS","location":"New York, United States","list_date":"2026-03-22 00:00:00","company_url":"https://www.linkedin.com/company/tiktok","company_name":"TikTok"},{"id":4378400293,"url":"https://www.linkedin.com/jobs/view/4378400293","title":"TikTok Shop - Category Manager","location":"New York, United States","list_date":"2026-02-28 00:00:00","company_url":"https://www.linkedin.com/company/tiktok","company_name":"TikTok"},{"id":4387167337,"url":"https://www.linkedin.com/jobs/view/4387167337","title":"Program Manager, TikTok Program Management Office","location":"New York, United States","list_date":"2026-03-18 00:00:00","company_url":"https://www.linkedin.com/company/tiktok","company_name":"TikTok"}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/product/info":{"get":{"summary":"LinkedIn Product Info","description":"Gain competitive insights with detailed LinkedIn product information for strategic advantage.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-product-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The full LinkedIn product page URL to retrieve.\n\n**Accepted format:**\n- `https://www.linkedin.com/products/15five`. LinkedIn product URL\n\n**Example:**\n\n    https://www.linkedin.com/products/15five\n\n**Notes:**\n- Only LinkedIn product pages are supported (URLs starting with `https://www.linkedin.com/products/`).\n- Company pages and showcase pages are not supported by this endpoint: use LinkedIn Company Info instead.","schema":{"type":"string","description":"The full LinkedIn product page URL to retrieve.\n\n**Accepted format:**\n- `https://www.linkedin.com/products/15five`. LinkedIn product URL\n\n**Example:**\n\n    https://www.linkedin.com/products/15five\n\n**Notes:**\n- Only LinkedIn product pages are supported (URLs starting with `https://www.linkedin.com/products/`).\n- Company pages and showcase pages are not supported by this endpoint: use LinkedIn Company Info instead."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"logo_url":{"type":"string"},"learn_more":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"company_name":{"type":"string"},"product_title":{"type":"string"},"background_url":{"type":"string"},"product_category":{"type":"string"},"similar_products":{"type":"array","items":{"type":"object","properties":{"product_url":{"type":"string"},"company_logo":{"type":"string"},"product_name":{"type":"string"}}}},"featured_customers":{"type":"array","items":{"type":"object","properties":{"company_url":{"type":"string"},"company_logo":{"type":"string"},"company_name":{"type":"string"}}}},"product_category_url":{"type":"string"}}},"examples":{"Lookup by product URL: 15Five":{"value":{"roles":["Human Resources Manager","Human Resources Director","Human Resources Administrator","Human Resources Officer","Head of Human Resources","Chief Human Resources Officer"],"logo_url":"https://media.licdn.com/dms/image/v2/D560BAQFPaExVtxGgaQ/company-logo_100_100/company-logo_100_100/0/1719856771742/15five_logo","learn_more":"https://www.15five.com/getstarted/?utm_medium=social&utm_source=linkedin&utm_campaign=social-2020-linkedin-productpage","company_url":"https://www.linkedin.com/company/15five/","description":"15Five is the performance management platform that drives business results. 15Five's platform combines coaching and manager training, 360° performance reviews, in-depth engagement surveys, robust goal & OKR tracking, and manager-employee feedback tools.","company_name":"15Five","product_title":"15Five","background_url":"https://media.licdn.com/dms/image/v2/D4E1BAQHOGF3tsVhmlg/company-background_10000/B4EZsti4r4IwAU-/0/1765995678944/15five_cover","product_category":"Employee Engagement Software","similar_products":[{"product_url":"https://www.linkedin.com/products/employment-hero/","company_logo":"https://media.licdn.com/dms/image/v2/D560BAQEMgvBwgbKtjQ/company-logo_100_100","product_name":"Employment Hero"}],"featured_customers":[{"company_url":"https://www.linkedin.com/company/indeed-com","company_logo":"https://media.licdn.com/dms/image/v2/C4E0BAQGRyD6gjS54VA/company-logo_100_100","company_name":"Indeed"},{"company_url":"https://www.linkedin.com/company/hubspot","company_logo":"https://media.licdn.com/dms/image/v2/C4D0BAQF8H-SLmMDZlA/company-logo_100_100","company_name":"HubSpot"}],"product_category_url":"https://www.linkedin.com/products/categories/employee-engagement-software"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Product Info","description":"Gain competitive insights with detailed LinkedIn product information for strategic advantage.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-product-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The full LinkedIn product page URL to retrieve.\n\n**Accepted format:**\n- `https://www.linkedin.com/products/15five`. LinkedIn product URL\n\n**Example:**\n\n    https://www.linkedin.com/products/15five\n\n**Notes:**\n- Only LinkedIn product pages are supported (URLs starting with `https://www.linkedin.com/products/`).\n- Company pages and showcase pages are not supported by this endpoint: use LinkedIn Company Info instead.","schema":{"type":"string","description":"The full LinkedIn product page URL to retrieve.\n\n**Accepted format:**\n- `https://www.linkedin.com/products/15five`. LinkedIn product URL\n\n**Example:**\n\n    https://www.linkedin.com/products/15five\n\n**Notes:**\n- Only LinkedIn product pages are supported (URLs starting with `https://www.linkedin.com/products/`).\n- Company pages and showcase pages are not supported by this endpoint: use LinkedIn Company Info instead."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"logo_url":{"type":"string"},"learn_more":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"company_name":{"type":"string"},"product_title":{"type":"string"},"background_url":{"type":"string"},"product_category":{"type":"string"},"similar_products":{"type":"array","items":{"type":"object","properties":{"product_url":{"type":"string"},"company_logo":{"type":"string"},"product_name":{"type":"string"}}}},"featured_customers":{"type":"array","items":{"type":"object","properties":{"company_url":{"type":"string"},"company_logo":{"type":"string"},"company_name":{"type":"string"}}}},"product_category_url":{"type":"string"}}},"examples":{"Lookup by product URL: 15Five":{"value":{"roles":["Human Resources Manager","Human Resources Director","Human Resources Administrator","Human Resources Officer","Head of Human Resources","Chief Human Resources Officer"],"logo_url":"https://media.licdn.com/dms/image/v2/D560BAQFPaExVtxGgaQ/company-logo_100_100/company-logo_100_100/0/1719856771742/15five_logo","learn_more":"https://www.15five.com/getstarted/?utm_medium=social&utm_source=linkedin&utm_campaign=social-2020-linkedin-productpage","company_url":"https://www.linkedin.com/company/15five/","description":"15Five is the performance management platform that drives business results. 15Five's platform combines coaching and manager training, 360° performance reviews, in-depth engagement surveys, robust goal & OKR tracking, and manager-employee feedback tools.","company_name":"15Five","product_title":"15Five","background_url":"https://media.licdn.com/dms/image/v2/D4E1BAQHOGF3tsVhmlg/company-background_10000/B4EZsti4r4IwAU-/0/1765995678944/15five_cover","product_category":"Employee Engagement Software","similar_products":[{"product_url":"https://www.linkedin.com/products/employment-hero/","company_logo":"https://media.licdn.com/dms/image/v2/D560BAQEMgvBwgbKtjQ/company-logo_100_100","product_name":"Employment Hero"}],"featured_customers":[{"company_url":"https://www.linkedin.com/company/indeed-com","company_logo":"https://media.licdn.com/dms/image/v2/C4E0BAQGRyD6gjS54VA/company-logo_100_100","company_name":"Indeed"},{"company_url":"https://www.linkedin.com/company/hubspot","company_logo":"https://media.licdn.com/dms/image/v2/C4D0BAQF8H-SLmMDZlA/company-logo_100_100","company_name":"HubSpot"}],"product_category_url":"https://www.linkedin.com/products/categories/employee-engagement-software"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/post/info":{"get":{"summary":"LinkedIn Post Info","description":"Simplify LinkedIn post retrieval with our efficient API for enhanced content analysis.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The LinkedIn post to retrieve. Accepts a numeric post ID or a full post URL.\n\n**Accepted formats:**\n- `7027826235833520128`: LinkedIn numeric post ID\n- `https://www.linkedin.com/posts/tanyalindsay_...-activity-7027826235833520128-m0GW`: full post URL\n\n**Example:**\n\n    https://www.linkedin.com/posts/tanyalindsay_we-have-been-building-a-web3-gaming-platform-activity-7027826235833520128-m0GW\n\n**Notes:**\n- **Deleted posts:** Returns a not-found error if the post has been removed.\n- **Comments:** Up to the first batch of comments are returned. Deep comment threads may be truncated.","schema":{"type":"string","description":"The LinkedIn post to retrieve. Accepts a numeric post ID or a full post URL.\n\n**Accepted formats:**\n- `7027826235833520128`: LinkedIn numeric post ID\n- `https://www.linkedin.com/posts/tanyalindsay_...-activity-7027826235833520128-m0GW`: full post URL\n\n**Example:**\n\n    https://www.linkedin.com/posts/tanyalindsay_we-have-been-building-a-web3-gaming-platform-activity-7027826235833520128-m0GW\n\n**Notes:**\n- **Deleted posts:** Returns a not-found error if the post has been removed.\n- **Comments:** Up to the first batch of comments are returned. Deep comment threads may be truncated."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"text":{"type":"string"},"author":{"type":"object","properties":{"url":{"type":"string"},"full_name":{"type":"string"},"image_url":{"nullable":true},"profile_type":{"type":"string"}}},"images":{"type":"array","items":{"type":"string"}},"comments":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"author":{"type":"object","properties":{"url":{"type":"string"},"headline":{"type":"string"},"full_name":{"type":"string"},"image_url":{"nullable":true},"profile_type":{"type":"string"}}}}}},"hashtags":{"type":"array","items":{}},"image_url":{"type":"string"},"like_count":{"type":"integer"},"shared_link":{"nullable":true},"shared_post":{"type":"object","properties":{"id":{"type":"string"},"link":{"nullable":true},"text":{"type":"string"},"image":{"nullable":true},"title":{"nullable":true}}},"shared_video":{"nullable":true},"comments_count":{"type":"integer"},"date_published":{"type":"string"},"total_engagement":{"type":"integer"},"mentioned_profiles":{"type":"array","items":{}}}},"examples":{"Lookup by post ID":{"value":{"id":"7027826235833520128","url":"https://www.linkedin.com/posts/tanyalindsay_we-have-been-building-a-web3-gaming-platform-activity-7027826235833520128-m0GW","text":"We have been building a web3 gaming platform based on entertainment and not on ponzi or the p2e narrative...","author":{"url":"https://ca.linkedin.com/in/example-user","full_name":"Alex Martin","image_url":null,"profile_type":"person"},"images":["https://media.licdn.com/dms/image/v2/C4E22AQGXHY67ydHRgQ/feedshare-shrink_2048_1536/feedshare-shrink_2048_1536/0/1675462056613"],"comments":[{"text":"These stats are too funny. The web3 investors need to learn that whilst youth audiences have ideals and morals but these get easily lost when it comes down to having fun.","author":{"url":"https://uk.linkedin.com/in/example-user-2","headline":"Virtual Reality SPECIALIST| VR/AR/MR/360/XR | CEO Omnilux VR","full_name":"Jordan Lee","image_url":null,"profile_type":"person"}}],"hashtags":[],"image_url":"https://media.licdn.com/dms/image/v2/C4E22AQGXHY67ydHRgQ/feedshare-shrink_2048_1536/feedshare-shrink_2048_1536/0/1675462056613","like_count":5,"shared_link":null,"shared_post":{"id":"7027397210061328384","link":null,"text":"Web 3 Gaming has a serious problem...","image":null,"title":null},"shared_video":null,"comments_count":2,"date_published":"2023-02-05T02:32:25.297Z","total_engagement":7,"mentioned_profiles":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Post Info","description":"Simplify LinkedIn post retrieval with our efficient API for enhanced content analysis.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-post-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The LinkedIn post to retrieve. Accepts a numeric post ID or a full post URL.\n\n**Accepted formats:**\n- `7027826235833520128`: LinkedIn numeric post ID\n- `https://www.linkedin.com/posts/tanyalindsay_...-activity-7027826235833520128-m0GW`: full post URL\n\n**Example:**\n\n    https://www.linkedin.com/posts/tanyalindsay_we-have-been-building-a-web3-gaming-platform-activity-7027826235833520128-m0GW\n\n**Notes:**\n- **Deleted posts:** Returns a not-found error if the post has been removed.\n- **Comments:** Up to the first batch of comments are returned. Deep comment threads may be truncated.","schema":{"type":"string","description":"The LinkedIn post to retrieve. Accepts a numeric post ID or a full post URL.\n\n**Accepted formats:**\n- `7027826235833520128`: LinkedIn numeric post ID\n- `https://www.linkedin.com/posts/tanyalindsay_...-activity-7027826235833520128-m0GW`: full post URL\n\n**Example:**\n\n    https://www.linkedin.com/posts/tanyalindsay_we-have-been-building-a-web3-gaming-platform-activity-7027826235833520128-m0GW\n\n**Notes:**\n- **Deleted posts:** Returns a not-found error if the post has been removed.\n- **Comments:** Up to the first batch of comments are returned. Deep comment threads may be truncated."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"text":{"type":"string"},"author":{"type":"object","properties":{"url":{"type":"string"},"full_name":{"type":"string"},"image_url":{"nullable":true},"profile_type":{"type":"string"}}},"images":{"type":"array","items":{"type":"string"}},"comments":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"author":{"type":"object","properties":{"url":{"type":"string"},"headline":{"type":"string"},"full_name":{"type":"string"},"image_url":{"nullable":true},"profile_type":{"type":"string"}}}}}},"hashtags":{"type":"array","items":{}},"image_url":{"type":"string"},"like_count":{"type":"integer"},"shared_link":{"nullable":true},"shared_post":{"type":"object","properties":{"id":{"type":"string"},"link":{"nullable":true},"text":{"type":"string"},"image":{"nullable":true},"title":{"nullable":true}}},"shared_video":{"nullable":true},"comments_count":{"type":"integer"},"date_published":{"type":"string"},"total_engagement":{"type":"integer"},"mentioned_profiles":{"type":"array","items":{}}}},"examples":{"Lookup by post ID":{"value":{"id":"7027826235833520128","url":"https://www.linkedin.com/posts/tanyalindsay_we-have-been-building-a-web3-gaming-platform-activity-7027826235833520128-m0GW","text":"We have been building a web3 gaming platform based on entertainment and not on ponzi or the p2e narrative...","author":{"url":"https://ca.linkedin.com/in/example-user","full_name":"Alex Martin","image_url":null,"profile_type":"person"},"images":["https://media.licdn.com/dms/image/v2/C4E22AQGXHY67ydHRgQ/feedshare-shrink_2048_1536/feedshare-shrink_2048_1536/0/1675462056613"],"comments":[{"text":"These stats are too funny. The web3 investors need to learn that whilst youth audiences have ideals and morals but these get easily lost when it comes down to having fun.","author":{"url":"https://uk.linkedin.com/in/example-user-2","headline":"Virtual Reality SPECIALIST| VR/AR/MR/360/XR | CEO Omnilux VR","full_name":"Jordan Lee","image_url":null,"profile_type":"person"}}],"hashtags":[],"image_url":"https://media.licdn.com/dms/image/v2/C4E22AQGXHY67ydHRgQ/feedshare-shrink_2048_1536/feedshare-shrink_2048_1536/0/1675462056613","like_count":5,"shared_link":null,"shared_post":{"id":"7027397210061328384","link":null,"text":"Web 3 Gaming has a serious problem...","image":null,"title":null},"shared_video":null,"comments_count":2,"date_published":"2023-02-05T02:32:25.297Z","total_engagement":7,"mentioned_profiles":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/linkedin/profile/info":{"get":{"summary":"LinkedIn Profile Info","description":"Streamline recruitment and business development by extracting valuable LinkedIn profile insights.\n\n**Credit cost:** 1 credit per call","operationId":"get-linkedin-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The LinkedIn profile to retrieve. Accepts a username, full profile URL, or numeric member ID.\n\n**Accepted formats:**\n- `example-user`: LinkedIn username/public identifier\n- `https://www.linkedin.com/in/example-user`: full profile URL\n- `ACoAAA8BYqEBmLJMezmvqCLszS5NiJtJz7L9N9M`: encoded member ID\n\n**Example:**\n\n    https://www.linkedin.com/in/example-user\n\n**Notes:**\n- **Private profiles:** Some fields may be empty if the profile visibility is restricted.\n- **Deleted accounts:** Returns a not-found error if the account no longer exists.","schema":{"type":"string","description":"The LinkedIn profile to retrieve. Accepts a username, full profile URL, or numeric member ID.\n\n**Accepted formats:**\n- `example-user`: LinkedIn username/public identifier\n- `https://www.linkedin.com/in/example-user`: full profile URL\n- `ACoAAA8BYqEBmLJMezmvqCLszS5NiJtJz7L9N9M`: encoded member ID\n\n**Example:**\n\n    https://www.linkedin.com/in/example-user\n\n**Notes:**\n- **Private profiles:** Some fields may be empty if the profile visibility is restricted.\n- **Deleted accounts:** Returns a not-found error if the account no longer exists."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"skills":{"type":"array","items":{"type":"string"}},"address":{"nullable":true},"summary":{"type":"string"},"articles":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"}}}},"headline":{"type":"string"},"username":{"type":"string"},"full_name":{"type":"string"},"languages":{"type":"array","items":{}},"photo_url":{"type":"string"},"educations":{"type":"array","items":{"type":"object","properties":{"school":{"type":"string"},"end_date":{"nullable":true},"end_year":{"nullable":true},"start_date":{"nullable":true},"start_year":{"nullable":true},"field_of_study":{"type":"string"}}}},"experiences":{"type":"array","items":{"type":"object","properties":{"company":{"type":"string"},"end_date":{"nullable":true},"job_title":{"type":"string"},"start_date":{"type":"string"},"company_url":{"type":"string"},"description":{"nullable":true},"company_logo":{"type":"string"}}}},"profile_url":{"type":"string"},"certifications":{"type":"array","items":{}},"follower_count":{"type":"integer"},"recommendations":{"type":"array","items":{}},"connection_count":{"type":"integer"},"member_identifier":{"type":"string"}}},"examples":{"Lookup by username. Alex Martin":{"value":{"skills":["Software Development","Technology","Philanthropy","Public Speaking","Strategic Planning"],"address":null,"summary":"Chair of the Gates Foundation. Founder of Breakthrough Energy. Co-founder of Microsoft. Voracious reader. Avid traveler. Active blogger.","articles":[{"url":"https://www.linkedin.com/pulse/phone-call-saves-lives-bill-gates-yspvc","title":"A phone call that saves lives","author":"Alex Martin"},{"url":"https://www.linkedin.com/pulse/expanding-access-health-care-through-ai-bill-gates-xyqtc","title":"Expanding access to health care through AI","author":"Jordan Lee"}],"headline":"Chair, Gates Foundation and Founder, Breakthrough Energy","username":"example-user","full_name":"Alex Martin","languages":[],"photo_url":"https://media.licdn.com/placeholder/example-user.jpg","educations":[{"school":"Harvard University","end_date":null,"end_year":null,"start_date":null,"start_year":null,"field_of_study":"Computer Science and Economics"}],"experiences":[{"company":"Gates Foundation","end_date":null,"job_title":"Chair","start_date":"2022-01-01","company_url":"https://www.linkedin.com/company/gatesfoundation","description":null,"company_logo":"https://media.licdn.com/dms/image/v2/D4E0BAQG8h8v5PqC7dA/company-logo_100_100"},{"company":"Breakthrough Energy","end_date":null,"job_title":"Founder","start_date":"2015-01-01","company_url":"https://www.linkedin.com/company/breakthrough-energy","description":null,"company_logo":null}],"profile_url":"https://www.linkedin.com/in/example-user","certifications":[],"follower_count":36800000,"recommendations":[],"connection_count":500,"member_identifier":"example-user"}},"Lookup by profile URL - https://www.linkedin.com/in/example-user-2":{"value":{"address":{"city":"Toulouse","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"summary":null,"articles":[],"headline":null,"username":"example-user-2","full_name":"Jordan Lee","languages":[],"photo_url":"https://media.licdn.com/placeholder/example-user-2.jpg","activities":[],"educations":[],"experiences":[{"address":{"city":"Toulouse","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":"WebAPI Group","end_date":null,"location":"Toulouse, Occitanie, France","start_at":null,"company_url":"https://www.linkedin.com/company/webapi-group","description":null},{"address":{"city":"Flourens","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Flourens, Occitanie, France","start_at":null,"company_url":null,"description":null},{"address":{"city":"Flourens","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Flourens","start_at":null,"company_url":null,"description":null},{"address":{"city":"Flourens","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Flourens (31)","start_at":null,"company_url":null,"description":null},{"address":{"city":null,"state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Castanet-Tolosan","start_at":null,"company_url":null,"description":null},{"address":{"city":"Villefranche-de-Lauragais","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Villefranche de Lauragais ","start_at":null,"company_url":null,"description":null}],"profile_url":"https://fr.linkedin.com/in/example-user-2","website_url":"https://webapi.group/","background_url":"https://media.licdn.com/placeholder/example-user-2.jpg","follower_count":664,"recommendations":[],"section_courses":[],"section_patents":[],"connection_count":500,"section_projects":[],"people_also_viewed":[{"url":"https://fr.linkedin.com/in/example-user-3","name":"Sam Rivera","summary":"Rolls-Royce","location":"384 abonnésParis et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-4","name":"Casey Nguyen","summary":"Nestlé Waters","location":"287 abonnésNîmes"},{"url":"https://fr.linkedin.com/in/example-user-5","name":"Morgan Blake","summary":"Astek","location":"862 abonnésLe Bouscat"},{"url":"https://fr.linkedin.com/in/example-user-6","name":"Riley Chen","summary":"Turbotech","location":"264 abonnésNice"},{"url":"https://fr.linkedin.com/in/example-user-7","name":"Taylor Brooks","summary":"Alternoon","location":"444 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-8","name":"Quinn Parker","summary":"Safran","location":"325 abonnésVert-Saint-Denis"},{"url":"https://fr.linkedin.com/in/example-user-9","name":"Avery Kim","summary":"Safran","location":"635 abonnésBois-d'Arcy"},{"url":"https://fr.linkedin.com/in/example-user-10","name":"Drew Patel","summary":"Stelliant","location":"499 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-11","name":"Jamie Costa","summary":"Thales","location":"700 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-12","name":"Robin Singh","summary":"PYMCO Technologies","location":"477 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-13","name":"Sky Reed","summary":"eve, la vivante","location":"2 k abonnésMarseille et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-14","name":"Reese Diaz","summary":"Aegys","location":"893 abonnésToulouse et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-15","name":"Rowan Hughes","summary":"Howmet Aerospace","location":"367 abonnésMaisons-Laffitte"},{"url":"https://fr.linkedin.com/in/example-user-16","name":"Elliot Bennett","summary":"ODELI","location":"1 k abonnésClermont-Ferrand et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-17","name":"Harper Cruz","summary":"CAF (Construcciones y Auxiliar de Ferrocarriles)","location":"374 abonnésStrasbourg et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-18","name":"Finley Ward","summary":"Safran","location":"347 abonnésPalaiseau"},{"url":"https://fr.linkedin.com/in/example-user-19","name":"Shawn Price","summary":"VARTAN.AERO","location":"473 abonnésToulouse et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-20","name":"Kendall Morales","summary":"Plug'Heur","location":"7 k abonnésBordeaux"},{"url":"https://fr.linkedin.com/in/example-user-21","name":"Logan Ross","summary":"Kickmaker","location":"1 k abonnésParis et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-22","name":"Micah Campbell","summary":"Airbus","location":"308 abonnésSaint-Nazaire"}],"section_test_scores":[],"section_publications":[],"card_current_position":{"url":"https://www.linkedin.com/company/webapi-group","name":"WebAPI Group"},"section_honors_awards":[],"section_organizations":[],"card_current_education":null,"section_certifications":[],"section_volunteer_experiences":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"LinkedIn Profile Info","description":"Streamline recruitment and business development by extracting valuable LinkedIn profile insights.\n\n**Credit cost:** 1 credit per call","operationId":"post-linkedin-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The LinkedIn profile to retrieve. Accepts a username, full profile URL, or numeric member ID.\n\n**Accepted formats:**\n- `example-user`: LinkedIn username/public identifier\n- `https://www.linkedin.com/in/example-user`: full profile URL\n- `ACoAAA8BYqEBmLJMezmvqCLszS5NiJtJz7L9N9M`: encoded member ID\n\n**Example:**\n\n    https://www.linkedin.com/in/example-user\n\n**Notes:**\n- **Private profiles:** Some fields may be empty if the profile visibility is restricted.\n- **Deleted accounts:** Returns a not-found error if the account no longer exists.","schema":{"type":"string","description":"The LinkedIn profile to retrieve. Accepts a username, full profile URL, or numeric member ID.\n\n**Accepted formats:**\n- `example-user`: LinkedIn username/public identifier\n- `https://www.linkedin.com/in/example-user`: full profile URL\n- `ACoAAA8BYqEBmLJMezmvqCLszS5NiJtJz7L9N9M`: encoded member ID\n\n**Example:**\n\n    https://www.linkedin.com/in/example-user\n\n**Notes:**\n- **Private profiles:** Some fields may be empty if the profile visibility is restricted.\n- **Deleted accounts:** Returns a not-found error if the account no longer exists."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"skills":{"type":"array","items":{"type":"string"}},"address":{"nullable":true},"summary":{"type":"string"},"articles":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"}}}},"headline":{"type":"string"},"username":{"type":"string"},"full_name":{"type":"string"},"languages":{"type":"array","items":{}},"photo_url":{"type":"string"},"educations":{"type":"array","items":{"type":"object","properties":{"school":{"type":"string"},"end_date":{"nullable":true},"end_year":{"nullable":true},"start_date":{"nullable":true},"start_year":{"nullable":true},"field_of_study":{"type":"string"}}}},"experiences":{"type":"array","items":{"type":"object","properties":{"company":{"type":"string"},"end_date":{"nullable":true},"job_title":{"type":"string"},"start_date":{"type":"string"},"company_url":{"type":"string"},"description":{"nullable":true},"company_logo":{"type":"string"}}}},"profile_url":{"type":"string"},"certifications":{"type":"array","items":{}},"follower_count":{"type":"integer"},"recommendations":{"type":"array","items":{}},"connection_count":{"type":"integer"},"member_identifier":{"type":"string"}}},"examples":{"Lookup by username. Alex Martin":{"value":{"skills":["Software Development","Technology","Philanthropy","Public Speaking","Strategic Planning"],"address":null,"summary":"Chair of the Gates Foundation. Founder of Breakthrough Energy. Co-founder of Microsoft. Voracious reader. Avid traveler. Active blogger.","articles":[{"url":"https://www.linkedin.com/pulse/phone-call-saves-lives-bill-gates-yspvc","title":"A phone call that saves lives","author":"Alex Martin"},{"url":"https://www.linkedin.com/pulse/expanding-access-health-care-through-ai-bill-gates-xyqtc","title":"Expanding access to health care through AI","author":"Jordan Lee"}],"headline":"Chair, Gates Foundation and Founder, Breakthrough Energy","username":"example-user","full_name":"Alex Martin","languages":[],"photo_url":"https://media.licdn.com/placeholder/example-user.jpg","educations":[{"school":"Harvard University","end_date":null,"end_year":null,"start_date":null,"start_year":null,"field_of_study":"Computer Science and Economics"}],"experiences":[{"company":"Gates Foundation","end_date":null,"job_title":"Chair","start_date":"2022-01-01","company_url":"https://www.linkedin.com/company/gatesfoundation","description":null,"company_logo":"https://media.licdn.com/dms/image/v2/D4E0BAQG8h8v5PqC7dA/company-logo_100_100"},{"company":"Breakthrough Energy","end_date":null,"job_title":"Founder","start_date":"2015-01-01","company_url":"https://www.linkedin.com/company/breakthrough-energy","description":null,"company_logo":null}],"profile_url":"https://www.linkedin.com/in/example-user","certifications":[],"follower_count":36800000,"recommendations":[],"connection_count":500,"member_identifier":"example-user"}},"Lookup by profile URL - https://www.linkedin.com/in/example-user-2":{"value":{"address":{"city":"Toulouse","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"summary":null,"articles":[],"headline":null,"username":"example-user-2","full_name":"Jordan Lee","languages":[],"photo_url":"https://media.licdn.com/placeholder/example-user-2.jpg","activities":[],"educations":[],"experiences":[{"address":{"city":"Toulouse","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":"WebAPI Group","end_date":null,"location":"Toulouse, Occitanie, France","start_at":null,"company_url":"https://www.linkedin.com/company/webapi-group","description":null},{"address":{"city":"Flourens","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Flourens, Occitanie, France","start_at":null,"company_url":null,"description":null},{"address":{"city":"Flourens","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Flourens","start_at":null,"company_url":null,"description":null},{"address":{"city":"Flourens","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Flourens (31)","start_at":null,"company_url":null,"description":null},{"address":{"city":null,"state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Castanet-Tolosan","start_at":null,"company_url":null,"description":null},{"address":{"city":"Villefranche-de-Lauragais","state":"Occitanie","county":"Haute-Garonne","country":"France","country_code":"FR"},"company":null,"end_date":null,"location":"Villefranche de Lauragais ","start_at":null,"company_url":null,"description":null}],"profile_url":"https://fr.linkedin.com/in/example-user-2","website_url":"https://webapi.group/","background_url":"https://media.licdn.com/placeholder/example-user-2.jpg","follower_count":664,"recommendations":[],"section_courses":[],"section_patents":[],"connection_count":500,"section_projects":[],"people_also_viewed":[{"url":"https://fr.linkedin.com/in/example-user-3","name":"Sam Rivera","summary":"Rolls-Royce","location":"384 abonnésParis et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-4","name":"Casey Nguyen","summary":"Nestlé Waters","location":"287 abonnésNîmes"},{"url":"https://fr.linkedin.com/in/example-user-5","name":"Morgan Blake","summary":"Astek","location":"862 abonnésLe Bouscat"},{"url":"https://fr.linkedin.com/in/example-user-6","name":"Riley Chen","summary":"Turbotech","location":"264 abonnésNice"},{"url":"https://fr.linkedin.com/in/example-user-7","name":"Taylor Brooks","summary":"Alternoon","location":"444 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-8","name":"Quinn Parker","summary":"Safran","location":"325 abonnésVert-Saint-Denis"},{"url":"https://fr.linkedin.com/in/example-user-9","name":"Avery Kim","summary":"Safran","location":"635 abonnésBois-d'Arcy"},{"url":"https://fr.linkedin.com/in/example-user-10","name":"Drew Patel","summary":"Stelliant","location":"499 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-11","name":"Jamie Costa","summary":"Thales","location":"700 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-12","name":"Robin Singh","summary":"PYMCO Technologies","location":"477 abonnésFrance"},{"url":"https://fr.linkedin.com/in/example-user-13","name":"Sky Reed","summary":"eve, la vivante","location":"2 k abonnésMarseille et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-14","name":"Reese Diaz","summary":"Aegys","location":"893 abonnésToulouse et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-15","name":"Rowan Hughes","summary":"Howmet Aerospace","location":"367 abonnésMaisons-Laffitte"},{"url":"https://fr.linkedin.com/in/example-user-16","name":"Elliot Bennett","summary":"ODELI","location":"1 k abonnésClermont-Ferrand et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-17","name":"Harper Cruz","summary":"CAF (Construcciones y Auxiliar de Ferrocarriles)","location":"374 abonnésStrasbourg et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-18","name":"Finley Ward","summary":"Safran","location":"347 abonnésPalaiseau"},{"url":"https://fr.linkedin.com/in/example-user-19","name":"Shawn Price","summary":"VARTAN.AERO","location":"473 abonnésToulouse et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-20","name":"Kendall Morales","summary":"Plug'Heur","location":"7 k abonnésBordeaux"},{"url":"https://fr.linkedin.com/in/example-user-21","name":"Logan Ross","summary":"Kickmaker","location":"1 k abonnésParis et périphérie"},{"url":"https://fr.linkedin.com/in/example-user-22","name":"Micah Campbell","summary":"Airbus","location":"308 abonnésSaint-Nazaire"}],"section_test_scores":[],"section_publications":[],"card_current_position":{"url":"https://www.linkedin.com/company/webapi-group","name":"WebAPI Group"},"section_honors_awards":[],"section_organizations":[],"card_current_education":null,"section_certifications":[],"section_volunteer_experiences":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/usage":{"get":{"summary":"Usage","description":"Retrieve real-time usage statistics and credit balance for your Piloterr account.","operationId":"usage","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"packs":{"nullable":true},"period":{"type":"object","properties":{"end":{"type":"string"},"start":{"type":"string"}}},"account":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"}}},"api_key":{"type":"object","properties":{"alias":{"type":"string"},"active":{"type":"boolean"},"quotas":{"type":"object","properties":{"daily":{"nullable":true},"total":{"nullable":true},"weekly":{"nullable":true},"monthly":{"nullable":true}}},"expires":{"nullable":true},"category":{"type":"string"}}},"credits":{"type":"object","properties":{"given":{"type":"integer"},"consumed":{"type":"integer"},"remaining":{"type":"integer"},"percent_used":{"type":"integer"}}},"remaining":{"type":"integer"},"rate_limit":{"type":"object","properties":{"per_minute":{"nullable":true},"per_second":{"nullable":true}}},"total_used":{"type":"integer"},"renewal_date":{"type":"string"},"subscription":{"type":"object","properties":{"used":{"type":"integer"},"total":{"type":"integer"},"remaining":{"type":"integer"},"percent_used":{"type":"integer"}}}}},"examples":{"Account usage overview":{"value":{"packs":null,"period":{"end":"2026-04-25","start":"2026-03-25"},"account":{"name":"Microsoft","slug":"microsoft"},"api_key":{"alias":"my-api-key","active":true,"quotas":{"daily":null,"total":null,"weekly":null,"monthly":null},"expires":null,"category":"development"},"credits":{"given":0,"consumed":0,"remaining":0,"percent_used":0},"remaining":0,"rate_limit":{"per_minute":null,"per_second":null},"total_used":15871,"renewal_date":"2026-04-25","subscription":{"used":15871,"total":50,"remaining":0,"percent_used":31742}}},"Account with one-time packs":{"value":{"packs":{"used":15200000,"count":2,"items":[{"id":"cmhtn…","used":12500000,"title":"Ultimate","total":12500000,"exhausted":true,"remaining":0,"percent_used":100,"purchased_at":"2025-11-10"},{"id":"cmlc9…","used":2700000,"title":"Ultimate","total":12500000,"exhausted":false,"remaining":9800000,"percent_used":21.6,"purchased_at":"2026-02-07"}],"total":25000000,"current":{"id":"cmlc9…","used":2700000,"title":"Ultimate","total":12500000,"exhausted":false,"remaining":9800000,"percent_used":21.6,"purchased_at":"2026-02-07"},"remaining":9800000,"percent_used":60.8,"all_exhausted":false,"current_index":2,"exhausted_count":1},"period":{"end":"2026-10-01","start":"2026-09-01"},"account":{"name":"Microsoft","slug":"microsoft"},"api_key":{"alias":"my-api-key","active":true,"quotas":{"daily":null,"total":null,"weekly":null,"monthly":null},"expires":null,"category":"development"},"credits":{"given":0,"consumed":0,"remaining":0,"percent_used":0},"remaining":9800000,"rate_limit":{"per_minute":null,"per_second":null},"total_used":15200000,"renewal_date":"2026-10-01","subscription":{"used":15200000,"total":25000000,"remaining":9800000,"percent_used":60.8}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/seloger/agency/rent":{"get":{"summary":"SeLoger Agency Rent","description":"Retrieve paginated rental property listings published by a specific SeLoger agency using its numeric agency ID.\n\n**Credit cost:** 2 credits per call","operationId":"get-seloger-agency-rent","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can find it on any agency page.","schema":{"type":"string","description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can find it on any agency page."}},{"name":"page","in":"query","required":false,"description":"Page number for paginating through the agency's rental listings.\n\nUse this parameter to iterate through multiple pages of results when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2","schema":{"type":"number","default":"1","description":"Page number for paginating through the agency's rental listings.\n\nUse this parameter to iterate through multiple pages of results when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"type":{"type":"integer"},"image":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"}}},"price":{"type":"integer"},"surface":{"type":"integer"},"rooms_count":{"type":"integer"},"bedrooms_count":{"type":"integer"},"locality_label":{"type":"string"}}}}}},"examples":{"Rental listings for agency 18317 (page 1)":{"value":{"count":1,"result":[{"id":"263165015","url":"https://www.seloger-bureaux-commerces.com/annonces/location/local-commercial/paris-11eme/263165015","type":7,"image":{"alt":null,"src":"https://v.seloger.com/s/width/400/visuels/0/2/c/y/02cyrydlv40zdojea0frfgvs3g39ali32o6m6jc45.jpg"},"price":908,"surface":66,"rooms_count":0,"bedrooms_count":0,"locality_label":"Paris 11ème"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SeLoger Agency Rent","description":"Retrieve paginated rental property listings published by a specific SeLoger agency using its numeric agency ID.\n\n**Credit cost:** 2 credits per call","operationId":"post-seloger-agency-rent","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can find it on any agency page.","schema":{"type":"string","description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can find it on any agency page."}},{"name":"page","in":"query","required":false,"description":"Page number for paginating through the agency's rental listings.\n\nUse this parameter to iterate through multiple pages of results when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2","schema":{"type":"number","default":"1","description":"Page number for paginating through the agency's rental listings.\n\nUse this parameter to iterate through multiple pages of results when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"type":{"type":"integer"},"image":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"}}},"price":{"type":"integer"},"surface":{"type":"integer"},"rooms_count":{"type":"integer"},"bedrooms_count":{"type":"integer"},"locality_label":{"type":"string"}}}}}},"examples":{"Rental listings for agency 18317 (page 1)":{"value":{"count":1,"result":[{"id":"263165015","url":"https://www.seloger-bureaux-commerces.com/annonces/location/local-commercial/paris-11eme/263165015","type":7,"image":{"alt":null,"src":"https://v.seloger.com/s/width/400/visuels/0/2/c/y/02cyrydlv40zdojea0frfgvs3g39ali32o6m6jc45.jpg"},"price":908,"surface":66,"rooms_count":0,"bedrooms_count":0,"locality_label":"Paris 11ème"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/seloger/agency/sale":{"get":{"summary":"SeLoger Agency Sale","description":"Retrieve paginated sale property listings published by a specific SeLoger agency using its numeric agency ID.\n\n**Credit cost:** 2 credits per call","operationId":"get-seloger-agency-sale","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can retrieve it from any SeLoger agency page.","schema":{"type":"string","description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can retrieve it from any SeLoger agency page."}},{"name":"page","in":"query","required":false,"description":"Page number for paginating through the agency's sale listings.\n\nUse this parameter to iterate through multiple pages when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2","schema":{"type":"number","default":"1","description":"Page number for paginating through the agency's sale listings.\n\nUse this parameter to iterate through multiple pages when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"type":{"type":"integer"},"image":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"}}},"price":{"type":"integer"},"surface":{"type":"integer"},"rooms_count":{"type":"integer"},"bedrooms_count":{"type":"integer"},"locality_label":{"type":"string"}}}}}},"examples":{"Sale listings for agency 18317 (page 1)":{"value":{"count":21,"result":[{"id":"251442903","url":"https://www.seloger.com/annonces/achat/appartement/boulogne-billancourt-92/silly-gallieni/251442903.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/1/4/o/b/14obdze5vc9jkjkg5xhz1m2yr4z6oofk2ls1vb2ga.jpg"},"price":449000,"surface":60,"rooms_count":3,"bedrooms_count":2,"locality_label":"Boulogne-Billancourt"},{"id":"262053933","url":"https://www.seloger.com/annonces/achat/appartement/paris-13eme-75/olympiades-choisy/262053933.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/f/m/a/0fma04f1ouosugxx7d77pguuyz4ohv5euyxhalgdm.jpg"},"price":483000,"surface":94,"rooms_count":5,"bedrooms_count":3,"locality_label":"Paris 13ème"},{"id":"259336891","url":"https://www.seloger.com/annonces/achat/appartement/villemomble-93/carette-eglise/259336891.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/1/j/r/v/1jrvp0kms0ie7avqh2qjb68mfev0aioo0bbgx7u0p.jpg"},"price":234500,"surface":56,"rooms_count":2,"bedrooms_count":1,"locality_label":"Villemomble"},{"id":"259336887","url":"https://www.seloger.com/annonces/achat/appartement/villemomble-93/carette-eglise/259336887.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/2/0/w/q/20wq0pw940vde6nyy5g0vkpxu7kbstneyqo7b7vzj.jpg"},"price":264300,"surface":68,"rooms_count":3,"bedrooms_count":2,"locality_label":"Villemomble"}]}},"Sale listings for agency 3088 (page 1)":{"value":{"count":13,"result":[{"id":"250783955","url":"https://www.seloger.com/annonces/achat/maison/le-tignet-06/250783955.htm","type":2,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/d/4/a/0d4an9fj575oxz65wq0ceotc2lpwo5jo0okh3qoio.jpg"},"price":769000,"surface":130,"rooms_count":4,"bedrooms_count":3,"locality_label":"Le Tignet"},{"id":"260369779","url":"https://www.seloger.com/annonces/achat/maison/saint-cezaire-sur-siagne-06/260369779.htm","type":2,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/1/g/3/3/1g339fgwo15vp0j5j711fydslddoiqmybbjwh2nq8.jpg"},"price":479000,"surface":117,"rooms_count":3,"bedrooms_count":2,"locality_label":"Saint-Cézaire-sur-Siagne"},{"id":"257991879","url":"https://www.seloger.com/annonces/achat/maison/le-plan-de-grasse-06/257991879.htm","type":2,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/v/0/e/0v0ejw6qb805wda717fe6a1htpjz3hjuy6s126ug0.jpg"},"price":369000,"surface":84,"rooms_count":3,"bedrooms_count":2,"locality_label":"Le Plan de Grasse"},{"id":"262249939","url":"https://www.seloger.com/annonces/achat/appartement/le-tignet-06/262249939.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/x/2/x/0x2xi7ol0jnsr6hxf5qp07ogum521how2aiqqd6sg.jpg"},"price":179000,"surface":55,"rooms_count":3,"bedrooms_count":2,"locality_label":"Le Tignet"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SeLoger Agency Sale","description":"Retrieve paginated sale property listings published by a specific SeLoger agency using its numeric agency ID.\n\n**Credit cost:** 2 credits per call","operationId":"post-seloger-agency-sale","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can retrieve it from any SeLoger agency page.","schema":{"type":"string","description":"A valid SeLoger agency ID.\n\n**Example:**\n\n    18317\n\n**Note:** The agency ID is the numeric identifier found at the end of SeLoger agency profile URLs (e.g. `https://www.seloger.com/.../agence-18317/`). You can retrieve it from any SeLoger agency page."}},{"name":"page","in":"query","required":false,"description":"Page number for paginating through the agency's sale listings.\n\nUse this parameter to iterate through multiple pages when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2","schema":{"type":"number","default":"1","description":"Page number for paginating through the agency's sale listings.\n\nUse this parameter to iterate through multiple pages when the agency has more listings than returned in a single call.\n\n**Example:**\n\n    2"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"type":{"type":"integer"},"image":{"type":"object","properties":{"alt":{"nullable":true},"src":{"type":"string"}}},"price":{"type":"integer"},"surface":{"type":"integer"},"rooms_count":{"type":"integer"},"bedrooms_count":{"type":"integer"},"locality_label":{"type":"string"}}}}}},"examples":{"Sale listings for agency 18317 (page 1)":{"value":{"count":21,"result":[{"id":"251442903","url":"https://www.seloger.com/annonces/achat/appartement/boulogne-billancourt-92/silly-gallieni/251442903.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/1/4/o/b/14obdze5vc9jkjkg5xhz1m2yr4z6oofk2ls1vb2ga.jpg"},"price":449000,"surface":60,"rooms_count":3,"bedrooms_count":2,"locality_label":"Boulogne-Billancourt"},{"id":"262053933","url":"https://www.seloger.com/annonces/achat/appartement/paris-13eme-75/olympiades-choisy/262053933.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/f/m/a/0fma04f1ouosugxx7d77pguuyz4ohv5euyxhalgdm.jpg"},"price":483000,"surface":94,"rooms_count":5,"bedrooms_count":3,"locality_label":"Paris 13ème"},{"id":"259336891","url":"https://www.seloger.com/annonces/achat/appartement/villemomble-93/carette-eglise/259336891.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/1/j/r/v/1jrvp0kms0ie7avqh2qjb68mfev0aioo0bbgx7u0p.jpg"},"price":234500,"surface":56,"rooms_count":2,"bedrooms_count":1,"locality_label":"Villemomble"},{"id":"259336887","url":"https://www.seloger.com/annonces/achat/appartement/villemomble-93/carette-eglise/259336887.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/2/0/w/q/20wq0pw940vde6nyy5g0vkpxu7kbstneyqo7b7vzj.jpg"},"price":264300,"surface":68,"rooms_count":3,"bedrooms_count":2,"locality_label":"Villemomble"}]}},"Sale listings for agency 3088 (page 1)":{"value":{"count":13,"result":[{"id":"250783955","url":"https://www.seloger.com/annonces/achat/maison/le-tignet-06/250783955.htm","type":2,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/d/4/a/0d4an9fj575oxz65wq0ceotc2lpwo5jo0okh3qoio.jpg"},"price":769000,"surface":130,"rooms_count":4,"bedrooms_count":3,"locality_label":"Le Tignet"},{"id":"260369779","url":"https://www.seloger.com/annonces/achat/maison/saint-cezaire-sur-siagne-06/260369779.htm","type":2,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/1/g/3/3/1g339fgwo15vp0j5j711fydslddoiqmybbjwh2nq8.jpg"},"price":479000,"surface":117,"rooms_count":3,"bedrooms_count":2,"locality_label":"Saint-Cézaire-sur-Siagne"},{"id":"257991879","url":"https://www.seloger.com/annonces/achat/maison/le-plan-de-grasse-06/257991879.htm","type":2,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/v/0/e/0v0ejw6qb805wda717fe6a1htpjz3hjuy6s126ug0.jpg"},"price":369000,"surface":84,"rooms_count":3,"bedrooms_count":2,"locality_label":"Le Plan de Grasse"},{"id":"262249939","url":"https://www.seloger.com/annonces/achat/appartement/le-tignet-06/262249939.htm","type":1,"image":{"alt":null,"src":"https://v.seloger.com/s/width/800/visuels/0/x/2/x/0x2xi7ol0jnsr6hxf5qp07ogum521how2aiqqd6sg.jpg"},"price":179000,"surface":55,"rooms_count":3,"bedrooms_count":2,"locality_label":"Le Tignet"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/seloger/agency":{"get":{"summary":"SeLoger Agency","description":"Retrieve detailed profile information for a SeLoger real estate agency including contact details, ratings, reviews, and address.\n\n**Credit cost:** 2 credits per call","operationId":"get-seloger-agency","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger agency profile URL.\n\n**Supported URL formats:**\n```\n/professionnels/agences-immobilieres/{city}/{slug}/\n```\n\n```\n/professionnels/agents-commerciaux/{city}/{slug}/\n```\n\n**Example:**\n\n    https://www.seloger.com/professionnels/agences-immobilieres/castanet-tolosan-31320/agence-21719\n\n**Note:** The URL must point to a SeLoger agency profile page. The agency slug and numeric ID are both embedded in the URL.","schema":{"type":"string","description":"A valid SeLoger agency profile URL.\n\n**Supported URL formats:**\n```\n/professionnels/agences-immobilieres/{city}/{slug}/\n```\n\n```\n/professionnels/agents-commerciaux/{city}/{slug}/\n```\n\n**Example:**\n\n    https://www.seloger.com/professionnels/agences-immobilieres/castanet-tolosan-31320/agence-21719\n\n**Note:** The URL must point to a SeLoger agency profile page. The agency slug and numeric ID are both embedded in the URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"logo":{"type":"object","properties":{"alt":{"type":"string"},"src":{"type":"string"}}},"name":{"type":"string"},"email":{"type":"string"},"siret":{"type":"string"},"banner":{"type":"object","properties":{"alt":{"type":"string"},"src":{"nullable":true}}},"id_rcu":{"type":"string"},"rating":{"type":"object","properties":{"value":{"type":"number"},"reviews_count":{"type":"integer"}}},"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"zip_code":{"type":"string"}}},"fee_url":{"type":"string"},"reviews":{"type":"object","properties":{"count":{"type":"integer"},"result":{"type":"array","items":{}}}},"website":{"type":"string"},"id_tiers":{"type":"string"},"is_seller":{"nullable":true},"languages":{"type":"string"},"legal_form":{"nullable":true},"sold_count":{"nullable":true},"agency_type":{"type":"integer"},"description":{"nullable":true},"phone_number":{"type":"string"},"intermediary_id":{"type":"integer"},"social_networks":{"type":"array","items":{}},"sold_properties":{"nullable":true},"intermediary_type":{"type":"integer"},"environment_source":{"type":"string"},"head_office_address":{"nullable":true}}},"examples":{"Agency profile for L'ADRESSE CASTANET TOLOSAN":{"value":{"id":"73866","logo":{"alt":"Logo du pro L'ADRESSE CASTANET TOLOSAN","src":"04yui7bokni23pkvnpeje9fsrpfqf364vk6xbc1qo"},"name":"L'ADRESSE CASTANET TOLOSAN","email":"name@example.com","siret":"51965411500020","banner":{"alt":"Banniere du pro L'ADRESSE CASTANET TOLOSAN","src":null},"id_rcu":"RC-079919","rating":{"value":4.8,"reviews_count":129},"address":{"city":"Castanet Tolosan","street":"43 avenue de Toulouse ","zip_code":"31320"},"fee_url":"https://media.immo-facile.com/segments/immo/catalog/images/manufacturers_bareme/72614.pdf","reviews":{"count":129,"result":[]},"website":"http://www.ladresse-castanet.com","id_tiers":"102577","is_seller":null,"languages":"en,es,fr","legal_form":null,"sold_count":null,"agency_type":0,"description":null,"phone_number":"+33 1 99 00 00 00","intermediary_id":21719,"social_networks":[],"sold_properties":null,"intermediary_type":1,"environment_source":"SELOGER","head_office_address":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SeLoger Agency","description":"Retrieve detailed profile information for a SeLoger real estate agency including contact details, ratings, reviews, and address.\n\n**Credit cost:** 2 credits per call","operationId":"post-seloger-agency","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger agency profile URL.\n\n**Supported URL formats:**\n```\n/professionnels/agences-immobilieres/{city}/{slug}/\n```\n\n```\n/professionnels/agents-commerciaux/{city}/{slug}/\n```\n\n**Example:**\n\n    https://www.seloger.com/professionnels/agences-immobilieres/castanet-tolosan-31320/agence-21719\n\n**Note:** The URL must point to a SeLoger agency profile page. The agency slug and numeric ID are both embedded in the URL.","schema":{"type":"string","description":"A valid SeLoger agency profile URL.\n\n**Supported URL formats:**\n```\n/professionnels/agences-immobilieres/{city}/{slug}/\n```\n\n```\n/professionnels/agents-commerciaux/{city}/{slug}/\n```\n\n**Example:**\n\n    https://www.seloger.com/professionnels/agences-immobilieres/castanet-tolosan-31320/agence-21719\n\n**Note:** The URL must point to a SeLoger agency profile page. The agency slug and numeric ID are both embedded in the URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"logo":{"type":"object","properties":{"alt":{"type":"string"},"src":{"type":"string"}}},"name":{"type":"string"},"email":{"type":"string"},"siret":{"type":"string"},"banner":{"type":"object","properties":{"alt":{"type":"string"},"src":{"nullable":true}}},"id_rcu":{"type":"string"},"rating":{"type":"object","properties":{"value":{"type":"number"},"reviews_count":{"type":"integer"}}},"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"zip_code":{"type":"string"}}},"fee_url":{"type":"string"},"reviews":{"type":"object","properties":{"count":{"type":"integer"},"result":{"type":"array","items":{}}}},"website":{"type":"string"},"id_tiers":{"type":"string"},"is_seller":{"nullable":true},"languages":{"type":"string"},"legal_form":{"nullable":true},"sold_count":{"nullable":true},"agency_type":{"type":"integer"},"description":{"nullable":true},"phone_number":{"type":"string"},"intermediary_id":{"type":"integer"},"social_networks":{"type":"array","items":{}},"sold_properties":{"nullable":true},"intermediary_type":{"type":"integer"},"environment_source":{"type":"string"},"head_office_address":{"nullable":true}}},"examples":{"Agency profile for L'ADRESSE CASTANET TOLOSAN":{"value":{"id":"73866","logo":{"alt":"Logo du pro L'ADRESSE CASTANET TOLOSAN","src":"04yui7bokni23pkvnpeje9fsrpfqf364vk6xbc1qo"},"name":"L'ADRESSE CASTANET TOLOSAN","email":"name@example.com","siret":"51965411500020","banner":{"alt":"Banniere du pro L'ADRESSE CASTANET TOLOSAN","src":null},"id_rcu":"RC-079919","rating":{"value":4.8,"reviews_count":129},"address":{"city":"Castanet Tolosan","street":"43 avenue de Toulouse ","zip_code":"31320"},"fee_url":"https://media.immo-facile.com/segments/immo/catalog/images/manufacturers_bareme/72614.pdf","reviews":{"count":129,"result":[]},"website":"http://www.ladresse-castanet.com","id_tiers":"102577","is_seller":null,"languages":"en,es,fr","legal_form":null,"sold_count":null,"agency_type":0,"description":null,"phone_number":"+33 1 99 00 00 00","intermediary_id":21719,"social_networks":[],"sold_properties":null,"intermediary_type":1,"environment_source":"SELOGER","head_office_address":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/seloger/property":{"get":{"summary":"SeLoger Property","description":"Efficiently extract detailed data from a SeLoger real estate listing including agency info, pricing, photos, description, and property criteria.\n\n**Credit cost:** 2 credits per call","operationId":"get-seloger-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger property listing URL.\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/capucins-saint-michel-nansouty-saint-genes/234462129.htm\n\n**Note:** The URL must point to an active SeLoger property listing page. Expired or removed listings will return an error. Both sale and rental listing URLs are supported.","schema":{"type":"string","description":"A valid SeLoger property listing URL.\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/capucins-saint-michel-nansouty-saint-genes/234462129.htm\n\n**Note:** The URL must point to an active SeLoger property listing page. Expired or removed listings will return an error. Both sale and rental listing URLs are supported."}},{"name":"return_page_source","in":"query","required":false,"description":"Whether to return the raw HTML source of the property page instead of parsed JSON data.\n\n- `false`: Returns structured JSON data (default)\n- `true`: Returns the raw HTML source of the page\n\n**Note:** Enabling this option is useful for custom parsing or debugging, but the response will not be structured JSON.","schema":{"type":"boolean","default":"false","description":"Whether to return the raw HTML source of the property page instead of parsed JSON data.\n\n- `false`: Returns structured JSON data (default)\n- `true`: Returns the raw HTML source of the page\n\n**Note:** Enabling this option is useful for custom parsing or debugging, but the response will not be structured JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"agency":{"type":"object","properties":{"id":{"type":"integer"},"logo":{"type":"string"},"name":{"type":"string"},"id_rcu":{"type":"string"},"rating":{"type":"object","properties":{"rating":{"type":"number"},"review_url":{"type":"string"},"review_count":{"type":"integer"}}},"address":{"type":"string"},"tier_id":{"type":"integer"},"fees_url":{"type":"string"},"description":{"nullable":true},"website_url":{"type":"string"},"legal_notice":{"type":"object","properties":{"rcs_siren":{"type":"string"},"legal_form":{"nullable":true},"is_individual":{"type":"boolean"},"share_capital":{"type":"integer"},"social_reason":{"type":"string"},"headquarter_address":{"type":"string"},"financial_guarantee_fund":{"type":"string"},"professional_card_number":{"nullable":true},"financial_guarantee_amount":{"type":"integer"},"professional_card_prefecture":{"nullable":true}}},"phone_number":{"type":"string"},"contact_hidden":{"type":"boolean"},"profession_type":{"type":"string"},"profil_page_url":{"type":"string"},"organisation_logo":{"nullable":true}}},"seeker":{"nullable":true},"contact":{"type":"object","properties":{"book_a_visit":{"type":"object","properties":{"slots":{"nullable":true},"enabled":{"type":"boolean"},"event_type":{"nullable":true},"required_form":{"type":"boolean"},"plato_agency_id":{"nullable":true},"allowed_contracts":{"nullable":true},"unpaid_rent_garanty":{"type":"boolean"},"unpaid_rent_garanty_rate":{"type":"integer"}}}}},"listing":{"type":"object","properties":{"url":{"type":"object","properties":{"value":{"type":"string"},"nature":{"type":"integer"},"business_unit_type":{"type":"string"}}},"early_access":{"nullable":true},"listing_detail":{"type":"object","properties":{"id":{"type":"integer"},"media":{"type":"object","properties":{"photos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"mobile_url":{"type":"string"},"square_url":{"type":"string"},"default_url":{"type":"string"},"original_url":{"type":"string"},"is_horizontal":{"type":"boolean"},"descriptive_fr":{"nullable":true},"square_large_url":{"type":"string"},"low_resolution_url":{"type":"string"},"photo_description_tags":{"nullable":true}}}}}}}}}}}},"examples":{"Property listing detail: apartment Bordeaux (ID 234462129)":{"value":{"agency":{"id":336312,"logo":"https://v.seloger.com/s/width/150/logos/0/h/0/l/0h0leun3rcbdmdyf0pb8fdq1wkqufnq0wjzms4qw6.jpg","name":"Efficity   Gael Brossaud","id_rcu":"RC-267721","rating":{"rating":4.9,"review_url":"/professionnels/agents-commerciaux/paris-13eme-arrondissement-75013/agence-18317/#?avisImmo=true","review_count":139},"address":"","tier_id":399543,"fees_url":"http://diszln7ft1ccx.cloudfront.net/pdf/BAREME_NATIONAL.pdf","description":null,"website_url":"https://www.efficity.com/gbrossaud","legal_notice":{"rcs_siren":"813142676","legal_form":null,"is_individual":false,"share_capital":116847,"social_reason":"SAS","headquarter_address":"48 avenue de Villiers 75017 Paris","financial_guarantee_fund":"GALIAN Assurances","professional_card_number":null,"financial_guarantee_amount":500000,"professional_card_prefecture":null},"phone_number":"06 11 49 76 90","contact_hidden":false,"profession_type":"Agents commerciaux","profil_page_url":"/professionnels/agents-commerciaux/paris-13eme-arrondissement-75013/agence-18317/","organisation_logo":null},"seeker":null,"contact":{"book_a_visit":{"slots":null,"enabled":false,"event_type":null,"required_form":false,"plato_agency_id":null,"allowed_contracts":null,"unpaid_rent_garanty":false,"unpaid_rent_garanty_rate":0}},"listing":{"url":{"value":"https://www.seloger.com/annonces/achat/appartement/bordeaux-33/capucins-saint-michel-nansouty-saint-genes/234462129.htm","nature":1,"business_unit_type":"SL"},"early_access":null,"listing_detail":{"id":234462129,"media":{"photos":[{"id":141138868,"mobile_url":"https://v.seloger.com/s/width/600/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","square_url":"https://v.seloger.com/s/crop/200x200/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","default_url":"https://v.seloger.com/s/width/800/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","original_url":"https://v.seloger.com/s/cdn/x/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","is_horizontal":true,"descriptive_fr":null,"square_large_url":"https://v.seloger.com/s/crop/414x414/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","low_resolution_url":"https://v.seloger.com/s/width/400/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","photo_description_tags":null}]}}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SeLoger Property","description":"Efficiently extract detailed data from a SeLoger real estate listing including agency info, pricing, photos, description, and property criteria.\n\n**Credit cost:** 2 credits per call","operationId":"post-seloger-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger property listing URL.\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/capucins-saint-michel-nansouty-saint-genes/234462129.htm\n\n**Note:** The URL must point to an active SeLoger property listing page. Expired or removed listings will return an error. Both sale and rental listing URLs are supported.","schema":{"type":"string","description":"A valid SeLoger property listing URL.\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/capucins-saint-michel-nansouty-saint-genes/234462129.htm\n\n**Note:** The URL must point to an active SeLoger property listing page. Expired or removed listings will return an error. Both sale and rental listing URLs are supported."}},{"name":"return_page_source","in":"query","required":false,"description":"Whether to return the raw HTML source of the property page instead of parsed JSON data.\n\n- `false`: Returns structured JSON data (default)\n- `true`: Returns the raw HTML source of the page\n\n**Note:** Enabling this option is useful for custom parsing or debugging, but the response will not be structured JSON.","schema":{"type":"boolean","default":"false","description":"Whether to return the raw HTML source of the property page instead of parsed JSON data.\n\n- `false`: Returns structured JSON data (default)\n- `true`: Returns the raw HTML source of the page\n\n**Note:** Enabling this option is useful for custom parsing or debugging, but the response will not be structured JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"agency":{"type":"object","properties":{"id":{"type":"integer"},"logo":{"type":"string"},"name":{"type":"string"},"id_rcu":{"type":"string"},"rating":{"type":"object","properties":{"rating":{"type":"number"},"review_url":{"type":"string"},"review_count":{"type":"integer"}}},"address":{"type":"string"},"tier_id":{"type":"integer"},"fees_url":{"type":"string"},"description":{"nullable":true},"website_url":{"type":"string"},"legal_notice":{"type":"object","properties":{"rcs_siren":{"type":"string"},"legal_form":{"nullable":true},"is_individual":{"type":"boolean"},"share_capital":{"type":"integer"},"social_reason":{"type":"string"},"headquarter_address":{"type":"string"},"financial_guarantee_fund":{"type":"string"},"professional_card_number":{"nullable":true},"financial_guarantee_amount":{"type":"integer"},"professional_card_prefecture":{"nullable":true}}},"phone_number":{"type":"string"},"contact_hidden":{"type":"boolean"},"profession_type":{"type":"string"},"profil_page_url":{"type":"string"},"organisation_logo":{"nullable":true}}},"seeker":{"nullable":true},"contact":{"type":"object","properties":{"book_a_visit":{"type":"object","properties":{"slots":{"nullable":true},"enabled":{"type":"boolean"},"event_type":{"nullable":true},"required_form":{"type":"boolean"},"plato_agency_id":{"nullable":true},"allowed_contracts":{"nullable":true},"unpaid_rent_garanty":{"type":"boolean"},"unpaid_rent_garanty_rate":{"type":"integer"}}}}},"listing":{"type":"object","properties":{"url":{"type":"object","properties":{"value":{"type":"string"},"nature":{"type":"integer"},"business_unit_type":{"type":"string"}}},"early_access":{"nullable":true},"listing_detail":{"type":"object","properties":{"id":{"type":"integer"},"media":{"type":"object","properties":{"photos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"mobile_url":{"type":"string"},"square_url":{"type":"string"},"default_url":{"type":"string"},"original_url":{"type":"string"},"is_horizontal":{"type":"boolean"},"descriptive_fr":{"nullable":true},"square_large_url":{"type":"string"},"low_resolution_url":{"type":"string"},"photo_description_tags":{"nullable":true}}}}}}}}}}}},"examples":{"Property listing detail: apartment Bordeaux (ID 234462129)":{"value":{"agency":{"id":336312,"logo":"https://v.seloger.com/s/width/150/logos/0/h/0/l/0h0leun3rcbdmdyf0pb8fdq1wkqufnq0wjzms4qw6.jpg","name":"Efficity   Gael Brossaud","id_rcu":"RC-267721","rating":{"rating":4.9,"review_url":"/professionnels/agents-commerciaux/paris-13eme-arrondissement-75013/agence-18317/#?avisImmo=true","review_count":139},"address":"","tier_id":399543,"fees_url":"http://diszln7ft1ccx.cloudfront.net/pdf/BAREME_NATIONAL.pdf","description":null,"website_url":"https://www.efficity.com/gbrossaud","legal_notice":{"rcs_siren":"813142676","legal_form":null,"is_individual":false,"share_capital":116847,"social_reason":"SAS","headquarter_address":"48 avenue de Villiers 75017 Paris","financial_guarantee_fund":"GALIAN Assurances","professional_card_number":null,"financial_guarantee_amount":500000,"professional_card_prefecture":null},"phone_number":"06 11 49 76 90","contact_hidden":false,"profession_type":"Agents commerciaux","profil_page_url":"/professionnels/agents-commerciaux/paris-13eme-arrondissement-75013/agence-18317/","organisation_logo":null},"seeker":null,"contact":{"book_a_visit":{"slots":null,"enabled":false,"event_type":null,"required_form":false,"plato_agency_id":null,"allowed_contracts":null,"unpaid_rent_garanty":false,"unpaid_rent_garanty_rate":0}},"listing":{"url":{"value":"https://www.seloger.com/annonces/achat/appartement/bordeaux-33/capucins-saint-michel-nansouty-saint-genes/234462129.htm","nature":1,"business_unit_type":"SL"},"early_access":null,"listing_detail":{"id":234462129,"media":{"photos":[{"id":141138868,"mobile_url":"https://v.seloger.com/s/width/600/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","square_url":"https://v.seloger.com/s/crop/200x200/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","default_url":"https://v.seloger.com/s/width/800/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","original_url":"https://v.seloger.com/s/cdn/x/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","is_horizontal":true,"descriptive_fr":null,"square_large_url":"https://v.seloger.com/s/crop/414x414/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","low_resolution_url":"https://v.seloger.com/s/width/400/visuels/0/e/n/8/0en8kp68vupvoihci64icm9ho97p4edc2er0n3bje.jpg","photo_description_tags":null}]}}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/seloger/search":{"get":{"summary":"SeLoger Search","description":"Efficiently extract real estate listings from SeLoger search pages for market insights, property management, and investment analysis.\n\n**Credit cost:** 2 credits per call","operationId":"get-seloger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger search results URL. Any SeLoger search page URL with filters is supported: location, property type, price range, surface, and number of rooms can all be embedded in the URL.\n\n**Supported transaction types:**\n- `/annonces/achat/`: property for sale\n- `/annonces/locations/`: property for rent\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/\n\n**Notes:**\n- Pagination parameters can be appended directly to the URL\n- All filters visible in the SeLoger search interface are supported","schema":{"type":"string","description":"A valid SeLoger search results URL. Any SeLoger search page URL with filters is supported: location, property type, price range, surface, and number of rooms can all be embedded in the URL.\n\n**Supported transaction types:**\n- `/annonces/achat/`: property for sale\n- `/annonces/locations/`: property for rent\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/\n\n**Notes:**\n- Pagination parameters can be appended directly to the URL\n- All filters visible in the SeLoger search interface are supported"}},{"name":"return_page_source","in":"query","required":false,"description":"Whether to return the raw HTML source of the search results page instead of parsed JSON data.\n\n- `false`: Returns structured JSON array of listings (default)\n- `true`: Returns the raw HTML source of the page\n\n**Default:** `false`\n\n**Note:** Useful for debugging or custom parsing workflows.","schema":{"type":"boolean","default":"false","description":"Whether to return the raw HTML source of the search results page instead of parsed JSON data.\n\n- `false`: Returns structured JSON array of listings (default)\n- `true`: Returns the raw HTML source of the page\n\n**Default:** `false`\n\n**Note:** Useful for debugging or custom parsing workflows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"epc":{"nullable":true},"tags":{"type":"array","items":{"type":"string"}},"rooms":{"type":"integer"},"title":{"type":"string"},"is_new":{"type":"boolean"},"nature":{"type":"integer"},"photos":{"type":"array","items":{"type":"string"}},"contact":{"type":"object","properties":{"email":{"type":"string"},"id_rcu":{"type":"string"},"img_url":{"type":"string"},"agency_id":{"type":"integer"},"agency_link":{"nullable":true},"agency_page":{"nullable":true},"contact_name":{"type":"string"},"phone_number":{"type":"string"},"is_private_seller":{"type":"boolean"}}},"pricing":{"type":"object","properties":{"price":{"type":"string"},"lifetime":{"type":"boolean"},"raw_price":{"type":"string"},"price_note":{"nullable":true},"monthly_price":{"type":"integer"},"square_meter_price":{"type":"string"}}},"surface":{"type":"number"},"position":{"type":"integer"},"zip_code":{"type":"string"},"card_type":{"type":"string"},"transport":{"nullable":true},"city_label":{"type":"string"},"desk_count":{"type":"integer"},"photos_qty":{"type":"integer"},"description":{"type":"string"},"estate_type":{"type":"string"},"video_u_r_l":{"nullable":true},"early_access":{"nullable":true},"is_exclusive":{"type":"boolean"},"bedroom_count":{"type":"integer"},"business_unit":{"type":"integer"},"housing_batch":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"}}}},"lease_type_id":{"type":"integer"},"district_label":{"type":"string"},"estate_type_id":{"type":"integer"},"publication_id":{"type":"integer"},"classified_u_r_l":{"type":"string"},"optional_criteria":{"type":"array","items":{}},"partner_link_type":{"type":"integer"},"highlighting_level":{"type":"integer"},"forced_intermediary":{"type":"boolean"},"transaction_type_id":{"type":"integer"},"virtual_visit_u_r_l":{"type":"string"},"missing_optional_criteria":{"type":"array","items":{}}}}},"examples":{"Search apartments for sale in Bordeaux":{"value":[{"id":227349507,"epc":null,"tags":["4 pièces","3 chambres","98 m²","Étage 2/–","Parking","Ascenseur"],"rooms":4,"title":"Appartement neuf","is_new":false,"nature":2,"photos":["/0/k/z/2/0kz2n5mhqtt4d922z0yk7ey61booyo9gqe5ikflog.jpg","/1/f/4/v/1f4v1cu618rao9z3jydwi7re88naslrnrie78v3i8.jpg"],"contact":{"email":"true","id_rcu":"RC-082608","img_url":"https://v.seloger.com/s/width/150/logos/0/x/q/v/0xqv4maey1fc6dtb7les934ocr8k2ue8850ffaueo.jpg","agency_id":76929,"agency_link":null,"agency_page":null,"contact_name":"Alex Martin","phone_number":"+33 1 99 00 00 00","is_private_seller":false},"pricing":{"price":"716 000 €","lifetime":false,"raw_price":"716000","price_note":null,"monthly_price":3596,"square_meter_price":"7 282 €"},"surface":98.32,"position":0,"zip_code":"33200","card_type":"classified","transport":null,"city_label":"Bordeaux","desk_count":0,"photos_qty":6,"description":"","estate_type":"Appartement neuf","video_u_r_l":null,"early_access":null,"is_exclusive":false,"bedroom_count":3,"business_unit":2,"housing_batch":[{"label":"3 pièces"},{"label":"2 pièces"},{"label":"5 pièces"},{"label":"4 pièces"}],"lease_type_id":0,"district_label":"Caudéran-Barrière Judaïque","estate_type_id":1,"publication_id":30076929,"classified_u_r_l":"https://www.selogerneuf.com/annonces/neuf/programme/bordeaux-33/208938143/","optional_criteria":[],"partner_link_type":1,"highlighting_level":3,"forced_intermediary":false,"transaction_type_id":2,"virtual_visit_u_r_l":"https://vimeo.com/953477395/35ed79aa17?share=copy","missing_optional_criteria":[]},{"id":232159607,"epc":"C","tags":["3 pièces","2 chambres","70 m²","Étage 1/2"],"rooms":3,"title":"Appartement","is_new":false,"nature":1,"photos":["/0/3/f/l/03flt9ozsl0o40fysnzj5d8m9lko4ozrtprgxgyw0.jpg","/0/0/3/q/003qpl4f372irog1qjnwkibqaix3ul4s4uoll7j4w.jpg"],"contact":{"email":"true","id_rcu":"RC-035271","img_url":"https://v.seloger.com/s/width/150/logos/1/i/8/7/1i870528o8j063099u4r7sk9gqvgr35b1ur2ejaez.jpg","agency_id":3088,"agency_link":null,"agency_page":"/professionnels/agences-immobilieres/bordeaux-33000/agence-48208/","contact_name":"Jordan Lee","phone_number":"+33 1 99 00 00 01","is_private_seller":false},"pricing":{"price":"472 000 €","lifetime":false,"raw_price":"472000","price_note":null,"monthly_price":2525,"square_meter_price":"6 743 €"},"surface":70,"position":1,"zip_code":"33000","card_type":"classified","transport":null,"city_label":"Bordeaux","desk_count":0,"photos_qty":7,"description":"Appartement à vendre - BORDEAUX - QUAIS DES CHARTRONS...","estate_type":"Appartement","video_u_r_l":null,"early_access":null,"is_exclusive":false,"bedroom_count":2,"business_unit":1,"housing_batch":[],"lease_type_id":0,"district_label":"Grand Parc-Chartrons-Paul Doumer","estate_type_id":1,"publication_id":30003088,"classified_u_r_l":"/annonces/achat/appartement/bordeaux-33/grand-parc-chartrons-paul-doumer/232159607.htm","optional_criteria":[],"partner_link_type":1,"highlighting_level":3,"forced_intermediary":false,"transaction_type_id":2,"virtual_visit_u_r_l":"https://youtu.be/ncAlgVjfZ0Y","missing_optional_criteria":[]}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"SeLoger Search","description":"Efficiently extract real estate listings from SeLoger search pages for market insights, property management, and investment analysis.\n\n**Credit cost:** 2 credits per call","operationId":"post-seloger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"A valid SeLoger search results URL. Any SeLoger search page URL with filters is supported: location, property type, price range, surface, and number of rooms can all be embedded in the URL.\n\n**Supported transaction types:**\n- `/annonces/achat/`: property for sale\n- `/annonces/locations/`: property for rent\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/\n\n**Notes:**\n- Pagination parameters can be appended directly to the URL\n- All filters visible in the SeLoger search interface are supported","schema":{"type":"string","description":"A valid SeLoger search results URL. Any SeLoger search page URL with filters is supported: location, property type, price range, surface, and number of rooms can all be embedded in the URL.\n\n**Supported transaction types:**\n- `/annonces/achat/`: property for sale\n- `/annonces/locations/`: property for rent\n\n**Example:**\n\n    https://www.seloger.com/annonces/achat/appartement/bordeaux-33/\n\n**Notes:**\n- Pagination parameters can be appended directly to the URL\n- All filters visible in the SeLoger search interface are supported"}},{"name":"return_page_source","in":"query","required":false,"description":"Whether to return the raw HTML source of the search results page instead of parsed JSON data.\n\n- `false`: Returns structured JSON array of listings (default)\n- `true`: Returns the raw HTML source of the page\n\n**Default:** `false`\n\n**Note:** Useful for debugging or custom parsing workflows.","schema":{"type":"boolean","default":"false","description":"Whether to return the raw HTML source of the search results page instead of parsed JSON data.\n\n- `false`: Returns structured JSON array of listings (default)\n- `true`: Returns the raw HTML source of the page\n\n**Default:** `false`\n\n**Note:** Useful for debugging or custom parsing workflows."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"epc":{"nullable":true},"tags":{"type":"array","items":{"type":"string"}},"rooms":{"type":"integer"},"title":{"type":"string"},"is_new":{"type":"boolean"},"nature":{"type":"integer"},"photos":{"type":"array","items":{"type":"string"}},"contact":{"type":"object","properties":{"email":{"type":"string"},"id_rcu":{"type":"string"},"img_url":{"type":"string"},"agency_id":{"type":"integer"},"agency_link":{"nullable":true},"agency_page":{"nullable":true},"contact_name":{"type":"string"},"phone_number":{"type":"string"},"is_private_seller":{"type":"boolean"}}},"pricing":{"type":"object","properties":{"price":{"type":"string"},"lifetime":{"type":"boolean"},"raw_price":{"type":"string"},"price_note":{"nullable":true},"monthly_price":{"type":"integer"},"square_meter_price":{"type":"string"}}},"surface":{"type":"number"},"position":{"type":"integer"},"zip_code":{"type":"string"},"card_type":{"type":"string"},"transport":{"nullable":true},"city_label":{"type":"string"},"desk_count":{"type":"integer"},"photos_qty":{"type":"integer"},"description":{"type":"string"},"estate_type":{"type":"string"},"video_u_r_l":{"nullable":true},"early_access":{"nullable":true},"is_exclusive":{"type":"boolean"},"bedroom_count":{"type":"integer"},"business_unit":{"type":"integer"},"housing_batch":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"}}}},"lease_type_id":{"type":"integer"},"district_label":{"type":"string"},"estate_type_id":{"type":"integer"},"publication_id":{"type":"integer"},"classified_u_r_l":{"type":"string"},"optional_criteria":{"type":"array","items":{}},"partner_link_type":{"type":"integer"},"highlighting_level":{"type":"integer"},"forced_intermediary":{"type":"boolean"},"transaction_type_id":{"type":"integer"},"virtual_visit_u_r_l":{"type":"string"},"missing_optional_criteria":{"type":"array","items":{}}}}},"examples":{"Search apartments for sale in Bordeaux":{"value":[{"id":227349507,"epc":null,"tags":["4 pièces","3 chambres","98 m²","Étage 2/–","Parking","Ascenseur"],"rooms":4,"title":"Appartement neuf","is_new":false,"nature":2,"photos":["/0/k/z/2/0kz2n5mhqtt4d922z0yk7ey61booyo9gqe5ikflog.jpg","/1/f/4/v/1f4v1cu618rao9z3jydwi7re88naslrnrie78v3i8.jpg"],"contact":{"email":"true","id_rcu":"RC-082608","img_url":"https://v.seloger.com/s/width/150/logos/0/x/q/v/0xqv4maey1fc6dtb7les934ocr8k2ue8850ffaueo.jpg","agency_id":76929,"agency_link":null,"agency_page":null,"contact_name":"Alex Martin","phone_number":"+33 1 99 00 00 00","is_private_seller":false},"pricing":{"price":"716 000 €","lifetime":false,"raw_price":"716000","price_note":null,"monthly_price":3596,"square_meter_price":"7 282 €"},"surface":98.32,"position":0,"zip_code":"33200","card_type":"classified","transport":null,"city_label":"Bordeaux","desk_count":0,"photos_qty":6,"description":"","estate_type":"Appartement neuf","video_u_r_l":null,"early_access":null,"is_exclusive":false,"bedroom_count":3,"business_unit":2,"housing_batch":[{"label":"3 pièces"},{"label":"2 pièces"},{"label":"5 pièces"},{"label":"4 pièces"}],"lease_type_id":0,"district_label":"Caudéran-Barrière Judaïque","estate_type_id":1,"publication_id":30076929,"classified_u_r_l":"https://www.selogerneuf.com/annonces/neuf/programme/bordeaux-33/208938143/","optional_criteria":[],"partner_link_type":1,"highlighting_level":3,"forced_intermediary":false,"transaction_type_id":2,"virtual_visit_u_r_l":"https://vimeo.com/953477395/35ed79aa17?share=copy","missing_optional_criteria":[]},{"id":232159607,"epc":"C","tags":["3 pièces","2 chambres","70 m²","Étage 1/2"],"rooms":3,"title":"Appartement","is_new":false,"nature":1,"photos":["/0/3/f/l/03flt9ozsl0o40fysnzj5d8m9lko4ozrtprgxgyw0.jpg","/0/0/3/q/003qpl4f372irog1qjnwkibqaix3ul4s4uoll7j4w.jpg"],"contact":{"email":"true","id_rcu":"RC-035271","img_url":"https://v.seloger.com/s/width/150/logos/1/i/8/7/1i870528o8j063099u4r7sk9gqvgr35b1ur2ejaez.jpg","agency_id":3088,"agency_link":null,"agency_page":"/professionnels/agences-immobilieres/bordeaux-33000/agence-48208/","contact_name":"Jordan Lee","phone_number":"+33 1 99 00 00 01","is_private_seller":false},"pricing":{"price":"472 000 €","lifetime":false,"raw_price":"472000","price_note":null,"monthly_price":2525,"square_meter_price":"6 743 €"},"surface":70,"position":1,"zip_code":"33000","card_type":"classified","transport":null,"city_label":"Bordeaux","desk_count":0,"photos_qty":7,"description":"Appartement à vendre - BORDEAUX - QUAIS DES CHARTRONS...","estate_type":"Appartement","video_u_r_l":null,"early_access":null,"is_exclusive":false,"bedroom_count":2,"business_unit":1,"housing_batch":[],"lease_type_id":0,"district_label":"Grand Parc-Chartrons-Paul Doumer","estate_type_id":1,"publication_id":30003088,"classified_u_r_l":"/annonces/achat/appartement/bordeaux-33/grand-parc-chartrons-paul-doumer/232159607.htm","optional_criteria":[],"partner_link_type":1,"highlighting_level":3,"forced_intermediary":false,"transaction_type_id":2,"virtual_visit_u_r_l":"https://youtu.be/ncAlgVjfZ0Y","missing_optional_criteria":[]}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/mascus/ad":{"get":{"summary":"Mascus Ad","description":"Get full details for a Mascus used equipment listing: specs, price, seller and description.\n\n**Credit cost:** 1 credit per call","operationId":"get-mascus-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Mascus listing URL. Usually taken from `results[].url` in search.\n\n**Example:**\n\n    https://www.mascus.fr/travaux-publics/broyeur-dechets/doppstadt-ak-435-profi/hocmgmfi.html\n\nWorks on all Mascus country sites (`mascus.fr`, `mascus.de`, `mascus.com`, …).","schema":{"type":"string","description":"Full Mascus listing URL. Usually taken from `results[].url` in search.\n\n**Example:**\n\n    https://www.mascus.fr/travaux-publics/broyeur-dechets/doppstadt-ak-435-profi/hocmgmfi.html\n\nWorks on all Mascus country sites (`mascus.fr`, `mascus.de`, `mascus.com`, …)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"string"},"model":{"type":"string"},"meta_data":{"type":"object","properties":{"meta_title":{"type":"string"}}},"catalog_name":{"type":"string"},"company_city":{"type":"string"},"company_name":{"type":"string"},"user_currency":{"type":"string"},"company_country":{"type":"string"},"asset_details_info":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"asset_pricing_info":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"price_in_user_currency":{"type":"integer"}}},"examples":{"Doppstadt AK 435 Profi listing":{"value":{"brand":"Doppstadt","model":"AK 435 Profi","meta_data":{"meta_title":"Doppstadt AK 435 Profi, 2012, France - Mascus France"},"catalog_name":"construction","company_city":"saint-genis-laval","company_name":"RHONE ENVIRONNEMENT","user_currency":"EUR","company_country":"FR","asset_details_info":[{"label":"Année","value":"2012"}],"asset_pricing_info":[{"label":"Prix","value":"108 000 EUR"}],"price_in_user_currency":108000}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Mascus Ad","description":"Get full details for a Mascus used equipment listing: specs, price, seller and description.\n\n**Credit cost:** 1 credit per call","operationId":"post-mascus-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Mascus listing URL. Usually taken from `results[].url` in search.\n\n**Example:**\n\n    https://www.mascus.fr/travaux-publics/broyeur-dechets/doppstadt-ak-435-profi/hocmgmfi.html\n\nWorks on all Mascus country sites (`mascus.fr`, `mascus.de`, `mascus.com`, …).","schema":{"type":"string","description":"Full Mascus listing URL. Usually taken from `results[].url` in search.\n\n**Example:**\n\n    https://www.mascus.fr/travaux-publics/broyeur-dechets/doppstadt-ak-435-profi/hocmgmfi.html\n\nWorks on all Mascus country sites (`mascus.fr`, `mascus.de`, `mascus.com`, …)."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"string"},"model":{"type":"string"},"meta_data":{"type":"object","properties":{"meta_title":{"type":"string"}}},"catalog_name":{"type":"string"},"company_city":{"type":"string"},"company_name":{"type":"string"},"user_currency":{"type":"string"},"company_country":{"type":"string"},"asset_details_info":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"asset_pricing_info":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"price_in_user_currency":{"type":"integer"}}},"examples":{"Doppstadt AK 435 Profi listing":{"value":{"brand":"Doppstadt","model":"AK 435 Profi","meta_data":{"meta_title":"Doppstadt AK 435 Profi, 2012, France - Mascus France"},"catalog_name":"construction","company_city":"saint-genis-laval","company_name":"RHONE ENVIRONNEMENT","user_currency":"EUR","company_country":"FR","asset_details_info":[{"label":"Année","value":"2012"}],"asset_pricing_info":[{"label":"Prix","value":"108 000 EUR"}],"price_in_user_currency":108000}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/mascus/search":{"get":{"summary":"Mascus Search","description":"Search used equipment listings on Mascus from a category URL, with pagination that keeps country and category filters.\n\n**Credit cost:** 1 credit per call","operationId":"get-mascus-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Mascus category or search URL. The country site comes from the host (`mascus.be`, `mascus.nl`, `mascus.de`, `mascus.com`, …).\n\n**Recommended (pagination keeps category + country):**\n\n```\nhttps://www.mascus.be/bouw/graafmachines/be,country.html\n```\n\n```\nhttps://www.mascus.nl/bouw/graafmachines/nl,country.html\n```\n\n```\nhttps://www.mascus.de/baumaschinen/bagger/de,country.html\n```\n\n**Also supported:**\n\n    https://www.mascus.be/+/catalogs=construction&categories=excavators&countries=BE/1,relevance,search.html\n\nFilters from the URL are kept on page 2+.","schema":{"type":"string","description":"Full Mascus category or search URL. The country site comes from the host (`mascus.be`, `mascus.nl`, `mascus.de`, `mascus.com`, …).\n\n**Recommended (pagination keeps category + country):**\n\n```\nhttps://www.mascus.be/bouw/graafmachines/be,country.html\n```\n\n```\nhttps://www.mascus.nl/bouw/graafmachines/nl,country.html\n```\n\n```\nhttps://www.mascus.de/baumaschinen/bagger/de,country.html\n```\n\n**Also supported:**\n\n    https://www.mascus.be/+/catalogs=construction&categories=excavators&countries=BE/1,relevance,search.html\n\nFilters from the URL are kept on page 2+."}},{"name":"page","in":"query","required":false,"description":"Page number (default: `1`). About 40 results per page.\n\n**Example:** `2`\n\nWorks with classic country browse URLs (`…/be,country.html`) and `+/catalogs=…/N,relevance,search.html` URLs. You can also put `?page=2` in the query URL.","schema":{"type":"number","description":"Page number (default: `1`). About 40 results per page.\n\n**Example:** `2`\n\nWorks with classic country browse URLs (`…/be,country.html`) and `+/catalogs=…/N,relevance,search.html` URLs. You can also put `?page=2` in the query URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"model":{"type":"string"},"image_url":{"type":"string"},"rental_ad":{"type":"boolean"},"auction_ad":{"type":"boolean"},"price_euro":{"type":"integer"},"product_id":{"type":"string"},"catalog_name":{"type":"string"},"company_name":{"type":"string"},"category_name":{"type":"string"},"location_city":{"type":"string"},"user_currency":{"type":"string"},"year_of_manufacture":{"type":"integer"},"location_country_code":{"type":"string"},"price_in_user_currency":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"page_size":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Belgian excavators (page 1)":{"value":{"results":[{"url":"https://www.mascus.be/bouw/minigraafmachines---7t/airman-ax10u-7-ax10u-7/ff3ch5ch.html","brand":"Airman","model":"AX10U-7","image_url":"https://dnge9sb91helb.cloudfront.net/image/product/medium/example.jpg","rental_ad":false,"auction_ad":false,"price_euro":0,"product_id":"{example}","catalog_name":"construction","company_name":"Example Dealer","category_name":"miniexcavators","location_city":"Oostrozebeke","user_currency":"EUR","year_of_manufacture":2020,"location_country_code":"BE","price_in_user_currency":0}],"pagination":{"next":2,"current":1,"page_size":40,"total_pages":14,"has_next_page":true,"total_results":547}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Mascus Search","description":"Search used equipment listings on Mascus from a category URL, with pagination that keeps country and category filters.\n\n**Credit cost:** 1 credit per call","operationId":"post-mascus-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Mascus category or search URL. The country site comes from the host (`mascus.be`, `mascus.nl`, `mascus.de`, `mascus.com`, …).\n\n**Recommended (pagination keeps category + country):**\n\n```\nhttps://www.mascus.be/bouw/graafmachines/be,country.html\n```\n\n```\nhttps://www.mascus.nl/bouw/graafmachines/nl,country.html\n```\n\n```\nhttps://www.mascus.de/baumaschinen/bagger/de,country.html\n```\n\n**Also supported:**\n\n    https://www.mascus.be/+/catalogs=construction&categories=excavators&countries=BE/1,relevance,search.html\n\nFilters from the URL are kept on page 2+.","schema":{"type":"string","description":"Full Mascus category or search URL. The country site comes from the host (`mascus.be`, `mascus.nl`, `mascus.de`, `mascus.com`, …).\n\n**Recommended (pagination keeps category + country):**\n\n```\nhttps://www.mascus.be/bouw/graafmachines/be,country.html\n```\n\n```\nhttps://www.mascus.nl/bouw/graafmachines/nl,country.html\n```\n\n```\nhttps://www.mascus.de/baumaschinen/bagger/de,country.html\n```\n\n**Also supported:**\n\n    https://www.mascus.be/+/catalogs=construction&categories=excavators&countries=BE/1,relevance,search.html\n\nFilters from the URL are kept on page 2+."}},{"name":"page","in":"query","required":false,"description":"Page number (default: `1`). About 40 results per page.\n\n**Example:** `2`\n\nWorks with classic country browse URLs (`…/be,country.html`) and `+/catalogs=…/N,relevance,search.html` URLs. You can also put `?page=2` in the query URL.","schema":{"type":"number","description":"Page number (default: `1`). About 40 results per page.\n\n**Example:** `2`\n\nWorks with classic country browse URLs (`…/be,country.html`) and `+/catalogs=…/N,relevance,search.html` URLs. You can also put `?page=2` in the query URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"model":{"type":"string"},"image_url":{"type":"string"},"rental_ad":{"type":"boolean"},"auction_ad":{"type":"boolean"},"price_euro":{"type":"integer"},"product_id":{"type":"string"},"catalog_name":{"type":"string"},"company_name":{"type":"string"},"category_name":{"type":"string"},"location_city":{"type":"string"},"user_currency":{"type":"string"},"year_of_manufacture":{"type":"integer"},"location_country_code":{"type":"string"},"price_in_user_currency":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"page_size":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Belgian excavators (page 1)":{"value":{"results":[{"url":"https://www.mascus.be/bouw/minigraafmachines---7t/airman-ax10u-7-ax10u-7/ff3ch5ch.html","brand":"Airman","model":"AX10U-7","image_url":"https://dnge9sb91helb.cloudfront.net/image/product/medium/example.jpg","rental_ad":false,"auction_ad":false,"price_euro":0,"product_id":"{example}","catalog_name":"construction","company_name":"Example Dealer","category_name":"miniexcavators","location_city":"Oostrozebeke","user_currency":"EUR","year_of_manufacture":2020,"location_country_code":"BE","price_in_user_currency":0}],"pagination":{"next":2,"current":1,"page_size":40,"total_pages":14,"has_next_page":true,"total_results":547}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ovoko/ad":{"get":{"summary":"Ovoko Ad","description":"Extract an Ovoko listing from a SKU URL: price, currency, images, seller, quality, vehicle make, part numbers, and warranty.\n\n**Credit cost:** 1 credit per call","operationId":"get-ovoko-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Ovoko listing URL. The last path segment must be a SKU slug (example: `qbb17557-95c827460c-porsche-macan-...`) or a known product prefix.\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Live product paths:**\n- France: `/les-pieces/`\n- Poland: `/czesci-samochodowe/`\n- Germany: `/gebrauchte-ersatzteile/`\n- Spain / Italy: `/parte/`\n- Finland: `/osat/`\n- Romania: `/piesa-uzata/`\n- Lithuania: `/autodalis/`\n- United Kingdom: `/en/used-part/`\n- Latvia: `/lv/auto-dalas/`\n- Russia: `/ru/zapchasti/`\n\n**Rejected:** search URLs, `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and catalog/offer paths.\n\n**Examples:**\n\n    https://ovoko.fr/les-pieces/lgn634714-1780a036-mitsubishi-asx-filtre-d-habitacle\n    https://ovoko.es/parte/ovp227641-6650473120-peugeot-407-filtro-de-combustible\n    https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni\n    https://rrr.lt/en/used-part/dzb40236-peugeot-607-fuel-filter\n    https://rrr.lt/ru/zapchasti/dzb40236-peugeot-607-filtr-topliva","schema":{"type":"string","description":"Full Ovoko listing URL. The last path segment must be a SKU slug (example: `qbb17557-95c827460c-porsche-macan-...`) or a known product prefix.\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Live product paths:**\n- France: `/les-pieces/`\n- Poland: `/czesci-samochodowe/`\n- Germany: `/gebrauchte-ersatzteile/`\n- Spain / Italy: `/parte/`\n- Finland: `/osat/`\n- Romania: `/piesa-uzata/`\n- Lithuania: `/autodalis/`\n- United Kingdom: `/en/used-part/`\n- Latvia: `/lv/auto-dalas/`\n- Russia: `/ru/zapchasti/`\n\n**Rejected:** search URLs, `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and catalog/offer paths.\n\n**Examples:**\n\n    https://ovoko.fr/les-pieces/lgn634714-1780a036-mitsubishi-asx-filtre-d-habitacle\n    https://ovoko.es/parte/ovp227641-6650473120-peugeot-407-filtro-de-combustible\n    https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni\n    https://rrr.lt/en/used-part/dzb40236-peugeot-607-fuel-filter\n    https://rrr.lt/ru/zapchasti/dzb40236-peugeot-607-filtr-topliva"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"rhd":{"type":"boolean"},"sku":{"type":"string"},"url":{"type":"string"},"sold":{"type":"boolean"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"name":{"type":"string"}}},"status":{"type":"string"},"quality":{"type":"string"},"vehicle":{"type":"object","properties":{"make":{"type":"string"}}},"category":{"type":"object","properties":{"name":{"type":"string"}}},"currency":{"type":"string"},"discount":{"type":"integer"},"position":{"type":"string"},"warranty":{"nullable":true},"attributes":{"type":"array","items":{}},"part_number":{"type":"string"},"part_numbers":{"type":"array","items":{"type":"string"}},"display_labels":{"type":"array","items":{}}}},"examples":{"Lookup Audi A4 front bumper listing on Ovoko Poland":{"value":{"id":"mth8663","rhd":false,"sku":"mth8663","url":"https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni","sold":false,"price":1690.01,"images":["https://images.ovoko.com/bl/542x407/mth/0/0/0/0/0/8/6/6/3/c496a92f17dc1e839aebddf482037e83-audi_a4_s4_b9_front_bumper.jpg"],"seller":{"name":"Alex Martin"},"status":"IN_STOCK","quality":"USED","vehicle":{"make":"Audi"},"category":{"name":"Zderzak przedni"},"currency":"PLN","discount":75,"position":"FRONT","warranty":null,"attributes":[],"part_number":"8W0807437AB","part_numbers":["8W0807437AB"],"display_labels":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Ovoko Ad","description":"Extract an Ovoko listing from a SKU URL: price, currency, images, seller, quality, vehicle make, part numbers, and warranty.\n\n**Credit cost:** 1 credit per call","operationId":"post-ovoko-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Ovoko listing URL. The last path segment must be a SKU slug (example: `qbb17557-95c827460c-porsche-macan-...`) or a known product prefix.\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Live product paths:**\n- France: `/les-pieces/`\n- Poland: `/czesci-samochodowe/`\n- Germany: `/gebrauchte-ersatzteile/`\n- Spain / Italy: `/parte/`\n- Finland: `/osat/`\n- Romania: `/piesa-uzata/`\n- Lithuania: `/autodalis/`\n- United Kingdom: `/en/used-part/`\n- Latvia: `/lv/auto-dalas/`\n- Russia: `/ru/zapchasti/`\n\n**Rejected:** search URLs, `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and catalog/offer paths.\n\n**Examples:**\n\n    https://ovoko.fr/les-pieces/lgn634714-1780a036-mitsubishi-asx-filtre-d-habitacle\n    https://ovoko.es/parte/ovp227641-6650473120-peugeot-407-filtro-de-combustible\n    https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni\n    https://rrr.lt/en/used-part/dzb40236-peugeot-607-fuel-filter\n    https://rrr.lt/ru/zapchasti/dzb40236-peugeot-607-filtr-topliva","schema":{"type":"string","description":"Full Ovoko listing URL. The last path segment must be a SKU slug (example: `qbb17557-95c827460c-porsche-macan-...`) or a known product prefix.\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Live product paths:**\n- France: `/les-pieces/`\n- Poland: `/czesci-samochodowe/`\n- Germany: `/gebrauchte-ersatzteile/`\n- Spain / Italy: `/parte/`\n- Finland: `/osat/`\n- Romania: `/piesa-uzata/`\n- Lithuania: `/autodalis/`\n- United Kingdom: `/en/used-part/`\n- Latvia: `/lv/auto-dalas/`\n- Russia: `/ru/zapchasti/`\n\n**Rejected:** search URLs, `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and catalog/offer paths.\n\n**Examples:**\n\n    https://ovoko.fr/les-pieces/lgn634714-1780a036-mitsubishi-asx-filtre-d-habitacle\n    https://ovoko.es/parte/ovp227641-6650473120-peugeot-407-filtro-de-combustible\n    https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni\n    https://rrr.lt/en/used-part/dzb40236-peugeot-607-fuel-filter\n    https://rrr.lt/ru/zapchasti/dzb40236-peugeot-607-filtr-topliva"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"rhd":{"type":"boolean"},"sku":{"type":"string"},"url":{"type":"string"},"sold":{"type":"boolean"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"name":{"type":"string"}}},"status":{"type":"string"},"quality":{"type":"string"},"vehicle":{"type":"object","properties":{"make":{"type":"string"}}},"category":{"type":"object","properties":{"name":{"type":"string"}}},"currency":{"type":"string"},"discount":{"type":"integer"},"position":{"type":"string"},"warranty":{"nullable":true},"attributes":{"type":"array","items":{}},"part_number":{"type":"string"},"part_numbers":{"type":"array","items":{"type":"string"}},"display_labels":{"type":"array","items":{}}}},"examples":{"Lookup Audi A4 front bumper listing on Ovoko Poland":{"value":{"id":"mth8663","rhd":false,"sku":"mth8663","url":"https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni","sold":false,"price":1690.01,"images":["https://images.ovoko.com/bl/542x407/mth/0/0/0/0/0/8/6/6/3/c496a92f17dc1e839aebddf482037e83-audi_a4_s4_b9_front_bumper.jpg"],"seller":{"name":"Alex Martin"},"status":"IN_STOCK","quality":"USED","vehicle":{"make":"Audi"},"category":{"name":"Zderzak przedni"},"currency":"PLN","discount":75,"position":"FRONT","warranty":null,"attributes":[],"part_number":"8W0807437AB","part_numbers":["8W0807437AB"],"display_labels":[]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ovoko/search":{"get":{"summary":"Ovoko Search","description":"Search Ovoko used-parts listings from a search URL and retrieve title, price, OEM codes, seller, vehicle text, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-ovoko-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Search paths:** `/chercher` (FR), `/szukaj` (PL), `/suche` (DE), `/buscar` (ES), `/ricerca` (IT), `/haku` (FI), `/cautare` (RO), `/paieska` (LT), `/en/search` (UK), `/lv/meklesana` (LV), `/ru/poisk` (RU).\n\n**Rejected:** `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and paths such as `/oferta/` or `/katalog-czesci/`.\n\n**Examples:**\n\n    https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1\n    https://ovoko.fr/chercher?q=filtre\n    https://ovoko.es/buscar?q=filtro\n    https://rrr.lt/en/search?q=filter\n    https://rrr.lt/ru/poisk?q=filtr\n\n**Notes:**\n- Append `&page=2` (or `?page=2`) to paginate. The response exposes `pagination.next`.\n- Every market returns the same listing keys. Use each result `url` with the Ovoko Ad endpoint.\n- Search `id` is the lowercase SKU and matches Ad `id` / `sku`.","schema":{"type":"string","description":"Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Search paths:** `/chercher` (FR), `/szukaj` (PL), `/suche` (DE), `/buscar` (ES), `/ricerca` (IT), `/haku` (FI), `/cautare` (RO), `/paieska` (LT), `/en/search` (UK), `/lv/meklesana` (LV), `/ru/poisk` (RU).\n\n**Rejected:** `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and paths such as `/oferta/` or `/katalog-czesci/`.\n\n**Examples:**\n\n    https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1\n    https://ovoko.fr/chercher?q=filtre\n    https://ovoko.es/buscar?q=filtro\n    https://rrr.lt/en/search?q=filter\n    https://rrr.lt/ru/poisk?q=filtr\n\n**Notes:**\n- Append `&page=2` (or `?page=2`) to paginate. The response exposes `pagination.next`.\n- Every market returns the same listing keys. Use each result `url` with the Ovoko Ad endpoint.\n- Search `id` is the lowercase SKU and matches Ad `id` / `sku`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"seller":{"type":"object","properties":{"name":{"type":"string"}}},"vehicle":{"type":"string"},"currency":{"type":"string"},"part_number":{"type":"string"},"part_numbers":{"type":"array","items":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search Porsche Macan tailgate seal on Ovoko Poland":{"value":{"results":[{"id":"qbb17557","url":"https://ovoko.pl/czesci-samochodowe/qbb17557-95c827460c-porsche-macan-95c-uszczelka-tylnej-klapy-bagaznika","image":"https://images.ovoko.com/tr/fill/1024x768/qbb/0/0/0/0/1/7/5/5/7/6e97a74672da438c268a980449538b78-porsche_macan__95c__seal_rubber__tailgate_.jpg","price":200.01,"title":"Uszczelka tylnej klapy bagażnika","seller":{"name":"Example Motors"},"vehicle":"Porsche Macan (95C)  2024  0cm3  0kW Manualna","currency":"PLN","part_number":"95C827460C","part_numbers":["95C827460C"]}],"pagination":{"next":"https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1&page=2","page":1,"per_page":15,"total_pages":667,"total_results":10000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Ovoko Search","description":"Search Ovoko used-parts listings from a search URL and retrieve title, price, OEM codes, seller, vehicle text, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-ovoko-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Search paths:** `/chercher` (FR), `/szukaj` (PL), `/suche` (DE), `/buscar` (ES), `/ricerca` (IT), `/haku` (FI), `/cautare` (RO), `/paieska` (LT), `/en/search` (UK), `/lv/meklesana` (LV), `/ru/poisk` (RU).\n\n**Rejected:** `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and paths such as `/oferta/` or `/katalog-czesci/`.\n\n**Examples:**\n\n    https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1\n    https://ovoko.fr/chercher?q=filtre\n    https://ovoko.es/buscar?q=filtro\n    https://rrr.lt/en/search?q=filter\n    https://rrr.lt/ru/poisk?q=filtr\n\n**Notes:**\n- Append `&page=2` (or `?page=2`) to paginate. The response exposes `pagination.next`.\n- Every market returns the same listing keys. Use each result `url` with the Ovoko Ad endpoint.\n- Search `id` is the lowercase SKU and matches Ad `id` / `sku`.","schema":{"type":"string","description":"Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Search paths:** `/chercher` (FR), `/szukaj` (PL), `/suche` (DE), `/buscar` (ES), `/ricerca` (IT), `/haku` (FI), `/cautare` (RO), `/paieska` (LT), `/en/search` (UK), `/lv/meklesana` (LV), `/ru/poisk` (RU).\n\n**Rejected:** `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and paths such as `/oferta/` or `/katalog-czesci/`.\n\n**Examples:**\n\n    https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1\n    https://ovoko.fr/chercher?q=filtre\n    https://ovoko.es/buscar?q=filtro\n    https://rrr.lt/en/search?q=filter\n    https://rrr.lt/ru/poisk?q=filtr\n\n**Notes:**\n- Append `&page=2` (or `?page=2`) to paginate. The response exposes `pagination.next`.\n- Every market returns the same listing keys. Use each result `url` with the Ovoko Ad endpoint.\n- Search `id` is the lowercase SKU and matches Ad `id` / `sku`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"seller":{"type":"object","properties":{"name":{"type":"string"}}},"vehicle":{"type":"string"},"currency":{"type":"string"},"part_number":{"type":"string"},"part_numbers":{"type":"array","items":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search Porsche Macan tailgate seal on Ovoko Poland":{"value":{"results":[{"id":"qbb17557","url":"https://ovoko.pl/czesci-samochodowe/qbb17557-95c827460c-porsche-macan-95c-uszczelka-tylnej-klapy-bagaznika","image":"https://images.ovoko.com/tr/fill/1024x768/qbb/0/0/0/0/1/7/5/5/7/6e97a74672da438c268a980449538b78-porsche_macan__95c__seal_rubber__tailgate_.jpg","price":200.01,"title":"Uszczelka tylnej klapy bagażnika","seller":{"name":"Example Motors"},"vehicle":"Porsche Macan (95C)  2024  0cm3  0kW Manualna","currency":"PLN","part_number":"95C827460C","part_numbers":["95C827460C"]}],"pagination":{"next":"https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1&page=2","page":1,"per_page":15,"total_pages":667,"total_results":10000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/leboncoin/search_api":{"post":{"summary":"Leboncoin Search API","description":"Search Leboncoin listings via structured POST API with advanced filters for category, location, price range, seller type, and sorting.\n\n**Credit cost:** 1 credit per call","operationId":"leboncoin-search-api","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ads":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"body":{"type":"string"},"owner":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"siren":{"nullable":true}}},"price":{"type":"array","items":{"type":"integer"}},"images":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"}},"nb_images":{"type":"integer"},"small_url":{"type":"string"},"thumb_url":{"type":"string"}}},"status":{"type":"string"},"ad_type":{"type":"string"},"list_id":{"type":"integer"},"subject":{"type":"string"},"currency":{"type":"string"},"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"city":{"type":"string"},"zipcode":{"type":"string"},"region_id":{"type":"string"},"country_id":{"type":"string"},"region_name":{"type":"string"},"department_id":{"type":"string"},"department_name":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"value_label":{"type":"string"}}}},"brand_name":{"nullable":true},"category_id":{"type":"string"},"price_cents":{"type":"array","items":{"type":"integer"}},"category_name":{"type":"string"},"creation_date":{"type":"string"},"expiration_date":{"type":"string"}}}},"total":{"type":"integer"},"max_pages":{"type":"integer"},"total_all":{"type":"integer"},"total_pro":{"type":"integer"},"total_private":{"type":"integer"}}},"examples":{"Search Volkswagen Golf car listings":{"value":{"ads":[{"url":"https://www.leboncoin.fr/voitures/2712345678.htm","body":"Bonjour, je vends ma Golf 7 en parfait état, CT valable, aucun défaut.","owner":{"name":"Alex Martin","type":"private","siren":null},"price":[11500],"images":{"urls":["https://img.leboncoin.fr/api/cdn/thumbs/abcdef1.jpg"],"nb_images":6,"small_url":"https://img.leboncoin.fr/api/cdn/thumbs/abcdef1.jpg","thumb_url":"https://img.leboncoin.fr/api/cdn/thumbs/abcdef1_thumb.jpg"},"status":"active","ad_type":"classified","list_id":2712345678,"subject":"Volkswagen Golf VII 1.6 TDI 110 Confortline Business","currency":"EUR","location":{"lat":45.75,"lng":4.85,"city":"Lyon","zipcode":"69003","region_id":"22","country_id":"FR","region_name":"Auvergne-Rhône-Alpes","department_id":"69","department_name":"Rhône"},"attributes":[{"key":"regdate","value":"2017","value_label":"2017"},{"key":"mileage","value":"112000","value_label":"112 000 km"},{"key":"fuel","value":"diesel","value_label":"Diesel"},{"key":"gearbox","value":"manual","value_label":"Manuelle"},{"key":"brand","value":"volkswagen","value_label":"Volkswagen"},{"key":"model","value":"Golf VII","value_label":"Golf VII"},{"key":"critair","value":"2","value_label":"Crit'Air 2"}],"brand_name":null,"category_id":"2","price_cents":[1150000],"category_name":"Voitures","creation_date":"2024-09-10T11:00:00+02:00","expiration_date":"2024-10-10T11:00:00+02:00"}],"total":4821,"max_pages":100,"total_all":4821,"total_pro":1203,"total_private":3618}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autoscout24/ad":{"get":{"summary":"AutoScout24 Ad","description":"Read one AutoScout24 listing, including an inactive ad that still exposes the listing. Price, vehicle, seller, and location. (1 credit)\n\n**Credit cost:** 1 credit per call","operationId":"get-autoscout24-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoScout24 listing URL. An inactive listing that still contains script#__NEXT_DATA__ is returned with status Inactive. A page without that selector returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/offres/porsche-macan-s-diesel-pano-1-hand-diesel-or-cat_ma57mo20311-547632b2-e4fc-47f3-8143-1a2d7b276366","schema":{"type":"string","description":"Full AutoScout24 listing URL. An inactive listing that still contains script#__NEXT_DATA__ is returned with status Inactive. A page without that selector returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/offres/porsche-macan-s-diesel-pano-1-hand-diesel-or-cat_ma57mo20311-547632b2-e4fc-47f3-8143-1a2d7b276366"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"image":{"type":"string"},"price":{"type":"object","properties":{"price_formatted":{"type":"string"},"is_conditional_price":{"type":"boolean"},"is_vat_label_legally_required":{"type":"boolean"}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"prices":{"type":"object","properties":{"dealer":{"type":"object","properties":{"price":{"type":"string"},"price_raw":{"type":"integer"},"negotiable":{"type":"boolean"},"tax_deductible":{"type":"boolean"},"on_request_only":{"type":"boolean"}}},"public":{"type":"object","properties":{"price":{"type":"string"},"price_raw":{"type":"integer"},"negotiable":{"type":"boolean"},"tax_deductible":{"type":"boolean"},"on_request_only":{"type":"boolean"}}}}},"seller":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"phones":{"type":"array","items":{"type":"object","properties":{"call_to":{"type":"string"},"phone_type":{"type":"string"},"formatted_number":{"type":"string"}}}},"is_dealer":{"type":"boolean"},"company_name":{"type":"string"}}},"status":{"type":"string"},"vehicle":{"type":"object","properties":{"make":{"type":"string"},"model":{"type":"string"},"body_type":{"type":"string"},"body_color":{"type":"string"},"power_in_kw":{"type":"string"},"primary_fuel":{"type":"object","properties":{"raw":{"type":"integer"},"formatted":{"type":"string"}}},"mileage_in_km":{"type":"string"},"number_of_doors":{"type":"integer"},"number_of_seats":{"type":"integer"},"mileage_in_km_raw":{"type":"integer"},"transmission_type":{"type":"string"},"model_version_input":{"type":"string"},"first_registration_date":{"type":"string"}}},"location":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"country_code":{"type":"string"}}},"web_page":{"type":"string"},"description":{"type":"string"}}},"examples":{"Porsche Macan, inactive listing":{"value":{"id":"547632b2-e4fc-47f3-8143-1a2d7b276366","image":"https://prod.pictures.autoscout24.net/listing-images/547632b2-e4fc-47f3-8143-1a2d7b276366_e8e7d7f9-5101-4dad-9d0c-342384727f9d.jpg/1280x960.webp","price":{"price_formatted":"€ 39 990","is_conditional_price":false,"is_vat_label_legally_required":false},"title":"Porsche Macan","images":["https://prod.pictures.autoscout24.net/listing-images/547632b2-e4fc-47f3-8143-1a2d7b276366_e8e7d7f9-5101-4dad-9d0c-342384727f9d.jpg/1280x960.webp"],"prices":{"dealer":{"price":"€ 39 990","price_raw":39990,"negotiable":false,"tax_deductible":false,"on_request_only":false},"public":{"price":"€ 39 990","price_raw":39990,"negotiable":false,"tax_deductible":false,"on_request_only":false}},"seller":{"id":20068,"type":"Dealer","phones":[{"call_to":"+33 1 99 00 00 00","phone_type":"Office","formatted_number":"+33 1 99 00 00 01"}],"is_dealer":true,"company_name":"Alex Martin"},"status":"Inactive","vehicle":{"make":"Porsche","model":"Macan","body_type":"SUV/4x4/Pick-Up","body_color":"Or","power_in_kw":"190 kW","primary_fuel":{"raw":7,"formatted":"Diesel"},"mileage_in_km":"24 585 km","number_of_doors":4,"number_of_seats":5,"mileage_in_km_raw":24585,"transmission_type":"Boîte automatique","model_version_input":"S Diesel Pano 1.Hand","first_registration_date":"04/2015"},"location":{"zip":"88074","city":"Meckenbeuren","street":"Hauptstrasse 67","country_code":"DE"},"web_page":"https://www.autoscout24.fr/offres/porsche-macan-s-diesel-pano-1-hand-diesel-or-cat_ma57mo20311-547632b2-e4fc-47f3-8143-1a2d7b276366","description":"<strong>Sonderausstattung:<br />Deutsches Fahrzeug, 1. Hand, PZ Scheckheft</strong>"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"AutoScout24 Ad","description":"Read one AutoScout24 listing, including an inactive ad that still exposes the listing. Price, vehicle, seller, and location. (1 credit)\n\n**Credit cost:** 1 credit per call","operationId":"post-autoscout24-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoScout24 listing URL. An inactive listing that still contains script#__NEXT_DATA__ is returned with status Inactive. A page without that selector returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/offres/porsche-macan-s-diesel-pano-1-hand-diesel-or-cat_ma57mo20311-547632b2-e4fc-47f3-8143-1a2d7b276366","schema":{"type":"string","description":"Full AutoScout24 listing URL. An inactive listing that still contains script#__NEXT_DATA__ is returned with status Inactive. A page without that selector returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/offres/porsche-macan-s-diesel-pano-1-hand-diesel-or-cat_ma57mo20311-547632b2-e4fc-47f3-8143-1a2d7b276366"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"image":{"type":"string"},"price":{"type":"object","properties":{"price_formatted":{"type":"string"},"is_conditional_price":{"type":"boolean"},"is_vat_label_legally_required":{"type":"boolean"}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"prices":{"type":"object","properties":{"dealer":{"type":"object","properties":{"price":{"type":"string"},"price_raw":{"type":"integer"},"negotiable":{"type":"boolean"},"tax_deductible":{"type":"boolean"},"on_request_only":{"type":"boolean"}}},"public":{"type":"object","properties":{"price":{"type":"string"},"price_raw":{"type":"integer"},"negotiable":{"type":"boolean"},"tax_deductible":{"type":"boolean"},"on_request_only":{"type":"boolean"}}}}},"seller":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"phones":{"type":"array","items":{"type":"object","properties":{"call_to":{"type":"string"},"phone_type":{"type":"string"},"formatted_number":{"type":"string"}}}},"is_dealer":{"type":"boolean"},"company_name":{"type":"string"}}},"status":{"type":"string"},"vehicle":{"type":"object","properties":{"make":{"type":"string"},"model":{"type":"string"},"body_type":{"type":"string"},"body_color":{"type":"string"},"power_in_kw":{"type":"string"},"primary_fuel":{"type":"object","properties":{"raw":{"type":"integer"},"formatted":{"type":"string"}}},"mileage_in_km":{"type":"string"},"number_of_doors":{"type":"integer"},"number_of_seats":{"type":"integer"},"mileage_in_km_raw":{"type":"integer"},"transmission_type":{"type":"string"},"model_version_input":{"type":"string"},"first_registration_date":{"type":"string"}}},"location":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"country_code":{"type":"string"}}},"web_page":{"type":"string"},"description":{"type":"string"}}},"examples":{"Porsche Macan, inactive listing":{"value":{"id":"547632b2-e4fc-47f3-8143-1a2d7b276366","image":"https://prod.pictures.autoscout24.net/listing-images/547632b2-e4fc-47f3-8143-1a2d7b276366_e8e7d7f9-5101-4dad-9d0c-342384727f9d.jpg/1280x960.webp","price":{"price_formatted":"€ 39 990","is_conditional_price":false,"is_vat_label_legally_required":false},"title":"Porsche Macan","images":["https://prod.pictures.autoscout24.net/listing-images/547632b2-e4fc-47f3-8143-1a2d7b276366_e8e7d7f9-5101-4dad-9d0c-342384727f9d.jpg/1280x960.webp"],"prices":{"dealer":{"price":"€ 39 990","price_raw":39990,"negotiable":false,"tax_deductible":false,"on_request_only":false},"public":{"price":"€ 39 990","price_raw":39990,"negotiable":false,"tax_deductible":false,"on_request_only":false}},"seller":{"id":20068,"type":"Dealer","phones":[{"call_to":"+33 1 99 00 00 00","phone_type":"Office","formatted_number":"+33 1 99 00 00 01"}],"is_dealer":true,"company_name":"Alex Martin"},"status":"Inactive","vehicle":{"make":"Porsche","model":"Macan","body_type":"SUV/4x4/Pick-Up","body_color":"Or","power_in_kw":"190 kW","primary_fuel":{"raw":7,"formatted":"Diesel"},"mileage_in_km":"24 585 km","number_of_doors":4,"number_of_seats":5,"mileage_in_km_raw":24585,"transmission_type":"Boîte automatique","model_version_input":"S Diesel Pano 1.Hand","first_registration_date":"04/2015"},"location":{"zip":"88074","city":"Meckenbeuren","street":"Hauptstrasse 67","country_code":"DE"},"web_page":"https://www.autoscout24.fr/offres/porsche-macan-s-diesel-pano-1-hand-diesel-or-cat_ma57mo20311-547632b2-e4fc-47f3-8143-1a2d7b276366","description":"<strong>Sonderausstattung:<br />Deutsches Fahrzeug, 1. Hand, PZ Scheckheft</strong>"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autoscout24/search":{"get":{"summary":"AutoScout24 Search","description":"Search AutoScout24 listings from a search URL. Each card has make, model, numeric price, mileage, and the listing URL. (1 credit)\n\n**Credit cost:** 1 credit per call","operationId":"get-autoscout24-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoScout24 search URL. Filters and page in the URL are kept. page starts at 1. A page with no cards returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/lst/volkswagen/golf?atype=C\n\nPass `results[].url` to `/v2/autoscout24/ad` for the full listing.","schema":{"type":"string","description":"Full AutoScout24 search URL. Filters and page in the URL are kept. page starts at 1. A page with no cards returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/lst/volkswagen/golf?atype=C\n\nPass `results[].url` to `/v2/autoscout24/ad` for the full listing."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"make":{"type":"string"},"year":{"type":"string"},"image":{"type":"string"},"model":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"mileage":{"type":"string"},"first_registration":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Volkswagen Golf, France, first card of page 1":{"value":{"results":[{"id":"3657ed97-289f-4a4f-b537-5b539339b1f7","url":"https://www.autoscout24.fr/offres/volkswagen-golf-vi-1-6-tdi-dsg-7-confort-diesel-gris-cat_ma74mo2084-3657ed97-289f-4a4f-b537-5b539339b1f7","make":"Volkswagen","year":"2010","image":"https://prod.pictures.autoscout24.net/listing-images/3657ed97-289f-4a4f-b537-5b539339b1f7_423f3826-4b1a-48c2-ba73-79fcfa2bdd3b.jpg/250x188.webp","model":"Golf","price":7900,"title":"Volkswagen Golf","mileage":"166 900 km","first_registration":"12/2010"}],"pagination":{"next":"https://www.autoscout24.fr/lst/volkswagen/golf?atype=C&page=2","page":1,"per_page":20,"total_pages":77,"total_results":1523}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"AutoScout24 Search","description":"Search AutoScout24 listings from a search URL. Each card has make, model, numeric price, mileage, and the listing URL. (1 credit)\n\n**Credit cost:** 1 credit per call","operationId":"post-autoscout24-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoScout24 search URL. Filters and page in the URL are kept. page starts at 1. A page with no cards returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/lst/volkswagen/golf?atype=C\n\nPass `results[].url` to `/v2/autoscout24/ad` for the full listing.","schema":{"type":"string","description":"Full AutoScout24 search URL. Filters and page in the URL are kept. page starts at 1. A page with no cards returns 404.\n\n**Supported domains:** autoscout24.de, autoscout24.be, autoscout24.es, autoscout24.fr, autoscout24.it, autoscout24.lu, autoscout24.nl, autoscout24.at, autoscout24.bg, autoscout24.cz, autoscout24.com, autoscout24.hr, autoscout24.pl, autoscout24.ro, autoscout24.ru, autoscout24.se, autoscout24.com.tr, autoscout24.com.ua, autoscout24.hu\n\n**Example:**\n\n    https://www.autoscout24.fr/lst/volkswagen/golf?atype=C\n\nPass `results[].url` to `/v2/autoscout24/ad` for the full listing."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"make":{"type":"string"},"year":{"type":"string"},"image":{"type":"string"},"model":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"mileage":{"type":"string"},"first_registration":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Volkswagen Golf, France, first card of page 1":{"value":{"results":[{"id":"3657ed97-289f-4a4f-b537-5b539339b1f7","url":"https://www.autoscout24.fr/offres/volkswagen-golf-vi-1-6-tdi-dsg-7-confort-diesel-gris-cat_ma74mo2084-3657ed97-289f-4a4f-b537-5b539339b1f7","make":"Volkswagen","year":"2010","image":"https://prod.pictures.autoscout24.net/listing-images/3657ed97-289f-4a4f-b537-5b539339b1f7_423f3826-4b1a-48c2-ba73-79fcfa2bdd3b.jpg/250x188.webp","model":"Golf","price":7900,"title":"Volkswagen Golf","mileage":"166 900 km","first_registration":"12/2010"}],"pagination":{"next":"https://www.autoscout24.fr/lst/volkswagen/golf?atype=C&page=2","page":1,"per_page":20,"total_pages":77,"total_results":1523}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/manomano/product/offer":{"get":{"summary":"ManoMano Product Offer","description":"Get all marketplace seller offers for a ManoMano product by product ID, including pricing, shipping, and seller information.\n\n**Credit cost:** 1 credit per call","operationId":"get-manomano-product-offer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"ManoMano product ID. This is the numeric `product_id` returned by the ManoMano Product endpoint.\n\n**How to get this value:**\n1. Call the ManoMano Product endpoint with a product URL.\n2. Extract the `product_id` field from the response.\n3. Use that value as the `query` parameter here.\n\n**Example:**\n\n    28910102\n\n**Note:** Do not pass a product URL here, only numeric product IDs are accepted.","schema":{"type":"string","description":"ManoMano product ID. This is the numeric `product_id` returned by the ManoMano Product endpoint.\n\n**How to get this value:**\n1. Call the ManoMano Product endpoint with a product URL.\n2. Extract the `product_id` field from the response.\n3. Use that value as the `query` parameter here.\n\n**Example:**\n\n    28910102\n\n**Note:** Do not pass a product URL here, only numeric product IDs are accepted."}},{"name":"region","in":"query","required":true,"description":"Region code for the ManoMano platform. Must match the original product's domain.\n\n- `FR`: France (manomano.fr)\n- `GB`: United Kingdom (manomano.co.uk)\n- `DE`: Germany (manomano.de)\n- `ES`: Spain (manomano.es)\n- `IT`: Italy (manomano.it)\n\n**Example:**\n\n    FR","schema":{"type":"string","default":"FR","description":"Region code for the ManoMano platform. Must match the original product's domain.\n\n- `FR`: France (manomano.fr)\n- `GB`: United Kingdom (manomano.co.uk)\n- `DE`: Germany (manomano.de)\n- `ES`: Spain (manomano.es)\n- `IT`: Italy (manomano.it)\n\n**Example:**\n\n    FR"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"object","properties":{"title":{"type":"string"},"master_product":{"type":"object","properties":{"slug":{"type":"string"},"article_id":{"type":"string"}}}}},"market":{"type":"string"},"seller":{"type":"object","properties":{"is_m_f":{"type":"boolean"},"contract_id":{"type":"string"},"contract_name":{"type":"string"},"country_location":{"type":"string"}}},"pricing":{"type":"object","properties":{"sell_price":{"type":"object","properties":{"amount_vat_excluded":{"type":"number"},"amount_vat_included":{"type":"number"}}},"retail_price":{"nullable":true},"eco_participation":{"type":"object","properties":{"amount_vat_included":{"type":"number"}}}}},"packaging":{"type":"object","properties":{"increment":{"type":"string"},"minimum_quantity":{"type":"string"}}},"product_id":{"type":"string"},"is_sellable":{"type":"boolean"},"delivery_offers":{"type":"array","items":{"type":"object","properties":{"estimate_delivery":{"type":"object","properties":{"is_express":{"type":"boolean"},"delivery_time":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}}},"free_delivery":{"type":"object","properties":{"threshold":{"nullable":true},"is_reached":{"type":"boolean"}}}}},"delivery_countries":{"type":"array","items":{"type":"string"}}}}}}}}}},"examples":{"Get offers for product 28910102 (FR)":{"value":{"count":2,"results":[{"sku":{"title":"Modern single basin sink mixer tap slotted drain curved spout chrome bathroom","master_product":{"slug":"modern-mono-basin-mixer-tap-slotted-waste-chrome-cloakroom","article_id":"9655074"}},"market":"B2C","seller":{"is_m_f":false,"contract_id":"36769168","contract_name":"COOCHEER","country_location":"FR"},"pricing":{"sell_price":{"amount_vat_excluded":32.92,"amount_vat_included":39.5},"retail_price":null,"eco_participation":{"amount_vat_included":0.1}},"packaging":{"increment":"1","minimum_quantity":"1"},"product_id":"137641413","is_sellable":true,"delivery_offers":[{"estimate_delivery":{"is_express":false,"delivery_time":{"max":11,"min":8},"free_delivery":{"threshold":null,"is_reached":true}},"delivery_countries":["GB"]}]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ManoMano Product Offer","description":"Get all marketplace seller offers for a ManoMano product by product ID, including pricing, shipping, and seller information.\n\n**Credit cost:** 1 credit per call","operationId":"post-manomano-product-offer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"ManoMano product ID. This is the numeric `product_id` returned by the ManoMano Product endpoint.\n\n**How to get this value:**\n1. Call the ManoMano Product endpoint with a product URL.\n2. Extract the `product_id` field from the response.\n3. Use that value as the `query` parameter here.\n\n**Example:**\n\n    28910102\n\n**Note:** Do not pass a product URL here, only numeric product IDs are accepted.","schema":{"type":"string","description":"ManoMano product ID. This is the numeric `product_id` returned by the ManoMano Product endpoint.\n\n**How to get this value:**\n1. Call the ManoMano Product endpoint with a product URL.\n2. Extract the `product_id` field from the response.\n3. Use that value as the `query` parameter here.\n\n**Example:**\n\n    28910102\n\n**Note:** Do not pass a product URL here, only numeric product IDs are accepted."}},{"name":"region","in":"query","required":true,"description":"Region code for the ManoMano platform. Must match the original product's domain.\n\n- `FR`: France (manomano.fr)\n- `GB`: United Kingdom (manomano.co.uk)\n- `DE`: Germany (manomano.de)\n- `ES`: Spain (manomano.es)\n- `IT`: Italy (manomano.it)\n\n**Example:**\n\n    FR","schema":{"type":"string","default":"FR","description":"Region code for the ManoMano platform. Must match the original product's domain.\n\n- `FR`: France (manomano.fr)\n- `GB`: United Kingdom (manomano.co.uk)\n- `DE`: Germany (manomano.de)\n- `ES`: Spain (manomano.es)\n- `IT`: Italy (manomano.it)\n\n**Example:**\n\n    FR"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"object","properties":{"title":{"type":"string"},"master_product":{"type":"object","properties":{"slug":{"type":"string"},"article_id":{"type":"string"}}}}},"market":{"type":"string"},"seller":{"type":"object","properties":{"is_m_f":{"type":"boolean"},"contract_id":{"type":"string"},"contract_name":{"type":"string"},"country_location":{"type":"string"}}},"pricing":{"type":"object","properties":{"sell_price":{"type":"object","properties":{"amount_vat_excluded":{"type":"number"},"amount_vat_included":{"type":"number"}}},"retail_price":{"nullable":true},"eco_participation":{"type":"object","properties":{"amount_vat_included":{"type":"number"}}}}},"packaging":{"type":"object","properties":{"increment":{"type":"string"},"minimum_quantity":{"type":"string"}}},"product_id":{"type":"string"},"is_sellable":{"type":"boolean"},"delivery_offers":{"type":"array","items":{"type":"object","properties":{"estimate_delivery":{"type":"object","properties":{"is_express":{"type":"boolean"},"delivery_time":{"type":"object","properties":{"max":{"type":"integer"},"min":{"type":"integer"}}},"free_delivery":{"type":"object","properties":{"threshold":{"nullable":true},"is_reached":{"type":"boolean"}}}}},"delivery_countries":{"type":"array","items":{"type":"string"}}}}}}}}}},"examples":{"Get offers for product 28910102 (FR)":{"value":{"count":2,"results":[{"sku":{"title":"Modern single basin sink mixer tap slotted drain curved spout chrome bathroom","master_product":{"slug":"modern-mono-basin-mixer-tap-slotted-waste-chrome-cloakroom","article_id":"9655074"}},"market":"B2C","seller":{"is_m_f":false,"contract_id":"36769168","contract_name":"COOCHEER","country_location":"FR"},"pricing":{"sell_price":{"amount_vat_excluded":32.92,"amount_vat_included":39.5},"retail_price":null,"eco_participation":{"amount_vat_included":0.1}},"packaging":{"increment":"1","minimum_quantity":"1"},"product_id":"137641413","is_sellable":true,"delivery_offers":[{"estimate_delivery":{"is_express":false,"delivery_time":{"max":11,"min":8},"free_delivery":{"threshold":null,"is_reached":true}},"delivery_countries":["GB"]}]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/manomano/product":{"get":{"summary":"ManoMano Product","description":"Extract full product details from a ManoMano product page, including price, seller, brand, images, variants, and stock.\n\n**Credit cost:** 1 credit per call","operationId":"get-manomano-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full ManoMano product page URL. Optionally include the `model_id` query parameter to target a specific variant.\n\n**Example:**\n\n    https://www.manomano.fr/p/pergola-retractable-298l-x-213l-x-222h-m-structure-metal-epoxy-anticorrosion-toile-polyester-haute-densite-180-g-m-incluse-gris-17786586?model_id=17784588\n\n**Notes:**\n- Supported domains: `manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`\n- If `model_id` is omitted, the default variant is returned.","schema":{"type":"string","description":"Full ManoMano product page URL. Optionally include the `model_id` query parameter to target a specific variant.\n\n**Example:**\n\n    https://www.manomano.fr/p/pergola-retractable-298l-x-213l-x-222h-m-structure-metal-epoxy-anticorrosion-toile-polyester-haute-densite-180-g-m-incluse-gris-17786586?model_id=17784588\n\n**Notes:**\n- Supported domains: `manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`\n- If `model_id` is omitted, the default variant is returned."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"}}},"media":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"large_url":{"type":"string"},"regular_url":{"type":"string"},"thumbnail_url":{"type":"string"}}}},"mm_id":{"type":"integer"},"price":{"type":"object","properties":{"primary_price":{"type":"object","properties":{"amount_with_vat":{"type":"number"},"measurement_unit":{"type":"string"},"amount_without_vat":{"type":"number"}}},"discount_percentage":{"type":"integer"},"eco_participation_with_vat":{"type":"number"}}},"stock":{"type":"object","properties":{"minimum_value":{"type":"integer"},"increase_quantity":{"type":"integer"}}},"title":{"type":"string"},"seller":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"country":{"type":"string"}}},"currency":{"type":"string"},"delivery":{"type":"object","properties":{"weight":{"type":"integer"},"fulfillment":{"type":"boolean"}}},"model_id":{"type":"integer"},"offer_id":{"type":"string"},"quantity":{"type":"object","properties":{"stock":{"nullable":true},"value":{"type":"integer"}}},"variants":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"model_id":{"type":"integer"},"is_available":{"type":"boolean"}}}}}}}}}}},"examples":{"Lookup OUTSUNNY retractable pergola":{"value":{"ean":"3662970077672","brand":{"id":6502,"url":"/marque/outsunny-6502","name":"OUTSUNNY"},"media":[{"type":"image","large_url":"https://cdn.manomano.com/images/images_products/6132097/L/28916742_1.jpg","regular_url":"https://cdn.manomano.com/images/images_products/6132097/P/28916742_1.jpg","thumbnail_url":"https://cdn.manomano.com/images/images_products/6132097/T/28916742_1.jpg"}],"mm_id":127463740566,"price":{"primary_price":{"amount_with_vat":335.9,"measurement_unit":"","amount_without_vat":279.92},"discount_percentage":0,"eco_participation_with_vat":5.25},"stock":{"minimum_value":1,"increase_quantity":1},"title":"Pergola rétractable OUTSUNNY - 2,98L x 2,13l x 2,22H m - Structure métal époxy anticorrosion","seller":{"id":6132097,"url":"/marchand-6132097","name":"Aosom France MF","country":"FR"},"currency":"EUR","delivery":{"weight":40,"fulfillment":true},"model_id":17784588,"offer_id":"afa4d772-b372-4f8a-b3d0-0f37ee205b58","quantity":{"stock":null,"value":1},"variants":{"list":[{"name":"couleur","values":[{"type":"hexacolor","label":"Gris","value":"#A9A9A9","model_id":17784588,"is_available":true}]}]}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ManoMano Product","description":"Extract full product details from a ManoMano product page, including price, seller, brand, images, variants, and stock.\n\n**Credit cost:** 1 credit per call","operationId":"post-manomano-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full ManoMano product page URL. Optionally include the `model_id` query parameter to target a specific variant.\n\n**Example:**\n\n    https://www.manomano.fr/p/pergola-retractable-298l-x-213l-x-222h-m-structure-metal-epoxy-anticorrosion-toile-polyester-haute-densite-180-g-m-incluse-gris-17786586?model_id=17784588\n\n**Notes:**\n- Supported domains: `manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`\n- If `model_id` is omitted, the default variant is returned.","schema":{"type":"string","description":"Full ManoMano product page URL. Optionally include the `model_id` query parameter to target a specific variant.\n\n**Example:**\n\n    https://www.manomano.fr/p/pergola-retractable-298l-x-213l-x-222h-m-structure-metal-epoxy-anticorrosion-toile-polyester-haute-densite-180-g-m-incluse-gris-17786586?model_id=17784588\n\n**Notes:**\n- Supported domains: `manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`\n- If `model_id` is omitted, the default variant is returned."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ean":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"}}},"media":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"large_url":{"type":"string"},"regular_url":{"type":"string"},"thumbnail_url":{"type":"string"}}}},"mm_id":{"type":"integer"},"price":{"type":"object","properties":{"primary_price":{"type":"object","properties":{"amount_with_vat":{"type":"number"},"measurement_unit":{"type":"string"},"amount_without_vat":{"type":"number"}}},"discount_percentage":{"type":"integer"},"eco_participation_with_vat":{"type":"number"}}},"stock":{"type":"object","properties":{"minimum_value":{"type":"integer"},"increase_quantity":{"type":"integer"}}},"title":{"type":"string"},"seller":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"name":{"type":"string"},"country":{"type":"string"}}},"currency":{"type":"string"},"delivery":{"type":"object","properties":{"weight":{"type":"integer"},"fulfillment":{"type":"boolean"}}},"model_id":{"type":"integer"},"offer_id":{"type":"string"},"quantity":{"type":"object","properties":{"stock":{"nullable":true},"value":{"type":"integer"}}},"variants":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"model_id":{"type":"integer"},"is_available":{"type":"boolean"}}}}}}}}}}},"examples":{"Lookup OUTSUNNY retractable pergola":{"value":{"ean":"3662970077672","brand":{"id":6502,"url":"/marque/outsunny-6502","name":"OUTSUNNY"},"media":[{"type":"image","large_url":"https://cdn.manomano.com/images/images_products/6132097/L/28916742_1.jpg","regular_url":"https://cdn.manomano.com/images/images_products/6132097/P/28916742_1.jpg","thumbnail_url":"https://cdn.manomano.com/images/images_products/6132097/T/28916742_1.jpg"}],"mm_id":127463740566,"price":{"primary_price":{"amount_with_vat":335.9,"measurement_unit":"","amount_without_vat":279.92},"discount_percentage":0,"eco_participation_with_vat":5.25},"stock":{"minimum_value":1,"increase_quantity":1},"title":"Pergola rétractable OUTSUNNY - 2,98L x 2,13l x 2,22H m - Structure métal époxy anticorrosion","seller":{"id":6132097,"url":"/marchand-6132097","name":"Aosom France MF","country":"FR"},"currency":"EUR","delivery":{"weight":40,"fulfillment":true},"model_id":17784588,"offer_id":"afa4d772-b372-4f8a-b3d0-0f37ee205b58","quantity":{"stock":null,"value":1},"variants":{"list":[{"name":"couleur","values":[{"type":"hexacolor","label":"Gris","value":"#A9A9A9","model_id":17784588,"is_available":true}]}]}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/manomano/search":{"get":{"summary":"ManoMano Search","description":"Search for products on ManoMano by category or keyword URL, returning listings with prices, ratings, and seller information.\n\n**Credit cost:** 1 credit per call","operationId":"get-manomano-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full ManoMano search or category page URL.\n\n**Example:**\n\n    https://www.manomano.fr/perceuse-1146\n\n**Notes:**\n- Use any valid ManoMano search or category URL from any supported domain (`manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`)\n- Pagination and filter parameters present in the URL are respected","schema":{"type":"string","description":"Full ManoMano search or category page URL.\n\n**Example:**\n\n    https://www.manomano.fr/perceuse-1146\n\n**Notes:**\n- Use any valid ManoMano search or category URL from any supported domain (`manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`)\n- Pagination and filter parameters present in the URL are respected"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"cpc":{"type":"number"},"url":{"type":"string"},"bulk":{"type":"boolean"},"title":{"type":"string"},"is_b2b":{"type":"boolean"},"is_mmf":{"type":"boolean"},"prices":{"type":"object","properties":{"main":{"type":"number"},"unit":{"nullable":true},"retail":{"type":"number"},"discount":{"type":"string"},"secondary":{"nullable":true}}},"rating":{"type":"number"},"brand_id":{"type":"integer"},"is_local":{"type":"boolean"},"model_id":{"type":"integer"},"offer_id":{"type":"string"},"position":{"type":"integer"},"seller_id":{"type":"integer"},"article_id":{"type":"integer"}}}}}},"examples":{"Search for drills (perceuse)":{"value":{"results":[{"cpc":0.1,"url":"https://www.manomano.fr/makita-perceuse-visseuse-18v-3x3ah-ddf484rf3j","bulk":false,"title":"Perceuse visseuse 18V Ø 13 mm - MAKITA - Avec 2 batteries 18V Li-Ion 5.0 Ah, chargeur, MakPak- DDF484RTJ","is_b2b":false,"is_mmf":true,"prices":{"main":277.2,"unit":null,"retail":569.16,"discount":"51","secondary":null},"rating":4.589109,"brand_id":16,"is_local":false,"model_id":54973303,"offer_id":"d63853b8-314b-4de0-8cd8-fc9c993fe6f6","position":1,"seller_id":5307819,"article_id":78566961},{"url":"https://www.manomano.fr/dewalt-perceuse-visseuse-18v-dcd778d2t","bulk":false,"title":"Perceuse visseuse sans fil 18V - DEWALT - DCD778D2T","is_b2b":false,"is_mmf":false,"prices":{"main":149.99,"unit":null,"retail":199.99,"discount":"25","secondary":null},"rating":4.72,"model_id":12345678,"offer_id":"abc123-def456","position":2,"article_id":12345678}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"ManoMano Search","description":"Search for products on ManoMano by category or keyword URL, returning listings with prices, ratings, and seller information.\n\n**Credit cost:** 1 credit per call","operationId":"post-manomano-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full ManoMano search or category page URL.\n\n**Example:**\n\n    https://www.manomano.fr/perceuse-1146\n\n**Notes:**\n- Use any valid ManoMano search or category URL from any supported domain (`manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`)\n- Pagination and filter parameters present in the URL are respected","schema":{"type":"string","description":"Full ManoMano search or category page URL.\n\n**Example:**\n\n    https://www.manomano.fr/perceuse-1146\n\n**Notes:**\n- Use any valid ManoMano search or category URL from any supported domain (`manomano.fr`, `manomano.co.uk`, `manomano.de`, `manomano.es`, `manomano.it`)\n- Pagination and filter parameters present in the URL are respected"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"cpc":{"type":"number"},"url":{"type":"string"},"bulk":{"type":"boolean"},"title":{"type":"string"},"is_b2b":{"type":"boolean"},"is_mmf":{"type":"boolean"},"prices":{"type":"object","properties":{"main":{"type":"number"},"unit":{"nullable":true},"retail":{"type":"number"},"discount":{"type":"string"},"secondary":{"nullable":true}}},"rating":{"type":"number"},"brand_id":{"type":"integer"},"is_local":{"type":"boolean"},"model_id":{"type":"integer"},"offer_id":{"type":"string"},"position":{"type":"integer"},"seller_id":{"type":"integer"},"article_id":{"type":"integer"}}}}}},"examples":{"Search for drills (perceuse)":{"value":{"results":[{"cpc":0.1,"url":"https://www.manomano.fr/makita-perceuse-visseuse-18v-3x3ah-ddf484rf3j","bulk":false,"title":"Perceuse visseuse 18V Ø 13 mm - MAKITA - Avec 2 batteries 18V Li-Ion 5.0 Ah, chargeur, MakPak- DDF484RTJ","is_b2b":false,"is_mmf":true,"prices":{"main":277.2,"unit":null,"retail":569.16,"discount":"51","secondary":null},"rating":4.589109,"brand_id":16,"is_local":false,"model_id":54973303,"offer_id":"d63853b8-314b-4de0-8cd8-fc9c993fe6f6","position":1,"seller_id":5307819,"article_id":78566961},{"url":"https://www.manomano.fr/dewalt-perceuse-visseuse-18v-dcd778d2t","bulk":false,"title":"Perceuse visseuse sans fil 18V - DEWALT - DCD778D2T","is_b2b":false,"is_mmf":false,"prices":{"main":149.99,"unit":null,"retail":199.99,"discount":"25","secondary":null},"rating":4.72,"model_id":12345678,"offer_id":"abc123-def456","position":2,"article_id":12345678}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/walmart/product":{"get":{"summary":"Walmart Product","description":"Extract full Walmart product page (PDP) data from a /ip/ URL: pricing, ratings, images, fulfillment, specs, badges, and availability via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-walmart-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Walmart product page URL.\n\n**Example:**\n\n    https://www.walmart.com/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096\n\n**Notes:**\n- The URL must point to a Walmart product detail page containing `/ip/` in the path.\n- The numeric ID at the end of the URL is the Walmart `us_item_id`.\n- Copy the full URL from walmart.com (including query params if present).\n- Walmart PDP data is loaded via JavaScript; this endpoint uses browser rendering.","schema":{"type":"string","description":"Full Walmart product page URL.\n\n**Example:**\n\n    https://www.walmart.com/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096\n\n**Notes:**\n- The URL must point to a Walmart product detail page containing `/ip/` in the path.\n- The numeric ID at the end of the URL is the Walmart `us_item_id`.\n- Copy the full URL from walmart.com (including query params if present).\n- Walmart PDP data is loaded via JavaScript; this endpoint uses browser rendering."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"pac":{"nullable":true},"upc":{"type":"string"},"esrb":{"nullable":true},"idml":{"type":"object","properties":{"videos":{"nullable":true},"warranty":{"nullable":true},"drug_guide":{"nullable":true},"esrb_rating":{"nullable":true},"ingredients":{"type":"object","properties":{"ingredients":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"active_ingredients":{"nullable":true},"inactive_ingredients":{"nullable":true},"active_ingredient_name":{"nullable":true}}},"mpaa_rating":{"nullable":true},"size_charts":{"nullable":true},"infographics":{"nullable":true},"social_media":{"nullable":true},"ar_experience":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"gen_ai_details":{"type":"object","properties":{"gen_ai_concise_summary":{"nullable":true},"gen_ai_description_bullet":{"nullable":true}}},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"choking_hazards":{"nullable":true},"enriched360_spin":{"nullable":true},"long_description":{"type":"string"},"short_description":{"type":"string"},"product_highlights":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"icon_url":{"nullable":true}}}},"has_marketing_description":{"type":"boolean"},"interactive_product_video":{"nullable":true},"interactive_product_assets":{"nullable":true},"product360_image_container":{"nullable":true}}},"name":{"type":"string"},"type":{"type":"string"},"brand":{"type":"string"},"model":{"nullable":true},"badges":{"type":"object","properties":{"tags":{"type":"array","items":{}},"flags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"rank":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string"},"query":{"type":"string"},"style_id":{"type":"string"},"__typename":{"type":"string"}}}},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"rank":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string"},"icon_id":{"type":"string"},"sla_date":{"nullable":true},"sla_text":{"nullable":true},"style_id":{"type":"string"},"action_id":{"type":"string"},"__typename":{"type":"string"},"member_type":{"type":"string"},"text_values":{"nullable":true},"sla_date_iso":{"nullable":true},"badge_content":{"nullable":true},"text_template":{"nullable":true}}}},"__typename":{"type":"string"}}}},"labels":{"nullable":true},"groups_v2":{"type":"array","items":{"type":"object","properties":{"pos":{"type":"string"},"flow":{"type":"string"},"name":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"mem_id":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"url":{"nullable":true},"type":{"type":"string"},"value":{"type":"string"},"style_id":{"type":"string"},"action_id":{"nullable":true},"cont_desc":{"nullable":true},"action_content":{"nullable":true}}}},"mem_type":{"type":"string"},"mem_style_id":{"type":"string"},"content_variants":{"nullable":true}}}}}}}}},"ebooks":{"nullable":true},"gender":{"nullable":true},"pet_rx":{"type":"object","properties":{"eligible":{"type":"boolean"},"single_dispense":{"nullable":true}}},"vision":{"type":"object","properties":{"age_group":{"nullable":true},"vision_center_approved":{"type":"boolean"}}},"is_byod":{"type":"boolean"},"rewards":{"nullable":true},"rh_path":{"type":"string"},"category":{"type":"object","properties":{"path":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"category_path_id":{"type":"string"}}},"class_id":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"intent":{"type":"string"},"store_ids":{"type":"array","items":{"type":"string"}},"address_id":{"nullable":true},"postal_code":{"type":"string"},"pickup_location":{"type":"object","properties":{"store_id":{"type":"string"},"access_type":{"nullable":true},"access_point_id":{"nullable":true}}},"mp_pickup_location":{"nullable":true},"state_or_province_code":{"type":"string"}}},"offer_id":{"type":"string"},"redirect":{"type":"object","properties":{"replaced_by_item_id":{"type":"string"},"replaced_by_product_id":{"type":"string"},"replaced_by_product_url_text":{"type":"string"}}},"show_atc":{"type":"boolean"},"variants":{"type":"array","items":{}},"brand_url":{"type":"string"},"discounts":{"type":"object","properties":{"discounted_value":{"nullable":true},"discount_meta_data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"price":{"type":"object","properties":{"price":{"nullable":true},"price_string":{"nullable":true},"price_display":{"type":"string"}}},"savings":{"type":"object","properties":{"amount":{"nullable":true},"percent":{"nullable":true},"price_string":{"type":"string"}}},"unit_price":{"type":"object","properties":{"price":{"nullable":true},"price_string":{"nullable":true}}},"comparison_price":{"type":"object","properties":{"price":{"nullable":true},"price_string":{"nullable":true}}},"unit_price_display_condition":{"nullable":true}}}}}},"image_map":{"type":"object","properties":{}},"item_type":{"nullable":true},"lang_urls":{"nullable":true},"mhmd_flag":{"type":"boolean"},"pre_order":{"type":"object","properties":{"is_pre_order":{"type":"boolean"},"release_date":{"nullable":true}}},"seller_id":{"type":"string"},"tire_size":{"nullable":true},"viscosity":{"nullable":true},"blitz_item":{"nullable":true},"claim_rate":{"nullable":true},"class_type":{"type":"string"},"image_info":{"type":"object","properties":{"all_images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"zoomable":{"type":"boolean"}}}},"thumbnail_url":{"type":"string"},"thumbnail_aspect_ratio":{"type":"string"}}},"offer_type":{"type":"string"},"price_info":{"type":"object","properties":{"savings":{"nullable":true},"cap_type":{"nullable":true},"tax_info":{"nullable":true},"was_price":{"nullable":true},"base_price":{"nullable":true},"drop_price":{"type":"boolean"},"list_price":{"nullable":true},"ship_price":{"nullable":true},"unit_price":{"type":"object","properties":{"price":{"type":"number"},"best_value":{"nullable":true},"price_string":{"type":"string"},"support_text":{"nullable":true},"currency_unit":{"type":"string"},"variant_price_string":{"nullable":true}}},"price_range":{"type":"object","properties":{"max_price":{"nullable":true},"min_price":{"nullable":true},"price_string":{"nullable":true},"currency_unit":{"nullable":true},"denominations":{"nullable":true}}},"current_price":{"type":"object","properties":{"price":{"type":"number"},"best_value":{"nullable":true},"price_string":{"type":"string"},"support_text":{"nullable":true},"currency_unit":{"type":"string"},"price_display":{"type":"string"},"variant_price_string":{"type":"string"}}},"savings_amount":{"nullable":true},"additional_fees":{"type":"object","properties":{"duty_fee":{"type":"object","properties":{"price":{"type":"integer"},"price_string":{"type":"string"}}},"country_name":{"nullable":true},"estimated_total_price":{"type":"object","properties":{"price":{"type":"number"},"price_string":{"type":"string"}}},"shipping_and_import_fee":{"type":"object","properties":{"price":{"type":"integer"},"price_string":{"type":"string"}}},"gift_card_margin_and_fee":{"nullable":true}}},"comparison_price":{"nullable":true},"is_price_reduced":{"type":"boolean"},"subscription_price":{"nullable":true},"volume_price_tiers":{"type":"array","items":{}},"price_display_codes":{"type":"object","properties":{"rollback":{"nullable":true},"clearance":{"nullable":true},"submap_type":{"nullable":true},"is_b2_b_price":{"type":"boolean"},"reduced_price":{"nullable":true},"price_display_type":{"type":"string"},"price_per_unit_uom":{"type":"string"},"final_cost_by_weight":{"nullable":true},"price_display_condition":{"nullable":true},"eligible_for_associate_discount":{"type":"boolean"}}},"price_reduced_display":{"nullable":true},"secondary_offer_boost":{"nullable":true},"walmart_funded_amount":{"nullable":true},"w_plus_early_access_price":{"nullable":true}}},"promo_data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"terms":{"type":"string"},"metadata":{"type":"string"},"description":{"type":"string"},"template_data":{"type":"object","properties":{"flag_type":{"nullable":true},"image_url":{"type":"string"},"apr_string":{"nullable":true},"price_string":{"nullable":true},"finance_data_promotion_type":{"nullable":true}}},"installments_promotion":{"nullable":true},"no_interest_installments_promotion":{"nullable":true}}}},"sales_unit":{"type":"string"},"ship_as_is":{"type":"boolean"},"us_item_id":{"type":"string"},"e_gift_card":{"nullable":true},"is_preowned":{"type":"boolean"},"is_qsr_item":{"type":"boolean"},"order_limit":{"type":"integer"},"seller_name":{"type":"string"},"seller_type":{"type":"string"},"wfs_enabled":{"type":"boolean"},"zeekit_data":{"nullable":true},"annual_event":{"nullable":true},"collectibles":{"nullable":true},"condition_v2":{"type":"object","properties":{"code":{"type":"integer"},"group_code":{"type":"integer"}}},"item_type_v2":{"type":"string"},"lmp_eligible":{"type":"boolean"},"member_limit":{"nullable":true},"subscription":{"type":"object","properties":{"subscription_eligible":{"type":"boolean"},"subscription_submessage":{"type":"string"},"show_subscription_module":{"type":"boolean"},"subscription_transactable":{"type":"boolean"}}},"trust_badges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"nullable":true}}}},"variants_map":{"type":"object","properties":{}},"aaia_brand_id":{"nullable":true},"canonical_url":{"type":"string"},"external_info":{"nullable":true},"grading_label":{"type":"string"},"is_collection":{"type":"boolean"},"is_qsr_seller":{"type":"boolean"},"pickup_option":{"type":"object","properties":{"sla_tier":{"nullable":true},"store_id":{"nullable":true},"store_name":{"nullable":true},"access_types":{"type":"array","items":{"type":"string"}},"availability_status":{"type":"string"}}},"primary_offer":{"type":"object","properties":{"warranty":{"nullable":true}}},"return_policy":{"type":"object","properties":{"returnable":{"type":"boolean"},"free_returns":{"type":"boolean"},"return_window":{"type":"object","properties":{"value":{"type":"integer"},"unit_type":{"type":"string"}}},"return_location":{"type":"string"},"return_policy_text":{"type":"string"},"return_policy_type":{"type":"string"},"returnable_to_store":{"type":"boolean"},"holiday_return_enabled":{"type":"boolean"},"return_policy_condition":{"nullable":true},"return_policy_text_code":{"type":"object","properties":{"code":{"type":"string"},"data":{"nullable":true}}},"return_policy_clarity_text":{"type":"string"},"return_policy_clarity_text_more":{"nullable":true}}},"snap_eligible":{"type":"boolean"},"average_rating":{"type":"number"},"condition_type":{"type":"string"},"has_care_plans":{"type":"boolean"},"motor_oil_type":{"nullable":true},"personalizable":{"type":"boolean"},"promo_discount":{"nullable":true},"promo_eligible":{"type":"boolean"},"sem_store_data":{"nullable":true},"shipping_price":{"nullable":true},"show_condition":{"type":"boolean"},"top_promo_text":{"nullable":true},"add_on_services":{"nullable":true},"can_add_to_list":{"type":"boolean"},"experience_type":{"nullable":true},"group_meta_data":{"nullable":true},"is_customizable":{"type":"boolean"},"is_wplus_member":{"type":"boolean"},"order_min_limit":{"type":"integer"},"pet_rx_eligible":{"nullable":true},"product_type_id":{"type":"string"},"seller_logo_url":{"nullable":true},"shipping_option":{"type":"object","properties":{"sla_tier":{"nullable":true},"ship_price":{"nullable":true},"ship_method":{"nullable":true},"delivery_date":{"nullable":true},"max_delivery_date":{"nullable":true},"availability_status":{"type":"string"},"international_shipping":{"nullable":true}}},"tire_load_index":{"nullable":true},"buy_now_eligible":{"type":"boolean"},"condition_offers":{"type":"array","items":{"type":"object","properties":{"price":{"type":"object","properties":{"price":{"type":"number"},"price_string":{"type":"string"}}},"offer_id":{"type":"string"},"condition":{"type":"object","properties":{"code":{"type":"integer"},"text":{"type":"string"},"group_code":{"type":"integer"},"group_text":{"type":"string"}}},"more_conditions":{"nullable":true},"top_boosted_offer":{"nullable":true},"availability_status":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}}}}},"event_attributes":{"type":"object","properties":{"price_flip":{"type":"boolean"},"special_buy":{"type":"boolean"}}},"fsa_eligible_ind":{"type":"boolean"},"fulfillment_type":{"type":"string"},"has_seller_badge":{"nullable":true},"is_free_warranty":{"type":"boolean"},"is_replenishable":{"type":"boolean"},"ozark_attributes":{"type":"object","properties":{"exact_address":{"type":"boolean"},"shipping_promise":{"nullable":true}}},"primary_shelf_id":{"type":"string"},"product_location":{"type":"array","items":{"type":"object","properties":{"display_value":{"type":"string"}}}},"secondary_offers":{"type":"array","items":{}},"special_cta_type":{"type":"string"},"suppress_reviews":{"type":"boolean"},"variant_criteria":{"type":"array","items":{}},"weight_increment":{"type":"integer"},"wireless_carrier":{"type":"string"},"catalog_seller_id":{"type":"integer"},"fulfillment_badge":{"nullable":true},"fulfillment_label":{"type":"array","items":{"type":"object","properties":{"sla":{"nullable":true},"message":{"type":"string"},"postal_code":{"nullable":true},"delivery_date":{"nullable":true},"location_text":{"type":"string"},"shipping_text":{"type":"string"},"fulfillment_text":{"type":"string"},"fulfillment_type":{"type":"string"},"fulfillment_method":{"type":"string"},"address_eligibility":{"type":"boolean"},"w_plus_fulfillment_text":{"nullable":true},"check_store_availability":{"nullable":true}}}},"fulfillment_title":{"type":"string"},"grading_type_code":{"nullable":true},"has_home_services":{"nullable":true},"ironbank_category":{"type":"string"},"legal_restriction":{"type":"boolean"},"number_of_reviews":{"type":"integer"},"return_attributes":{"type":"object","properties":{"frequency_of_return":{"type":"string"}}},"selected_offer_id":{"type":"string"},"short_description":{"type":"string"},"tire_speed_rating":{"nullable":true},"top_boosted_offer":{"type":"object","properties":{"offer_id":{"nullable":true},"seller_id":{"nullable":true},"date_string":{"nullable":true},"seller_name":{"nullable":true},"price_string":{"nullable":true},"display_price":{"nullable":true},"shipping_cost":{"nullable":true},"fulfillment_promise":{"nullable":true}}},"wfs_provider_name":{"nullable":true},"early_access_event":{"type":"boolean"},"preowned_condition":{"type":"string"},"primary_product_id":{"nullable":true},"primary_us_item_id":{"nullable":true},"shipping_cost_type":{"nullable":true},"abstract_product_id":{"nullable":true},"availability_status":{"type":"string"},"buy_box_suppression":{"type":"boolean"},"fulfillment_options":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"intent":{"type":"boolean"},"selected":{"type":"boolean"},"view_only":{"type":"boolean"},"__typename":{"type":"string"},"restricted":{"nullable":true},"order_limit":{"nullable":true},"location_text":{"type":"string"},"speed_details":{"nullable":true},"is_low_in_stock":{"nullable":true},"inventory_status":{"nullable":true},"availability_type":{"type":"string"},"available_quantity":{"nullable":true},"max_order_quantity":{"nullable":true},"availability_status":{"type":"string"},"subscription_submessage":{"type":"string"}}}},"fulfillment_summary":{"type":"array","items":{"type":"object","properties":{"sla":{"type":"object","properties":{"rank":{"type":"integer"},"unit_of_measure":{"type":"string"},"measurement_value":{"type":"integer"}}},"store_id":{"type":"string"},"is_express":{"type":"boolean"},"fulfillment":{"type":"string"},"regular_sla":{"nullable":true},"delivery_date":{"nullable":true},"store_timezone":{"nullable":true},"fulfillment_badge":{"nullable":true},"fulfillment_price":{"nullable":true},"max_delivery_date":{"nullable":true},"is_free_for_w_plus":{"nullable":true},"calculated_sla_days":{"type":"integer"},"fulfillment_methods":{"type":"array","items":{"type":"string"}},"store_delivery_date":{"nullable":true},"fulfillment_discount":{"nullable":true},"out_of_country_eligible":{"nullable":true},"store_max_delivery_date":{"nullable":true}}}},"gifting_eligibility":{"type":"boolean"},"is_lmp_alcohol_item":{"type":"boolean"},"product_disclaimers":{"type":"array","items":{}},"seller_display_name":{"type":"string"},"seller_review_count":{"nullable":true},"show_buy_with_wplus":{"type":"boolean"},"special_cta_context":{"type":"string"},"special_instruction":{"type":"boolean"},"static_message_type":{"type":"string"},"associated_bundle_id":{"nullable":true},"flower_delivery_info":{"type":"array","items":{}},"is_early_access_item":{"type":"boolean"},"selected_variant_ids":{"type":"array","items":{}},"shipping_restriction":{"type":"boolean"},"show_add_on_services":{"type":"boolean"},"hide_atc_for_services":{"type":"boolean"},"is_lmp_alcohol_seller":{"type":"boolean"},"secondary_offer_price":{"type":"object","properties":{"tax_info":{"nullable":true},"current_price":{"type":"object","properties":{"price":{"type":"number"},"price_type":{"nullable":true},"price_string":{"type":"string"}}}}},"seller_average_rating":{"nullable":true},"show_fulfillment_link":{"type":"boolean"},"subscription_eligible":{"type":"boolean"},"additional_offer_count":{"nullable":true},"availability_status_v2":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}},"is_get_it_now_eligible":{"type":"boolean"},"seller_store_front_url":{"nullable":true},"tobacco_static_mesages":{"type":"array","items":{}},"variant_product_id_map":{"type":"object","properties":{}},"is_native1_p_egift_card":{"nullable":true},"manufacturer_product_id":{"type":"string"},"new_condition_product_id":{"nullable":true},"transactable_offer_count":{"type":"integer"},"wireless_third_party_url":{"nullable":true},"display_offer_level_image":{"type":"boolean"},"availability_in_nearby_store":{"nullable":true},"check_store_availability_atc":{"type":"boolean"},"available_fulfillment_options":{"type":"array","items":{"type":"string"}},"check_availability_global_dfs":{"type":"boolean"},"item_page_availability_status":{"type":"string"},"max_reward_among_all_variants":{"nullable":true},"show_highlights_seller_rating":{"type":"boolean"},"fulfillment_type_classification":{"type":"string"},"is_part_of_low_return_rate_test":{"type":"boolean"},"special_order_quantity_eligible":{"type":"boolean"},"show_explore_other_conditions_cta":{"type":"boolean"}}},"examples":{"Fresh Rockit Apples 3lb Tub":{"value":{"id":"40KH71FS6S1U","pac":null,"upc":"888289403510","esrb":null,"idml":{"videos":null,"warranty":null,"drug_guide":null,"esrb_rating":null,"ingredients":{"ingredients":{"name":"Ingredients","value":"Fresh Produce"},"active_ingredients":null,"inactive_ingredients":null,"active_ingredient_name":null},"mpaa_rating":null,"size_charts":null,"infographics":null,"social_media":null,"ar_experience":[{"name":"Augmented Reality Experiences","values":["{\"ar_eligible\":\"true\",\"ar_enabled\":\"false\",\"ar_experiencetype_info\":{\"version\":\"2.0\",\"platforms\":{}},\"requestId\":\"6d13d9ca-be65-4b30-aaf6-aafcaac4d47a\",\"offerings\":{\"enriched_media\":{\"id\":\"050c7ab0-3142-49c7-b4cf-7c24ee411482\",\"enabled\":true}}}"]}],"gen_ai_details":{"gen_ai_concise_summary":null,"gen_ai_description_bullet":null},"specifications":[{"name":"Plant variety","value":"Rockit"},{"name":"Average sold by weight","value":"3 Pounds"},{"name":"Food condition","value":"Fresh"},{"name":"Container type","value":"Tub"},{"name":"Food form","value":"Whole"},{"name":"Product net content parent","value":"3 Pound"},{"name":"Brand","value":"Rock It"}],"choking_hazards":null,"enriched360_spin":null,"long_description":"<ul>  <li>Sweet, crisp and juicy with every bite</li>  <li>Conveniently sized for on-the-go snacking</li>  <li>Perfect as a healthy treat or seasonal baking ingredient</li>  <li>Excellent source of fiber and vitamin C</li>  <li>Two apples = 70 calories</li>  <li>80% rPET packaging that can be upcycled or recycled</li>  <li>Adds flavor to a variety of recipes</li>  <li>Fresh and ready-to-eat food condition</li>  <li>Includes Rockit plant variety for a unique taste</li> </ul>","short_description":"Experience the perfect combination of sweetness and crispness with our Fresh Rockit Miniature Apples. Naturally grown to be miniature, these apples are rich in flavor and high in energy. Ideal for snacking, baking, and adding a burst of taste to salads or charcuterie boards. Enjoy the benefits of consuming fewer calories with just two apples totaling 70 calories. Packaged sustainably in 80% rPET containers that can be recycled, it's a great choice for conscious consumers who value freshness and environmental responsibility. Available while stocks last.","product_highlights":[{"name":"Plant variety","value":"Rockit","icon_url":null},{"name":"Average sold by weight","value":"3 Pounds","icon_url":null},{"name":"Food condition","value":"Fresh","icon_url":null},{"name":"Container type","value":"Tub","icon_url":null},{"name":"Food form","value":"Whole","icon_url":null},{"name":"Product net content parent","value":"3 Pound","icon_url":null}],"has_marketing_description":false,"interactive_product_video":null,"interactive_product_assets":null,"product360_image_container":null},"name":"Fresh Rockit, Crisp Sweet Miniature Apples, 3lb Tub","type":"Apples","brand":"Rock It","model":null,"badges":{"tags":[],"flags":[{"id":"L1200","key":"CUSTOMER_PICK","rank":1,"text":"Overall pick","type":"LABEL","query":"mini apples","style_id":"PRIMARY_BLUE_BOLD","__typename":"BaseBadge"}],"groups":[{"name":"benefits","members":[{"id":"L1033","key":"SNAP_ELIGIBLE","rank":1,"text":"SNAP EBT eligible","type":"ICON","icon_id":"CreditCard","sla_date":null,"sla_text":null,"style_id":"EBT_STYLE","action_id":"SNAP","__typename":"BadgeGroupMember","member_type":"badge","text_values":null,"sla_date_iso":null,"badge_content":null,"text_template":null}],"__typename":"UnifiedBadgeGroup"}],"labels":null,"groups_v2":[{"pos":"ItemPageBadgeModule2","flow":"HORIZONTAL","name":"flags","members":[{"mem_id":"L1200","content":[{"url":null,"type":"TEXT","value":"Overall pick","style_id":"WHITE_BOLD","action_id":null,"cont_desc":null,"action_content":null}],"mem_type":"badge","mem_style_id":"PRIMARY_PRUSSIANBLUE_MR4","content_variants":null}]}]},"ebooks":null,"gender":null,"pet_rx":{"eligible":false,"single_dispense":null},"vision":{"age_group":null,"vision_center_approved":false},"is_byod":false,"rewards":null,"rh_path":"40000:46000:46001:46104:46231","category":{"path":[{"url":"/cp/food/976759","name":"Food"},{"url":"/cp/fresh-produce/976793","name":"Fresh Produce"},{"url":"/cp/fresh-fruits/9756351","name":"Fresh Fruits"},{"url":"/cp/apples/7796396","name":"Apples"}],"category_path_id":"0:976759:976793:9756351:7796396"},"class_id":"1","location":{"city":"Sacramento","intent":"SHIPPING","store_ids":["3081"],"address_id":null,"postal_code":"95829","pickup_location":{"store_id":"3081","access_type":null,"access_point_id":null},"mp_pickup_location":null,"state_or_province_code":"CA"},"offer_id":"AC8C51F0396B4072B53EDABAA1DF222B","redirect":{"replaced_by_item_id":"","replaced_by_product_id":"","replaced_by_product_url_text":""},"show_atc":true,"variants":[],"brand_url":"/search?q=Rock+It&facet=brand:Rock+It","discounts":{"discounted_value":null,"discount_meta_data":[{"id":"wplus_subscription","type":"wplus_subscription","price":{"price":null,"price_string":null,"price_display":"Now est. $ null "},"savings":{"amount":null,"percent":null,"price_string":"$ null "},"unit_price":{"price":null,"price_string":null},"comparison_price":{"price":null,"price_string":null},"unit_price_display_condition":null}]},"image_map":{},"item_type":null,"lang_urls":null,"mhmd_flag":false,"pre_order":{"is_pre_order":false,"release_date":null},"seller_id":"F55CDC31AB754BB68FE0B39041159D63","tire_size":null,"viscosity":null,"blitz_item":null,"claim_rate":null,"class_type":"REGULAR","image_info":{"all_images":[{"id":"832D3DF0CE174E1799E84513215B1D18","url":"https://i5.walmartimages.com/seo/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub_de6d6d44-507a-43e4-9bd9-d86286473870.4d6dbcb5c200885859982510d4314077.jpeg","zoomable":true},{"id":"AC0D7F45DD8C4C8984FCE3B92DD2080E","url":"https://i5.walmartimages.com/asr/1ebc2554-b285-4ab4-a21c-3c57ccf601a6.98459edf6aa1850e39ff23051c3d4365.jpeg","zoomable":true},{"id":"F57FD3779D134D0D9E41B1222B043D0D","url":"https://i5.walmartimages.com/asr/3f5d03f8-f6dc-435f-a3cc-7963632e0d33.6072f6e0b48d303e9f1f150b72868e9c.jpeg","zoomable":true},{"id":"BE49A2839C654AEAAD7DCF6004B6C8E8","url":"https://i5.walmartimages.com/asr/8918ad26-64f7-4ba0-86fd-85e68824b13a.c5faccb05a2f04616c2db3556d38e10c.jpeg","zoomable":true},{"id":"DB003140BD8448B68423EC445B6CBC3F","url":"https://i5.walmartimages.com/asr/358e5fe9-60e5-4208-9496-f463afe5654e.36d169879e0ae07c407c784600a5f9ba.jpeg","zoomable":true},{"id":"9A5972B65EE9408B91C71997227CF0C0","url":"https://i5.walmartimages.com/asr/5e9a9e92-c609-47e5-a1a0-9cafcd631c81.76082eba161ce1894eea0e78f393c1cd.jpeg","zoomable":true}],"thumbnail_url":"https://i5.walmartimages.com/seo/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub_de6d6d44-507a-43e4-9bd9-d86286473870.4d6dbcb5c200885859982510d4314077.jpeg","thumbnail_aspect_ratio":"1:1"},"offer_type":"STORE_ONLY","price_info":{"savings":null,"cap_type":null,"tax_info":null,"was_price":null,"base_price":null,"drop_price":false,"list_price":null,"ship_price":null,"unit_price":{"price":2.99,"best_value":null,"price_string":"$2.99/lb","support_text":null,"currency_unit":"USD","variant_price_string":null},"price_range":{"max_price":null,"min_price":null,"price_string":null,"currency_unit":null,"denominations":null},"current_price":{"price":8.97,"best_value":null,"price_string":"$8.97","support_text":null,"currency_unit":"USD","price_display":"$8.97","variant_price_string":"$8.97"},"savings_amount":null,"additional_fees":{"duty_fee":{"price":0,"price_string":"$0.00"},"country_name":null,"estimated_total_price":{"price":8.97,"price_string":"$8.97"},"shipping_and_import_fee":{"price":0,"price_string":"$0.00"},"gift_card_margin_and_fee":null},"comparison_price":null,"is_price_reduced":false,"subscription_price":null,"volume_price_tiers":[],"price_display_codes":{"rollback":null,"clearance":null,"submap_type":null,"is_b2_b_price":false,"reduced_price":null,"price_display_type":"UNKNOWN","price_per_unit_uom":"LB","final_cost_by_weight":null,"price_display_condition":null,"eligible_for_associate_discount":true},"price_reduced_display":null,"secondary_offer_boost":null,"walmart_funded_amount":null,"w_plus_early_access_price":null},"promo_data":[{"id":"8885f40c-8096-4686-83f1-5bf460f97952","type":"1PAYCC","terms":"walmart://onecreditcard/landing?source=itemPage&utm_content=WMD-CRD-ITBD&showconfirmationonsuccess=true","metadata":"{\"ipmSlotId\":\"1\",\"type\":\"1PAYCC\",\"image\":\"https://i5.walmartimages.com/dfwrs/76316474-4b44/k2-_7221675a-6d36-4e9f-81a5-27dd4d84bf0b.v1.png\",\"finance_type\":\"interest\",\"altImage\":\"https://i5.walmartimages.com/dfwrs/76316474-4b44/k2-_7221675a-6d36-4e9f-81a5-27dd4d84bf0b.v1.png\"}","description":"Earn up to <b>5% cash back</b> with OnePay CashRewards.","template_data":{"flag_type":null,"image_url":"https://i5.walmartimages.com/dfwrs/76316474-4b44/k2-_7221675a-6d36-4e9f-81a5-27dd4d84bf0b.v1.png","apr_string":null,"price_string":null,"finance_data_promotion_type":null},"installments_promotion":null,"no_interest_installments_promotion":null}],"sales_unit":"EACH","ship_as_is":false,"us_item_id":"309762096","e_gift_card":null,"is_preowned":false,"is_qsr_item":false,"order_limit":12,"seller_name":"Walmart.com","seller_type":"INTERNAL","wfs_enabled":false,"zeekit_data":null,"annual_event":null,"collectibles":null,"condition_v2":{"code":1,"group_code":1},"item_type_v2":"UNKNOWN","lmp_eligible":false,"member_limit":null,"subscription":{"subscription_eligible":true,"subscription_submessage":"NONE","show_subscription_module":true,"subscription_transactable":true},"trust_badges":[{"type":"FREE_RETURN","subtype":null},{"type":"PICKUP","subtype":null},{"type":"SOLD_BY_WALMART","subtype":null}],"variants_map":{},"aaia_brand_id":null,"canonical_url":"/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096","external_info":null,"grading_label":"New","is_collection":false,"is_qsr_seller":false,"pickup_option":{"sla_tier":null,"store_id":null,"store_name":null,"access_types":["PICKUP_CURBSIDE"],"availability_status":"AVAILABLE"},"primary_offer":{"warranty":null},"return_policy":{"returnable":true,"free_returns":true,"return_window":{"value":90,"unit_type":"Day"},"return_location":"store","return_policy_text":"Free 90-day returns","return_policy_type":"seamless","returnable_to_store":true,"holiday_return_enabled":false,"return_policy_condition":null,"return_policy_text_code":{"code":"PRODUCT_RETURN_WINDOW","data":null},"return_policy_clarity_text":"Free 90-day returns - in store or online","return_policy_clarity_text_more":null},"snap_eligible":false,"average_rating":4.4,"condition_type":"New","has_care_plans":false,"motor_oil_type":null,"personalizable":false,"promo_discount":null,"promo_eligible":false,"sem_store_data":null,"shipping_price":null,"show_condition":false,"top_promo_text":null,"add_on_services":null,"can_add_to_list":true,"experience_type":null,"group_meta_data":null,"is_customizable":false,"is_wplus_member":false,"order_min_limit":1,"pet_rx_eligible":null,"product_type_id":"ib_apples","seller_logo_url":null,"shipping_option":{"sla_tier":null,"ship_price":null,"ship_method":null,"delivery_date":null,"max_delivery_date":null,"availability_status":"AVAILABLE","international_shipping":null},"tire_load_index":null,"buy_now_eligible":false,"condition_offers":[{"price":{"price":8.97,"price_string":"$8.97"},"offer_id":"AC8C51F0396B4072B53EDABAA1DF222B","condition":{"code":1,"text":"New","group_code":1,"group_text":"New"},"more_conditions":null,"top_boosted_offer":null,"availability_status":{"value":"IN_STOCK","display":"In stock"}}],"event_attributes":{"price_flip":false,"special_buy":false},"fsa_eligible_ind":false,"fulfillment_type":"STORE","has_seller_badge":null,"is_free_warranty":false,"is_replenishable":true,"ozark_attributes":{"exact_address":false,"shipping_promise":null},"primary_shelf_id":"7796396","product_location":[{"display_value":"AP6"}],"secondary_offers":[],"special_cta_type":"UNKNOWN","suppress_reviews":false,"variant_criteria":[],"weight_increment":1,"wireless_carrier":"","catalog_seller_id":0,"fulfillment_badge":null,"fulfillment_label":[{"sla":null,"message":"Pickup, today at Sacramento Supercenter","postal_code":null,"delivery_date":null,"location_text":"Sacramento Supercenter","shipping_text":"Pickup","fulfillment_text":"today","fulfillment_type":"STORE","fulfillment_method":"PICKUP","address_eligibility":false,"w_plus_fulfillment_text":null,"check_store_availability":null},{"sla":null,"message":"Delivery from store","postal_code":null,"delivery_date":null,"location_text":null,"shipping_text":"Delivery from store","fulfillment_text":null,"fulfillment_type":"STORE","fulfillment_method":"DELIVERY","address_eligibility":true,"w_plus_fulfillment_text":null,"check_store_availability":null}],"fulfillment_title":"title_store_delivery_curbside_pickup","grading_type_code":null,"has_home_services":null,"ironbank_category":"Food & Beverage","legal_restriction":false,"number_of_reviews":2043,"return_attributes":{"frequency_of_return":"Parity"},"selected_offer_id":"AC8C51F0396B4072B53EDABAA1DF222B","short_description":"Experience the perfect combination of sweetness and crispness with our Fresh Rockit Miniature Apples. Naturally grown to be miniature, these apples are rich in flavor and high in energy. Ideal for snacking, baking, and adding a burst of taste to salads or charcuterie boards. Enjoy the benefits of consuming fewer calories with just two apples totaling 70 calories. Packaged sustainably in 80% rPET containers that can be recycled, it's a great choice for conscious consumers who value freshness and environmental responsibility. Available while stocks last.","tire_speed_rating":null,"top_boosted_offer":{"offer_id":null,"seller_id":null,"date_string":null,"seller_name":null,"price_string":null,"display_price":null,"shipping_cost":null,"fulfillment_promise":null},"wfs_provider_name":null,"early_access_event":false,"preowned_condition":"New","primary_product_id":null,"primary_us_item_id":null,"shipping_cost_type":null,"abstract_product_id":null,"availability_status":"IN_STOCK","buy_box_suppression":false,"fulfillment_options":[{"type":"SHIPPING","intent":true,"selected":false,"view_only":false,"__typename":"ShippingOptionV2","restricted":null,"order_limit":null,"location_text":"Sacramento, 95829","speed_details":null,"is_low_in_stock":null,"inventory_status":null,"availability_type":"CURRENT","available_quantity":null,"max_order_quantity":null,"availability_status":"NOT_AVAILABLE","subscription_submessage":"NONE"},{"type":"PICKUP","intent":false,"selected":true,"view_only":false,"__typename":"PickupOptionV2","store_name":null,"order_limit":12,"location_text":"Sacramento Supercenter","speed_details":{"is_express":false,"sla_in_mins":null,"express_type":null,"sla_day_enum":"TODAY","delivery_date":null,"earliest_slot":null,"store_timezone":"US/Pacific","min_sla_in_mins":null,"w_plus_eligible":false,"free_fulfillment":false,"fulfillment_badge":"Today","fulfillment_price":null,"max_delivery_date":"2026-06-24T15:00:00.000-07:00","store_delivery_date":"2026-06-24T15:00:00.000-07:00","has_fast_delivery_options":false,"delivery_date_iso_with_time_offset":null,"max_delivery_date_iso_with_time_offset":null},"is_low_in_stock":false,"inventory_status":null,"location_address":null,"product_location":[{"display_value":"AP6"}],"available_quantity":null,"max_order_quantity":12,"availability_status":"IN_STOCK","subscription_submessage":"NONE","check_store_availability":false},{"type":"DELIVERY","intent":false,"selected":false,"view_only":false,"__typename":"DeliveryOptionV2","restricted":false,"order_limit":12,"delivery_tier":null,"location_text":"Sacramento, 95829","speed_details":{"is_express":true,"sla_in_mins":23,"express_type":null,"sla_day_enum":"TODAY","delivery_date":null,"store_timezone":"US/Pacific","min_sla_in_mins":13,"w_plus_eligible":false,"free_fulfillment":false,"fulfillment_badge":"Today","fulfillment_price":{"price":7.95,"price_string":null},"max_delivery_date":null,"store_delivery_date":"2026-06-24T15:00:00.000-07:00","has_fast_delivery_options":true,"delivery_date_iso_with_time_offset":null,"max_delivery_date_iso_with_time_offset":null},"drone_eligible":false,"is_low_in_stock":false,"available_quantity":null,"max_order_quantity":12,"availability_status":"IN_STOCK","subscription_submessage":"NONE"}],"fulfillment_summary":[{"sla":{"rank":1,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":true,"fulfillment":"DELIVERY","regular_sla":null,"delivery_date":null,"store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":null,"is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null},{"sla":{"rank":2,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":true,"fulfillment":"DELIVERY","regular_sla":null,"delivery_date":null,"store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":null,"is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null},{"sla":{"rank":3,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":false,"fulfillment":"DELIVERY","regular_sla":null,"delivery_date":"2026-06-24T22:00:00.000Z","store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":"2026-06-24T23:00:00.000Z","is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null},{"sla":{"rank":1,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":false,"fulfillment":"PICKUP","regular_sla":null,"delivery_date":"2026-06-24T22:00:00.000Z","store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":"2026-06-24T23:00:00.000Z","is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null}],"gifting_eligibility":false,"is_lmp_alcohol_item":false,"product_disclaimers":[],"seller_display_name":"Walmart.com","seller_review_count":null,"show_buy_with_wplus":false,"special_cta_context":"","special_instruction":false,"static_message_type":"UNKNOWN","associated_bundle_id":null,"flower_delivery_info":[],"is_early_access_item":false,"selected_variant_ids":[],"shipping_restriction":false,"show_add_on_services":true,"hide_atc_for_services":false,"is_lmp_alcohol_seller":false,"secondary_offer_price":{"tax_info":null,"current_price":{"price":8.99,"price_type":null,"price_string":"$8.99"}},"seller_average_rating":null,"show_fulfillment_link":false,"subscription_eligible":true,"additional_offer_count":null,"availability_status_v2":{"value":"IN_STOCK","display":"In stock"},"is_get_it_now_eligible":false,"seller_store_front_url":null,"tobacco_static_mesages":[],"variant_product_id_map":{},"is_native1_p_egift_card":null,"manufacturer_product_id":"313056097","new_condition_product_id":null,"transactable_offer_count":1,"wireless_third_party_url":null,"display_offer_level_image":false,"availability_in_nearby_store":null,"check_store_availability_atc":false,"available_fulfillment_options":["SCHEDULED_PICKUP","SCHEDULED_DELIVERY"],"check_availability_global_dfs":false,"item_page_availability_status":"IN_STOCK","max_reward_among_all_variants":null,"show_highlights_seller_rating":false,"fulfillment_type_classification":"PERISHABLE","is_part_of_low_return_rate_test":false,"special_order_quantity_eligible":true,"show_explore_other_conditions_cta":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Walmart Product","description":"Extract full Walmart product page (PDP) data from a /ip/ URL: pricing, ratings, images, fulfillment, specs, badges, and availability via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-walmart-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Walmart product page URL.\n\n**Example:**\n\n    https://www.walmart.com/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096\n\n**Notes:**\n- The URL must point to a Walmart product detail page containing `/ip/` in the path.\n- The numeric ID at the end of the URL is the Walmart `us_item_id`.\n- Copy the full URL from walmart.com (including query params if present).\n- Walmart PDP data is loaded via JavaScript; this endpoint uses browser rendering.","schema":{"type":"string","description":"Full Walmart product page URL.\n\n**Example:**\n\n    https://www.walmart.com/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096\n\n**Notes:**\n- The URL must point to a Walmart product detail page containing `/ip/` in the path.\n- The numeric ID at the end of the URL is the Walmart `us_item_id`.\n- Copy the full URL from walmart.com (including query params if present).\n- Walmart PDP data is loaded via JavaScript; this endpoint uses browser rendering."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"pac":{"nullable":true},"upc":{"type":"string"},"esrb":{"nullable":true},"idml":{"type":"object","properties":{"videos":{"nullable":true},"warranty":{"nullable":true},"drug_guide":{"nullable":true},"esrb_rating":{"nullable":true},"ingredients":{"type":"object","properties":{"ingredients":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"active_ingredients":{"nullable":true},"inactive_ingredients":{"nullable":true},"active_ingredient_name":{"nullable":true}}},"mpaa_rating":{"nullable":true},"size_charts":{"nullable":true},"infographics":{"nullable":true},"social_media":{"nullable":true},"ar_experience":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"gen_ai_details":{"type":"object","properties":{"gen_ai_concise_summary":{"nullable":true},"gen_ai_description_bullet":{"nullable":true}}},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"choking_hazards":{"nullable":true},"enriched360_spin":{"nullable":true},"long_description":{"type":"string"},"short_description":{"type":"string"},"product_highlights":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"icon_url":{"nullable":true}}}},"has_marketing_description":{"type":"boolean"},"interactive_product_video":{"nullable":true},"interactive_product_assets":{"nullable":true},"product360_image_container":{"nullable":true}}},"name":{"type":"string"},"type":{"type":"string"},"brand":{"type":"string"},"model":{"nullable":true},"badges":{"type":"object","properties":{"tags":{"type":"array","items":{}},"flags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"rank":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string"},"query":{"type":"string"},"style_id":{"type":"string"},"__typename":{"type":"string"}}}},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"rank":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string"},"icon_id":{"type":"string"},"sla_date":{"nullable":true},"sla_text":{"nullable":true},"style_id":{"type":"string"},"action_id":{"type":"string"},"__typename":{"type":"string"},"member_type":{"type":"string"},"text_values":{"nullable":true},"sla_date_iso":{"nullable":true},"badge_content":{"nullable":true},"text_template":{"nullable":true}}}},"__typename":{"type":"string"}}}},"labels":{"nullable":true},"groups_v2":{"type":"array","items":{"type":"object","properties":{"pos":{"type":"string"},"flow":{"type":"string"},"name":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"mem_id":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"url":{"nullable":true},"type":{"type":"string"},"value":{"type":"string"},"style_id":{"type":"string"},"action_id":{"nullable":true},"cont_desc":{"nullable":true},"action_content":{"nullable":true}}}},"mem_type":{"type":"string"},"mem_style_id":{"type":"string"},"content_variants":{"nullable":true}}}}}}}}},"ebooks":{"nullable":true},"gender":{"nullable":true},"pet_rx":{"type":"object","properties":{"eligible":{"type":"boolean"},"single_dispense":{"nullable":true}}},"vision":{"type":"object","properties":{"age_group":{"nullable":true},"vision_center_approved":{"type":"boolean"}}},"is_byod":{"type":"boolean"},"rewards":{"nullable":true},"rh_path":{"type":"string"},"category":{"type":"object","properties":{"path":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"category_path_id":{"type":"string"}}},"class_id":{"type":"string"},"location":{"type":"object","properties":{"city":{"type":"string"},"intent":{"type":"string"},"store_ids":{"type":"array","items":{"type":"string"}},"address_id":{"nullable":true},"postal_code":{"type":"string"},"pickup_location":{"type":"object","properties":{"store_id":{"type":"string"},"access_type":{"nullable":true},"access_point_id":{"nullable":true}}},"mp_pickup_location":{"nullable":true},"state_or_province_code":{"type":"string"}}},"offer_id":{"type":"string"},"redirect":{"type":"object","properties":{"replaced_by_item_id":{"type":"string"},"replaced_by_product_id":{"type":"string"},"replaced_by_product_url_text":{"type":"string"}}},"show_atc":{"type":"boolean"},"variants":{"type":"array","items":{}},"brand_url":{"type":"string"},"discounts":{"type":"object","properties":{"discounted_value":{"nullable":true},"discount_meta_data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"price":{"type":"object","properties":{"price":{"nullable":true},"price_string":{"nullable":true},"price_display":{"type":"string"}}},"savings":{"type":"object","properties":{"amount":{"nullable":true},"percent":{"nullable":true},"price_string":{"type":"string"}}},"unit_price":{"type":"object","properties":{"price":{"nullable":true},"price_string":{"nullable":true}}},"comparison_price":{"type":"object","properties":{"price":{"nullable":true},"price_string":{"nullable":true}}},"unit_price_display_condition":{"nullable":true}}}}}},"image_map":{"type":"object","properties":{}},"item_type":{"nullable":true},"lang_urls":{"nullable":true},"mhmd_flag":{"type":"boolean"},"pre_order":{"type":"object","properties":{"is_pre_order":{"type":"boolean"},"release_date":{"nullable":true}}},"seller_id":{"type":"string"},"tire_size":{"nullable":true},"viscosity":{"nullable":true},"blitz_item":{"nullable":true},"claim_rate":{"nullable":true},"class_type":{"type":"string"},"image_info":{"type":"object","properties":{"all_images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"zoomable":{"type":"boolean"}}}},"thumbnail_url":{"type":"string"},"thumbnail_aspect_ratio":{"type":"string"}}},"offer_type":{"type":"string"},"price_info":{"type":"object","properties":{"savings":{"nullable":true},"cap_type":{"nullable":true},"tax_info":{"nullable":true},"was_price":{"nullable":true},"base_price":{"nullable":true},"drop_price":{"type":"boolean"},"list_price":{"nullable":true},"ship_price":{"nullable":true},"unit_price":{"type":"object","properties":{"price":{"type":"number"},"best_value":{"nullable":true},"price_string":{"type":"string"},"support_text":{"nullable":true},"currency_unit":{"type":"string"},"variant_price_string":{"nullable":true}}},"price_range":{"type":"object","properties":{"max_price":{"nullable":true},"min_price":{"nullable":true},"price_string":{"nullable":true},"currency_unit":{"nullable":true},"denominations":{"nullable":true}}},"current_price":{"type":"object","properties":{"price":{"type":"number"},"best_value":{"nullable":true},"price_string":{"type":"string"},"support_text":{"nullable":true},"currency_unit":{"type":"string"},"price_display":{"type":"string"},"variant_price_string":{"type":"string"}}},"savings_amount":{"nullable":true},"additional_fees":{"type":"object","properties":{"duty_fee":{"type":"object","properties":{"price":{"type":"integer"},"price_string":{"type":"string"}}},"country_name":{"nullable":true},"estimated_total_price":{"type":"object","properties":{"price":{"type":"number"},"price_string":{"type":"string"}}},"shipping_and_import_fee":{"type":"object","properties":{"price":{"type":"integer"},"price_string":{"type":"string"}}},"gift_card_margin_and_fee":{"nullable":true}}},"comparison_price":{"nullable":true},"is_price_reduced":{"type":"boolean"},"subscription_price":{"nullable":true},"volume_price_tiers":{"type":"array","items":{}},"price_display_codes":{"type":"object","properties":{"rollback":{"nullable":true},"clearance":{"nullable":true},"submap_type":{"nullable":true},"is_b2_b_price":{"type":"boolean"},"reduced_price":{"nullable":true},"price_display_type":{"type":"string"},"price_per_unit_uom":{"type":"string"},"final_cost_by_weight":{"nullable":true},"price_display_condition":{"nullable":true},"eligible_for_associate_discount":{"type":"boolean"}}},"price_reduced_display":{"nullable":true},"secondary_offer_boost":{"nullable":true},"walmart_funded_amount":{"nullable":true},"w_plus_early_access_price":{"nullable":true}}},"promo_data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"terms":{"type":"string"},"metadata":{"type":"string"},"description":{"type":"string"},"template_data":{"type":"object","properties":{"flag_type":{"nullable":true},"image_url":{"type":"string"},"apr_string":{"nullable":true},"price_string":{"nullable":true},"finance_data_promotion_type":{"nullable":true}}},"installments_promotion":{"nullable":true},"no_interest_installments_promotion":{"nullable":true}}}},"sales_unit":{"type":"string"},"ship_as_is":{"type":"boolean"},"us_item_id":{"type":"string"},"e_gift_card":{"nullable":true},"is_preowned":{"type":"boolean"},"is_qsr_item":{"type":"boolean"},"order_limit":{"type":"integer"},"seller_name":{"type":"string"},"seller_type":{"type":"string"},"wfs_enabled":{"type":"boolean"},"zeekit_data":{"nullable":true},"annual_event":{"nullable":true},"collectibles":{"nullable":true},"condition_v2":{"type":"object","properties":{"code":{"type":"integer"},"group_code":{"type":"integer"}}},"item_type_v2":{"type":"string"},"lmp_eligible":{"type":"boolean"},"member_limit":{"nullable":true},"subscription":{"type":"object","properties":{"subscription_eligible":{"type":"boolean"},"subscription_submessage":{"type":"string"},"show_subscription_module":{"type":"boolean"},"subscription_transactable":{"type":"boolean"}}},"trust_badges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"nullable":true}}}},"variants_map":{"type":"object","properties":{}},"aaia_brand_id":{"nullable":true},"canonical_url":{"type":"string"},"external_info":{"nullable":true},"grading_label":{"type":"string"},"is_collection":{"type":"boolean"},"is_qsr_seller":{"type":"boolean"},"pickup_option":{"type":"object","properties":{"sla_tier":{"nullable":true},"store_id":{"nullable":true},"store_name":{"nullable":true},"access_types":{"type":"array","items":{"type":"string"}},"availability_status":{"type":"string"}}},"primary_offer":{"type":"object","properties":{"warranty":{"nullable":true}}},"return_policy":{"type":"object","properties":{"returnable":{"type":"boolean"},"free_returns":{"type":"boolean"},"return_window":{"type":"object","properties":{"value":{"type":"integer"},"unit_type":{"type":"string"}}},"return_location":{"type":"string"},"return_policy_text":{"type":"string"},"return_policy_type":{"type":"string"},"returnable_to_store":{"type":"boolean"},"holiday_return_enabled":{"type":"boolean"},"return_policy_condition":{"nullable":true},"return_policy_text_code":{"type":"object","properties":{"code":{"type":"string"},"data":{"nullable":true}}},"return_policy_clarity_text":{"type":"string"},"return_policy_clarity_text_more":{"nullable":true}}},"snap_eligible":{"type":"boolean"},"average_rating":{"type":"number"},"condition_type":{"type":"string"},"has_care_plans":{"type":"boolean"},"motor_oil_type":{"nullable":true},"personalizable":{"type":"boolean"},"promo_discount":{"nullable":true},"promo_eligible":{"type":"boolean"},"sem_store_data":{"nullable":true},"shipping_price":{"nullable":true},"show_condition":{"type":"boolean"},"top_promo_text":{"nullable":true},"add_on_services":{"nullable":true},"can_add_to_list":{"type":"boolean"},"experience_type":{"nullable":true},"group_meta_data":{"nullable":true},"is_customizable":{"type":"boolean"},"is_wplus_member":{"type":"boolean"},"order_min_limit":{"type":"integer"},"pet_rx_eligible":{"nullable":true},"product_type_id":{"type":"string"},"seller_logo_url":{"nullable":true},"shipping_option":{"type":"object","properties":{"sla_tier":{"nullable":true},"ship_price":{"nullable":true},"ship_method":{"nullable":true},"delivery_date":{"nullable":true},"max_delivery_date":{"nullable":true},"availability_status":{"type":"string"},"international_shipping":{"nullable":true}}},"tire_load_index":{"nullable":true},"buy_now_eligible":{"type":"boolean"},"condition_offers":{"type":"array","items":{"type":"object","properties":{"price":{"type":"object","properties":{"price":{"type":"number"},"price_string":{"type":"string"}}},"offer_id":{"type":"string"},"condition":{"type":"object","properties":{"code":{"type":"integer"},"text":{"type":"string"},"group_code":{"type":"integer"},"group_text":{"type":"string"}}},"more_conditions":{"nullable":true},"top_boosted_offer":{"nullable":true},"availability_status":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}}}}},"event_attributes":{"type":"object","properties":{"price_flip":{"type":"boolean"},"special_buy":{"type":"boolean"}}},"fsa_eligible_ind":{"type":"boolean"},"fulfillment_type":{"type":"string"},"has_seller_badge":{"nullable":true},"is_free_warranty":{"type":"boolean"},"is_replenishable":{"type":"boolean"},"ozark_attributes":{"type":"object","properties":{"exact_address":{"type":"boolean"},"shipping_promise":{"nullable":true}}},"primary_shelf_id":{"type":"string"},"product_location":{"type":"array","items":{"type":"object","properties":{"display_value":{"type":"string"}}}},"secondary_offers":{"type":"array","items":{}},"special_cta_type":{"type":"string"},"suppress_reviews":{"type":"boolean"},"variant_criteria":{"type":"array","items":{}},"weight_increment":{"type":"integer"},"wireless_carrier":{"type":"string"},"catalog_seller_id":{"type":"integer"},"fulfillment_badge":{"nullable":true},"fulfillment_label":{"type":"array","items":{"type":"object","properties":{"sla":{"nullable":true},"message":{"type":"string"},"postal_code":{"nullable":true},"delivery_date":{"nullable":true},"location_text":{"type":"string"},"shipping_text":{"type":"string"},"fulfillment_text":{"type":"string"},"fulfillment_type":{"type":"string"},"fulfillment_method":{"type":"string"},"address_eligibility":{"type":"boolean"},"w_plus_fulfillment_text":{"nullable":true},"check_store_availability":{"nullable":true}}}},"fulfillment_title":{"type":"string"},"grading_type_code":{"nullable":true},"has_home_services":{"nullable":true},"ironbank_category":{"type":"string"},"legal_restriction":{"type":"boolean"},"number_of_reviews":{"type":"integer"},"return_attributes":{"type":"object","properties":{"frequency_of_return":{"type":"string"}}},"selected_offer_id":{"type":"string"},"short_description":{"type":"string"},"tire_speed_rating":{"nullable":true},"top_boosted_offer":{"type":"object","properties":{"offer_id":{"nullable":true},"seller_id":{"nullable":true},"date_string":{"nullable":true},"seller_name":{"nullable":true},"price_string":{"nullable":true},"display_price":{"nullable":true},"shipping_cost":{"nullable":true},"fulfillment_promise":{"nullable":true}}},"wfs_provider_name":{"nullable":true},"early_access_event":{"type":"boolean"},"preowned_condition":{"type":"string"},"primary_product_id":{"nullable":true},"primary_us_item_id":{"nullable":true},"shipping_cost_type":{"nullable":true},"abstract_product_id":{"nullable":true},"availability_status":{"type":"string"},"buy_box_suppression":{"type":"boolean"},"fulfillment_options":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"intent":{"type":"boolean"},"selected":{"type":"boolean"},"view_only":{"type":"boolean"},"__typename":{"type":"string"},"restricted":{"nullable":true},"order_limit":{"nullable":true},"location_text":{"type":"string"},"speed_details":{"nullable":true},"is_low_in_stock":{"nullable":true},"inventory_status":{"nullable":true},"availability_type":{"type":"string"},"available_quantity":{"nullable":true},"max_order_quantity":{"nullable":true},"availability_status":{"type":"string"},"subscription_submessage":{"type":"string"}}}},"fulfillment_summary":{"type":"array","items":{"type":"object","properties":{"sla":{"type":"object","properties":{"rank":{"type":"integer"},"unit_of_measure":{"type":"string"},"measurement_value":{"type":"integer"}}},"store_id":{"type":"string"},"is_express":{"type":"boolean"},"fulfillment":{"type":"string"},"regular_sla":{"nullable":true},"delivery_date":{"nullable":true},"store_timezone":{"nullable":true},"fulfillment_badge":{"nullable":true},"fulfillment_price":{"nullable":true},"max_delivery_date":{"nullable":true},"is_free_for_w_plus":{"nullable":true},"calculated_sla_days":{"type":"integer"},"fulfillment_methods":{"type":"array","items":{"type":"string"}},"store_delivery_date":{"nullable":true},"fulfillment_discount":{"nullable":true},"out_of_country_eligible":{"nullable":true},"store_max_delivery_date":{"nullable":true}}}},"gifting_eligibility":{"type":"boolean"},"is_lmp_alcohol_item":{"type":"boolean"},"product_disclaimers":{"type":"array","items":{}},"seller_display_name":{"type":"string"},"seller_review_count":{"nullable":true},"show_buy_with_wplus":{"type":"boolean"},"special_cta_context":{"type":"string"},"special_instruction":{"type":"boolean"},"static_message_type":{"type":"string"},"associated_bundle_id":{"nullable":true},"flower_delivery_info":{"type":"array","items":{}},"is_early_access_item":{"type":"boolean"},"selected_variant_ids":{"type":"array","items":{}},"shipping_restriction":{"type":"boolean"},"show_add_on_services":{"type":"boolean"},"hide_atc_for_services":{"type":"boolean"},"is_lmp_alcohol_seller":{"type":"boolean"},"secondary_offer_price":{"type":"object","properties":{"tax_info":{"nullable":true},"current_price":{"type":"object","properties":{"price":{"type":"number"},"price_type":{"nullable":true},"price_string":{"type":"string"}}}}},"seller_average_rating":{"nullable":true},"show_fulfillment_link":{"type":"boolean"},"subscription_eligible":{"type":"boolean"},"additional_offer_count":{"nullable":true},"availability_status_v2":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}},"is_get_it_now_eligible":{"type":"boolean"},"seller_store_front_url":{"nullable":true},"tobacco_static_mesages":{"type":"array","items":{}},"variant_product_id_map":{"type":"object","properties":{}},"is_native1_p_egift_card":{"nullable":true},"manufacturer_product_id":{"type":"string"},"new_condition_product_id":{"nullable":true},"transactable_offer_count":{"type":"integer"},"wireless_third_party_url":{"nullable":true},"display_offer_level_image":{"type":"boolean"},"availability_in_nearby_store":{"nullable":true},"check_store_availability_atc":{"type":"boolean"},"available_fulfillment_options":{"type":"array","items":{"type":"string"}},"check_availability_global_dfs":{"type":"boolean"},"item_page_availability_status":{"type":"string"},"max_reward_among_all_variants":{"nullable":true},"show_highlights_seller_rating":{"type":"boolean"},"fulfillment_type_classification":{"type":"string"},"is_part_of_low_return_rate_test":{"type":"boolean"},"special_order_quantity_eligible":{"type":"boolean"},"show_explore_other_conditions_cta":{"type":"boolean"}}},"examples":{"Fresh Rockit Apples 3lb Tub":{"value":{"id":"40KH71FS6S1U","pac":null,"upc":"888289403510","esrb":null,"idml":{"videos":null,"warranty":null,"drug_guide":null,"esrb_rating":null,"ingredients":{"ingredients":{"name":"Ingredients","value":"Fresh Produce"},"active_ingredients":null,"inactive_ingredients":null,"active_ingredient_name":null},"mpaa_rating":null,"size_charts":null,"infographics":null,"social_media":null,"ar_experience":[{"name":"Augmented Reality Experiences","values":["{\"ar_eligible\":\"true\",\"ar_enabled\":\"false\",\"ar_experiencetype_info\":{\"version\":\"2.0\",\"platforms\":{}},\"requestId\":\"6d13d9ca-be65-4b30-aaf6-aafcaac4d47a\",\"offerings\":{\"enriched_media\":{\"id\":\"050c7ab0-3142-49c7-b4cf-7c24ee411482\",\"enabled\":true}}}"]}],"gen_ai_details":{"gen_ai_concise_summary":null,"gen_ai_description_bullet":null},"specifications":[{"name":"Plant variety","value":"Rockit"},{"name":"Average sold by weight","value":"3 Pounds"},{"name":"Food condition","value":"Fresh"},{"name":"Container type","value":"Tub"},{"name":"Food form","value":"Whole"},{"name":"Product net content parent","value":"3 Pound"},{"name":"Brand","value":"Rock It"}],"choking_hazards":null,"enriched360_spin":null,"long_description":"<ul>  <li>Sweet, crisp and juicy with every bite</li>  <li>Conveniently sized for on-the-go snacking</li>  <li>Perfect as a healthy treat or seasonal baking ingredient</li>  <li>Excellent source of fiber and vitamin C</li>  <li>Two apples = 70 calories</li>  <li>80% rPET packaging that can be upcycled or recycled</li>  <li>Adds flavor to a variety of recipes</li>  <li>Fresh and ready-to-eat food condition</li>  <li>Includes Rockit plant variety for a unique taste</li> </ul>","short_description":"Experience the perfect combination of sweetness and crispness with our Fresh Rockit Miniature Apples. Naturally grown to be miniature, these apples are rich in flavor and high in energy. Ideal for snacking, baking, and adding a burst of taste to salads or charcuterie boards. Enjoy the benefits of consuming fewer calories with just two apples totaling 70 calories. Packaged sustainably in 80% rPET containers that can be recycled, it's a great choice for conscious consumers who value freshness and environmental responsibility. Available while stocks last.","product_highlights":[{"name":"Plant variety","value":"Rockit","icon_url":null},{"name":"Average sold by weight","value":"3 Pounds","icon_url":null},{"name":"Food condition","value":"Fresh","icon_url":null},{"name":"Container type","value":"Tub","icon_url":null},{"name":"Food form","value":"Whole","icon_url":null},{"name":"Product net content parent","value":"3 Pound","icon_url":null}],"has_marketing_description":false,"interactive_product_video":null,"interactive_product_assets":null,"product360_image_container":null},"name":"Fresh Rockit, Crisp Sweet Miniature Apples, 3lb Tub","type":"Apples","brand":"Rock It","model":null,"badges":{"tags":[],"flags":[{"id":"L1200","key":"CUSTOMER_PICK","rank":1,"text":"Overall pick","type":"LABEL","query":"mini apples","style_id":"PRIMARY_BLUE_BOLD","__typename":"BaseBadge"}],"groups":[{"name":"benefits","members":[{"id":"L1033","key":"SNAP_ELIGIBLE","rank":1,"text":"SNAP EBT eligible","type":"ICON","icon_id":"CreditCard","sla_date":null,"sla_text":null,"style_id":"EBT_STYLE","action_id":"SNAP","__typename":"BadgeGroupMember","member_type":"badge","text_values":null,"sla_date_iso":null,"badge_content":null,"text_template":null}],"__typename":"UnifiedBadgeGroup"}],"labels":null,"groups_v2":[{"pos":"ItemPageBadgeModule2","flow":"HORIZONTAL","name":"flags","members":[{"mem_id":"L1200","content":[{"url":null,"type":"TEXT","value":"Overall pick","style_id":"WHITE_BOLD","action_id":null,"cont_desc":null,"action_content":null}],"mem_type":"badge","mem_style_id":"PRIMARY_PRUSSIANBLUE_MR4","content_variants":null}]}]},"ebooks":null,"gender":null,"pet_rx":{"eligible":false,"single_dispense":null},"vision":{"age_group":null,"vision_center_approved":false},"is_byod":false,"rewards":null,"rh_path":"40000:46000:46001:46104:46231","category":{"path":[{"url":"/cp/food/976759","name":"Food"},{"url":"/cp/fresh-produce/976793","name":"Fresh Produce"},{"url":"/cp/fresh-fruits/9756351","name":"Fresh Fruits"},{"url":"/cp/apples/7796396","name":"Apples"}],"category_path_id":"0:976759:976793:9756351:7796396"},"class_id":"1","location":{"city":"Sacramento","intent":"SHIPPING","store_ids":["3081"],"address_id":null,"postal_code":"95829","pickup_location":{"store_id":"3081","access_type":null,"access_point_id":null},"mp_pickup_location":null,"state_or_province_code":"CA"},"offer_id":"AC8C51F0396B4072B53EDABAA1DF222B","redirect":{"replaced_by_item_id":"","replaced_by_product_id":"","replaced_by_product_url_text":""},"show_atc":true,"variants":[],"brand_url":"/search?q=Rock+It&facet=brand:Rock+It","discounts":{"discounted_value":null,"discount_meta_data":[{"id":"wplus_subscription","type":"wplus_subscription","price":{"price":null,"price_string":null,"price_display":"Now est. $ null "},"savings":{"amount":null,"percent":null,"price_string":"$ null "},"unit_price":{"price":null,"price_string":null},"comparison_price":{"price":null,"price_string":null},"unit_price_display_condition":null}]},"image_map":{},"item_type":null,"lang_urls":null,"mhmd_flag":false,"pre_order":{"is_pre_order":false,"release_date":null},"seller_id":"F55CDC31AB754BB68FE0B39041159D63","tire_size":null,"viscosity":null,"blitz_item":null,"claim_rate":null,"class_type":"REGULAR","image_info":{"all_images":[{"id":"832D3DF0CE174E1799E84513215B1D18","url":"https://i5.walmartimages.com/seo/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub_de6d6d44-507a-43e4-9bd9-d86286473870.4d6dbcb5c200885859982510d4314077.jpeg","zoomable":true},{"id":"AC0D7F45DD8C4C8984FCE3B92DD2080E","url":"https://i5.walmartimages.com/asr/1ebc2554-b285-4ab4-a21c-3c57ccf601a6.98459edf6aa1850e39ff23051c3d4365.jpeg","zoomable":true},{"id":"F57FD3779D134D0D9E41B1222B043D0D","url":"https://i5.walmartimages.com/asr/3f5d03f8-f6dc-435f-a3cc-7963632e0d33.6072f6e0b48d303e9f1f150b72868e9c.jpeg","zoomable":true},{"id":"BE49A2839C654AEAAD7DCF6004B6C8E8","url":"https://i5.walmartimages.com/asr/8918ad26-64f7-4ba0-86fd-85e68824b13a.c5faccb05a2f04616c2db3556d38e10c.jpeg","zoomable":true},{"id":"DB003140BD8448B68423EC445B6CBC3F","url":"https://i5.walmartimages.com/asr/358e5fe9-60e5-4208-9496-f463afe5654e.36d169879e0ae07c407c784600a5f9ba.jpeg","zoomable":true},{"id":"9A5972B65EE9408B91C71997227CF0C0","url":"https://i5.walmartimages.com/asr/5e9a9e92-c609-47e5-a1a0-9cafcd631c81.76082eba161ce1894eea0e78f393c1cd.jpeg","zoomable":true}],"thumbnail_url":"https://i5.walmartimages.com/seo/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub_de6d6d44-507a-43e4-9bd9-d86286473870.4d6dbcb5c200885859982510d4314077.jpeg","thumbnail_aspect_ratio":"1:1"},"offer_type":"STORE_ONLY","price_info":{"savings":null,"cap_type":null,"tax_info":null,"was_price":null,"base_price":null,"drop_price":false,"list_price":null,"ship_price":null,"unit_price":{"price":2.99,"best_value":null,"price_string":"$2.99/lb","support_text":null,"currency_unit":"USD","variant_price_string":null},"price_range":{"max_price":null,"min_price":null,"price_string":null,"currency_unit":null,"denominations":null},"current_price":{"price":8.97,"best_value":null,"price_string":"$8.97","support_text":null,"currency_unit":"USD","price_display":"$8.97","variant_price_string":"$8.97"},"savings_amount":null,"additional_fees":{"duty_fee":{"price":0,"price_string":"$0.00"},"country_name":null,"estimated_total_price":{"price":8.97,"price_string":"$8.97"},"shipping_and_import_fee":{"price":0,"price_string":"$0.00"},"gift_card_margin_and_fee":null},"comparison_price":null,"is_price_reduced":false,"subscription_price":null,"volume_price_tiers":[],"price_display_codes":{"rollback":null,"clearance":null,"submap_type":null,"is_b2_b_price":false,"reduced_price":null,"price_display_type":"UNKNOWN","price_per_unit_uom":"LB","final_cost_by_weight":null,"price_display_condition":null,"eligible_for_associate_discount":true},"price_reduced_display":null,"secondary_offer_boost":null,"walmart_funded_amount":null,"w_plus_early_access_price":null},"promo_data":[{"id":"8885f40c-8096-4686-83f1-5bf460f97952","type":"1PAYCC","terms":"walmart://onecreditcard/landing?source=itemPage&utm_content=WMD-CRD-ITBD&showconfirmationonsuccess=true","metadata":"{\"ipmSlotId\":\"1\",\"type\":\"1PAYCC\",\"image\":\"https://i5.walmartimages.com/dfwrs/76316474-4b44/k2-_7221675a-6d36-4e9f-81a5-27dd4d84bf0b.v1.png\",\"finance_type\":\"interest\",\"altImage\":\"https://i5.walmartimages.com/dfwrs/76316474-4b44/k2-_7221675a-6d36-4e9f-81a5-27dd4d84bf0b.v1.png\"}","description":"Earn up to <b>5% cash back</b> with OnePay CashRewards.","template_data":{"flag_type":null,"image_url":"https://i5.walmartimages.com/dfwrs/76316474-4b44/k2-_7221675a-6d36-4e9f-81a5-27dd4d84bf0b.v1.png","apr_string":null,"price_string":null,"finance_data_promotion_type":null},"installments_promotion":null,"no_interest_installments_promotion":null}],"sales_unit":"EACH","ship_as_is":false,"us_item_id":"309762096","e_gift_card":null,"is_preowned":false,"is_qsr_item":false,"order_limit":12,"seller_name":"Walmart.com","seller_type":"INTERNAL","wfs_enabled":false,"zeekit_data":null,"annual_event":null,"collectibles":null,"condition_v2":{"code":1,"group_code":1},"item_type_v2":"UNKNOWN","lmp_eligible":false,"member_limit":null,"subscription":{"subscription_eligible":true,"subscription_submessage":"NONE","show_subscription_module":true,"subscription_transactable":true},"trust_badges":[{"type":"FREE_RETURN","subtype":null},{"type":"PICKUP","subtype":null},{"type":"SOLD_BY_WALMART","subtype":null}],"variants_map":{},"aaia_brand_id":null,"canonical_url":"/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096","external_info":null,"grading_label":"New","is_collection":false,"is_qsr_seller":false,"pickup_option":{"sla_tier":null,"store_id":null,"store_name":null,"access_types":["PICKUP_CURBSIDE"],"availability_status":"AVAILABLE"},"primary_offer":{"warranty":null},"return_policy":{"returnable":true,"free_returns":true,"return_window":{"value":90,"unit_type":"Day"},"return_location":"store","return_policy_text":"Free 90-day returns","return_policy_type":"seamless","returnable_to_store":true,"holiday_return_enabled":false,"return_policy_condition":null,"return_policy_text_code":{"code":"PRODUCT_RETURN_WINDOW","data":null},"return_policy_clarity_text":"Free 90-day returns - in store or online","return_policy_clarity_text_more":null},"snap_eligible":false,"average_rating":4.4,"condition_type":"New","has_care_plans":false,"motor_oil_type":null,"personalizable":false,"promo_discount":null,"promo_eligible":false,"sem_store_data":null,"shipping_price":null,"show_condition":false,"top_promo_text":null,"add_on_services":null,"can_add_to_list":true,"experience_type":null,"group_meta_data":null,"is_customizable":false,"is_wplus_member":false,"order_min_limit":1,"pet_rx_eligible":null,"product_type_id":"ib_apples","seller_logo_url":null,"shipping_option":{"sla_tier":null,"ship_price":null,"ship_method":null,"delivery_date":null,"max_delivery_date":null,"availability_status":"AVAILABLE","international_shipping":null},"tire_load_index":null,"buy_now_eligible":false,"condition_offers":[{"price":{"price":8.97,"price_string":"$8.97"},"offer_id":"AC8C51F0396B4072B53EDABAA1DF222B","condition":{"code":1,"text":"New","group_code":1,"group_text":"New"},"more_conditions":null,"top_boosted_offer":null,"availability_status":{"value":"IN_STOCK","display":"In stock"}}],"event_attributes":{"price_flip":false,"special_buy":false},"fsa_eligible_ind":false,"fulfillment_type":"STORE","has_seller_badge":null,"is_free_warranty":false,"is_replenishable":true,"ozark_attributes":{"exact_address":false,"shipping_promise":null},"primary_shelf_id":"7796396","product_location":[{"display_value":"AP6"}],"secondary_offers":[],"special_cta_type":"UNKNOWN","suppress_reviews":false,"variant_criteria":[],"weight_increment":1,"wireless_carrier":"","catalog_seller_id":0,"fulfillment_badge":null,"fulfillment_label":[{"sla":null,"message":"Pickup, today at Sacramento Supercenter","postal_code":null,"delivery_date":null,"location_text":"Sacramento Supercenter","shipping_text":"Pickup","fulfillment_text":"today","fulfillment_type":"STORE","fulfillment_method":"PICKUP","address_eligibility":false,"w_plus_fulfillment_text":null,"check_store_availability":null},{"sla":null,"message":"Delivery from store","postal_code":null,"delivery_date":null,"location_text":null,"shipping_text":"Delivery from store","fulfillment_text":null,"fulfillment_type":"STORE","fulfillment_method":"DELIVERY","address_eligibility":true,"w_plus_fulfillment_text":null,"check_store_availability":null}],"fulfillment_title":"title_store_delivery_curbside_pickup","grading_type_code":null,"has_home_services":null,"ironbank_category":"Food & Beverage","legal_restriction":false,"number_of_reviews":2043,"return_attributes":{"frequency_of_return":"Parity"},"selected_offer_id":"AC8C51F0396B4072B53EDABAA1DF222B","short_description":"Experience the perfect combination of sweetness and crispness with our Fresh Rockit Miniature Apples. Naturally grown to be miniature, these apples are rich in flavor and high in energy. Ideal for snacking, baking, and adding a burst of taste to salads or charcuterie boards. Enjoy the benefits of consuming fewer calories with just two apples totaling 70 calories. Packaged sustainably in 80% rPET containers that can be recycled, it's a great choice for conscious consumers who value freshness and environmental responsibility. Available while stocks last.","tire_speed_rating":null,"top_boosted_offer":{"offer_id":null,"seller_id":null,"date_string":null,"seller_name":null,"price_string":null,"display_price":null,"shipping_cost":null,"fulfillment_promise":null},"wfs_provider_name":null,"early_access_event":false,"preowned_condition":"New","primary_product_id":null,"primary_us_item_id":null,"shipping_cost_type":null,"abstract_product_id":null,"availability_status":"IN_STOCK","buy_box_suppression":false,"fulfillment_options":[{"type":"SHIPPING","intent":true,"selected":false,"view_only":false,"__typename":"ShippingOptionV2","restricted":null,"order_limit":null,"location_text":"Sacramento, 95829","speed_details":null,"is_low_in_stock":null,"inventory_status":null,"availability_type":"CURRENT","available_quantity":null,"max_order_quantity":null,"availability_status":"NOT_AVAILABLE","subscription_submessage":"NONE"},{"type":"PICKUP","intent":false,"selected":true,"view_only":false,"__typename":"PickupOptionV2","store_name":null,"order_limit":12,"location_text":"Sacramento Supercenter","speed_details":{"is_express":false,"sla_in_mins":null,"express_type":null,"sla_day_enum":"TODAY","delivery_date":null,"earliest_slot":null,"store_timezone":"US/Pacific","min_sla_in_mins":null,"w_plus_eligible":false,"free_fulfillment":false,"fulfillment_badge":"Today","fulfillment_price":null,"max_delivery_date":"2026-06-24T15:00:00.000-07:00","store_delivery_date":"2026-06-24T15:00:00.000-07:00","has_fast_delivery_options":false,"delivery_date_iso_with_time_offset":null,"max_delivery_date_iso_with_time_offset":null},"is_low_in_stock":false,"inventory_status":null,"location_address":null,"product_location":[{"display_value":"AP6"}],"available_quantity":null,"max_order_quantity":12,"availability_status":"IN_STOCK","subscription_submessage":"NONE","check_store_availability":false},{"type":"DELIVERY","intent":false,"selected":false,"view_only":false,"__typename":"DeliveryOptionV2","restricted":false,"order_limit":12,"delivery_tier":null,"location_text":"Sacramento, 95829","speed_details":{"is_express":true,"sla_in_mins":23,"express_type":null,"sla_day_enum":"TODAY","delivery_date":null,"store_timezone":"US/Pacific","min_sla_in_mins":13,"w_plus_eligible":false,"free_fulfillment":false,"fulfillment_badge":"Today","fulfillment_price":{"price":7.95,"price_string":null},"max_delivery_date":null,"store_delivery_date":"2026-06-24T15:00:00.000-07:00","has_fast_delivery_options":true,"delivery_date_iso_with_time_offset":null,"max_delivery_date_iso_with_time_offset":null},"drone_eligible":false,"is_low_in_stock":false,"available_quantity":null,"max_order_quantity":12,"availability_status":"IN_STOCK","subscription_submessage":"NONE"}],"fulfillment_summary":[{"sla":{"rank":1,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":true,"fulfillment":"DELIVERY","regular_sla":null,"delivery_date":null,"store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":null,"is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null},{"sla":{"rank":2,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":true,"fulfillment":"DELIVERY","regular_sla":null,"delivery_date":null,"store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":null,"is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null},{"sla":{"rank":3,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":false,"fulfillment":"DELIVERY","regular_sla":null,"delivery_date":"2026-06-24T22:00:00.000Z","store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":"2026-06-24T23:00:00.000Z","is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null},{"sla":{"rank":1,"unit_of_measure":"DAY","measurement_value":0},"store_id":"3081","is_express":false,"fulfillment":"PICKUP","regular_sla":null,"delivery_date":"2026-06-24T22:00:00.000Z","store_timezone":null,"fulfillment_badge":null,"fulfillment_price":null,"max_delivery_date":"2026-06-24T23:00:00.000Z","is_free_for_w_plus":null,"calculated_sla_days":0,"fulfillment_methods":["SCHEDULED"],"store_delivery_date":null,"fulfillment_discount":null,"out_of_country_eligible":null,"store_max_delivery_date":null}],"gifting_eligibility":false,"is_lmp_alcohol_item":false,"product_disclaimers":[],"seller_display_name":"Walmart.com","seller_review_count":null,"show_buy_with_wplus":false,"special_cta_context":"","special_instruction":false,"static_message_type":"UNKNOWN","associated_bundle_id":null,"flower_delivery_info":[],"is_early_access_item":false,"selected_variant_ids":[],"shipping_restriction":false,"show_add_on_services":true,"hide_atc_for_services":false,"is_lmp_alcohol_seller":false,"secondary_offer_price":{"tax_info":null,"current_price":{"price":8.99,"price_type":null,"price_string":"$8.99"}},"seller_average_rating":null,"show_fulfillment_link":false,"subscription_eligible":true,"additional_offer_count":null,"availability_status_v2":{"value":"IN_STOCK","display":"In stock"},"is_get_it_now_eligible":false,"seller_store_front_url":null,"tobacco_static_mesages":[],"variant_product_id_map":{},"is_native1_p_egift_card":null,"manufacturer_product_id":"313056097","new_condition_product_id":null,"transactable_offer_count":1,"wireless_third_party_url":null,"display_offer_level_image":false,"availability_in_nearby_store":null,"check_store_availability_atc":false,"available_fulfillment_options":["SCHEDULED_PICKUP","SCHEDULED_DELIVERY"],"check_availability_global_dfs":false,"item_page_availability_status":"IN_STOCK","max_reward_among_all_variants":null,"show_highlights_seller_rating":false,"fulfillment_type_classification":"PERISHABLE","is_part_of_low_return_rate_test":false,"special_order_quantity_eligible":true,"show_explore_other_conditions_cta":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bestbuy/product":{"get":{"summary":"Best Buy Product","description":"Get a Best Buy US or Canada product page: title, price, brand, stock, images, categories and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-bestbuy-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Best Buy product URL.\n\n**Examples:**\n\n```\nhttps://www.bestbuy.com/product/gigabyte-aero-x16-copilot-pc-165hz-wqxga-rtx-5070-ryzen-ai-7-350-1tb-ssd-16gb-ddr5-windows-11-lunar-white/J3GWPQC2RQ\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/produit/machine-a-espresso-automatique-800-de-philips-avec-moussoir-a-lait-noir-mat-exclusivite-best-buy/16691494\n```","schema":{"type":"string","description":"Full Best Buy product URL.\n\n**Examples:**\n\n```\nhttps://www.bestbuy.com/product/gigabyte-aero-x16-copilot-pc-165hz-wqxga-rtx-5070-ryzen-ai-7-350-1tb-ssd-16gb-ddr5-windows-11-lunar-white/J3GWPQC2RQ\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/produit/machine-a-espresso-automatique-800-de-philips-avec-moussoir-a-lait-noir-mat-exclusivite-best-buy/16691494\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"categories":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"GIGABYTE AERO X16 (US)":{"value":{"sku":"11377127","url":"https://www.bestbuy.com/product/gigabyte-aero-x16-copilot-pc-165hz-wqxga-rtx-5070-ryzen-ai-7-350-1tb-ssd-16gb-ddr5-windows-11-lunar-white/J3GWPQC2RQ","brand":"GIGABYTE","price":1932.49,"title":"GIGABYTE - AERO X16 Copilot+ PC - 165Hz WQXGA - RTX 5070 - Ryzen AI 7 350 - 1TB SSD 16GB DDR5 - Windows 11 - Lunar White","images":["https://pisces.bbystatic.com/image2/BestBuy_US/images/products/sample.jpg"],"region":"com","currency":"USD","in_stock":true,"categories":["Computers & Tablets","Laptops","All Laptops","Windows Laptops"],"product_id":"J3GWPQC2RQ","specifications":[{"name":"Screen Size","value":"16.0 inches"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Best Buy Product","description":"Get a Best Buy US or Canada product page: title, price, brand, stock, images, categories and specs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-bestbuy-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Best Buy product URL.\n\n**Examples:**\n\n```\nhttps://www.bestbuy.com/product/gigabyte-aero-x16-copilot-pc-165hz-wqxga-rtx-5070-ryzen-ai-7-350-1tb-ssd-16gb-ddr5-windows-11-lunar-white/J3GWPQC2RQ\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/produit/machine-a-espresso-automatique-800-de-philips-avec-moussoir-a-lait-noir-mat-exclusivite-best-buy/16691494\n```","schema":{"type":"string","description":"Full Best Buy product URL.\n\n**Examples:**\n\n```\nhttps://www.bestbuy.com/product/gigabyte-aero-x16-copilot-pc-165hz-wqxga-rtx-5070-ryzen-ai-7-350-1tb-ssd-16gb-ddr5-windows-11-lunar-white/J3GWPQC2RQ\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/produit/machine-a-espresso-automatique-800-de-philips-avec-moussoir-a-lait-noir-mat-exclusivite-best-buy/16691494\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"categories":{"type":"array","items":{"type":"string"}},"product_id":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"GIGABYTE AERO X16 (US)":{"value":{"sku":"11377127","url":"https://www.bestbuy.com/product/gigabyte-aero-x16-copilot-pc-165hz-wqxga-rtx-5070-ryzen-ai-7-350-1tb-ssd-16gb-ddr5-windows-11-lunar-white/J3GWPQC2RQ","brand":"GIGABYTE","price":1932.49,"title":"GIGABYTE - AERO X16 Copilot+ PC - 165Hz WQXGA - RTX 5070 - Ryzen AI 7 350 - 1TB SSD 16GB DDR5 - Windows 11 - Lunar White","images":["https://pisces.bbystatic.com/image2/BestBuy_US/images/products/sample.jpg"],"region":"com","currency":"USD","in_stock":true,"categories":["Computers & Tablets","Laptops","All Laptops","Windows Laptops"],"product_id":"J3GWPQC2RQ","specifications":[{"name":"Screen Size","value":"16.0 inches"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/bestbuy/search":{"get":{"summary":"Best Buy Search","description":"Search Best Buy US or Canada by keyword or search URL. Returns product listings with price, rating and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-bestbuy-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Best Buy search URL.\n\n**Examples:**\n\n```\nmachine\n```\n\n```\nhttps://www.bestbuy.com/site/searchpage.jsp?st=machine\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/chercher?search=machine\n```\n\nA full Best Buy URL auto-detects `region`.","schema":{"type":"string","description":"Keyword or full Best Buy search URL.\n\n**Examples:**\n\n```\nmachine\n```\n\n```\nhttps://www.bestbuy.com/site/searchpage.jsp?st=machine\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/chercher?search=machine\n```\n\nA full Best Buy URL auto-detects `region`."}},{"name":"region","in":"query","required":false,"description":"Best Buy country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.bestbuy.com, USD\n- `ca` → www.bestbuy.ca, CAD","schema":{"type":"string","description":"Best Buy country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.bestbuy.com, USD\n- `ca` → www.bestbuy.ca, CAD"}},{"name":"page","in":"query","required":false,"description":"Page number (default: `1`).","schema":{"type":"number","description":"Page number (default: `1`)."}},{"name":"sort","in":"query","required":false,"description":"Sort order (default: `best_selling`).\n\n**Supported:** `best_selling`, `best_discount`","schema":{"type":"string","default":"best_selling","description":"Sort order (default: `best_selling`).\n\n**Supported:** `best_selling`, `best_discount`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Keyword machine (US)":{"value":{"results":[{"url":"https://www.bestbuy.com/product/singing-machine-smk302pp-kids-bluetooth-headphones-pink-collectibles-multicolor/J7GW9JWXZ5","type":"product","price":29.99,"title":"Singing Machine - SMK302PP Kids Bluetooth Headphones Pink - COLLECTIBLES - Multicolor","currency":"USD","condition":"new","image_url":"https://pisces.bbystatic.com/image2/BestBuy_US/images/products/014a6bfe-fd8a-413d-a204-49efbdb9baaa.jpg","product_id":"J7GW9JWXZ5"}],"pagination":{"next":2,"page":1,"per_page":18,"total_pages":763,"has_next_page":true,"total_results":13730}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Best Buy Search","description":"Search Best Buy US or Canada by keyword or search URL. Returns product listings with price, rating and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-bestbuy-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Best Buy search URL.\n\n**Examples:**\n\n```\nmachine\n```\n\n```\nhttps://www.bestbuy.com/site/searchpage.jsp?st=machine\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/chercher?search=machine\n```\n\nA full Best Buy URL auto-detects `region`.","schema":{"type":"string","description":"Keyword or full Best Buy search URL.\n\n**Examples:**\n\n```\nmachine\n```\n\n```\nhttps://www.bestbuy.com/site/searchpage.jsp?st=machine\n```\n\n```\nhttps://www.bestbuy.ca/fr-ca/chercher?search=machine\n```\n\nA full Best Buy URL auto-detects `region`."}},{"name":"region","in":"query","required":false,"description":"Best Buy country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.bestbuy.com, USD\n- `ca` → www.bestbuy.ca, CAD","schema":{"type":"string","description":"Best Buy country when `query` is not a full URL (default: `com`).\n\n**Supported:**\n- `com` → www.bestbuy.com, USD\n- `ca` → www.bestbuy.ca, CAD"}},{"name":"page","in":"query","required":false,"description":"Page number (default: `1`).","schema":{"type":"number","description":"Page number (default: `1`)."}},{"name":"sort","in":"query","required":false,"description":"Sort order (default: `best_selling`).\n\n**Supported:** `best_selling`, `best_discount`","schema":{"type":"string","default":"best_selling","description":"Sort order (default: `best_selling`).\n\n**Supported:** `best_selling`, `best_discount`"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return rendered HTML as `{\"result\": \"...\"}` instead of JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Keyword machine (US)":{"value":{"results":[{"url":"https://www.bestbuy.com/product/singing-machine-smk302pp-kids-bluetooth-headphones-pink-collectibles-multicolor/J7GW9JWXZ5","type":"product","price":29.99,"title":"Singing Machine - SMK302PP Kids Bluetooth Headphones Pink - COLLECTIBLES - Multicolor","currency":"USD","condition":"new","image_url":"https://pisces.bbystatic.com/image2/BestBuy_US/images/products/014a6bfe-fd8a-413d-a204-49efbdb9baaa.jpg","product_id":"J7GW9JWXZ5"}],"pagination":{"next":2,"page":1,"per_page":18,"total_pages":763,"has_next_page":true,"total_results":13730}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/carrefour/product":{"get":{"summary":"Carrefour Product","description":"Read one Carrefour.fr product from its page URL. Every product returns the same keys: price, brand, pack size, Nutriscore, categories, unit price, and customer reviews.\n\n**Credit cost:** 2 credits per call","operationId":"get-carrefour-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product page URL on www.carrefour.fr. The path starts with `/p/`.\n\n**Example:**\n\n```\nhttps://www.carrefour.fr/p/oeufs-de-caille-le-gaulois-3266980075934\n```\n\nA search URL or another website returns 400. The response keys stay the same on every product.","schema":{"type":"string","description":"Product page URL on www.carrefour.fr. The path starts with `/p/`.\n\n**Example:**\n\n```\nhttps://www.carrefour.fr/p/oeufs-de-caille-le-gaulois-3266980075934\n```\n\nA search URL or another website returns 400. The response keys stay the same on every product."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"contact":{"type":"object","properties":{"consumer":{"type":"object","properties":{"email":{"nullable":true},"phone":{"type":"string"},"address":{"type":"string"},"website":{"type":"string"},"company_name":{"type":"string"}}},"operator":{"type":"object","properties":{"email":{"nullable":true},"phone":{"nullable":true},"address":{"type":"string"},"website":{"nullable":true},"company_name":{"type":"string"}}}}},"currency":{"type":"string"},"features":{"type":"object","properties":{"nom_legal":{"type":"string"},"ingredients":{"type":"string"},"valeurs_nutritionnelles":{"type":"object","properties":{"sel":{"type":"string"},"sucres":{"type":"string"},"glucides":{"type":"string"},"proteines":{"type":"string"},"matieres_grasses":{"type":"string"},"acides_gras_satures":{"type":"string"},"valeur_energetique_kj":{"type":"string"},"valeur_energetique_kcal":{"type":"string"}}}}},"packaging":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"level":{"type":"integer"}}}},"nutriscore":{"type":"string"},"more_offers":{"type":"object","properties":{"count":{"type":"integer"},"best_offer_id":{"nullable":true},"best_offer_price":{"nullable":true}}},"price_float":{"type":"number"},"short_title":{"type":"string"},"business_type":{"type":"string"},"is_best_seller":{"type":"boolean"},"price_per_unit":{"type":"string"},"customer_reviews":{"type":"object","properties":{"count":{"type":"integer"},"rates":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}},"average":{"type":"integer"}}},"price_per_unit_float":{"type":"number"},"price_per_unit_measure":{"type":"string"},"price_per_unit_currency":{"type":"string"}}},"examples":{"Crème fraîche épaisse légère 15% MG Bridelice":{"value":{"brand":"BRIDELICE","image":"https://media.carrefour.fr/media/referential/media/401fcdeffbdc46d69f04f16ff1c15acd/p_1500x1500/03155251205425_H1N1_s02.png","price":"1,99€","title":"Crème Fraiche Épaisse Légère 15% MG BRIDELICE","contact":{"consumer":{"email":null,"phone":"09 70 82 11 25","address":"- F 53089 LAVAL Cedex 9 53089 LAVAL Cedex 9","website":"service.consommateurs@jevousremercie.fr","company_name":"BRIDELICE"},"operator":{"email":null,"phone":null,"address":"15 Rue de l'Etang Z.A. Les Placis 35230 BOURGBARRE","website":null,"company_name":"LACTALIS BEURRES ET CREMES"}},"currency":"€","features":{"nom_legal":"Crème légère à 15% M.G.","ingredients":"Ingrédients : Crème légère (97%) (LAIT) (origine France), amidon modifié, ferments lactiques (LAIT).","valeurs_nutritionnelles":{"sel":"0.03 g / 25 g","sucres":"1 g / 25 g","glucides":"1.5 g / 25 g","proteines":"0.6 g / 25 g","matieres_grasses":"3.8 g / 25 g","acides_gras_satures":"2.5 g / 25 g","valeur_energetique_kj":"175 kJ / 25 g","valeur_energetique_kcal":"42 kcal / 25 g"}},"packaging":"le pot de 50 cl","categories":[{"id":"36993","slug":"cremerie","label":"Crèmerie et Produits laitiers","level":1},{"id":"36997","slug":"beurres-cremes","label":"Beurres et Crèmes","level":2},{"id":"28140","slug":"cremes-epaisses","label":"Crèmes épaisses","level":3}],"nutriscore":"O","more_offers":{"count":0,"best_offer_id":null,"best_offer_price":null},"price_float":1.99,"short_title":"Crème Fraiche Épaisse Légère 15% MG BRIDELICE","business_type":"food","is_best_seller":false,"price_per_unit":"3.98 € / L","customer_reviews":{"count":4,"rates":{"1":0,"2":0,"3":0,"4":0,"5":100},"average":5},"price_per_unit_float":3.98,"price_per_unit_measure":"L","price_per_unit_currency":"€"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Carrefour Product","description":"Read one Carrefour.fr product from its page URL. Every product returns the same keys: price, brand, pack size, Nutriscore, categories, unit price, and customer reviews.\n\n**Credit cost:** 2 credits per call","operationId":"post-carrefour-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product page URL on www.carrefour.fr. The path starts with `/p/`.\n\n**Example:**\n\n```\nhttps://www.carrefour.fr/p/oeufs-de-caille-le-gaulois-3266980075934\n```\n\nA search URL or another website returns 400. The response keys stay the same on every product.","schema":{"type":"string","description":"Product page URL on www.carrefour.fr. The path starts with `/p/`.\n\n**Example:**\n\n```\nhttps://www.carrefour.fr/p/oeufs-de-caille-le-gaulois-3266980075934\n```\n\nA search URL or another website returns 400. The response keys stay the same on every product."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"contact":{"type":"object","properties":{"consumer":{"type":"object","properties":{"email":{"nullable":true},"phone":{"type":"string"},"address":{"type":"string"},"website":{"type":"string"},"company_name":{"type":"string"}}},"operator":{"type":"object","properties":{"email":{"nullable":true},"phone":{"nullable":true},"address":{"type":"string"},"website":{"nullable":true},"company_name":{"type":"string"}}}}},"currency":{"type":"string"},"features":{"type":"object","properties":{"nom_legal":{"type":"string"},"ingredients":{"type":"string"},"valeurs_nutritionnelles":{"type":"object","properties":{"sel":{"type":"string"},"sucres":{"type":"string"},"glucides":{"type":"string"},"proteines":{"type":"string"},"matieres_grasses":{"type":"string"},"acides_gras_satures":{"type":"string"},"valeur_energetique_kj":{"type":"string"},"valeur_energetique_kcal":{"type":"string"}}}}},"packaging":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"level":{"type":"integer"}}}},"nutriscore":{"type":"string"},"more_offers":{"type":"object","properties":{"count":{"type":"integer"},"best_offer_id":{"nullable":true},"best_offer_price":{"nullable":true}}},"price_float":{"type":"number"},"short_title":{"type":"string"},"business_type":{"type":"string"},"is_best_seller":{"type":"boolean"},"price_per_unit":{"type":"string"},"customer_reviews":{"type":"object","properties":{"count":{"type":"integer"},"rates":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}},"average":{"type":"integer"}}},"price_per_unit_float":{"type":"number"},"price_per_unit_measure":{"type":"string"},"price_per_unit_currency":{"type":"string"}}},"examples":{"Crème fraîche épaisse légère 15% MG Bridelice":{"value":{"brand":"BRIDELICE","image":"https://media.carrefour.fr/media/referential/media/401fcdeffbdc46d69f04f16ff1c15acd/p_1500x1500/03155251205425_H1N1_s02.png","price":"1,99€","title":"Crème Fraiche Épaisse Légère 15% MG BRIDELICE","contact":{"consumer":{"email":null,"phone":"09 70 82 11 25","address":"- F 53089 LAVAL Cedex 9 53089 LAVAL Cedex 9","website":"service.consommateurs@jevousremercie.fr","company_name":"BRIDELICE"},"operator":{"email":null,"phone":null,"address":"15 Rue de l'Etang Z.A. Les Placis 35230 BOURGBARRE","website":null,"company_name":"LACTALIS BEURRES ET CREMES"}},"currency":"€","features":{"nom_legal":"Crème légère à 15% M.G.","ingredients":"Ingrédients : Crème légère (97%) (LAIT) (origine France), amidon modifié, ferments lactiques (LAIT).","valeurs_nutritionnelles":{"sel":"0.03 g / 25 g","sucres":"1 g / 25 g","glucides":"1.5 g / 25 g","proteines":"0.6 g / 25 g","matieres_grasses":"3.8 g / 25 g","acides_gras_satures":"2.5 g / 25 g","valeur_energetique_kj":"175 kJ / 25 g","valeur_energetique_kcal":"42 kcal / 25 g"}},"packaging":"le pot de 50 cl","categories":[{"id":"36993","slug":"cremerie","label":"Crèmerie et Produits laitiers","level":1},{"id":"36997","slug":"beurres-cremes","label":"Beurres et Crèmes","level":2},{"id":"28140","slug":"cremes-epaisses","label":"Crèmes épaisses","level":3}],"nutriscore":"O","more_offers":{"count":0,"best_offer_id":null,"best_offer_price":null},"price_float":1.99,"short_title":"Crème Fraiche Épaisse Légère 15% MG BRIDELICE","business_type":"food","is_best_seller":false,"price_per_unit":"3.98 € / L","customer_reviews":{"count":4,"rates":{"1":0,"2":0,"3":0,"4":0,"5":100},"average":5},"price_per_unit_float":3.98,"price_per_unit_measure":"L","price_per_unit_currency":"€"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/carrefour/search":{"get":{"summary":"Carrefour Search","description":"Search for products on Carrefour by keyword or URL, returning structured listings with prices, ratings, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-carrefour-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Carrefour search page URL.\n\n**Accepted formats:**\n- `pomme`: keyword search\n- `https://www.carrefour.fr/s?q=pomme`: full search URL\n\n**Example:**\n\n    pomme\n\n**Note:** Only `carrefour.fr` is currently supported.","schema":{"type":"string","description":"Search keyword or full Carrefour search page URL.\n\n**Accepted formats:**\n- `pomme`: keyword search\n- `https://www.carrefour.fr/s?q=pomme`: full search URL\n\n**Example:**\n\n    pomme\n\n**Note:** Only `carrefour.fr` is currently supported."}},{"name":"domain","in":"query","required":false,"description":"Carrefour domain to search on.\n\n- `fr`: carrefour.fr (default, only supported domain)\n\n**Note:** Only the `fr` domain is currently supported.","schema":{"type":"string","default":"fr","description":"Carrefour domain to search on.\n\n- `fr`: carrefour.fr (default, only supported domain)\n\n**Note:** Only the `fr` domain is currently supported."}},{"name":"page","in":"query","required":false,"description":"Page number to retrieve.\n\n**Example:** Pass `2` to retrieve the second page of results.","schema":{"type":"number","default":"1","description":"Page number to retrieve.\n\n**Example:** Pass `2` to retrieve the second page of results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"sponsored":{"type":"boolean"},"price_float":{"type":"number"},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for pasta (panzani)":{"value":{"results":[{"id":"3038350023605","slug":"pates-torti-panzani-3038350023605","image":"https://media.carrefour.fr/medias/b55716bc4b4a43abae8126835fdda61e/p_200x200/03038350023605_H1N1_s01.png","price":"1,95€","title":"Pâtes torti PANZANI","rating":4.5,"currency":"€","sponsored":false,"price_float":1.95,"reviews_count":523},{"id":"3038350013507","slug":"pates-coudes-rayes-panzani-3038350013507","image":"https://media.carrefour.fr/medias/7aadb8b182ed458c919dca3b560d82a2/p_200x200/03038350013507_H1N1_s01.png","price":"1,19€","title":"Pâtes coudes rayés PANZANI","rating":4.5,"currency":"€","sponsored":false,"price_float":1.19,"reviews_count":400},{"id":"3038350023001","slug":"pates-coquillettes-panzani-3038350023001","image":"https://media.carrefour.fr/medias/22a129b9d98d4254ae50af77adb0aa14/p_200x200/03038350023001_H1N1_s01.png","price":"1,95€","title":"Pâtes coquillettes PANZANI","rating":4.5,"currency":"€","sponsored":false,"price_float":1.95,"reviews_count":702}],"pagination":{"next":2,"current":1,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Carrefour Search","description":"Search for products on Carrefour by keyword or URL, returning structured listings with prices, ratings, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-carrefour-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Carrefour search page URL.\n\n**Accepted formats:**\n- `pomme`: keyword search\n- `https://www.carrefour.fr/s?q=pomme`: full search URL\n\n**Example:**\n\n    pomme\n\n**Note:** Only `carrefour.fr` is currently supported.","schema":{"type":"string","description":"Search keyword or full Carrefour search page URL.\n\n**Accepted formats:**\n- `pomme`: keyword search\n- `https://www.carrefour.fr/s?q=pomme`: full search URL\n\n**Example:**\n\n    pomme\n\n**Note:** Only `carrefour.fr` is currently supported."}},{"name":"domain","in":"query","required":false,"description":"Carrefour domain to search on.\n\n- `fr`: carrefour.fr (default, only supported domain)\n\n**Note:** Only the `fr` domain is currently supported.","schema":{"type":"string","default":"fr","description":"Carrefour domain to search on.\n\n- `fr`: carrefour.fr (default, only supported domain)\n\n**Note:** Only the `fr` domain is currently supported."}},{"name":"page","in":"query","required":false,"description":"Page number to retrieve.\n\n**Example:** Pass `2` to retrieve the second page of results.","schema":{"type":"number","default":"1","description":"Page number to retrieve.\n\n**Example:** Pass `2` to retrieve the second page of results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"sponsored":{"type":"boolean"},"price_float":{"type":"number"},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search for pasta (panzani)":{"value":{"results":[{"id":"3038350023605","slug":"pates-torti-panzani-3038350023605","image":"https://media.carrefour.fr/medias/b55716bc4b4a43abae8126835fdda61e/p_200x200/03038350023605_H1N1_s01.png","price":"1,95€","title":"Pâtes torti PANZANI","rating":4.5,"currency":"€","sponsored":false,"price_float":1.95,"reviews_count":523},{"id":"3038350013507","slug":"pates-coudes-rayes-panzani-3038350013507","image":"https://media.carrefour.fr/medias/7aadb8b182ed458c919dca3b560d82a2/p_200x200/03038350013507_H1N1_s01.png","price":"1,19€","title":"Pâtes coudes rayés PANZANI","rating":4.5,"currency":"€","sponsored":false,"price_float":1.19,"reviews_count":400},{"id":"3038350023001","slug":"pates-coquillettes-panzani-3038350023001","image":"https://media.carrefour.fr/medias/22a129b9d98d4254ae50af77adb0aa14/p_200x200/03038350023001_H1N1_s01.png","price":"1,95€","title":"Pâtes coquillettes PANZANI","rating":4.5,"currency":"€","sponsored":false,"price_float":1.95,"reviews_count":702}],"pagination":{"next":2,"current":1,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/carrefour/suggest":{"get":{"summary":"Carrefour Suggest","description":"Get product suggestions from Carrefour by keyword or EAN, returning matching products with pricing, availability, and product details.\n\n**Credit cost:** 1 credit per call","operationId":"get-carrefour-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or EAN code to get product suggestions from Carrefour.\n\n**Accepted formats:**\n- `coca`: keyword (e.g. brand name, product type)\n- `3276550063551`: EAN barcode\n\n**Example (keyword):**\n\n    coca\n\n**Example (EAN):**\n\n    3276550063551\n\n**Note:** Only `carrefour.fr` is currently supported.","schema":{"type":"string","description":"Search keyword or EAN code to get product suggestions from Carrefour.\n\n**Accepted formats:**\n- `coca`: keyword (e.g. brand name, product type)\n- `3276550063551`: EAN barcode\n\n**Example (keyword):**\n\n    coca\n\n**Example (EAN):**\n\n    3276550063551\n\n**Note:** Only `carrefour.fr` is currently supported."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"links":{"type":"object","properties":{"self":{"type":"string"},"reviews":{"type":"string"}}},"attributes":{"type":"object","properties":{"ean":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"title":{"type":"string"},"format":{"type":"string"},"offers":{"type":"object","properties":{"5000112611861":{"type":"object","properties":{"0261_150_6":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"ean":{"type":"string"},"price":{"type":"object","properties":{"price":{"type":"number"},"perunit":{"type":"number"},"perunitlabel":{"type":"string"},"unitofmeasure":{"type":"string"}}},"availability":{"type":"object","properties":{"purchasable":{"type":"boolean"}}}}}}}}}}},"packaging":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"level":{"type":"integer"}}}},"nutriscore":{"nullable":true},"shorttitle":{"type":"string"},"businesstype":{"type":"string"},"customerreviews":{"type":"object","properties":{"count":{"type":"integer"},"rates":{"nullable":true},"average":{"type":"number"}}}}}}}}}},"examples":{"Suggest by keyword 'coca'":{"value":{"results":[{"id":"product-5000112611861","type":"product","links":{"self":"/p/soda-au-cola-gout-original-coca-cola-5000112611861","reviews":"/product/5000112611861/reviews"},"attributes":{"ean":"5000112611861","slug":"soda-au-cola-gout-original-coca-cola","brand":"COCA-COLA","title":"Soda au Cola Goût Original COCA-COLA","format":"1,75L","offers":{"5000112611861":{"0261_150_6":{"id":"0261-150-6","type":"offer","attributes":{"ean":"5000112611861","price":{"price":2.39,"perunit":1.37,"perunitlabel":"1.37 € / L","unitofmeasure":"L"},"availability":{"purchasable":true}}}}},"packaging":"la bouteille d'1,75L","categories":[{"id":"27070","slug":"boissons","label":"Boissons","level":1},{"id":"27073","slug":"colas-thes-glaces-et-soft-drinks","label":"Colas, Thés glacés, Sirops et Sodas","level":2}],"nutriscore":null,"shorttitle":"Soda au Cola Goût Original COCA-COLA","businesstype":"food","customerreviews":{"count":33,"rates":null,"average":4.79}}}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Carrefour Suggest","description":"Get product suggestions from Carrefour by keyword or EAN, returning matching products with pricing, availability, and product details.\n\n**Credit cost:** 1 credit per call","operationId":"post-carrefour-suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or EAN code to get product suggestions from Carrefour.\n\n**Accepted formats:**\n- `coca`: keyword (e.g. brand name, product type)\n- `3276550063551`: EAN barcode\n\n**Example (keyword):**\n\n    coca\n\n**Example (EAN):**\n\n    3276550063551\n\n**Note:** Only `carrefour.fr` is currently supported.","schema":{"type":"string","description":"Search keyword or EAN code to get product suggestions from Carrefour.\n\n**Accepted formats:**\n- `coca`: keyword (e.g. brand name, product type)\n- `3276550063551`: EAN barcode\n\n**Example (keyword):**\n\n    coca\n\n**Example (EAN):**\n\n    3276550063551\n\n**Note:** Only `carrefour.fr` is currently supported."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"links":{"type":"object","properties":{"self":{"type":"string"},"reviews":{"type":"string"}}},"attributes":{"type":"object","properties":{"ean":{"type":"string"},"slug":{"type":"string"},"brand":{"type":"string"},"title":{"type":"string"},"format":{"type":"string"},"offers":{"type":"object","properties":{"5000112611861":{"type":"object","properties":{"0261_150_6":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"ean":{"type":"string"},"price":{"type":"object","properties":{"price":{"type":"number"},"perunit":{"type":"number"},"perunitlabel":{"type":"string"},"unitofmeasure":{"type":"string"}}},"availability":{"type":"object","properties":{"purchasable":{"type":"boolean"}}}}}}}}}}},"packaging":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"label":{"type":"string"},"level":{"type":"integer"}}}},"nutriscore":{"nullable":true},"shorttitle":{"type":"string"},"businesstype":{"type":"string"},"customerreviews":{"type":"object","properties":{"count":{"type":"integer"},"rates":{"nullable":true},"average":{"type":"number"}}}}}}}}}},"examples":{"Suggest by keyword 'coca'":{"value":{"results":[{"id":"product-5000112611861","type":"product","links":{"self":"/p/soda-au-cola-gout-original-coca-cola-5000112611861","reviews":"/product/5000112611861/reviews"},"attributes":{"ean":"5000112611861","slug":"soda-au-cola-gout-original-coca-cola","brand":"COCA-COLA","title":"Soda au Cola Goût Original COCA-COLA","format":"1,75L","offers":{"5000112611861":{"0261_150_6":{"id":"0261-150-6","type":"offer","attributes":{"ean":"5000112611861","price":{"price":2.39,"perunit":1.37,"perunitlabel":"1.37 € / L","unitofmeasure":"L"},"availability":{"purchasable":true}}}}},"packaging":"la bouteille d'1,75L","categories":[{"id":"27070","slug":"boissons","label":"Boissons","level":1},{"id":"27073","slug":"colas-thes-glaces-et-soft-drinks","label":"Colas, Thés glacés, Sirops et Sodas","level":2}],"nutriscore":null,"shorttitle":"Soda au Cola Goût Original COCA-COLA","businesstype":"food","customerreviews":{"count":33,"rates":null,"average":4.79}}}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/cdiscount/product/offer":{"get":{"summary":"Cdiscount Product Offer","description":"Retrieve all marketplace seller offers for a Cdiscount product, including prices, seller ratings, shipping costs, and availability.\n\n**Credit cost:** 2 credits per call","operationId":"get-cdiscount-product-offer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Cdiscount product offer page URL. Pass the `multiple_offer_url` value returned by the Cdiscount Product API.\n\n**Example:**\n\n    https://www.cdiscount.com/mp-352880-auc3283981039048.html\n\n**How to get this URL:**\n- Call the Cdiscount Product API with any product URL.\n- Extract the `multiple_offer_url` field from the response.\n- Use that URL as the `query` parameter here.\n\n**Note:** Only URLs with the pattern `/mp-{id}-{ean}.html` are accepted. Regular product page URLs will not work.","schema":{"type":"string","description":"Cdiscount product offer page URL. Pass the `multiple_offer_url` value returned by the Cdiscount Product API.\n\n**Example:**\n\n    https://www.cdiscount.com/mp-352880-auc3283981039048.html\n\n**How to get this URL:**\n- Call the Cdiscount Product API with any product URL.\n- Extract the `multiple_offer_url` field from the response.\n- Use that URL as the `query` parameter here.\n\n**Note:** Only URLs with the pattern `/mp-{id}-{ean}.html` are accepted. Regular product page URLs will not work."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"seller":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"rating":{"type":"object","properties":{"rating":{"type":"number"},"reviews_count":{"type":"integer"},"score_percentage":{"type":"integer"}}},"sales_count":{"type":"integer"}}},"condition":{"type":"string"},"shipped_by":{"type":"string"},"availability":{"type":"string"},"delivery_time":{"type":"string"},"shipping_cost":{"type":"string"},"shipping_country":{"type":"string"}}}}}},"examples":{"Lookup offers by offer URL":{"value":{"results":[{"price":8.68,"seller":{"url":"https://www.cdiscount.com/mpv-1818-brico-travo.html","name":"brico-travo","type":"VENDEUR PRO","rating":{"rating":3.2,"reviews_count":249,"score_percentage":60},"sales_count":16152},"condition":"Neuf","shipped_by":"brico-travo","availability":"En Stock !","delivery_time":"Entre le 10/04 et le 15/04","shipping_cost":"6,99€","shipping_country":"FRANCE"},{"price":8.19,"seller":{"url":"https://www.cdiscount.com/mpv-406441-NMA.html","name":"NMA","type":"VENDEUR PRO","rating":{"rating":4.2,"reviews_count":6,"score_percentage":80},"sales_count":348},"condition":"Neuf","shipped_by":"NMA","availability":"En Stock !","delivery_time":"Entre le 02/04 et le 08/04","shipping_cost":"8,81€","shipping_country":"FRANCE"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Cdiscount Product Offer","description":"Retrieve all marketplace seller offers for a Cdiscount product, including prices, seller ratings, shipping costs, and availability.\n\n**Credit cost:** 2 credits per call","operationId":"post-cdiscount-product-offer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Cdiscount product offer page URL. Pass the `multiple_offer_url` value returned by the Cdiscount Product API.\n\n**Example:**\n\n    https://www.cdiscount.com/mp-352880-auc3283981039048.html\n\n**How to get this URL:**\n- Call the Cdiscount Product API with any product URL.\n- Extract the `multiple_offer_url` field from the response.\n- Use that URL as the `query` parameter here.\n\n**Note:** Only URLs with the pattern `/mp-{id}-{ean}.html` are accepted. Regular product page URLs will not work.","schema":{"type":"string","description":"Cdiscount product offer page URL. Pass the `multiple_offer_url` value returned by the Cdiscount Product API.\n\n**Example:**\n\n    https://www.cdiscount.com/mp-352880-auc3283981039048.html\n\n**How to get this URL:**\n- Call the Cdiscount Product API with any product URL.\n- Extract the `multiple_offer_url` field from the response.\n- Use that URL as the `query` parameter here.\n\n**Note:** Only URLs with the pattern `/mp-{id}-{ean}.html` are accepted. Regular product page URLs will not work."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"seller":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"rating":{"type":"object","properties":{"rating":{"type":"number"},"reviews_count":{"type":"integer"},"score_percentage":{"type":"integer"}}},"sales_count":{"type":"integer"}}},"condition":{"type":"string"},"shipped_by":{"type":"string"},"availability":{"type":"string"},"delivery_time":{"type":"string"},"shipping_cost":{"type":"string"},"shipping_country":{"type":"string"}}}}}},"examples":{"Lookup offers by offer URL":{"value":{"results":[{"price":8.68,"seller":{"url":"https://www.cdiscount.com/mpv-1818-brico-travo.html","name":"brico-travo","type":"VENDEUR PRO","rating":{"rating":3.2,"reviews_count":249,"score_percentage":60},"sales_count":16152},"condition":"Neuf","shipped_by":"brico-travo","availability":"En Stock !","delivery_time":"Entre le 10/04 et le 15/04","shipping_cost":"6,99€","shipping_country":"FRANCE"},{"price":8.19,"seller":{"url":"https://www.cdiscount.com/mpv-406441-NMA.html","name":"NMA","type":"VENDEUR PRO","rating":{"rating":4.2,"reviews_count":6,"score_percentage":80},"sales_count":348},"condition":"Neuf","shipped_by":"NMA","availability":"En Stock !","delivery_time":"Entre le 02/04 et le 08/04","shipping_cost":"8,81€","shipping_country":"FRANCE"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/cdiscount/product":{"get":{"summary":"Cdiscount Product","description":"Extract full product details from a Cdiscount product page, including price, seller, ratings, specifications, and offers.\n\n**Credit cost:** 2 credits per call","operationId":"get-cdiscount-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Cdiscount product page URL.\n\n**Example:**\n\n    https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html\n\n**Notes:**\n- Only standard Cdiscount product URLs are accepted (e.g. `/f-{category}-{id}.html`).\n- Offer comparison pages (`/mp-{id}-{ean}.html`) should be used with the Cdiscount Product Offer endpoint instead.","schema":{"type":"string","description":"Full Cdiscount product page URL.\n\n**Example:**\n\n    https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html\n\n**Notes:**\n- Only standard Cdiscount product URLs are accepted (e.g. `/f-{category}-{id}.html`).\n- Offer comparison pages (`/mp-{id}-{ean}.html`) should be used with the Cdiscount Product Offer endpoint instead."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"seller":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"rating":{"type":"integer"},"sales_count":{"type":"integer"},"reviews_count":{"type":"integer"}}},"is_cdav":{"type":"boolean"},"currency":{"type":"string"},"offer_id":{"type":"integer"},"condition":{"type":"string"},"description":{"type":"string"},"is_available":{"type":"boolean"},"other_offers":{"type":"object","properties":{"total_offers":{"type":"integer"},"lowest_price_new":{"type":"number"},"new_offers_count":{"type":"integer"},"lowest_price_used":{"nullable":true},"used_offers_count":{"type":"integer"}}},"delivery_info":{"type":"string"},"reviews_count":{"type":"integer"},"original_price":{"type":"number"},"multiple_offer_url":{"type":"string"},"multiple_offer_text":{"type":"string"},"multiple_offer_starting_price":{"type":"number"}}},"examples":{"Lookup ACEMAGIC gaming laptop":{"value":{"id":"aaaph06865","ean":"0683370375062","url":"https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html","brand":"ACEMAGIC","price":429.99,"title":"ACEMAGIC PC Portables Gaming - 15.6\" FHD, AMD Ryzen 7 5700U(8C/16T, 4,3GHz),16Go RAM DDR4, 512Go M.2 SSD, WiFi 6, BT5.2, HDMI,Gris","images":["https://www.cdiscount.com/pdt2/8/6/5/1/700x700/aaaph06865/rw/acemagic-pc-portables-gaming.jpg"],"rating":4,"seller":{"id":405259,"name":"BOOMING","rating":5,"sales_count":1847,"reviews_count":20},"is_cdav":true,"currency":"EUR","offer_id":4258700481,"condition":"Neuf","description":"Portable gaming AMD Ryzen 7 5700U, 16Go RAM, 512Go SSD.","is_available":true,"other_offers":{"total_offers":1,"lowest_price_new":459.9,"new_offers_count":1,"lowest_price_used":null,"used_offers_count":0},"delivery_info":"Livraison gratuite | Expédié depuis: FRANCE","reviews_count":2,"original_price":499.9,"multiple_offer_url":"https://www.cdiscount.com/mp-352880-auc3283981039048.html","multiple_offer_text":"2 offres neuves","multiple_offer_starting_price":9.24}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Cdiscount Product","description":"Extract full product details from a Cdiscount product page, including price, seller, ratings, specifications, and offers.\n\n**Credit cost:** 2 credits per call","operationId":"post-cdiscount-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Cdiscount product page URL.\n\n**Example:**\n\n    https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html\n\n**Notes:**\n- Only standard Cdiscount product URLs are accepted (e.g. `/f-{category}-{id}.html`).\n- Offer comparison pages (`/mp-{id}-{ean}.html`) should be used with the Cdiscount Product Offer endpoint instead.","schema":{"type":"string","description":"Full Cdiscount product page URL.\n\n**Example:**\n\n    https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html\n\n**Notes:**\n- Only standard Cdiscount product URLs are accepted (e.g. `/f-{category}-{id}.html`).\n- Offer comparison pages (`/mp-{id}-{ean}.html`) should be used with the Cdiscount Product Offer endpoint instead."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"ean":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"integer"},"seller":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"rating":{"type":"integer"},"sales_count":{"type":"integer"},"reviews_count":{"type":"integer"}}},"is_cdav":{"type":"boolean"},"currency":{"type":"string"},"offer_id":{"type":"integer"},"condition":{"type":"string"},"description":{"type":"string"},"is_available":{"type":"boolean"},"other_offers":{"type":"object","properties":{"total_offers":{"type":"integer"},"lowest_price_new":{"type":"number"},"new_offers_count":{"type":"integer"},"lowest_price_used":{"nullable":true},"used_offers_count":{"type":"integer"}}},"delivery_info":{"type":"string"},"reviews_count":{"type":"integer"},"original_price":{"type":"number"},"multiple_offer_url":{"type":"string"},"multiple_offer_text":{"type":"string"},"multiple_offer_starting_price":{"type":"number"}}},"examples":{"Lookup ACEMAGIC gaming laptop":{"value":{"id":"aaaph06865","ean":"0683370375062","url":"https://www.cdiscount.com/informatique/ordinateurs-pc-portables/acemagic-pc-portables-gaming/f-1070992-aaaph06865.html","brand":"ACEMAGIC","price":429.99,"title":"ACEMAGIC PC Portables Gaming - 15.6\" FHD, AMD Ryzen 7 5700U(8C/16T, 4,3GHz),16Go RAM DDR4, 512Go M.2 SSD, WiFi 6, BT5.2, HDMI,Gris","images":["https://www.cdiscount.com/pdt2/8/6/5/1/700x700/aaaph06865/rw/acemagic-pc-portables-gaming.jpg"],"rating":4,"seller":{"id":405259,"name":"BOOMING","rating":5,"sales_count":1847,"reviews_count":20},"is_cdav":true,"currency":"EUR","offer_id":4258700481,"condition":"Neuf","description":"Portable gaming AMD Ryzen 7 5700U, 16Go RAM, 512Go SSD.","is_available":true,"other_offers":{"total_offers":1,"lowest_price_new":459.9,"new_offers_count":1,"lowest_price_used":null,"used_offers_count":0},"delivery_info":"Livraison gratuite | Expédié depuis: FRANCE","reviews_count":2,"original_price":499.9,"multiple_offer_url":"https://www.cdiscount.com/mp-352880-auc3283981039048.html","multiple_offer_text":"2 offres neuves","multiple_offer_starting_price":9.24}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/crunchbase/search":{"get":{"summary":"Crunchbase Search","description":"Search Crunchbase for companies and people by keyword and retrieve their profiles and Crunchbase identifiers.\n\n**Credit cost:** 2 credits per call","operationId":"get-crunchbase-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search keyword or phrase to query across Crunchbase. Searches both organizations and people.\n\n**Examples:**\n\n- `openai`: Search by company name\n- `elon`: Search by person or company name\n- `fintech london`: Multi-word search\n\n**Note:** The response includes both `organization` and `person` type results. Use the `type` field in each result to distinguish them.\n\n**Example:**\n\n    openai","schema":{"type":"string","description":"The search keyword or phrase to query across Crunchbase. Searches both organizations and people.\n\n**Examples:**\n\n- `openai`: Search by company name\n- `elon`: Search by person or company name\n- `fintech london`: Multi-word search\n\n**Note:** The response includes both `organization` and `person` type results. Use the `type` field in each result to distinguish them.\n\n**Example:**\n\n    openai"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Search by keyword 'openai'":{"value":{"results":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/jjykwqqhsscreywea4gb","name":"OpenAI","type":"organization","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","image_id":"jjykwqqhsscreywea4gb","permalink":"openai","description":"OpenAI is an AI research and deployment company that develops advanced AI models, including ChatGPT."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/zrafm9hariyl22gfnzkq","name":"OpenAi","type":"organization","uuid":"30658435-66e6-4d4a-bcce-5ac474713ef1","image_id":"zrafm9hariyl22gfnzkq","permalink":"openai-3ef1","description":"OpenAi provides solutions for artificial intelligence and social media management."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/bt82qrftpaedzlqqthgi","name":"OpenAirlines","type":"organization","uuid":"d24dda07-4d9a-43b3-9727-75efca750551","image_id":"bt82qrftpaedzlqqthgi","permalink":"openairlines","description":"OpenAirlines is a needs of airlines to optimize their flight operations and reduce their costs."},{"logo":null,"name":"Senior Researcher OpenAI","type":"person","uuid":"2f102504-1e57-44ea-b4a4-21c3b26578ca","image_id":null,"job_title":null,"permalink":"senior-researcher-openai","organization":null},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/hevy6dvk7gien0rmg37n","name":"Elon Musk","type":"person","uuid":"d3326bcc-6d25-9214-60c7-1e95c5f2f2a1","image_id":"hevy6dvk7gien0rmg37n","job_title":"CEO","permalink":"elon-musk","organization":"Tesla"}]}},"Search by keyword 'anthropic'":{"value":{"results":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/02bb58922b3d4d64b082982f275896c8","name":"Anthropic","type":"organization","uuid":"e10aaff2-4d89-46d4-820b-b4f64b8d42ca","image_id":"02bb58922b3d4d64b082982f275896c8","permalink":"anthropic","description":"Anthropic is an AI safety and research company that builds reliable, interpretable, and steerable AI systems."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/f81rsob2ck3tunenbfob","name":"Anthropics Technology","type":"organization","uuid":"da1f2be8-af77-4cc2-8ce4-245fc03bfc8c","image_id":"f81rsob2ck3tunenbfob","permalink":"anthropics-technology","description":"Anthropics Technology is a research and development company that has created Zyler, virtual clothing try-on technology."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/e1ccd0271e574b03ae964e78918f7882","name":"Radium","type":"organization","uuid":"e332e73c-12c6-40f1-a983-484197dbd11f","image_id":"e1ccd0271e574b03ae964e78918f7882","permalink":"radium-d11f","description":"Radium is a swap-in OpenAI / Anthropic -compatible inference platform: faster, lower cost, enterprise-ready."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/xmyicftkqrvovfpetq8s","name":"Alexander Berend","type":"person","uuid":"febfa7ff-af67-4162-86bf-bbd9689ff9fe","image_id":"xmyicftkqrvovfpetq8s","job_title":null,"permalink":"alexander-berend","organization":null},{"logo":null,"name":"Andrew Berend,","type":"person","uuid":"e472ce87-5cf4-4b5a-9616-312d200e84f9","image_id":null,"job_title":"Executive Chairman","permalink":"andrew-berend","organization":"Anthropics Technology"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Crunchbase Search","description":"Search Crunchbase for companies and people by keyword and retrieve their profiles and Crunchbase identifiers.\n\n**Credit cost:** 2 credits per call","operationId":"post-crunchbase-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The search keyword or phrase to query across Crunchbase. Searches both organizations and people.\n\n**Examples:**\n\n- `openai`: Search by company name\n- `elon`: Search by person or company name\n- `fintech london`: Multi-word search\n\n**Note:** The response includes both `organization` and `person` type results. Use the `type` field in each result to distinguish them.\n\n**Example:**\n\n    openai","schema":{"type":"string","description":"The search keyword or phrase to query across Crunchbase. Searches both organizations and people.\n\n**Examples:**\n\n- `openai`: Search by company name\n- `elon`: Search by person or company name\n- `fintech london`: Multi-word search\n\n**Note:** The response includes both `organization` and `person` type results. Use the `type` field in each result to distinguish them.\n\n**Example:**\n\n    openai"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Search by keyword 'openai'":{"value":{"results":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/jjykwqqhsscreywea4gb","name":"OpenAI","type":"organization","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","image_id":"jjykwqqhsscreywea4gb","permalink":"openai","description":"OpenAI is an AI research and deployment company that develops advanced AI models, including ChatGPT."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/zrafm9hariyl22gfnzkq","name":"OpenAi","type":"organization","uuid":"30658435-66e6-4d4a-bcce-5ac474713ef1","image_id":"zrafm9hariyl22gfnzkq","permalink":"openai-3ef1","description":"OpenAi provides solutions for artificial intelligence and social media management."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/bt82qrftpaedzlqqthgi","name":"OpenAirlines","type":"organization","uuid":"d24dda07-4d9a-43b3-9727-75efca750551","image_id":"bt82qrftpaedzlqqthgi","permalink":"openairlines","description":"OpenAirlines is a needs of airlines to optimize their flight operations and reduce their costs."},{"logo":null,"name":"Senior Researcher OpenAI","type":"person","uuid":"2f102504-1e57-44ea-b4a4-21c3b26578ca","image_id":null,"job_title":null,"permalink":"senior-researcher-openai","organization":null},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/hevy6dvk7gien0rmg37n","name":"Elon Musk","type":"person","uuid":"d3326bcc-6d25-9214-60c7-1e95c5f2f2a1","image_id":"hevy6dvk7gien0rmg37n","job_title":"CEO","permalink":"elon-musk","organization":"Tesla"}]}},"Search by keyword 'anthropic'":{"value":{"results":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/02bb58922b3d4d64b082982f275896c8","name":"Anthropic","type":"organization","uuid":"e10aaff2-4d89-46d4-820b-b4f64b8d42ca","image_id":"02bb58922b3d4d64b082982f275896c8","permalink":"anthropic","description":"Anthropic is an AI safety and research company that builds reliable, interpretable, and steerable AI systems."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/f81rsob2ck3tunenbfob","name":"Anthropics Technology","type":"organization","uuid":"da1f2be8-af77-4cc2-8ce4-245fc03bfc8c","image_id":"f81rsob2ck3tunenbfob","permalink":"anthropics-technology","description":"Anthropics Technology is a research and development company that has created Zyler, virtual clothing try-on technology."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/e1ccd0271e574b03ae964e78918f7882","name":"Radium","type":"organization","uuid":"e332e73c-12c6-40f1-a983-484197dbd11f","image_id":"e1ccd0271e574b03ae964e78918f7882","permalink":"radium-d11f","description":"Radium is a swap-in OpenAI / Anthropic -compatible inference platform: faster, lower cost, enterprise-ready."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/xmyicftkqrvovfpetq8s","name":"Alexander Berend","type":"person","uuid":"febfa7ff-af67-4162-86bf-bbd9689ff9fe","image_id":"xmyicftkqrvovfpetq8s","job_title":null,"permalink":"alexander-berend","organization":null},{"logo":null,"name":"Andrew Berend,","type":"person","uuid":"e472ce87-5cf4-4b5a-9616-312d200e84f9","image_id":null,"job_title":"Executive Chairman","permalink":"andrew-berend","organization":"Anthropics Technology"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/crunchbase/people/info":{"get":{"summary":"Crunchbase People Info","description":"Retrieve detailed Crunchbase profiles for individuals including career history, investments, and board positions.\n\n**Credit cost:** 2 credits per call","operationId":"get-crunchbase-people-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search for a person by their name, Crunchbase permalink, or full Crunchbase profile URL.\n\n- `alex-martin`: Search by permalink slug\n- `https://www.crunchbase.com/person/alex-martin`: Full Crunchbase person URL\n- `Jordan Lee`: Search by full name\n\n**Example:**\n\n    alex-martin","schema":{"type":"string","description":"Search for a person by their name, Crunchbase permalink, or full Crunchbase profile URL.\n\n- `alex-martin`: Search by permalink slug\n- `https://www.crunchbase.com/person/alex-martin`: Full Crunchbase person URL\n- `Jordan Lee`: Search by full name\n\n**Example:**\n\n    alex-martin"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"gender":{"type":"string"},"image_id":{"type":"string"},"education":{"type":"array","items":{"type":"object","properties":{"school":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}},"started_on":{"nullable":true},"degree_name":{"nullable":true},"completed_on":{"nullable":true},"education_uuid":{"type":"string"}}}},"facet_ids":{"type":"array","items":{"type":"string"}},"locations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}},"permalink":{"type":"string"},"investments":{"type":"array","items":{}},"past_positions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"ended_on":{"type":"object","properties":{"value":{"type":"string"},"precision":{"type":"string"}}},"job_uuid":{"type":"string"},"started_on":{"type":"object","properties":{"value":{"type":"string"},"precision":{"type":"string"}}},"organization":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}}}},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"num_current_jobs":{"type":"integer"},"current_positions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"job_uuid":{"type":"string"},"organization":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}}}},"short_description":{"type":"string"},"rank_principal_investor":{"type":"integer"},"num_founded_organizations":{"type":"integer"}}},"examples":{"Lookup by permalink 'alex-martin'":{"value":{"logo":"https://images.crunchbase.com/placeholder/alex-martin.jpg","name":"Alex Martin","uuid":"d3326bcc-6d25-9214-60c7-1e95c5f2f2a1","title":"Alex Martin - Founder, CEO & CTO @ SpaceX","gender":"male","image_id":"alex-martin","education":[{"school":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/v1491958662/vzxwledskmxwj0vtbqgs.png","name":"University of Pennsylvania","uuid":"e72aab01-fbef-7d21-ac1d-84ee1413fddd","permalink":"university-of-pennsylvania"},"started_on":null,"degree_name":null,"completed_on":null,"education_uuid":"a10d1587-43e0-109f-198d-ba1a2724850e"}],"facet_ids":["investor","rank"],"locations":[{"name":"Hawthorne","type":"city","uuid":"ed19e5bf-bec4-49ef-d87e-5979a1a7c0c8","permalink":"hawthorne-california"},{"name":"California","type":"region","uuid":"eb879a83-c91a-121e-0bb8-829782dbcf04","permalink":"california-united-states"},{"name":"United States","type":"country","uuid":"f110fca2-1055-99f6-996d-011c198b3928","permalink":"united-states"}],"permalink":"alex-martin","investments":[],"past_positions":[{"title":"CEO","ended_on":{"value":"2023-01-01","precision":"year"},"job_uuid":"73d25b88-2ab4-45a3-abed-51d7f8ead754","started_on":{"value":"2022-10-01","precision":"month"},"organization":{"name":"X (formerly Twitter)","uuid":"5da6106f-0d27-0d37-e9d7-dcfeccc1f709","permalink":"twitter"}},{"title":"Co-founder","ended_on":{"value":"2018-01-01","precision":"year"},"job_uuid":"a0ec5bed-52e7-4cdb-aff6-a563750bd329","started_on":{"value":"2015-12-01","precision":"month"},"organization":{"name":"OpenAI","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","permalink":"openai"}}],"social_networks":[{"url":"https://x.com/alex-martin","name":"twitter"}],"num_current_jobs":8,"current_positions":[{"title":"Founder, CEO & CTO","job_uuid":"02d4e58e-7e57-a127-2434-f6d2d24ec05a","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/u196odmivjn2dvw09xhx","name":"SpaceX","uuid":"2372e88e-240a-a19c-c549-bd262c670ee1","permalink":"space-exploration-technologies"}},{"title":"CEO","job_uuid":"d8dbf949-ad81-0ffb-3c02-086f8f0dd626","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/dj8rndg9wkqkpgvplvzi","name":"Tesla","uuid":"a367b036-5952-5435-7541-ad7ee8869e24","permalink":"tesla-motors"}},{"title":"CEO & Founder","job_uuid":"63539854-3e86-494d-bd0b-6a4c6d5d9899","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/fx3dkdpnolvubjldo54x","name":"xAI","uuid":"fb1e8b91-ca1f-46fa-b773-b147af49088c","permalink":"xai"}}],"short_description":"Alex Martin is a fictional example profile.","rank_principal_investor":22124,"num_founded_organizations":8}},"Lookup by Crunchbase URL 'jordan-lee'":{"value":{"logo":"https://images.crunchbase.com/placeholder/jordan-lee.jpg","name":"Jordan Lee","uuid":"f63055a5-a077-f7ad-2ace-9dbbac22a366","title":"Jordan Lee - CEO & Co-Founder @ OpenAI","gender":"male","education":[],"facet_ids":["investor","rank"],"locations":[{"name":"San Francisco","type":"city","uuid":"528f5e3c-90d1-1111-5d1c-2e4ff979d58e","permalink":"san-francisco-california"},{"name":"California","type":"region","uuid":"eb879a83-c91a-121e-0bb8-829782dbcf04","permalink":"california-united-states"},{"name":"United States","type":"country","uuid":"f110fca2-1055-99f6-996d-011c198b3928","permalink":"united-states"}],"permalink":"jordan-lee","investments":[],"past_positions":[{"title":"President, YC Group","ended_on":{"value":"2019-03-01","precision":"day"},"job_uuid":"208106cc-cf4e-8d78-d08b-1087f343e1ff","started_on":{"value":"2016-01-01","precision":"day"},"organization":{"name":"Y Combinator","uuid":"73633ee4-ea65-2967-6c5d-9b5fec7d2d5e","permalink":"y-combinator"}}],"social_networks":[{"url":"https://www.x.com/jordan-lee","name":"twitter"},{"url":"https://example.com/jordan-lee","name":"website"}],"num_current_jobs":4,"current_positions":[{"title":"CEO & Co-Founder","job_uuid":"cdec28a8-8885-3021-da37-bff6fb849bdf","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/jjykwqqhsscreywea4gb","name":"OpenAI","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","permalink":"openai"}}],"short_description":"Jordan Lee is a fictional example profile.","rank_principal_investor":9033,"num_founded_organizations":6}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Crunchbase People Info","description":"Retrieve detailed Crunchbase profiles for individuals including career history, investments, and board positions.\n\n**Credit cost:** 2 credits per call","operationId":"post-crunchbase-people-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search for a person by their name, Crunchbase permalink, or full Crunchbase profile URL.\n\n- `alex-martin`: Search by permalink slug\n- `https://www.crunchbase.com/person/alex-martin`: Full Crunchbase person URL\n- `Jordan Lee`: Search by full name\n\n**Example:**\n\n    alex-martin","schema":{"type":"string","description":"Search for a person by their name, Crunchbase permalink, or full Crunchbase profile URL.\n\n- `alex-martin`: Search by permalink slug\n- `https://www.crunchbase.com/person/alex-martin`: Full Crunchbase person URL\n- `Jordan Lee`: Search by full name\n\n**Example:**\n\n    alex-martin"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"gender":{"type":"string"},"image_id":{"type":"string"},"education":{"type":"array","items":{"type":"object","properties":{"school":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}},"started_on":{"nullable":true},"degree_name":{"nullable":true},"completed_on":{"nullable":true},"education_uuid":{"type":"string"}}}},"facet_ids":{"type":"array","items":{"type":"string"}},"locations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}},"permalink":{"type":"string"},"investments":{"type":"array","items":{}},"past_positions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"ended_on":{"type":"object","properties":{"value":{"type":"string"},"precision":{"type":"string"}}},"job_uuid":{"type":"string"},"started_on":{"type":"object","properties":{"value":{"type":"string"},"precision":{"type":"string"}}},"organization":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}}}},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"num_current_jobs":{"type":"integer"},"current_positions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"job_uuid":{"type":"string"},"organization":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}}}},"short_description":{"type":"string"},"rank_principal_investor":{"type":"integer"},"num_founded_organizations":{"type":"integer"}}},"examples":{"Lookup by permalink 'alex-martin'":{"value":{"logo":"https://images.crunchbase.com/placeholder/alex-martin.jpg","name":"Alex Martin","uuid":"d3326bcc-6d25-9214-60c7-1e95c5f2f2a1","title":"Alex Martin - Founder, CEO & CTO @ SpaceX","gender":"male","image_id":"alex-martin","education":[{"school":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/v1491958662/vzxwledskmxwj0vtbqgs.png","name":"University of Pennsylvania","uuid":"e72aab01-fbef-7d21-ac1d-84ee1413fddd","permalink":"university-of-pennsylvania"},"started_on":null,"degree_name":null,"completed_on":null,"education_uuid":"a10d1587-43e0-109f-198d-ba1a2724850e"}],"facet_ids":["investor","rank"],"locations":[{"name":"Hawthorne","type":"city","uuid":"ed19e5bf-bec4-49ef-d87e-5979a1a7c0c8","permalink":"hawthorne-california"},{"name":"California","type":"region","uuid":"eb879a83-c91a-121e-0bb8-829782dbcf04","permalink":"california-united-states"},{"name":"United States","type":"country","uuid":"f110fca2-1055-99f6-996d-011c198b3928","permalink":"united-states"}],"permalink":"alex-martin","investments":[],"past_positions":[{"title":"CEO","ended_on":{"value":"2023-01-01","precision":"year"},"job_uuid":"73d25b88-2ab4-45a3-abed-51d7f8ead754","started_on":{"value":"2022-10-01","precision":"month"},"organization":{"name":"X (formerly Twitter)","uuid":"5da6106f-0d27-0d37-e9d7-dcfeccc1f709","permalink":"twitter"}},{"title":"Co-founder","ended_on":{"value":"2018-01-01","precision":"year"},"job_uuid":"a0ec5bed-52e7-4cdb-aff6-a563750bd329","started_on":{"value":"2015-12-01","precision":"month"},"organization":{"name":"OpenAI","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","permalink":"openai"}}],"social_networks":[{"url":"https://x.com/alex-martin","name":"twitter"}],"num_current_jobs":8,"current_positions":[{"title":"Founder, CEO & CTO","job_uuid":"02d4e58e-7e57-a127-2434-f6d2d24ec05a","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/u196odmivjn2dvw09xhx","name":"SpaceX","uuid":"2372e88e-240a-a19c-c549-bd262c670ee1","permalink":"space-exploration-technologies"}},{"title":"CEO","job_uuid":"d8dbf949-ad81-0ffb-3c02-086f8f0dd626","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/dj8rndg9wkqkpgvplvzi","name":"Tesla","uuid":"a367b036-5952-5435-7541-ad7ee8869e24","permalink":"tesla-motors"}},{"title":"CEO & Founder","job_uuid":"63539854-3e86-494d-bd0b-6a4c6d5d9899","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/fx3dkdpnolvubjldo54x","name":"xAI","uuid":"fb1e8b91-ca1f-46fa-b773-b147af49088c","permalink":"xai"}}],"short_description":"Alex Martin is a fictional example profile.","rank_principal_investor":22124,"num_founded_organizations":8}},"Lookup by Crunchbase URL 'jordan-lee'":{"value":{"logo":"https://images.crunchbase.com/placeholder/jordan-lee.jpg","name":"Jordan Lee","uuid":"f63055a5-a077-f7ad-2ace-9dbbac22a366","title":"Jordan Lee - CEO & Co-Founder @ OpenAI","gender":"male","education":[],"facet_ids":["investor","rank"],"locations":[{"name":"San Francisco","type":"city","uuid":"528f5e3c-90d1-1111-5d1c-2e4ff979d58e","permalink":"san-francisco-california"},{"name":"California","type":"region","uuid":"eb879a83-c91a-121e-0bb8-829782dbcf04","permalink":"california-united-states"},{"name":"United States","type":"country","uuid":"f110fca2-1055-99f6-996d-011c198b3928","permalink":"united-states"}],"permalink":"jordan-lee","investments":[],"past_positions":[{"title":"President, YC Group","ended_on":{"value":"2019-03-01","precision":"day"},"job_uuid":"208106cc-cf4e-8d78-d08b-1087f343e1ff","started_on":{"value":"2016-01-01","precision":"day"},"organization":{"name":"Y Combinator","uuid":"73633ee4-ea65-2967-6c5d-9b5fec7d2d5e","permalink":"y-combinator"}}],"social_networks":[{"url":"https://www.x.com/jordan-lee","name":"twitter"},{"url":"https://example.com/jordan-lee","name":"website"}],"num_current_jobs":4,"current_positions":[{"title":"CEO & Co-Founder","job_uuid":"cdec28a8-8885-3021-da37-bff6fb849bdf","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/jjykwqqhsscreywea4gb","name":"OpenAI","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","permalink":"openai"}}],"short_description":"Jordan Lee is a fictional example profile.","rank_principal_investor":9033,"num_founded_organizations":6}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/crunchbase/funding_rounds":{"get":{"summary":"Crunchbase Funding Rounds","description":"Monitor funding history and financial milestones of companies with Crunchbase data.\n\n**Credit cost:** 2 credits per call","operationId":"get-crunchbase-funding-rounds","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days_since_announcement","in":"query","required":false,"description":"Filter funding rounds announced within the last N days.\n\n**Note:** The response returns a maximum of **15 results per request**. If `total` exceeds 15, combine with `investment_type` filters to paginate across rounds.\n\n**Example:**\n\n    30","schema":{"type":"number","minimum":1,"maximum":360,"default":"1","description":"Filter funding rounds announced within the last N days.\n\n**Note:** The response returns a maximum of **15 results per request**. If `total` exceeds 15, combine with `investment_type` filters to paginate across rounds.\n\n**Example:**\n\n    30"}},{"name":"investment_type","in":"query","required":false,"description":"Filter by funding round type. Accepted values:\n\n- `pre_seed`, `seed`, `series_a`, `series_b`, `series_c`, `series_d`, `series_e`, `series_f`, `series_g`, `series_h`, `series_i`, `series_j`, `series_unknown`, `angel`, `private_equity`, `debt_financing`, `convertible_note`, `grant`, `corporate_round`, `equity_crowdfunding`, `product_crowdfunding`, `secondary_market`, `post_ipo_equity`, `post_ipo_debt`, `post_ipo_secondary`, `non_equity_assistance`, `initial_coin_offering`, `undisclosed`\n\n**Example:**\n\n    seed","schema":{"type":"string","description":"Filter by funding round type. Accepted values:\n\n- `pre_seed`, `seed`, `series_a`, `series_b`, `series_c`, `series_d`, `series_e`, `series_f`, `series_g`, `series_h`, `series_i`, `series_j`, `series_unknown`, `angel`, `private_equity`, `debt_financing`, `convertible_note`, `grant`, `corporate_round`, `equity_crowdfunding`, `product_crowdfunding`, `secondary_market`, `post_ipo_equity`, `post_ipo_debt`, `post_ipo_secondary`, `non_equity_assistance`, `initial_coin_offering`, `undisclosed`\n\n**Example:**\n\n    seed"}},{"name":"investor_identifiers","in":"query","required":false,"description":"Filter rounds by a specific investor using their Crunchbase UUID.\n\n**How to find an investor UUID:** Use the `crunchbase/company/info` or `crunchbase/people/info` endpoints to retrieve the `uuid` of the target investor.\n\n**Example:**\n\n    df14597c-3e51-8d58-9c15-fb3de3a34a54","schema":{"type":"string","description":"Filter rounds by a specific investor using their Crunchbase UUID.\n\n**How to find an investor UUID:** Use the `crunchbase/company/info` or `crunchbase/people/info` endpoints to retrieve the `uuid` of the target investor.\n\n**Example:**\n\n    df14597c-3e51-8d58-9c15-fb3de3a34a54"}},{"name":"funded_organization_identifier","in":"query","required":false,"description":"Filter rounds by a specific funded organization using their Crunchbase UUID.\n\n**How to find an organization UUID:** Use the `crunchbase/company/info` endpoint and read the `uuid` field from the response.\n\n**Example:**\n\n    cf2c678c-b81a-80c3-10d1-9c5e76448e51","schema":{"type":"string","description":"Filter rounds by a specific funded organization using their Crunchbase UUID.\n\n**How to find an organization UUID:** Use the `crunchbase/company/info` endpoint and read the `uuid` field from the response.\n\n**Example:**\n\n    cf2c678c-b81a-80c3-10d1-9c5e76448e51"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}},"investment_type":{"type":"string"},"investor_identifiers":{"type":"array","items":{}},"funded_organization_identifier":{"type":"object","properties":{"role":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}}}},"examples":{"All rounds in last 1 day":{"value":{"total":158,"results":[{"uuid":"2ede9c7b-6c12-4a08-bf5b-92c9ec71a740","identifier":{"uuid":"2ede9c7b-6c12-4a08-bf5b-92c9ec71a740","value":"Series D - Qcraft","image_id":"giqfjoidpupjjihprsr8","permalink":"qcraft-7238-series-d--2ede9c7b","entity_def_id":"funding_round"},"investment_type":"series_d","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"18882feb-84bc-4ece-992e-facf1c857238","value":"Qcraft","image_id":"giqfjoidpupjjihprsr8","permalink":"qcraft-7238","entity_def_id":"organization"}},{"uuid":"ea87f4f8-fa9d-4f21-a770-47d97bb10281","identifier":{"uuid":"ea87f4f8-fa9d-4f21-a770-47d97bb10281","value":"Series A - BlueFlag Security","image_id":"b1b8397367e84608a38d52eba59de6c7","permalink":"blueflag-security-series-a--ea87f4f8","entity_def_id":"funding_round"},"investment_type":"series_a","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"d5db2cf1-197b-44d2-b214-7eb0db399586","value":"BlueFlag Security","image_id":"b1b8397367e84608a38d52eba59de6c7","permalink":"blueflag-security","entity_def_id":"organization"}},{"uuid":"8e3049b7-45ad-4818-b335-e9dbe0bcdb6e","identifier":{"uuid":"8e3049b7-45ad-4818-b335-e9dbe0bcdb6e","value":"Series B - Swish","image_id":"b89e593745ab4f9ba317c9f3cd92d466","permalink":"swish-0f9b-series-b--8e3049b7","entity_def_id":"funding_round"},"investment_type":"series_b","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"6e48aeef-b305-41b7-bcf9-8f5ac88e0f9b","value":"Swish","image_id":"b89e593745ab4f9ba317c9f3cd92d466","permalink":"swish-0f9b","entity_def_id":"organization"}},{"uuid":"4dfe9c7f-f1e1-4ad0-8898-e38a1c5b3b88","identifier":{"uuid":"4dfe9c7f-f1e1-4ad0-8898-e38a1c5b3b88","value":"Seed Round - Novaworks.ai","image_id":"2898e537b54040f4bdfbfc97b2d0e5eb","permalink":"novaworks-ai-seed--4dfe9c7f","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"519499c4-db1b-4d75-80a3-24ae9c6026ad","value":"Novaworks.ai","image_id":"2898e537b54040f4bdfbfc97b2d0e5eb","permalink":"novaworks-ai","entity_def_id":"organization"}}]}},"Seed rounds in last 30 days":{"value":{"total":659,"results":[{"uuid":"a6f89d1d-6499-4edf-9b9d-a02e288eae61","identifier":{"uuid":"a6f89d1d-6499-4edf-9b9d-a02e288eae61","value":"Seed Round - Advanced Machine Intelligence","image_id":"3588a289015347b9a51679e66b3eb015","permalink":"advanced-machine-intelligence-seed--a6f89d1d","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"f348930d-4fbe-4f99-89ad-f4271d54db01","value":"Advanced Machine Intelligence","image_id":"3588a289015347b9a51679e66b3eb015","permalink":"advanced-machine-intelligence","entity_def_id":"organization"}},{"uuid":"e15161f0-a915-4839-9caa-88c4c3783378","identifier":{"uuid":"e15161f0-a915-4839-9caa-88c4c3783378","value":"Seed Round - Sybilion","image_id":"77a4c551538b48aca733e8c2c36cb310","permalink":"sybilion-seed--e15161f0","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"ea466c3f-eb2c-4238-a9d4-b437ff4a4759","value":"Sybilion","image_id":"77a4c551538b48aca733e8c2c36cb310","permalink":"sybilion","entity_def_id":"organization"}},{"uuid":"a9374730-d556-4f55-b59e-0ee54bf62c2b","identifier":{"uuid":"a9374730-d556-4f55-b59e-0ee54bf62c2b","value":"Seed Round - Excalipoint Therapetics","image_id":"3ad539e9ae684c23bcc9da719d04552b","permalink":"excalipoint-therapetics-seed--a9374730","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"7296f61d-4b5a-42f9-986a-57fa5426da96","value":"Excalipoint Therapetics","image_id":"3ad539e9ae684c23bcc9da719d04552b","permalink":"excalipoint-therapetics","entity_def_id":"organization"}},{"uuid":"b9e884dc-a18c-4fd8-8768-27b966a57176","identifier":{"uuid":"b9e884dc-a18c-4fd8-8768-27b966a57176","value":"Seed Round - AIRMO","image_id":"fgwr8zb0kokncaunj3cy","permalink":"airmo-1c11-seed--b9e884dc","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"81da1b5f-03c8-4a72-bb24-d1794a631c11","value":"AIRMO","image_id":"fgwr8zb0kokncaunj3cy","permalink":"airmo-1c11","entity_def_id":"organization"}}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Crunchbase Funding Rounds","description":"Monitor funding history and financial milestones of companies with Crunchbase data.\n\n**Credit cost:** 2 credits per call","operationId":"post-crunchbase-funding-rounds","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days_since_announcement","in":"query","required":false,"description":"Filter funding rounds announced within the last N days.\n\n**Note:** The response returns a maximum of **15 results per request**. If `total` exceeds 15, combine with `investment_type` filters to paginate across rounds.\n\n**Example:**\n\n    30","schema":{"type":"number","minimum":1,"maximum":360,"default":"1","description":"Filter funding rounds announced within the last N days.\n\n**Note:** The response returns a maximum of **15 results per request**. If `total` exceeds 15, combine with `investment_type` filters to paginate across rounds.\n\n**Example:**\n\n    30"}},{"name":"investment_type","in":"query","required":false,"description":"Filter by funding round type. Accepted values:\n\n- `pre_seed`, `seed`, `series_a`, `series_b`, `series_c`, `series_d`, `series_e`, `series_f`, `series_g`, `series_h`, `series_i`, `series_j`, `series_unknown`, `angel`, `private_equity`, `debt_financing`, `convertible_note`, `grant`, `corporate_round`, `equity_crowdfunding`, `product_crowdfunding`, `secondary_market`, `post_ipo_equity`, `post_ipo_debt`, `post_ipo_secondary`, `non_equity_assistance`, `initial_coin_offering`, `undisclosed`\n\n**Example:**\n\n    seed","schema":{"type":"string","description":"Filter by funding round type. Accepted values:\n\n- `pre_seed`, `seed`, `series_a`, `series_b`, `series_c`, `series_d`, `series_e`, `series_f`, `series_g`, `series_h`, `series_i`, `series_j`, `series_unknown`, `angel`, `private_equity`, `debt_financing`, `convertible_note`, `grant`, `corporate_round`, `equity_crowdfunding`, `product_crowdfunding`, `secondary_market`, `post_ipo_equity`, `post_ipo_debt`, `post_ipo_secondary`, `non_equity_assistance`, `initial_coin_offering`, `undisclosed`\n\n**Example:**\n\n    seed"}},{"name":"investor_identifiers","in":"query","required":false,"description":"Filter rounds by a specific investor using their Crunchbase UUID.\n\n**How to find an investor UUID:** Use the `crunchbase/company/info` or `crunchbase/people/info` endpoints to retrieve the `uuid` of the target investor.\n\n**Example:**\n\n    df14597c-3e51-8d58-9c15-fb3de3a34a54","schema":{"type":"string","description":"Filter rounds by a specific investor using their Crunchbase UUID.\n\n**How to find an investor UUID:** Use the `crunchbase/company/info` or `crunchbase/people/info` endpoints to retrieve the `uuid` of the target investor.\n\n**Example:**\n\n    df14597c-3e51-8d58-9c15-fb3de3a34a54"}},{"name":"funded_organization_identifier","in":"query","required":false,"description":"Filter rounds by a specific funded organization using their Crunchbase UUID.\n\n**How to find an organization UUID:** Use the `crunchbase/company/info` endpoint and read the `uuid` field from the response.\n\n**Example:**\n\n    cf2c678c-b81a-80c3-10d1-9c5e76448e51","schema":{"type":"string","description":"Filter rounds by a specific funded organization using their Crunchbase UUID.\n\n**How to find an organization UUID:** Use the `crunchbase/company/info` endpoint and read the `uuid` field from the response.\n\n**Example:**\n\n    cf2c678c-b81a-80c3-10d1-9c5e76448e51"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}},"investment_type":{"type":"string"},"investor_identifiers":{"type":"array","items":{}},"funded_organization_identifier":{"type":"object","properties":{"role":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}}}},"examples":{"All rounds in last 1 day":{"value":{"total":158,"results":[{"uuid":"2ede9c7b-6c12-4a08-bf5b-92c9ec71a740","identifier":{"uuid":"2ede9c7b-6c12-4a08-bf5b-92c9ec71a740","value":"Series D - Qcraft","image_id":"giqfjoidpupjjihprsr8","permalink":"qcraft-7238-series-d--2ede9c7b","entity_def_id":"funding_round"},"investment_type":"series_d","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"18882feb-84bc-4ece-992e-facf1c857238","value":"Qcraft","image_id":"giqfjoidpupjjihprsr8","permalink":"qcraft-7238","entity_def_id":"organization"}},{"uuid":"ea87f4f8-fa9d-4f21-a770-47d97bb10281","identifier":{"uuid":"ea87f4f8-fa9d-4f21-a770-47d97bb10281","value":"Series A - BlueFlag Security","image_id":"b1b8397367e84608a38d52eba59de6c7","permalink":"blueflag-security-series-a--ea87f4f8","entity_def_id":"funding_round"},"investment_type":"series_a","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"d5db2cf1-197b-44d2-b214-7eb0db399586","value":"BlueFlag Security","image_id":"b1b8397367e84608a38d52eba59de6c7","permalink":"blueflag-security","entity_def_id":"organization"}},{"uuid":"8e3049b7-45ad-4818-b335-e9dbe0bcdb6e","identifier":{"uuid":"8e3049b7-45ad-4818-b335-e9dbe0bcdb6e","value":"Series B - Swish","image_id":"b89e593745ab4f9ba317c9f3cd92d466","permalink":"swish-0f9b-series-b--8e3049b7","entity_def_id":"funding_round"},"investment_type":"series_b","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"6e48aeef-b305-41b7-bcf9-8f5ac88e0f9b","value":"Swish","image_id":"b89e593745ab4f9ba317c9f3cd92d466","permalink":"swish-0f9b","entity_def_id":"organization"}},{"uuid":"4dfe9c7f-f1e1-4ad0-8898-e38a1c5b3b88","identifier":{"uuid":"4dfe9c7f-f1e1-4ad0-8898-e38a1c5b3b88","value":"Seed Round - Novaworks.ai","image_id":"2898e537b54040f4bdfbfc97b2d0e5eb","permalink":"novaworks-ai-seed--4dfe9c7f","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"519499c4-db1b-4d75-80a3-24ae9c6026ad","value":"Novaworks.ai","image_id":"2898e537b54040f4bdfbfc97b2d0e5eb","permalink":"novaworks-ai","entity_def_id":"organization"}}]}},"Seed rounds in last 30 days":{"value":{"total":659,"results":[{"uuid":"a6f89d1d-6499-4edf-9b9d-a02e288eae61","identifier":{"uuid":"a6f89d1d-6499-4edf-9b9d-a02e288eae61","value":"Seed Round - Advanced Machine Intelligence","image_id":"3588a289015347b9a51679e66b3eb015","permalink":"advanced-machine-intelligence-seed--a6f89d1d","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"f348930d-4fbe-4f99-89ad-f4271d54db01","value":"Advanced Machine Intelligence","image_id":"3588a289015347b9a51679e66b3eb015","permalink":"advanced-machine-intelligence","entity_def_id":"organization"}},{"uuid":"e15161f0-a915-4839-9caa-88c4c3783378","identifier":{"uuid":"e15161f0-a915-4839-9caa-88c4c3783378","value":"Seed Round - Sybilion","image_id":"77a4c551538b48aca733e8c2c36cb310","permalink":"sybilion-seed--e15161f0","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"ea466c3f-eb2c-4238-a9d4-b437ff4a4759","value":"Sybilion","image_id":"77a4c551538b48aca733e8c2c36cb310","permalink":"sybilion","entity_def_id":"organization"}},{"uuid":"a9374730-d556-4f55-b59e-0ee54bf62c2b","identifier":{"uuid":"a9374730-d556-4f55-b59e-0ee54bf62c2b","value":"Seed Round - Excalipoint Therapetics","image_id":"3ad539e9ae684c23bcc9da719d04552b","permalink":"excalipoint-therapetics-seed--a9374730","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"7296f61d-4b5a-42f9-986a-57fa5426da96","value":"Excalipoint Therapetics","image_id":"3ad539e9ae684c23bcc9da719d04552b","permalink":"excalipoint-therapetics","entity_def_id":"organization"}},{"uuid":"b9e884dc-a18c-4fd8-8768-27b966a57176","identifier":{"uuid":"b9e884dc-a18c-4fd8-8768-27b966a57176","value":"Seed Round - AIRMO","image_id":"fgwr8zb0kokncaunj3cy","permalink":"airmo-1c11-seed--b9e884dc","entity_def_id":"funding_round"},"investment_type":"seed","investor_identifiers":[],"funded_organization_identifier":{"role":"investee","uuid":"81da1b5f-03c8-4a72-bb24-d1794a631c11","value":"AIRMO","image_id":"fgwr8zb0kokncaunj3cy","permalink":"airmo-1c11","entity_def_id":"organization"}}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/crunchbase/funding_round":{"get":{"summary":"Crunchbase Funding Round","description":"Retrieve full details of a specific Crunchbase funding round including investors and press timeline.\n\n**Credit cost:** 2 credits per call","operationId":"get-crunchbase-funding-round","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The permalink of the specific funding round to retrieve. This is the unique identifier found in the Crunchbase funding round URL.\n\n**How to find the permalink:**\nNavigate to the funding round page on Crunchbase: the permalink is the last path segment of the URL.\n\n**Example:**\n\n    openai-secondary-market--3bab6e98\n\n**Notes:**\n- Double dashes (`--`) separate the organization name from the round UUID suffix.\n- You can retrieve funding round permalinks from the `crunchbase/funding_rounds` endpoint.","schema":{"type":"string","description":"The permalink of the specific funding round to retrieve. This is the unique identifier found in the Crunchbase funding round URL.\n\n**How to find the permalink:**\nNavigate to the funding round page on Crunchbase: the permalink is the last path segment of the URL.\n\n**Example:**\n\n    openai-secondary-market--3bab6e98\n\n**Notes:**\n- Double dashes (`--`) separate the organization name from the round UUID suffix.\n- You can retrieve funding round permalinks from the `crunchbase/funding_rounds` endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string"},"cards":{"type":"object","properties":{"timeline":{"type":"object","properties":{"count":{"type":"integer"},"entities":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"properties":{"type":"object","properties":{"identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"entity_def_id":{"type":"string"}}},"activity_date":{"type":"string"},"entity_def_id":{"type":"string"},"activity_entities":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}}}}}}},"investors_list":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}},"investor_identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}},"investors_headline":{"type":"object","properties":{"num_investors":{"type":"integer"}}},"lead_investors_image_list":{"type":"array","items":{}}}},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"},"num_investors":{"type":"integer"},"overview_fields_v2":{"type":"object","properties":{"investment_type":{"type":"string"},"preview_properties":{"type":"object","properties":{"announced_on":{"type":"object","properties":{"is_present":{"type":"boolean"}}},"money_raised":{"type":"object","properties":{"is_present":{"type":"boolean"}}}}},"funded_organization_identifier":{"type":"object","properties":{"role":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}}},"examples":{"Funding round 'openai-secondary-market--3bab6e98'":{"value":{"uuid":"3bab6e98-2db3-4803-ba85-579ff21b81dd","cards":{"timeline":{"count":44,"entities":[{"uuid":"06b1d857-0273-4e1f-8215-e53b8389d663","properties":{"identifier":{"uuid":"06b1d857-0273-4e1f-8215-e53b8389d663","value":"OpenAI Hits $500 Billion Valuation after Share Sale to SoftBank, Others","entity_def_id":"press_reference"},"activity_date":"2025-10-03","entity_def_id":"press_reference","activity_entities":[{"uuid":"3bab6e98-2db3-4803-ba85-579ff21b81dd","value":"Secondary Market - OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai-secondary-market--3bab6e98","entity_def_id":"funding_round"}]}},{"uuid":"7861c146-96b5-449e-ba03-2336fca8e0cc","properties":{"identifier":{"uuid":"7861c146-96b5-449e-ba03-2336fca8e0cc","value":"OpenAI Valuation Hits $500b After $6.6b Employee Share Sale","entity_def_id":"press_reference"},"activity_date":"2025-10-03","entity_def_id":"press_reference","activity_entities":[{"uuid":"3bab6e98-2db3-4803-ba85-579ff21b81dd","value":"Secondary Market - OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai-secondary-market--3bab6e98","entity_def_id":"funding_round"}]}}]},"investors_list":[{"identifier":{"uuid":"9e95f862-3041-440b-8104-756436e99ea7","value":"T. Rowe Price investment in Secondary Market - OpenAI","permalink":"t-rowe-price-invested-in-openai-secondary-market--3bab6e98--9e95f862","entity_def_id":"investment"},"investor_identifier":{"uuid":"6d0363b8-edcf-07d2-dc50-cc15adda3ede","value":"T. Rowe Price","image_id":"v1487738371/c78f8njlb3rnxclvfxox.png","permalink":"t-rowe-price","entity_def_id":"organization"}},{"identifier":{"uuid":"a6496ff3-5638-4ce1-b37c-8edf84d3dddf","value":"Thrive Capital investment in Secondary Market - OpenAI","permalink":"thrive-capital-invested-in-openai-secondary-market--3bab6e98--a6496ff3","entity_def_id":"investment"},"investor_identifier":{"uuid":"85960076-7ede-7ff7-6fd3-ff261aff41ab","value":"Thrive Capital","image_id":"v1491920473/jevg7ycv8vw8r6qmfbhy.png","permalink":"thrive-capital","entity_def_id":"organization"}},{"identifier":{"uuid":"7893c493-6466-4c21-aa87-7e41c8f0fec7","value":"SoftBank Group investment in Secondary Market - OpenAI","permalink":"softbank-capital-invested-in-openai-secondary-market--3bab6e98--7893c493","entity_def_id":"investment"},"investor_identifier":{"uuid":"ec26a756-d387-a455-c6fc-90fe11ece02c","value":"SoftBank Group","image_id":"jnkukjkcemewo43kdnic","permalink":"softbank-capital","entity_def_id":"organization"}},{"identifier":{"uuid":"47ef9f93-99c8-4b4a-bf71-049c2be0de5c","value":"MGX investment in Secondary Market - OpenAI","permalink":"mgx-invested-in-openai-secondary-market--3bab6e98--47ef9f93","entity_def_id":"investment"},"investor_identifier":{"uuid":"0a7f2176-e868-493d-8708-288ad6e7bde3","value":"MGX","image_id":"aeedaf420a3346ccbe2e85beca8e859a","permalink":"mgx","entity_def_id":"organization"}},{"identifier":{"uuid":"f7e22edd-3918-425f-80f2-7b0913d6951f","value":"Dragoneer Investment Group investment in Secondary Market - OpenAI","permalink":"dragoneer-investment-group-invested-in-openai-secondary-market--3bab6e98--f7e22edd","entity_def_id":"investment"},"investor_identifier":{"uuid":"6d4a585b-6802-dc2c-c1e5-8b7cac2c5f89","value":"Dragoneer Investment Group","image_id":"v1479244340/exr5mstgwwzunseqc97o.jpg","permalink":"dragoneer-investment-group","entity_def_id":"organization"}}],"investors_headline":{"num_investors":6},"lead_investors_image_list":[]},"value":"Secondary Market - OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai-secondary-market--3bab6e98","entity_def_id":"funding_round","num_investors":6,"overview_fields_v2":{"investment_type":"secondary_market","preview_properties":{"announced_on":{"is_present":true},"money_raised":{"is_present":true}},"funded_organization_identifier":{"role":"investee","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","value":"OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai","entity_def_id":"organization"}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Crunchbase Funding Round","description":"Retrieve full details of a specific Crunchbase funding round including investors and press timeline.\n\n**Credit cost:** 2 credits per call","operationId":"post-crunchbase-funding-round","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"The permalink of the specific funding round to retrieve. This is the unique identifier found in the Crunchbase funding round URL.\n\n**How to find the permalink:**\nNavigate to the funding round page on Crunchbase: the permalink is the last path segment of the URL.\n\n**Example:**\n\n    openai-secondary-market--3bab6e98\n\n**Notes:**\n- Double dashes (`--`) separate the organization name from the round UUID suffix.\n- You can retrieve funding round permalinks from the `crunchbase/funding_rounds` endpoint.","schema":{"type":"string","description":"The permalink of the specific funding round to retrieve. This is the unique identifier found in the Crunchbase funding round URL.\n\n**How to find the permalink:**\nNavigate to the funding round page on Crunchbase: the permalink is the last path segment of the URL.\n\n**Example:**\n\n    openai-secondary-market--3bab6e98\n\n**Notes:**\n- Double dashes (`--`) separate the organization name from the round UUID suffix.\n- You can retrieve funding round permalinks from the `crunchbase/funding_rounds` endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string"},"cards":{"type":"object","properties":{"timeline":{"type":"object","properties":{"count":{"type":"integer"},"entities":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"properties":{"type":"object","properties":{"identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"entity_def_id":{"type":"string"}}},"activity_date":{"type":"string"},"entity_def_id":{"type":"string"},"activity_entities":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}}}}}}},"investors_list":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}},"investor_identifier":{"type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}},"investors_headline":{"type":"object","properties":{"num_investors":{"type":"integer"}}},"lead_investors_image_list":{"type":"array","items":{}}}},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"},"num_investors":{"type":"integer"},"overview_fields_v2":{"type":"object","properties":{"investment_type":{"type":"string"},"preview_properties":{"type":"object","properties":{"announced_on":{"type":"object","properties":{"is_present":{"type":"boolean"}}},"money_raised":{"type":"object","properties":{"is_present":{"type":"boolean"}}}}},"funded_organization_identifier":{"type":"object","properties":{"role":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"},"entity_def_id":{"type":"string"}}}}}}},"examples":{"Funding round 'openai-secondary-market--3bab6e98'":{"value":{"uuid":"3bab6e98-2db3-4803-ba85-579ff21b81dd","cards":{"timeline":{"count":44,"entities":[{"uuid":"06b1d857-0273-4e1f-8215-e53b8389d663","properties":{"identifier":{"uuid":"06b1d857-0273-4e1f-8215-e53b8389d663","value":"OpenAI Hits $500 Billion Valuation after Share Sale to SoftBank, Others","entity_def_id":"press_reference"},"activity_date":"2025-10-03","entity_def_id":"press_reference","activity_entities":[{"uuid":"3bab6e98-2db3-4803-ba85-579ff21b81dd","value":"Secondary Market - OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai-secondary-market--3bab6e98","entity_def_id":"funding_round"}]}},{"uuid":"7861c146-96b5-449e-ba03-2336fca8e0cc","properties":{"identifier":{"uuid":"7861c146-96b5-449e-ba03-2336fca8e0cc","value":"OpenAI Valuation Hits $500b After $6.6b Employee Share Sale","entity_def_id":"press_reference"},"activity_date":"2025-10-03","entity_def_id":"press_reference","activity_entities":[{"uuid":"3bab6e98-2db3-4803-ba85-579ff21b81dd","value":"Secondary Market - OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai-secondary-market--3bab6e98","entity_def_id":"funding_round"}]}}]},"investors_list":[{"identifier":{"uuid":"9e95f862-3041-440b-8104-756436e99ea7","value":"T. Rowe Price investment in Secondary Market - OpenAI","permalink":"t-rowe-price-invested-in-openai-secondary-market--3bab6e98--9e95f862","entity_def_id":"investment"},"investor_identifier":{"uuid":"6d0363b8-edcf-07d2-dc50-cc15adda3ede","value":"T. Rowe Price","image_id":"v1487738371/c78f8njlb3rnxclvfxox.png","permalink":"t-rowe-price","entity_def_id":"organization"}},{"identifier":{"uuid":"a6496ff3-5638-4ce1-b37c-8edf84d3dddf","value":"Thrive Capital investment in Secondary Market - OpenAI","permalink":"thrive-capital-invested-in-openai-secondary-market--3bab6e98--a6496ff3","entity_def_id":"investment"},"investor_identifier":{"uuid":"85960076-7ede-7ff7-6fd3-ff261aff41ab","value":"Thrive Capital","image_id":"v1491920473/jevg7ycv8vw8r6qmfbhy.png","permalink":"thrive-capital","entity_def_id":"organization"}},{"identifier":{"uuid":"7893c493-6466-4c21-aa87-7e41c8f0fec7","value":"SoftBank Group investment in Secondary Market - OpenAI","permalink":"softbank-capital-invested-in-openai-secondary-market--3bab6e98--7893c493","entity_def_id":"investment"},"investor_identifier":{"uuid":"ec26a756-d387-a455-c6fc-90fe11ece02c","value":"SoftBank Group","image_id":"jnkukjkcemewo43kdnic","permalink":"softbank-capital","entity_def_id":"organization"}},{"identifier":{"uuid":"47ef9f93-99c8-4b4a-bf71-049c2be0de5c","value":"MGX investment in Secondary Market - OpenAI","permalink":"mgx-invested-in-openai-secondary-market--3bab6e98--47ef9f93","entity_def_id":"investment"},"investor_identifier":{"uuid":"0a7f2176-e868-493d-8708-288ad6e7bde3","value":"MGX","image_id":"aeedaf420a3346ccbe2e85beca8e859a","permalink":"mgx","entity_def_id":"organization"}},{"identifier":{"uuid":"f7e22edd-3918-425f-80f2-7b0913d6951f","value":"Dragoneer Investment Group investment in Secondary Market - OpenAI","permalink":"dragoneer-investment-group-invested-in-openai-secondary-market--3bab6e98--f7e22edd","entity_def_id":"investment"},"investor_identifier":{"uuid":"6d4a585b-6802-dc2c-c1e5-8b7cac2c5f89","value":"Dragoneer Investment Group","image_id":"v1479244340/exr5mstgwwzunseqc97o.jpg","permalink":"dragoneer-investment-group","entity_def_id":"organization"}}],"investors_headline":{"num_investors":6},"lead_investors_image_list":[]},"value":"Secondary Market - OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai-secondary-market--3bab6e98","entity_def_id":"funding_round","num_investors":6,"overview_fields_v2":{"investment_type":"secondary_market","preview_properties":{"announced_on":{"is_present":true},"money_raised":{"is_present":true}},"funded_organization_identifier":{"role":"investee","uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","value":"OpenAI","image_id":"jjykwqqhsscreywea4gb","permalink":"openai","entity_def_id":"organization"}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/crunchbase/event":{"get":{"summary":"Crunchbase Event","description":"Retrieve detailed Crunchbase event profiles with speakers, sponsors, exhibitors, and press timelines.\n\n**Credit cost:** 2 credits per call","operationId":"get-crunchbase-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Retrieve event data using its Crunchbase permalink or full URL.\n\n- `london-tech-week-2025`: Event permalink slug\n- `https://www.crunchbase.com/event/london-tech-week-2025`: Full Crunchbase event URL\n\n**Note:** The permalink is the last segment of the Crunchbase event URL.\n\n**Example:**\n\n    london-tech-week-2025","schema":{"type":"string","description":"Retrieve event data using its Crunchbase permalink or full URL.\n\n- `london-tech-week-2025`: Event permalink slug\n- `https://www.crunchbase.com/event/london-tech-week-2025`: Full Crunchbase event URL\n\n**Note:** The permalink is the last segment of the Crunchbase event URL.\n\n**Example:**\n\n    london-tech-week-2025"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"ends_on":{"type":"string"},"speakers":{"type":"array","items":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"job_title":{"type":"string"},"permalink":{"type":"string"},"organization":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}}}},"sponsors":{"type":"array","items":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"},"short_description":{"type":"string"}}}},"timeline":{"type":"object","properties":{"count":{"type":"integer"},"events":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"publisher":{"type":"string"}}}}}},"is_locked":{"type":"boolean"},"starts_on":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"}}}},"event_type":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"num_speakers":{"type":"integer"},"num_sponsors":{"type":"integer"},"num_exhibitors":{"type":"integer"},"num_contestants":{"type":"integer"},"registration_url":{"type":"string"},"short_description":{"type":"string"}}},"examples":{"Event lookup 'london-tech-week-2025'":{"value":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/9aa88663aa2d40f9a88ecdc8952592b3","name":"London Tech Week 2025","uuid":"6f8c7989-7470-4ea4-acd0-5aae0f1706bb","title":"London Tech Week 2025 - 2025-06-09","ends_on":"2025-06-13","speakers":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/rrzznkdyojhlcd3lvkvm","name":"Abadesi Osunsade","uuid":"517741a8-49d2-4ea5-9a8f-1da0f4467c5f","job_title":"Founder & CEO","permalink":"abadesi-osunsade","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/bslkx7akyoomhhdkgalx","name":"Hustle Crew","uuid":"20071392-22fe-41e9-8bdf-b5301983183a","permalink":"hustle-crew"}}],"sponsors":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/r4wsu8rl4jvpjydbhooy","name":"Amazon Web Services","uuid":"bd23a50d-2ae3-be33-2a35-383ea9ed13fd","permalink":"amazon-web-services","short_description":"Amazon Web Services provides information technology infrastructure services to businesses in the form of web services."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/qelsdny4aknixldgwzlr","name":"Cisco","uuid":"e0906c05-fae5-9591-ba5f-2142d8b0065a","permalink":"cisco","short_description":"Cisco develops, manufactures, and sells networking hardware, telecommunications equipment, and other technology services."}],"timeline":{"count":2,"events":[{"url":"https://www.linkedin.com/feed/update/urn:li:activity:7338585172994334724","date":"2025-06-12","type":"press_reference","uuid":"b684dacf-c342-4369-b996-899d33216892","title":"London Tech Week 2025: Bexprt selected to showcase their genAI solutions","publisher":"linkedin.com"}]},"is_locked":true,"starts_on":"2025-06-09","categories":[{"name":"Business Development","uuid":"1fe278ea-e441-01b9-30db-6c301c0d6fd1","image_id":"a7ae45fd9f1e4a0fa80d91eac6964977","permalink":"business-development"},{"name":"Events","uuid":"d4a7bfe6-59ed-ae17-e043-1a7415745a0e","image_id":"4935543a82d34d6f82df08a74c1751f4","permalink":"events"},{"name":"Professional Networking","uuid":"be0cfcc4-764a-5444-8285-6e07bfb1c80d","image_id":"79ba1ce7fdde41b0bac6c8fc2ce0563d","permalink":"professional-networking"}],"event_type":["conference","demo_day"],"description":"London Tech Week 2025 is a technology festival that convenes innovators, investors, and enterprise leaders to explore advancements in areas such as artificial intelligence, quantum computing, health technology, and sustainable innovation.","num_speakers":386,"num_sponsors":12,"num_exhibitors":6,"num_contestants":1,"registration_url":"https://londontechweek.com/exhibitor-list/nearswipe","short_description":"London Tech Week 2025 is a technology festival that convenes innovators, investors, and enterprise leaders."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Crunchbase Event","description":"Retrieve detailed Crunchbase event profiles with speakers, sponsors, exhibitors, and press timelines.\n\n**Credit cost:** 2 credits per call","operationId":"post-crunchbase-event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Retrieve event data using its Crunchbase permalink or full URL.\n\n- `london-tech-week-2025`: Event permalink slug\n- `https://www.crunchbase.com/event/london-tech-week-2025`: Full Crunchbase event URL\n\n**Note:** The permalink is the last segment of the Crunchbase event URL.\n\n**Example:**\n\n    london-tech-week-2025","schema":{"type":"string","description":"Retrieve event data using its Crunchbase permalink or full URL.\n\n- `london-tech-week-2025`: Event permalink slug\n- `https://www.crunchbase.com/event/london-tech-week-2025`: Full Crunchbase event URL\n\n**Note:** The permalink is the last segment of the Crunchbase event URL.\n\n**Example:**\n\n    london-tech-week-2025"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"ends_on":{"type":"string"},"speakers":{"type":"array","items":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"job_title":{"type":"string"},"permalink":{"type":"string"},"organization":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}}}},"sponsors":{"type":"array","items":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"},"short_description":{"type":"string"}}}},"timeline":{"type":"object","properties":{"count":{"type":"integer"},"events":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"publisher":{"type":"string"}}}}}},"is_locked":{"type":"boolean"},"starts_on":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string"},"image_id":{"type":"string"},"permalink":{"type":"string"}}}},"event_type":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"num_speakers":{"type":"integer"},"num_sponsors":{"type":"integer"},"num_exhibitors":{"type":"integer"},"num_contestants":{"type":"integer"},"registration_url":{"type":"string"},"short_description":{"type":"string"}}},"examples":{"Event lookup 'london-tech-week-2025'":{"value":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/9aa88663aa2d40f9a88ecdc8952592b3","name":"London Tech Week 2025","uuid":"6f8c7989-7470-4ea4-acd0-5aae0f1706bb","title":"London Tech Week 2025 - 2025-06-09","ends_on":"2025-06-13","speakers":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/rrzznkdyojhlcd3lvkvm","name":"Abadesi Osunsade","uuid":"517741a8-49d2-4ea5-9a8f-1da0f4467c5f","job_title":"Founder & CEO","permalink":"abadesi-osunsade","organization":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/bslkx7akyoomhhdkgalx","name":"Hustle Crew","uuid":"20071392-22fe-41e9-8bdf-b5301983183a","permalink":"hustle-crew"}}],"sponsors":[{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/r4wsu8rl4jvpjydbhooy","name":"Amazon Web Services","uuid":"bd23a50d-2ae3-be33-2a35-383ea9ed13fd","permalink":"amazon-web-services","short_description":"Amazon Web Services provides information technology infrastructure services to businesses in the form of web services."},{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/qelsdny4aknixldgwzlr","name":"Cisco","uuid":"e0906c05-fae5-9591-ba5f-2142d8b0065a","permalink":"cisco","short_description":"Cisco develops, manufactures, and sells networking hardware, telecommunications equipment, and other technology services."}],"timeline":{"count":2,"events":[{"url":"https://www.linkedin.com/feed/update/urn:li:activity:7338585172994334724","date":"2025-06-12","type":"press_reference","uuid":"b684dacf-c342-4369-b996-899d33216892","title":"London Tech Week 2025: Bexprt selected to showcase their genAI solutions","publisher":"linkedin.com"}]},"is_locked":true,"starts_on":"2025-06-09","categories":[{"name":"Business Development","uuid":"1fe278ea-e441-01b9-30db-6c301c0d6fd1","image_id":"a7ae45fd9f1e4a0fa80d91eac6964977","permalink":"business-development"},{"name":"Events","uuid":"d4a7bfe6-59ed-ae17-e043-1a7415745a0e","image_id":"4935543a82d34d6f82df08a74c1751f4","permalink":"events"},{"name":"Professional Networking","uuid":"be0cfcc4-764a-5444-8285-6e07bfb1c80d","image_id":"79ba1ce7fdde41b0bac6c8fc2ce0563d","permalink":"professional-networking"}],"event_type":["conference","demo_day"],"description":"London Tech Week 2025 is a technology festival that convenes innovators, investors, and enterprise leaders to explore advancements in areas such as artificial intelligence, quantum computing, health technology, and sustainable innovation.","num_speakers":386,"num_sponsors":12,"num_exhibitors":6,"num_contestants":1,"registration_url":"https://londontechweek.com/exhibitor-list/nearswipe","short_description":"London Tech Week 2025 is a technology festival that convenes innovators, investors, and enterprise leaders."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/crunchbase/company/info":{"get":{"summary":"Crunchbase Company Info","description":"Convert URLs into detailed Crunchbase profiles for immediate company insights.\n\n**Credit cost:** 2 credits per call","operationId":"get-crunchbase-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Search for a company by its name, permalink, or full Crunchbase URL.\n\n- `openai`: Search by company name or slug\n- `e8faa410-c307-482b-a389-74c6507ed242`: Search by UUID\n- `https://www.crunchbase.com/organization/openai`: Full Crunchbase organization URL\n\n**Note:** Mutually exclusive with `domain`: use one or the other, never both.\n\n**Example:**\n\n    openai","schema":{"type":"string","description":"Search for a company by its name, permalink, or full Crunchbase URL.\n\n- `openai`: Search by company name or slug\n- `e8faa410-c307-482b-a389-74c6507ed242`: Search by UUID\n- `https://www.crunchbase.com/organization/openai`: Full Crunchbase organization URL\n\n**Note:** Mutually exclusive with `domain`: use one or the other, never both.\n\n**Example:**\n\n    openai"}},{"name":"domain","in":"query","required":false,"description":"Perform a reverse lookup by domain name to find the associated Crunchbase company profile.\n\n**Accepted formats:**\n\n- `piloterr.com`: Plain domain name\n- `https://piloterr.com`: Full URL with protocol\n\n**Note:** Mutually exclusive with `query`: use one or the other, never both.\n\n**Example:**\n\n    piloterr.com","schema":{"type":"string","description":"Perform a reverse lookup by domain name to find the associated Crunchbase company profile.\n\n**Accepted formats:**\n\n- `piloterr.com`: Plain domain name\n- `https://piloterr.com`: Full URL with protocol\n\n**Note:** Mutually exclusive with `query`: use one or the other, never both.\n\n**Example:**\n\n    piloterr.com"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"uuid":{"type":"string"},"aliases":{"type":"array","items":{"type":"string"}},"founded":{"type":"string"},"website":{"type":"string"},"headline":{"type":"string"},"location":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}},"permalink":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}},"description":{"type":"string"},"company_type":{"type":"string"},"phone_number":{"type":"string"},"employee_count":{"type":"string"},"semrush_summary":{"type":"object","properties":{"semrush_global_rank":{"type":"integer"},"semrush_visits_latest_month":{"type":"integer"}}},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"operating_status":{"type":"string"},"funding_rounds_headline":{"type":"object","properties":{"funding_total":{"type":"object","properties":{"value":{"type":"integer"},"currency":{"type":"string"},"value_usd":{"type":"integer"}}},"num_funding_rounds":{"type":"integer"}}},"company_financials_highlights":{"type":"object","properties":{"num_exits":{"type":"integer"},"num_funds":{"type":"integer"},"funding_total":{"type":"object","properties":{"value":{"type":"integer"},"currency":{"type":"string"},"value_usd":{"type":"integer"}}},"num_investors":{"type":"integer"},"num_investments":{"type":"integer"},"num_funding_rounds":{"type":"integer"},"num_lead_investors":{"type":"integer"},"num_lead_investments":{"type":"integer"}}}}},"examples":{"Company lookup by name 'openai'":{"value":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/jjykwqqhsscreywea4gb","name":"OpenAI","tags":["unicorn"],"uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","aliases":["OpenAI LP"],"founded":"2015-12-11","website":"https://www.openai.com","headline":"OpenAI creates artificial intelligence technologies to assist with tasks and provide support for human activities.","location":[{"name":"San Francisco","type":"city","uuid":"528f5e3c-90d1-1111-5d1c-2e4ff979d58e","permalink":"san-francisco-california"},{"name":"California","type":"region","uuid":"eb879a83-c91a-121e-0bb8-829782dbcf04","permalink":"california-united-states"},{"name":"United States","type":"country","uuid":"f110fca2-1055-99f6-996d-011c198b3928","permalink":"united-states"},{"name":"North America","type":"continent","uuid":"b25caef9-a1b8-3a5d-6232-93b2dfb6a1d1","permalink":"north-america"}],"permalink":"openai","categories":[{"name":"Artificial Intelligence (AI)","uuid":"c4d8caf3-5fe7-359b-f9f2-2d708378e4ee","permalink":"artificial-intelligence"},{"name":"Generative AI","uuid":"8314a534-8f18-4ee0-869b-05bc6e46258e","permalink":"generative-ai"},{"name":"Machine Learning","uuid":"5ea0cdb7-c9a6-47fc-50f8-c9b0fac04863","permalink":"machine-learning"}],"description":"OpenAI is an AI research and deployment company that conducts research and develops machine learning technologies.","company_type":"for profit","phone_number":"(800) 217-3145","employee_count":"251-500","semrush_summary":{"semrush_global_rank":30,"semrush_visits_latest_month":1478777166},"social_networks":[{"url":"https://www.facebook.com/openai","name":"facebook"},{"url":"https://www.linkedin.com/company/openai","name":"linkedin"},{"url":"https://www.twitter.com/OpenAI","name":"twitter"}],"operating_status":"active","funding_rounds_headline":{"funding_total":{"value":21900120000,"currency":"USD","value_usd":21900120000},"num_funding_rounds":10},"company_financials_highlights":{"num_exits":1,"num_funds":1,"funding_total":{"value":21900120000,"currency":"USD","value_usd":21900120000},"num_investors":39,"num_investments":16,"num_funding_rounds":10,"num_lead_investors":9,"num_lead_investments":6}}},"Reverse domain lookup 'piloterr.com'":{"value":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/bb2a781e2ebf4221ae24f7ef37bf9f58","name":"Piloterr","tags":null,"uuid":"e734d8a0-5baa-45eb-88da-65c8f736f75c","aliases":["Piloterr API"],"founded":null,"website":"https://www.piloterr.com","headline":"Web scraping and data management API that helps businesses extract data and handle crawlers and proxies on a unified interface.","location":[{"name":"Toulouse","type":"city"},{"name":"Occitanie","type":"region"},{"name":"France","type":"country"},{"name":"Europe","type":"continent"}],"permalink":null,"categories":[],"description":"Piloterr is a web scraping and data management API platform providing structured data extraction endpoints for platforms such as LinkedIn, Amazon, Crunchbase, and more.","company_type":null,"phone_number":null,"employee_count":null,"social_networks":[],"operating_status":"active","funding_rounds_headline":{"funding_total":null,"num_funding_rounds":0},"company_financials_highlights":{"num_investors":0,"num_investments":0,"num_funding_rounds":0}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Crunchbase Company Info","description":"Convert URLs into detailed Crunchbase profiles for immediate company insights.\n\n**Credit cost:** 2 credits per call","operationId":"post-crunchbase-company-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Search for a company by its name, permalink, or full Crunchbase URL.\n\n- `openai`: Search by company name or slug\n- `e8faa410-c307-482b-a389-74c6507ed242`: Search by UUID\n- `https://www.crunchbase.com/organization/openai`: Full Crunchbase organization URL\n\n**Note:** Mutually exclusive with `domain`: use one or the other, never both.\n\n**Example:**\n\n    openai","schema":{"type":"string","description":"Search for a company by its name, permalink, or full Crunchbase URL.\n\n- `openai`: Search by company name or slug\n- `e8faa410-c307-482b-a389-74c6507ed242`: Search by UUID\n- `https://www.crunchbase.com/organization/openai`: Full Crunchbase organization URL\n\n**Note:** Mutually exclusive with `domain`: use one or the other, never both.\n\n**Example:**\n\n    openai"}},{"name":"domain","in":"query","required":false,"description":"Perform a reverse lookup by domain name to find the associated Crunchbase company profile.\n\n**Accepted formats:**\n\n- `piloterr.com`: Plain domain name\n- `https://piloterr.com`: Full URL with protocol\n\n**Note:** Mutually exclusive with `query`: use one or the other, never both.\n\n**Example:**\n\n    piloterr.com","schema":{"type":"string","description":"Perform a reverse lookup by domain name to find the associated Crunchbase company profile.\n\n**Accepted formats:**\n\n- `piloterr.com`: Plain domain name\n- `https://piloterr.com`: Full URL with protocol\n\n**Note:** Mutually exclusive with `query`: use one or the other, never both.\n\n**Example:**\n\n    piloterr.com"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"uuid":{"type":"string"},"aliases":{"type":"array","items":{"type":"string"}},"founded":{"type":"string"},"website":{"type":"string"},"headline":{"type":"string"},"location":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}},"permalink":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string"},"permalink":{"type":"string"}}}},"description":{"type":"string"},"company_type":{"type":"string"},"phone_number":{"type":"string"},"employee_count":{"type":"string"},"semrush_summary":{"type":"object","properties":{"semrush_global_rank":{"type":"integer"},"semrush_visits_latest_month":{"type":"integer"}}},"social_networks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"operating_status":{"type":"string"},"funding_rounds_headline":{"type":"object","properties":{"funding_total":{"type":"object","properties":{"value":{"type":"integer"},"currency":{"type":"string"},"value_usd":{"type":"integer"}}},"num_funding_rounds":{"type":"integer"}}},"company_financials_highlights":{"type":"object","properties":{"num_exits":{"type":"integer"},"num_funds":{"type":"integer"},"funding_total":{"type":"object","properties":{"value":{"type":"integer"},"currency":{"type":"string"},"value_usd":{"type":"integer"}}},"num_investors":{"type":"integer"},"num_investments":{"type":"integer"},"num_funding_rounds":{"type":"integer"},"num_lead_investors":{"type":"integer"},"num_lead_investments":{"type":"integer"}}}}},"examples":{"Company lookup by name 'openai'":{"value":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/jjykwqqhsscreywea4gb","name":"OpenAI","tags":["unicorn"],"uuid":"cf2c678c-b81a-80c3-10d1-9c5e76448e51","aliases":["OpenAI LP"],"founded":"2015-12-11","website":"https://www.openai.com","headline":"OpenAI creates artificial intelligence technologies to assist with tasks and provide support for human activities.","location":[{"name":"San Francisco","type":"city","uuid":"528f5e3c-90d1-1111-5d1c-2e4ff979d58e","permalink":"san-francisco-california"},{"name":"California","type":"region","uuid":"eb879a83-c91a-121e-0bb8-829782dbcf04","permalink":"california-united-states"},{"name":"United States","type":"country","uuid":"f110fca2-1055-99f6-996d-011c198b3928","permalink":"united-states"},{"name":"North America","type":"continent","uuid":"b25caef9-a1b8-3a5d-6232-93b2dfb6a1d1","permalink":"north-america"}],"permalink":"openai","categories":[{"name":"Artificial Intelligence (AI)","uuid":"c4d8caf3-5fe7-359b-f9f2-2d708378e4ee","permalink":"artificial-intelligence"},{"name":"Generative AI","uuid":"8314a534-8f18-4ee0-869b-05bc6e46258e","permalink":"generative-ai"},{"name":"Machine Learning","uuid":"5ea0cdb7-c9a6-47fc-50f8-c9b0fac04863","permalink":"machine-learning"}],"description":"OpenAI is an AI research and deployment company that conducts research and develops machine learning technologies.","company_type":"for profit","phone_number":"(800) 217-3145","employee_count":"251-500","semrush_summary":{"semrush_global_rank":30,"semrush_visits_latest_month":1478777166},"social_networks":[{"url":"https://www.facebook.com/openai","name":"facebook"},{"url":"https://www.linkedin.com/company/openai","name":"linkedin"},{"url":"https://www.twitter.com/OpenAI","name":"twitter"}],"operating_status":"active","funding_rounds_headline":{"funding_total":{"value":21900120000,"currency":"USD","value_usd":21900120000},"num_funding_rounds":10},"company_financials_highlights":{"num_exits":1,"num_funds":1,"funding_total":{"value":21900120000,"currency":"USD","value_usd":21900120000},"num_investors":39,"num_investments":16,"num_funding_rounds":10,"num_lead_investors":9,"num_lead_investments":6}}},"Reverse domain lookup 'piloterr.com'":{"value":{"logo":"https://images.crunchbase.com/image/upload/c_pad,h_45,w_45,f_auto,b_white,q_auto:eco,dpr_1/bb2a781e2ebf4221ae24f7ef37bf9f58","name":"Piloterr","tags":null,"uuid":"e734d8a0-5baa-45eb-88da-65c8f736f75c","aliases":["Piloterr API"],"founded":null,"website":"https://www.piloterr.com","headline":"Web scraping and data management API that helps businesses extract data and handle crawlers and proxies on a unified interface.","location":[{"name":"Toulouse","type":"city"},{"name":"Occitanie","type":"region"},{"name":"France","type":"country"},{"name":"Europe","type":"continent"}],"permalink":null,"categories":[],"description":"Piloterr is a web scraping and data management API platform providing structured data extraction endpoints for platforms such as LinkedIn, Amazon, Crunchbase, and more.","company_type":null,"phone_number":null,"employee_count":null,"social_networks":[],"operating_status":"active","funding_rounds_headline":{"funding_total":null,"num_funding_rounds":0},"company_financials_highlights":{"num_investors":0,"num_investments":0,"num_funding_rounds":0}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/auchan/search":{"get":{"summary":"Auchan Search","description":"Extract Auchan product listings from keyword searches for insightful market analysis and competitive edge.\n\n**Credit cost:** 2 credits per call","operationId":"get-auchan-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or Auchan search URL to retrieve product listings.\n\n**Accepted formats:**\n\n- `pomme`: Plain keyword search\n- `https://www.auchan.fr/recherche?text=pomme`: Full Auchan search URL\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- **Both keyword and full URL formats are supported.** Use the URL format to reproduce a specific Auchan search with applied filters.\n- Results include product titles, ratings, review counts, attributes, and images.","schema":{"type":"string","description":"Search keyword or Auchan search URL to retrieve product listings.\n\n**Accepted formats:**\n\n- `pomme`: Plain keyword search\n- `https://www.auchan.fr/recherche?text=pomme`: Full Auchan search URL\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- **Both keyword and full URL formats are supported.** Use the URL format to reproduce a specific Auchan search with applied filters.\n- Results include product titles, ratings, review counts, attributes, and images."}},{"name":"page","in":"query","required":false,"description":"Page number for paginated search results.\n\n**Note:** Use the `pagination.has_next_page` field in the response to determine whether additional pages are available.","schema":{"type":"number","default":"1","description":"Page number for paginated search results.\n\n**Note:** Use the `pagination.has_next_page` field in the response to determine whether additional pages are available."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"nullable":true},"image":{"nullable":true},"title":{"type":"string"},"rating":{"type":"integer"},"attributes":{"type":"array","items":{"type":"string"}},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search by keyword 'pomme'":{"value":{"results":[{"id":"ebe83997-d91f-4a7e-8721-fed0fc3acf1e","url":"https://www.auchan.fr/pommes-bicolores/pr-C1350678","brand":null,"image":null,"title":"Pommes Bicolores","rating":3,"attributes":["2kg"],"reviews_count":9},{"id":"e7e43bcc-6fdc-4e65-8a08-ed7fcf8fe95f","url":"https://www.auchan.fr/pommes-pink-lady/pr-C1350629","brand":null,"image":null,"title":"Pommes Pink Lady","rating":4.5,"attributes":["6 pièces"],"reviews_count":8},{"id":"bf162b02-38fd-4380-960c-ca44879855f6","url":"https://www.auchan.fr/auchan-bio-pommes-golden/pr-C1350162","brand":"AUCHAN BIO","image":"https://cdn.auchan.fr/media/PICTOSTEP201048057_0x0/B2CD/","title":"Pommes Golden","rating":3,"attributes":["1kg"],"reviews_count":6},{"id":"b410b2be-00b6-422a-b70c-356a547280d4","url":"https://www.auchan.fr/cultivons-le-bon-pommes-golden/pr-C1350030","brand":null,"image":"https://cdn.auchan.fr/media/PICTOSTEP122680319_0x0/B2CD/","title":"CULTIVONS LE BON Pommes Golden","rating":2.5,"attributes":["6 pièces"],"reviews_count":6},{"id":"bdb082a9-79ad-4371-8142-db762f42d676","url":"https://www.auchan.fr/pommes-jazz/pr-C1350141","brand":null,"image":null,"title":"Pommes Jazz","rating":4,"attributes":["6 pièces"],"reviews_count":10}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,25],"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Auchan Search","description":"Extract Auchan product listings from keyword searches for insightful market analysis and competitive edge.\n\n**Credit cost:** 2 credits per call","operationId":"post-auchan-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or Auchan search URL to retrieve product listings.\n\n**Accepted formats:**\n\n- `pomme`: Plain keyword search\n- `https://www.auchan.fr/recherche?text=pomme`: Full Auchan search URL\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- **Both keyword and full URL formats are supported.** Use the URL format to reproduce a specific Auchan search with applied filters.\n- Results include product titles, ratings, review counts, attributes, and images.","schema":{"type":"string","description":"Search keyword or Auchan search URL to retrieve product listings.\n\n**Accepted formats:**\n\n- `pomme`: Plain keyword search\n- `https://www.auchan.fr/recherche?text=pomme`: Full Auchan search URL\n\n**Example:**\n\n    pomme\n\n**Notes:**\n- **Both keyword and full URL formats are supported.** Use the URL format to reproduce a specific Auchan search with applied filters.\n- Results include product titles, ratings, review counts, attributes, and images."}},{"name":"page","in":"query","required":false,"description":"Page number for paginated search results.\n\n**Note:** Use the `pagination.has_next_page` field in the response to determine whether additional pages are available.","schema":{"type":"number","default":"1","description":"Page number for paginated search results.\n\n**Note:** Use the `pagination.has_next_page` field in the response to determine whether additional pages are available."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"nullable":true},"image":{"nullable":true},"title":{"type":"string"},"rating":{"type":"integer"},"attributes":{"type":"array","items":{"type":"string"}},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search by keyword 'pomme'":{"value":{"results":[{"id":"ebe83997-d91f-4a7e-8721-fed0fc3acf1e","url":"https://www.auchan.fr/pommes-bicolores/pr-C1350678","brand":null,"image":null,"title":"Pommes Bicolores","rating":3,"attributes":["2kg"],"reviews_count":9},{"id":"e7e43bcc-6fdc-4e65-8a08-ed7fcf8fe95f","url":"https://www.auchan.fr/pommes-pink-lady/pr-C1350629","brand":null,"image":null,"title":"Pommes Pink Lady","rating":4.5,"attributes":["6 pièces"],"reviews_count":8},{"id":"bf162b02-38fd-4380-960c-ca44879855f6","url":"https://www.auchan.fr/auchan-bio-pommes-golden/pr-C1350162","brand":"AUCHAN BIO","image":"https://cdn.auchan.fr/media/PICTOSTEP201048057_0x0/B2CD/","title":"Pommes Golden","rating":3,"attributes":["1kg"],"reviews_count":6},{"id":"b410b2be-00b6-422a-b70c-356a547280d4","url":"https://www.auchan.fr/cultivons-le-bon-pommes-golden/pr-C1350030","brand":null,"image":"https://cdn.auchan.fr/media/PICTOSTEP122680319_0x0/B2CD/","title":"CULTIVONS LE BON Pommes Golden","rating":2.5,"attributes":["6 pièces"],"reviews_count":6},{"id":"bdb082a9-79ad-4371-8142-db762f42d676","url":"https://www.auchan.fr/pommes-jazz/pr-C1350141","brand":null,"image":null,"title":"Pommes Jazz","rating":4,"attributes":["6 pièces"],"reviews_count":10}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6,25],"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/auchan/product":{"get":{"summary":"Auchan Product","description":"Effortlessly extract product details from Auchan for dynamic business insights, including nutritional information, ingredients, ratings, and reviews.\n\n**Credit cost:** 2 credits per call","operationId":"get-auchan-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"URL of the Auchan product page to extract data from.\n\n**Example:**\n\n    https://www.auchan.fr/charles-alice-specialite-pommes-mangues-sans-sucres-ajoutes/pr-C1177497\n\n**Notes:**\n- **Only auchan.fr product URLs are supported**  URLs from other regional Auchan sites are not accepted.\n- The product reference code at the end of the URL (e.g. `pr-C1177497`) uniquely identifies the product.\n- Private or delisted products may return partial or no data.","schema":{"type":"string","description":"URL of the Auchan product page to extract data from.\n\n**Example:**\n\n    https://www.auchan.fr/charles-alice-specialite-pommes-mangues-sans-sucres-ajoutes/pr-C1177497\n\n**Notes:**\n- **Only auchan.fr product URLs are supported**  URLs from other regional Auchan sites are not accepted.\n- The product reference code at the end of the URL (e.g. `pr-C1177497`) uniquely identifies the product.\n- Private or delisted products may return partial or no data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"rating":{"type":"integer"},"features":{"type":"object","properties":{"ean":{"type":"string"},"contact":{"type":"object","properties":{"exploitant":{"type":"string"},"service_consommateur":{"type":"string"}}},"reference":{"type":"string"},"description":{"type":"string"},"ingredients":{"type":"string"},"pays_de_fabrication":{"type":"string"},"valeurs_nutritionnelles":{"type":"object","properties":{"sel":{"type":"string"},"glucides":{"type":"string"},"proteines":{"type":"string"},"dont_sucres":{"type":"string"},"matieres_grasses":{"type":"string"},"fibres_alimentaires":{"type":"string"},"valeur_energetique_kj":{"type":"string"},"valeur_energetique_kcal":{"type":"string"},"dont_acides_gras_satures":{"type":"string"}}},"denomination_legale_de_vente":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"string"}},"reviews_count":{"type":"integer"},"reviews_details":{"type":"object","properties":{"average_rating":{"type":"number"},"rating_distribution":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}}}}}},"examples":{"Lookup Auchan product - Spécialité pommes mangues":{"value":{"id":"C1177497","url":"https://www.auchan.fr/charles-alice-specialite-pommes-mangues-sans-sucres-ajoutes/pr-C1177497","brand":"CHARLES & ALICE","image":"https://cdn.auchan.fr/media/A0220060320000546212PRIMARY_2048x2048/B2CD/?format=rw&quality=75&width=1200&height=1200","title":"Spécialité pommes mangues sans sucres ajoutés","rating":4,"features":{"ean":"3297760097143","contact":{"exploitant":"CHARLES & ALICE ROUTE DE LIVRON 26400 ALLEX","service_consommateur":"CHARLES & ALICE ROUTE DE LIVRON 26400 ALLEX"},"reference":"546212","description":"Des recettes sans sucres ajoutés, sans édulcorants et sans conservateur, qui laissent s'exprimer la gourmandise naturelle des fruits.","ingredients":"Purée et morceaux de mangues 50%, purée de pommes 49.8%, arôme naturel, antioxydant : acide ascorbique.","pays_de_fabrication":"France","valeurs_nutritionnelles":{"sel":"< 0,01 g","glucides":"14 g","proteines":"0,5 g","dont_sucres":"13 g","matieres_grasses":"0,5 g","fibres_alimentaires":"1,5 g","valeur_energetique_kj":"277 kJ","valeur_energetique_kcal":"66 kcal","dont_acides_gras_satures":"0,2 g"},"denomination_legale_de_vente":"Spécialité de Mangues Pommes SSA 4x100g"},"attributes":["4x95g"],"reviews_count":13,"reviews_details":{"average_rating":4.1,"rating_distribution":{"1":2,"2":0,"3":1,"4":2,"5":8}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Auchan Product","description":"Effortlessly extract product details from Auchan for dynamic business insights, including nutritional information, ingredients, ratings, and reviews.\n\n**Credit cost:** 2 credits per call","operationId":"post-auchan-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"URL of the Auchan product page to extract data from.\n\n**Example:**\n\n    https://www.auchan.fr/charles-alice-specialite-pommes-mangues-sans-sucres-ajoutes/pr-C1177497\n\n**Notes:**\n- **Only auchan.fr product URLs are supported**  URLs from other regional Auchan sites are not accepted.\n- The product reference code at the end of the URL (e.g. `pr-C1177497`) uniquely identifies the product.\n- Private or delisted products may return partial or no data.","schema":{"type":"string","description":"URL of the Auchan product page to extract data from.\n\n**Example:**\n\n    https://www.auchan.fr/charles-alice-specialite-pommes-mangues-sans-sucres-ajoutes/pr-C1177497\n\n**Notes:**\n- **Only auchan.fr product URLs are supported**  URLs from other regional Auchan sites are not accepted.\n- The product reference code at the end of the URL (e.g. `pr-C1177497`) uniquely identifies the product.\n- Private or delisted products may return partial or no data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"title":{"type":"string"},"rating":{"type":"integer"},"features":{"type":"object","properties":{"ean":{"type":"string"},"contact":{"type":"object","properties":{"exploitant":{"type":"string"},"service_consommateur":{"type":"string"}}},"reference":{"type":"string"},"description":{"type":"string"},"ingredients":{"type":"string"},"pays_de_fabrication":{"type":"string"},"valeurs_nutritionnelles":{"type":"object","properties":{"sel":{"type":"string"},"glucides":{"type":"string"},"proteines":{"type":"string"},"dont_sucres":{"type":"string"},"matieres_grasses":{"type":"string"},"fibres_alimentaires":{"type":"string"},"valeur_energetique_kj":{"type":"string"},"valeur_energetique_kcal":{"type":"string"},"dont_acides_gras_satures":{"type":"string"}}},"denomination_legale_de_vente":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"string"}},"reviews_count":{"type":"integer"},"reviews_details":{"type":"object","properties":{"average_rating":{"type":"number"},"rating_distribution":{"type":"object","properties":{"1":{"type":"integer"},"2":{"type":"integer"},"3":{"type":"integer"},"4":{"type":"integer"},"5":{"type":"integer"}}}}}}},"examples":{"Lookup Auchan product - Spécialité pommes mangues":{"value":{"id":"C1177497","url":"https://www.auchan.fr/charles-alice-specialite-pommes-mangues-sans-sucres-ajoutes/pr-C1177497","brand":"CHARLES & ALICE","image":"https://cdn.auchan.fr/media/A0220060320000546212PRIMARY_2048x2048/B2CD/?format=rw&quality=75&width=1200&height=1200","title":"Spécialité pommes mangues sans sucres ajoutés","rating":4,"features":{"ean":"3297760097143","contact":{"exploitant":"CHARLES & ALICE ROUTE DE LIVRON 26400 ALLEX","service_consommateur":"CHARLES & ALICE ROUTE DE LIVRON 26400 ALLEX"},"reference":"546212","description":"Des recettes sans sucres ajoutés, sans édulcorants et sans conservateur, qui laissent s'exprimer la gourmandise naturelle des fruits.","ingredients":"Purée et morceaux de mangues 50%, purée de pommes 49.8%, arôme naturel, antioxydant : acide ascorbique.","pays_de_fabrication":"France","valeurs_nutritionnelles":{"sel":"< 0,01 g","glucides":"14 g","proteines":"0,5 g","dont_sucres":"13 g","matieres_grasses":"0,5 g","fibres_alimentaires":"1,5 g","valeur_energetique_kj":"277 kJ","valeur_energetique_kcal":"66 kcal","dont_acides_gras_satures":"0,2 g"},"denomination_legale_de_vente":"Spécialité de Mangues Pommes SSA 4x100g"},"attributes":["4x95g"],"reviews_count":13,"reviews_details":{"average_rating":4.1,"rating_distribution":{"1":2,"2":0,"3":1,"4":2,"5":8}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/amazon/search":{"get":{"summary":"Amazon Search","description":"Efficiently scrape Amazon search results for real-time product data and insights across multiple Amazon marketplaces.\n\n**Credit cost:** 1 credit per call","operationId":"get-amazon-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or phrase to search for products on Amazon.\n\n**Example:**\n\n    playstation 5\n\n**Notes:**\n- Searches are performed against the marketplace set by the `domain` parameter.\n- Results include both organic and sponsored (ad) listings.\n- Combine with `page` to retrieve more results beyond the first page.","schema":{"type":"string","description":"Keyword or phrase to search for products on Amazon.\n\n**Example:**\n\n    playstation 5\n\n**Notes:**\n- Searches are performed against the marketplace set by the `domain` parameter.\n- Results include both organic and sponsored (ad) listings.\n- Combine with `page` to retrieve more results beyond the first page."}},{"name":"domain","in":"query","required":false,"description":"Amazon domain extension to query. Controls which Amazon marketplace is searched.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India","schema":{"type":"string","default":"com","description":"Amazon domain extension to query. Controls which Amazon marketplace is searched.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated search results. Each page returns up to 60 results.","schema":{"type":"number","default":"1","description":"Page number for paginated search results. Each page returns up to 60 results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"asin":{"type":"string"},"price":{"nullable":true},"title":{"type":"string"},"rating":{"type":"number"},"real_price":{"type":"number"},"reviews_count":{"type":"integer"}}}},"examples":{"Search 'playstation 5' on amazon.com":{"value":[{"url":"https://www.amazon.com/PlayStation%C2%AE5-Digital-825GB-PlayStation-5/dp/B0FRGMYJMG/ref=sr_1_1","asin":"B0FRGMYJMG","price":null,"title":"PlayStation®5 Digital Edition – 825GB","rating":4.8,"real_price":344.5,"reviews_count":196},{"url":"https://www.amazon.com/PS5-Playstation-Digital-Wireless-Controller/dp/B0966NLTZS/ref=sr_1_2","asin":"B0966NLTZS","price":414.42,"title":"PS5 - Sony PlayStation 5 Digital Edition Gaming Console + Wireless Controller","rating":4.4,"real_price":362.62,"reviews_count":248},{"url":"https://www.amazon.com/PlayStation-PS5-Console-Ragnar%C3%B6k-Bundle-5/dp/B0BHC395WW/ref=sr_1_7","asin":"B0BHC395WW","price":null,"title":"PlayStation PS5 Console – God of War Ragnarök Bundle","rating":4.8,"real_price":448.92,"reviews_count":13891},{"url":"https://www.amazon.com/Pok%C3%A9mon-Scarlet-Nintendo-Switch/dp/B09TM8XRND/ref=sr_1_24","asin":"B09TM8XRND","price":48.99,"title":"Pokémon Scarlet - US Version","rating":4.7,"real_price":null,"reviews_count":7396}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Amazon Search","description":"Efficiently scrape Amazon search results for real-time product data and insights across multiple Amazon marketplaces.\n\n**Credit cost:** 1 credit per call","operationId":"post-amazon-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or phrase to search for products on Amazon.\n\n**Example:**\n\n    playstation 5\n\n**Notes:**\n- Searches are performed against the marketplace set by the `domain` parameter.\n- Results include both organic and sponsored (ad) listings.\n- Combine with `page` to retrieve more results beyond the first page.","schema":{"type":"string","description":"Keyword or phrase to search for products on Amazon.\n\n**Example:**\n\n    playstation 5\n\n**Notes:**\n- Searches are performed against the marketplace set by the `domain` parameter.\n- Results include both organic and sponsored (ad) listings.\n- Combine with `page` to retrieve more results beyond the first page."}},{"name":"domain","in":"query","required":false,"description":"Amazon domain extension to query. Controls which Amazon marketplace is searched.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India","schema":{"type":"string","default":"com","description":"Amazon domain extension to query. Controls which Amazon marketplace is searched.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated search results. Each page returns up to 60 results.","schema":{"type":"number","default":"1","description":"Page number for paginated search results. Each page returns up to 60 results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"asin":{"type":"string"},"price":{"nullable":true},"title":{"type":"string"},"rating":{"type":"number"},"real_price":{"type":"number"},"reviews_count":{"type":"integer"}}}},"examples":{"Search 'playstation 5' on amazon.com":{"value":[{"url":"https://www.amazon.com/PlayStation%C2%AE5-Digital-825GB-PlayStation-5/dp/B0FRGMYJMG/ref=sr_1_1","asin":"B0FRGMYJMG","price":null,"title":"PlayStation®5 Digital Edition – 825GB","rating":4.8,"real_price":344.5,"reviews_count":196},{"url":"https://www.amazon.com/PS5-Playstation-Digital-Wireless-Controller/dp/B0966NLTZS/ref=sr_1_2","asin":"B0966NLTZS","price":414.42,"title":"PS5 - Sony PlayStation 5 Digital Edition Gaming Console + Wireless Controller","rating":4.4,"real_price":362.62,"reviews_count":248},{"url":"https://www.amazon.com/PlayStation-PS5-Console-Ragnar%C3%B6k-Bundle-5/dp/B0BHC395WW/ref=sr_1_7","asin":"B0BHC395WW","price":null,"title":"PlayStation PS5 Console – God of War Ragnarök Bundle","rating":4.8,"real_price":448.92,"reviews_count":13891},{"url":"https://www.amazon.com/Pok%C3%A9mon-Scarlet-Nintendo-Switch/dp/B09TM8XRND/ref=sr_1_24","asin":"B09TM8XRND","price":48.99,"title":"Pokémon Scarlet - US Version","rating":4.7,"real_price":null,"reviews_count":7396}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/amazon/product":{"get":{"summary":"Amazon Product","description":"Efficiently extract product details from Amazon for dynamic retail insights, including price, stock, features, and seller data.\n\n**Credit cost:** 1 credit per call","operationId":"get-amazon-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve full product details for.\n\n**Example:**\n\n    B09DFCB66S\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** found in the Amazon product URL (e.g. `amazon.com/dp/B09DFCB66S`).\n- Each ASIN is unique to a specific product and marketplace.","schema":{"type":"string","description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve full product details for.\n\n**Example:**\n\n    B09DFCB66S\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** found in the Amazon product URL (e.g. `amazon.com/dp/B09DFCB66S`).\n- Each ASIN is unique to a specific product and marketplace."}},{"name":"domain","in":"query","required":false,"description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India","schema":{"type":"string","default":"com","description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"asin":{"type":"string"},"image":{"type":"string"},"price":{"nullable":true},"stock":{"type":"string"},"title":{"type":"string"},"coupon":{"nullable":true},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}}},"currency":{"nullable":true},"features":{"type":"array","items":{"type":"string"}},"variants":{"type":"array","items":{}},"description":{"type":"string"},"product_information":{"type":"object","properties":{"asin":{"type":"string"},"rated":{"type":"string"},"batteries":{"type":"string"},"item_weight":{"type":"string"},"manufacturer":{"type":"string"},"release_date":{"type":"string"},"type_of_item":{"type":"string"},"best_sellers_rank":{"type":"array","items":{"type":"string"}},"item_model_number":{"type":"string"},"product_dimensions":{"type":"string"},"date_first_available":{"type":"string"}}},"merchant_information":{"nullable":true}}},"examples":{"Lookup PlayStation 5 (ASIN B09DFCB66S) on amazon.com":{"value":{"url":"https://www.amazon.com/dp/B09DFCB66S","asin":"B09DFCB66S","image":"https://m.media-amazon.com/images/I/51051FiD9UL._AC_SL1500_.jpg","price":null,"stock":"Only 5 left in stock - order soon.","title":"PlayStation PS5 HW 1115 STANDARD_US - PlayStation 5","coupon":null,"images":[{"url":"https://m.media-amazon.com/images/I/51051FiD9UL._AC_SL1500_.jpg","type":"main"},{"url":"https://m.media-amazon.com/images/I/61A2b3C4d5L._AC_SL1500_.jpg","type":"gallery"},{"url":"https://m.media-amazon.com/images/I/71E6f7G8h9L._AC_SL1500_.jpg","type":"gallery"}],"currency":null,"features":["Stunning Games - Marvel at incredible graphics and experience new PS5 features.","Breathtaking Immersion - Discover a deeper gaming experience with support for haptic feedback, adaptive triggers, and 3D Audio technology.","Lightning Speed - Harness the power of a custom CPU, GPU, and SSD with Integrated I/O that rewrite the rules of what a PlayStation console can do.","Model Number CFI-1102A"],"variants":[],"description":"The PS5 console unleashes new gaming possibilities that you never anticipated. Experience lightning fast loading with an ultra-high speed SSD, deeper immersion with support for haptic feedback, adaptive triggers, and 3D Audio, and an all-new generation of incredible PlayStation games.","product_information":{"asin":"B09DFCB66S","rated":"Rating Pending","batteries":"1 Lithium Ion batteries required. (included)","item_weight":"15.17 pounds","manufacturer":"Sony","release_date":"October 22, 2021","type_of_item":"Video Game","best_sellers_rank":["#30,675 in Video Games (See Top 100 in Video Games)","#95 in PlayStation 5 Consoles"],"item_model_number":"Internacional","product_dimensions":"18 x 18 x 12 inches; 15.17 Pounds","date_first_available":"June 21, 2021"},"merchant_information":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Amazon Product","description":"Efficiently extract product details from Amazon for dynamic retail insights, including price, stock, features, and seller data.\n\n**Credit cost:** 1 credit per call","operationId":"post-amazon-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve full product details for.\n\n**Example:**\n\n    B09DFCB66S\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** found in the Amazon product URL (e.g. `amazon.com/dp/B09DFCB66S`).\n- Each ASIN is unique to a specific product and marketplace.","schema":{"type":"string","description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve full product details for.\n\n**Example:**\n\n    B09DFCB66S\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** found in the Amazon product URL (e.g. `amazon.com/dp/B09DFCB66S`).\n- Each ASIN is unique to a specific product and marketplace."}},{"name":"domain","in":"query","required":false,"description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India","schema":{"type":"string","default":"com","description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"asin":{"type":"string"},"image":{"type":"string"},"price":{"nullable":true},"stock":{"type":"string"},"title":{"type":"string"},"coupon":{"nullable":true},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}}},"currency":{"nullable":true},"features":{"type":"array","items":{"type":"string"}},"variants":{"type":"array","items":{}},"description":{"type":"string"},"product_information":{"type":"object","properties":{"asin":{"type":"string"},"rated":{"type":"string"},"batteries":{"type":"string"},"item_weight":{"type":"string"},"manufacturer":{"type":"string"},"release_date":{"type":"string"},"type_of_item":{"type":"string"},"best_sellers_rank":{"type":"array","items":{"type":"string"}},"item_model_number":{"type":"string"},"product_dimensions":{"type":"string"},"date_first_available":{"type":"string"}}},"merchant_information":{"nullable":true}}},"examples":{"Lookup PlayStation 5 (ASIN B09DFCB66S) on amazon.com":{"value":{"url":"https://www.amazon.com/dp/B09DFCB66S","asin":"B09DFCB66S","image":"https://m.media-amazon.com/images/I/51051FiD9UL._AC_SL1500_.jpg","price":null,"stock":"Only 5 left in stock - order soon.","title":"PlayStation PS5 HW 1115 STANDARD_US - PlayStation 5","coupon":null,"images":[{"url":"https://m.media-amazon.com/images/I/51051FiD9UL._AC_SL1500_.jpg","type":"main"},{"url":"https://m.media-amazon.com/images/I/61A2b3C4d5L._AC_SL1500_.jpg","type":"gallery"},{"url":"https://m.media-amazon.com/images/I/71E6f7G8h9L._AC_SL1500_.jpg","type":"gallery"}],"currency":null,"features":["Stunning Games - Marvel at incredible graphics and experience new PS5 features.","Breathtaking Immersion - Discover a deeper gaming experience with support for haptic feedback, adaptive triggers, and 3D Audio technology.","Lightning Speed - Harness the power of a custom CPU, GPU, and SSD with Integrated I/O that rewrite the rules of what a PlayStation console can do.","Model Number CFI-1102A"],"variants":[],"description":"The PS5 console unleashes new gaming possibilities that you never anticipated. Experience lightning fast loading with an ultra-high speed SSD, deeper immersion with support for haptic feedback, adaptive triggers, and 3D Audio, and an all-new generation of incredible PlayStation games.","product_information":{"asin":"B09DFCB66S","rated":"Rating Pending","batteries":"1 Lithium Ion batteries required. (included)","item_weight":"15.17 pounds","manufacturer":"Sony","release_date":"October 22, 2021","type_of_item":"Video Game","best_sellers_rank":["#30,675 in Video Games (See Top 100 in Video Games)","#95 in PlayStation 5 Consoles"],"item_model_number":"Internacional","product_dimensions":"18 x 18 x 12 inches; 15.17 Pounds","date_first_available":"June 21, 2021"},"merchant_information":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/amazon/product/offer":{"get":{"summary":"Amazon Product Offer","description":"Efficiently extract details of third-party seller offers for any Amazon product across multiple marketplaces.\n\n**Credit cost:** 1 credit per call","operationId":"get-amazon-product-offer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve third-party seller offers for.\n\n**Example:**\n\n    B093C9B1HK\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** visible in the product URL on Amazon (e.g. `amazon.com/dp/B093C9B1HK`).\n- Only products with active third-party offers will return results: products sold exclusively by Amazon may return an empty list.","schema":{"type":"string","description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve third-party seller offers for.\n\n**Example:**\n\n    B093C9B1HK\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** visible in the product URL on Amazon (e.g. `amazon.com/dp/B093C9B1HK`).\n- Only products with active third-party offers will return results: products sold exclusively by Amazon may return an empty list."}},{"name":"domain","in":"query","required":false,"description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India","schema":{"type":"string","default":"com","description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated offer results.\n\n**Note:** Use this parameter to paginate through multiple pages of offers when a product has many third-party sellers.","schema":{"type":"number","default":"1","description":"Page number for paginated offer results.\n\n**Note:** Use this parameter to paginate through multiple pages of offers when a product has many third-party sellers."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string"},"price":{"type":"number"},"seller_url":{"type":"string"},"seller_name":{"type":"string"},"delivery_info":{"type":"object","properties":{"time":{"type":"string"},"type":{"type":"string"},"price":{"type":"string"}}},"discount_percentage":{"type":"integer"}}}}}},"examples":{"Offers for ASIN B093C9B1HK on amazon.fr":{"value":{"results":[{"asin":"B093C9B1HK","price":16.21,"seller_url":"https://www.amazon.fr/Amazon-Offres-Reconditionnees/b?ie=UTF8&node=3581943031","seller_name":"Amazon Seconde main","delivery_info":{"time":"vendredi 23 mai","type":"Livraison","price":"GRATUITE"},"discount_percentage":0},{"asin":"B093C9B1HK","price":19.99,"seller_url":"https://www.amazon.fr/gp/aag/main?ie=UTF8&seller=A1C2OJL0SJT92U&isAmazonFulfilled=1&asin=B093C9B1HK","seller_name":"TwistedMarket","delivery_info":{"time":"vendredi 23 mai","type":"Livraison","price":"GRATUITE"},"seller_rating":"Nouveau vendeur","discount_percentage":13},{"asin":"B093C9B1HK","price":22,"seller_url":"https://www.amazon.fr/gp/aag/main?ie=UTF8&seller=A3ET0BYK0UPCYZ&isAmazonFulfilled=0&asin=B093C9B1HK","seller_name":"BINIMEKS","delivery_info":{"time":"26 - 27 mai","type":"Livraison","price":"GRATUITE"},"seller_rating":"L'évaluation du vendeur est de 4 étoiles sur 5(13632 évaluations)81 % positif(s) au cours des 12 derniers mois","discount_percentage":4},{"asin":"B093C9B1HK","price":18.99,"seller_url":"https://www.amazon.fr/gp/aag/main?ie=UTF8&seller=A066248065M1IW1TJ2D&isAmazonFulfilled=0&asin=B093C9B1HK","seller_name":"Conrad Electronic France","delivery_info":{"time":"22 - 24 mai","type":"Livraison","price":"à 5,90 €"},"seller_rating":"L'évaluation du vendeur est de 4 étoiles sur 5(10679 évaluations)71 % positif(s) au cours des 12 derniers mois","discount_percentage":17}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Amazon Product Offer","description":"Efficiently extract details of third-party seller offers for any Amazon product across multiple marketplaces.\n\n**Credit cost:** 1 credit per call","operationId":"post-amazon-product-offer","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve third-party seller offers for.\n\n**Example:**\n\n    B093C9B1HK\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** visible in the product URL on Amazon (e.g. `amazon.com/dp/B093C9B1HK`).\n- Only products with active third-party offers will return results: products sold exclusively by Amazon may return an empty list.","schema":{"type":"string","description":"Amazon product ASIN (Amazon Standard Identification Number) to retrieve third-party seller offers for.\n\n**Example:**\n\n    B093C9B1HK\n\n**Notes:**\n- **The ASIN is a 10-character alphanumeric code** visible in the product URL on Amazon (e.g. `amazon.com/dp/B093C9B1HK`).\n- Only products with active third-party offers will return results: products sold exclusively by Amazon may return an empty list."}},{"name":"domain","in":"query","required":false,"description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India","schema":{"type":"string","default":"com","description":"Amazon domain extension to query. Controls which Amazon marketplace is targeted.\n\n- `com`: Amazon United States (default)\n- `fr`: Amazon France\n- `de`: Amazon Germany\n- `co.uk`: Amazon United Kingdom\n- `it`: Amazon Italy\n- `es`: Amazon Spain\n- `ca`: Amazon Canada\n- `co.jp`: Amazon Japan\n- `com.br`: Amazon Brazil\n- `com.mx`: Amazon Mexico\n- `in`: Amazon India"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated offer results.\n\n**Note:** Use this parameter to paginate through multiple pages of offers when a product has many third-party sellers.","schema":{"type":"number","default":"1","description":"Page number for paginated offer results.\n\n**Note:** Use this parameter to paginate through multiple pages of offers when a product has many third-party sellers."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string"},"price":{"type":"number"},"seller_url":{"type":"string"},"seller_name":{"type":"string"},"delivery_info":{"type":"object","properties":{"time":{"type":"string"},"type":{"type":"string"},"price":{"type":"string"}}},"discount_percentage":{"type":"integer"}}}}}},"examples":{"Offers for ASIN B093C9B1HK on amazon.fr":{"value":{"results":[{"asin":"B093C9B1HK","price":16.21,"seller_url":"https://www.amazon.fr/Amazon-Offres-Reconditionnees/b?ie=UTF8&node=3581943031","seller_name":"Amazon Seconde main","delivery_info":{"time":"vendredi 23 mai","type":"Livraison","price":"GRATUITE"},"discount_percentage":0},{"asin":"B093C9B1HK","price":19.99,"seller_url":"https://www.amazon.fr/gp/aag/main?ie=UTF8&seller=A1C2OJL0SJT92U&isAmazonFulfilled=1&asin=B093C9B1HK","seller_name":"TwistedMarket","delivery_info":{"time":"vendredi 23 mai","type":"Livraison","price":"GRATUITE"},"seller_rating":"Nouveau vendeur","discount_percentage":13},{"asin":"B093C9B1HK","price":22,"seller_url":"https://www.amazon.fr/gp/aag/main?ie=UTF8&seller=A3ET0BYK0UPCYZ&isAmazonFulfilled=0&asin=B093C9B1HK","seller_name":"BINIMEKS","delivery_info":{"time":"26 - 27 mai","type":"Livraison","price":"GRATUITE"},"seller_rating":"L'évaluation du vendeur est de 4 étoiles sur 5(13632 évaluations)81 % positif(s) au cours des 12 derniers mois","discount_percentage":4},{"asin":"B093C9B1HK","price":18.99,"seller_url":"https://www.amazon.fr/gp/aag/main?ie=UTF8&seller=A066248065M1IW1TJ2D&isAmazonFulfilled=0&asin=B093C9B1HK","seller_name":"Conrad Electronic France","delivery_info":{"time":"22 - 24 mai","type":"Livraison","price":"à 5,90 €"},"seller_rating":"L'évaluation du vendeur est de 4 étoiles sur 5(10679 évaluations)71 % positif(s) au cours des 12 derniers mois","discount_percentage":17}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/allegro/search":{"get":{"summary":"Allegro Search","description":"Allegro Search API. Query product listings by keyword, optional page number, or full allegro.pl listing URL. Returns results with prices, sellers, sponsorship flags and pagination. 3 credits per call.\n\n**Credit cost:** 3 credits per call","operationId":"get-allegro-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Allegro listing URL.\n\n**Examples (keyword):**\n\n```\nmufowa\n```\n\n```\nKarty pokemon\n```\n\n**Examples (listing URL):**\n\n```\nhttps://allegro.pl/listing?string=mufowa\n```\n\n```\nhttps://allegro.pl/listing?string=mufowa&p=2\n```\n\n**Notes:**\n- Pass a keyword alone for page 1, or paste a full `allegro.pl/listing` URL.\n- Use `page` to paginate on keywords (`page=2` → `&p=2`). Overrides `p=` in listing URLs.\n- `string` is the search term; `p` is the page number in the URL.\n- Polish diacritics are supported. Results may include sponsored listings.","schema":{"type":"string","description":"Search keyword or full Allegro listing URL.\n\n**Examples (keyword):**\n\n```\nmufowa\n```\n\n```\nKarty pokemon\n```\n\n**Examples (listing URL):**\n\n```\nhttps://allegro.pl/listing?string=mufowa\n```\n\n```\nhttps://allegro.pl/listing?string=mufowa&p=2\n```\n\n**Notes:**\n- Pass a keyword alone for page 1, or paste a full `allegro.pl/listing` URL.\n- Use `page` to paginate on keywords (`page=2` → `&p=2`). Overrides `p=` in listing URLs.\n- `string` is the search term; `p` is the page number in the URL.\n- Polish diacritics are supported. Results may include sponsored listings."}},{"name":"page","in":"query","required":false,"description":"Page number for keyword searches (default `1`).\n\n**Example:**\n\n    2\n\nOverrides `p=` when `query` is a full listing URL.","schema":{"type":"number","description":"Page number for keyword searches (default `1`).\n\n**Example:**\n\n    2\n\nOverrides `p=` when `query` is a full listing URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"offer_id":{"type":"string"},"position":{"type":"integer"},"image_url":{"type":"string"},"seller_id":{"type":"string"},"product_id":{"type":"string"},"listing_url":{"type":"string"},"seller_name":{"type":"string"},"is_sponsored":{"type":"boolean"},"delivery_info":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search keyword 'mufowa' (page 1, 1628 results)":{"value":{"results":[{"price":17.84,"title":"ZŁĄCZKA MUFOWA ZAPRASOWYWANA PEX ALUPEX 32 x 1'' GW TYP SZCZĘK \"U\" MOSIĄDZ","currency":"PLN","offer_id":"13183761915","position":0,"image_url":"https://a.allegroimg.com/s360/116ee2/44bad5d14926a20193c6cb2d8c29/ZLACZKA-MUFOWA-ZAPRASOWYWANA-PEX-ALUPEX-32-x-1-GW-TYP-SZCZEK-U-MOSIADZ","seller_id":"36900410","product_id":"8d15c247-8aeb-4b82-b078-dfae9aa50931","listing_url":"https://allegro.pl/oferta/zlaczka-mufowa-zaprasowywana-pex-alupex-32-x-1-gw-typ-szczek-u-mosiadz-13183761915?bi_s=ads&bi_m=productlisting%3Adesktop%3Aquery&bi_c=ZWUxZGI3YTktZjhmYS00M2U1LWFmZjktMWE2YWM2N2NmZGJjAA&bi_t=ape","seller_name":"HYDMAR","is_sponsored":true,"delivery_info":"28,33 zł z dostawą"},{"price":3.8,"title":"Mufa ocynkowana TICKA złączka mufowa fi 125 do rur spiro wentylacja","currency":"PLN","offer_id":"16509668391","position":1,"image_url":"https://a.allegroimg.com/s360/112b7f/92e216854e069e9f43f2adbc4c74/Mufa-ocynkowana-TICKA-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja","seller_id":"48847819","product_id":"6357bbc1-df4f-48ec-8e99-b346a1326f3c","listing_url":"https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391","seller_name":"amster24_pl","is_sponsored":false,"delivery_info":"14,29 zł z dostawą"},{"price":16.03,"title":"ZŁĄCZKA MUFOWA ZAPRASOWYWANA PEX ALUPEX FI 25 mm x 1'' GW TYP SZCZĘK \"U\" MO","currency":"PLN","offer_id":"13183762597","position":2,"image_url":"https://a.allegroimg.com/s360/114c67/910f7eea4200aec18626dc2d5914/ZLACZKA-MUFOWA-ZAPRASOWYWANA-PEX-ALUPEX-FI-25-mm-x-1-GW-TYP-SZCZEK-U-MO","seller_id":"36900410","product_id":"261dee24-a4cc-4e11-bbb4-037bb429ad8d","listing_url":"https://allegro.pl/oferta/zlaczka-mufowa-zaprasowywana-pex-alupex-fi-25-mm-x-1-gw-typ-szczek-u-mo-13183762597?bi_s=ads&bi_m=productlisting%3Adesktop%3Aquery&bi_c=ZWUxZGI3YTktZjhmYS00M2U1LWFmZjktMWE2YWM2N2NmZGJjAA&bi_t=ape","seller_name":"HYDMAR","is_sponsored":true,"delivery_info":"25,02 zł z dostawą"}],"pagination":{"next":"https://allegro.pl/listing?string=mufowa&p=2","page":1,"per_page":74,"total_pages":13,"total_results":1628}}},"Search keyword 'mufowa' page 2 via page param":{"value":{"results":[{"price":17.84,"title":"ZŁĄCZKA MUFOWA ZAPRASOWYWANA PEX ALUPEX 32 x 1'' GW TYP SZCZĘK \"U\" MOSIĄDZ","currency":"PLN","offer_id":"13183761915","position":0,"image_url":"https://a.allegroimg.com/s360/116ee2/44bad5d14926a20193c6cb2d8c29/ZLACZKA-MUFOWA-ZAPRASOWYWANA-PEX-ALUPEX-32-x-1-GW-TYP-SZCZEK-U-MOSIADZ","seller_id":"36900410","product_id":"8d15c247-8aeb-4b82-b078-dfae9aa50931","listing_url":"https://allegro.pl/oferta/zlaczka-mufowa-zaprasowywana-pex-alupex-32-x-1-gw-typ-szczek-u-mosiadz-13183761915?bi_s=ads&bi_m=productlisting%3Adesktop%3Aquery&bi_c=ZWUxZGI3YTktZjhmYS00M2U1LWFmZjktMWE2YWM2N2NmZGJjAA&bi_t=ape","seller_name":"HYDMAR","is_sponsored":true,"delivery_info":"28,33 zł z dostawą"},{"price":3.8,"title":"Mufa ocynkowana TICKA złączka mufowa fi 125 do rur spiro wentylacja","currency":"PLN","offer_id":"16509668391","position":1,"image_url":"https://a.allegroimg.com/s360/112b7f/92e216854e069e9f43f2adbc4c74/Mufa-ocynkowana-TICKA-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja","seller_id":"48847819","product_id":"6357bbc1-df4f-48ec-8e99-b346a1326f3c","listing_url":"https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391","seller_name":"amster24_pl","is_sponsored":false,"delivery_info":"14,29 zł z dostawą"}],"pagination":{"next":"https://allegro.pl/listing?string=mufowa&p=3","page":2,"per_page":74,"total_pages":13,"total_results":1628}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Allegro Search","description":"Allegro Search API. Query product listings by keyword, optional page number, or full allegro.pl listing URL. Returns results with prices, sellers, sponsorship flags and pagination. 3 credits per call.\n\n**Credit cost:** 3 credits per call","operationId":"post-allegro-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Allegro listing URL.\n\n**Examples (keyword):**\n\n```\nmufowa\n```\n\n```\nKarty pokemon\n```\n\n**Examples (listing URL):**\n\n```\nhttps://allegro.pl/listing?string=mufowa\n```\n\n```\nhttps://allegro.pl/listing?string=mufowa&p=2\n```\n\n**Notes:**\n- Pass a keyword alone for page 1, or paste a full `allegro.pl/listing` URL.\n- Use `page` to paginate on keywords (`page=2` → `&p=2`). Overrides `p=` in listing URLs.\n- `string` is the search term; `p` is the page number in the URL.\n- Polish diacritics are supported. Results may include sponsored listings.","schema":{"type":"string","description":"Search keyword or full Allegro listing URL.\n\n**Examples (keyword):**\n\n```\nmufowa\n```\n\n```\nKarty pokemon\n```\n\n**Examples (listing URL):**\n\n```\nhttps://allegro.pl/listing?string=mufowa\n```\n\n```\nhttps://allegro.pl/listing?string=mufowa&p=2\n```\n\n**Notes:**\n- Pass a keyword alone for page 1, or paste a full `allegro.pl/listing` URL.\n- Use `page` to paginate on keywords (`page=2` → `&p=2`). Overrides `p=` in listing URLs.\n- `string` is the search term; `p` is the page number in the URL.\n- Polish diacritics are supported. Results may include sponsored listings."}},{"name":"page","in":"query","required":false,"description":"Page number for keyword searches (default `1`).\n\n**Example:**\n\n    2\n\nOverrides `p=` when `query` is a full listing URL.","schema":{"type":"number","description":"Page number for keyword searches (default `1`).\n\n**Example:**\n\n    2\n\nOverrides `p=` when `query` is a full listing URL."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"offer_id":{"type":"string"},"position":{"type":"integer"},"image_url":{"type":"string"},"seller_id":{"type":"string"},"product_id":{"type":"string"},"listing_url":{"type":"string"},"seller_name":{"type":"string"},"is_sponsored":{"type":"boolean"},"delivery_info":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search keyword 'mufowa' (page 1, 1628 results)":{"value":{"results":[{"price":17.84,"title":"ZŁĄCZKA MUFOWA ZAPRASOWYWANA PEX ALUPEX 32 x 1'' GW TYP SZCZĘK \"U\" MOSIĄDZ","currency":"PLN","offer_id":"13183761915","position":0,"image_url":"https://a.allegroimg.com/s360/116ee2/44bad5d14926a20193c6cb2d8c29/ZLACZKA-MUFOWA-ZAPRASOWYWANA-PEX-ALUPEX-32-x-1-GW-TYP-SZCZEK-U-MOSIADZ","seller_id":"36900410","product_id":"8d15c247-8aeb-4b82-b078-dfae9aa50931","listing_url":"https://allegro.pl/oferta/zlaczka-mufowa-zaprasowywana-pex-alupex-32-x-1-gw-typ-szczek-u-mosiadz-13183761915?bi_s=ads&bi_m=productlisting%3Adesktop%3Aquery&bi_c=ZWUxZGI3YTktZjhmYS00M2U1LWFmZjktMWE2YWM2N2NmZGJjAA&bi_t=ape","seller_name":"HYDMAR","is_sponsored":true,"delivery_info":"28,33 zł z dostawą"},{"price":3.8,"title":"Mufa ocynkowana TICKA złączka mufowa fi 125 do rur spiro wentylacja","currency":"PLN","offer_id":"16509668391","position":1,"image_url":"https://a.allegroimg.com/s360/112b7f/92e216854e069e9f43f2adbc4c74/Mufa-ocynkowana-TICKA-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja","seller_id":"48847819","product_id":"6357bbc1-df4f-48ec-8e99-b346a1326f3c","listing_url":"https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391","seller_name":"amster24_pl","is_sponsored":false,"delivery_info":"14,29 zł z dostawą"},{"price":16.03,"title":"ZŁĄCZKA MUFOWA ZAPRASOWYWANA PEX ALUPEX FI 25 mm x 1'' GW TYP SZCZĘK \"U\" MO","currency":"PLN","offer_id":"13183762597","position":2,"image_url":"https://a.allegroimg.com/s360/114c67/910f7eea4200aec18626dc2d5914/ZLACZKA-MUFOWA-ZAPRASOWYWANA-PEX-ALUPEX-FI-25-mm-x-1-GW-TYP-SZCZEK-U-MO","seller_id":"36900410","product_id":"261dee24-a4cc-4e11-bbb4-037bb429ad8d","listing_url":"https://allegro.pl/oferta/zlaczka-mufowa-zaprasowywana-pex-alupex-fi-25-mm-x-1-gw-typ-szczek-u-mo-13183762597?bi_s=ads&bi_m=productlisting%3Adesktop%3Aquery&bi_c=ZWUxZGI3YTktZjhmYS00M2U1LWFmZjktMWE2YWM2N2NmZGJjAA&bi_t=ape","seller_name":"HYDMAR","is_sponsored":true,"delivery_info":"25,02 zł z dostawą"}],"pagination":{"next":"https://allegro.pl/listing?string=mufowa&p=2","page":1,"per_page":74,"total_pages":13,"total_results":1628}}},"Search keyword 'mufowa' page 2 via page param":{"value":{"results":[{"price":17.84,"title":"ZŁĄCZKA MUFOWA ZAPRASOWYWANA PEX ALUPEX 32 x 1'' GW TYP SZCZĘK \"U\" MOSIĄDZ","currency":"PLN","offer_id":"13183761915","position":0,"image_url":"https://a.allegroimg.com/s360/116ee2/44bad5d14926a20193c6cb2d8c29/ZLACZKA-MUFOWA-ZAPRASOWYWANA-PEX-ALUPEX-32-x-1-GW-TYP-SZCZEK-U-MOSIADZ","seller_id":"36900410","product_id":"8d15c247-8aeb-4b82-b078-dfae9aa50931","listing_url":"https://allegro.pl/oferta/zlaczka-mufowa-zaprasowywana-pex-alupex-32-x-1-gw-typ-szczek-u-mosiadz-13183761915?bi_s=ads&bi_m=productlisting%3Adesktop%3Aquery&bi_c=ZWUxZGI3YTktZjhmYS00M2U1LWFmZjktMWE2YWM2N2NmZGJjAA&bi_t=ape","seller_name":"HYDMAR","is_sponsored":true,"delivery_info":"28,33 zł z dostawą"},{"price":3.8,"title":"Mufa ocynkowana TICKA złączka mufowa fi 125 do rur spiro wentylacja","currency":"PLN","offer_id":"16509668391","position":1,"image_url":"https://a.allegroimg.com/s360/112b7f/92e216854e069e9f43f2adbc4c74/Mufa-ocynkowana-TICKA-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja","seller_id":"48847819","product_id":"6357bbc1-df4f-48ec-8e99-b346a1326f3c","listing_url":"https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391","seller_name":"amster24_pl","is_sponsored":false,"delivery_info":"14,29 zł z dostawą"}],"pagination":{"next":"https://allegro.pl/listing?string=mufowa&p=3","page":2,"per_page":74,"total_pages":13,"total_results":1628}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/allegro/product":{"get":{"summary":"Allegro Product","description":"Allegro Product API. Extract full product page data from allegro.pl by URL (`/produkt/`, `/oferta/`, `/ogloszenie/`). Browser rendering, 3 credits per call. Pair with Allegro Search (3 credits) for listing discovery.\n\n**Credit cost:** 3 credits per call","operationId":"get-allegro-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full allegro.pl product or offer URL to extract structured PDP data.\n\n**Accepted URL formats:**\n\n```\nhttps://allegro.pl/produkt/slug-uuid?offerId=123\n```\n\n```\nhttps://allegro.pl/oferta/slug-offerId\n```\n\n```\nhttps://allegro.pl/ogloszenie/slug-offerId\n```\n\n**Example:**\n\n    https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391\n\n**Notes:**\n- Paste any `listing_url` returned by [Allegro Search](https://www.piloterr.com/library/allegro-search).\n- Supports `/produkt/`, `/oferta/` and `/ogloszenie/` paths on allegro.pl.\n- Inactive or removed listings may return partial data.","schema":{"type":"string","description":"Full allegro.pl product or offer URL to extract structured PDP data.\n\n**Accepted URL formats:**\n\n```\nhttps://allegro.pl/produkt/slug-uuid?offerId=123\n```\n\n```\nhttps://allegro.pl/oferta/slug-offerId\n```\n\n```\nhttps://allegro.pl/ogloszenie/slug-offerId\n```\n\n**Example:**\n\n    https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391\n\n**Notes:**\n- Paste any `listing_url` returned by [Allegro Search](https://www.piloterr.com/library/allegro-search).\n- Supports `/produkt/`, `/oferta/` and `/ogloszenie/` paths on allegro.pl.\n- Inactive or removed listings may return partial data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"bars":{"type":"array","items":{}},"icon":{"type":"string"},"name":{"type":"string"},"skin":{"type":"string"},"type":{"type":"integer"},"brand":{"nullable":true},"image":{"type":"string"},"offer":{"type":"object","properties":{"id":{"type":"string"},"seo":{"type":"object","properties":{"title":{"type":"string"},"noindex":{"type":"boolean"},"nofollow":{"type":"boolean"},"canonical":{"type":"object","properties":{"url":{"type":"string"}}},"description":{"type":"string"}}},"name":{"type":"string"},"view":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"ended":{"nullable":true},"future":{"nullable":true},"snapshot":{"nullable":true},"restricted":{"nullable":true}}},"coins":{"nullable":true},"stock":{"nullable":true},"images":{"type":"array","items":{"type":"object","properties":{"alt":{"type":"string"},"url":{"type":"string"}}}},"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"brand":{"type":"object","properties":{"logotype":{"nullable":true},"description":{"nullable":true}}},"login":{"type":"string"},"banner":{"nullable":true},"company":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"zip_code":{"type":"string"},"country_code":{"type":"string"}}},"verified":{"type":"boolean"},"representative_label":{"type":"string"},"tax_identification_number":{"type":"string"},"national_court_register_number":{"nullable":true},"statistical_identification_number":{"type":"string"}}},"contact":{"type":"object","properties":{"emails":{"type":"array","items":{}},"phones":{"type":"array","items":{}},"open_hours":{"type":"array","items":{"type":"object","properties":{"days_label":{"type":"string"},"hours_labels":{"type":"array","items":{"type":"string"}},"days_short_label":{"type":"string"}}}}}},"listing":{"type":"object","properties":{"url":{"type":"string"}}},"logotype":{"nullable":true},"vacation":{"nullable":true},"descriptions":{"type":"object","properties":{"main":{"nullable":true},"additional":{"nullable":true}}},"super_seller":{"nullable":true},"privacy_policy":{"nullable":true},"representation":{"nullable":true},"category_listing":{"type":"object","properties":{"url":{"type":"string"}}}}},"charity":{"nullable":true},"contact":{"type":"object","properties":{"id":{"type":"string"},"emails":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"}}}},"phones":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"number_label":{"type":"string"},"number_label_masked":{"type":"string"}}}}}},"product":{"type":"object","properties":{"rating":{"nullable":true},"reviews":{"nullable":true}}},"rebates":{"type":"object","properties":{"bundles":{"type":"array","items":{}}}},"category":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tree":{"type":"string"}}},"delivery":{"type":"object","properties":{"summary":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"object","properties":{"id":{"type":"string"}}},"name":{"type":"object","properties":{"icon":{"nullable":true},"text":{"type":"string"},"featured":{"type":"boolean"}}},"badge":{"nullable":true},"value":{"type":"object","properties":{"text":{"type":"string"},"text_color":{"nullable":true},"context_info":{"nullable":true}}},"action":{"nullable":true},"labels":{"type":"array","items":{}}}}}}},"location":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"},"country_code":{"type":"string"}}},"campaigns":{"type":"object","properties":{"summary":{"type":"array","items":{}}}},"watchlist":{"type":"object","properties":{"is_watched":{"type":"boolean"}}},"automotive":{"type":"object","properties":{}},"info_boxes":{"type":"array","items":{}},"parameters":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"url":{"nullable":true},"value_label":{"type":"string"}}}}}}},"attachments":{"type":"array","items":{}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"publication":{"type":"object","properties":{"ended_at":{"nullable":true},"ending_at":{"type":"string"},"starting_at":{"nullable":true},"availability":{"nullable":true}}},"installments":{"nullable":true},"selling_mode":{"type":"object","properties":{"tax":{"nullable":true},"cart":{"nullable":true},"auction":{"nullable":true},"buy_now":{"nullable":true},"restricted":{"nullable":true},"advertisement":{"type":"object","properties":{"price":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"before_exchange":{"nullable":true}}},"price_prefix_label":{"nullable":true}}},"one_click_buy":{"nullable":true}}},"view_counter":{"nullable":true},"product_series":{"nullable":true},"parameters_groups":{"type":"object","properties":{"title":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"icon":{"nullable":true},"name":{"nullable":true},"parameters":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"url":{"nullable":true},"value_label":{"type":"string"}}}}}}},"description":{"nullable":true}}}}}},"assortment_category":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"assortment_category_path":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}},"price":{"type":"string"},"route":{"type":"string"},"title":{"type":"string"},"erotic":{"type":"boolean"}}},"examples":{"Lookup by product URL (obejmy fi50 listing)":{"value":{"sku":"11917354378","url":"https://allegro.pl/ogloszenie/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek-11917354378","bars":[],"icon":"https://a.allegroimg.com/original/341ba4/cb3e84504cacb8b50a0f2c505a62/illustration-small-wallet-d2280e232b","name":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek","skin":"common","type":2,"brand":null,"image":"https://a.allegroimg.com/original/1109e9/c8450d474d65a25d8082ca52dbf3/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek","offer":{"id":"11917354378","seo":{"title":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek 11917354378 - Allegro.pl","noindex":false,"nofollow":false,"canonical":{"url":"https://allegro.pl/ogloszenie/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek-11917354378"},"description":"Kup teraz na Allegro.pl za 6 zł - obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek (11917354378). Allegro.pl - Radość zakupów i bezpieczeństwo dzięki Allegro Protect!"},"name":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek","view":{"url":"https://allegro.pl/ogloszenie/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek-11917354378","type":"ACTIVE","ended":null,"future":null,"snapshot":null,"restricted":null},"coins":null,"stock":null,"images":[{"alt":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek","url":"https://a.allegroimg.com/original/1109e9/c8450d474d65a25d8082ca52dbf3/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek"},{"alt":null,"url":"https://a.allegroimg.com/original/110924/2f2fc328416faa649198eb3b0f0d"},{"alt":null,"url":"https://a.allegroimg.com/original/11faf6/fff75cf143189a981197a7e54d8b"}],"seller":{"id":"46897551","name":"example-user","brand":{"logotype":null,"description":null},"login":"example-user","banner":null,"company":{"name":"FAREX","address":{"city":"Łubniany","street":"Dworcowa, 42","country":"Polska","zip_code":"46-024","country_code":"PL"},"verified":true,"representative_label":"ARTUR PUSCZ","tax_identification_number":"754-201-97-61","national_court_register_number":null,"statistical_identification_number":"532469268"},"contact":{"emails":[],"phones":[],"open_hours":[{"days_label":"poniedziałek - piątek","hours_labels":["08:00–18:00"],"days_short_label":"pon. - pt."},{"days_label":"sobota","hours_labels":["09:00–15:00"],"days_short_label":"sob."},{"days_label":"niedziela","hours_labels":["zamknięte"],"days_short_label":"nd."}]},"listing":{"url":"https://allegro.pl/uzytkownik/example-user"},"logotype":null,"vacation":null,"descriptions":{"main":null,"additional":null},"super_seller":null,"privacy_policy":null,"representation":null,"category_listing":{"url":"https://allegro.pl/uzytkownik/example-user/uslugi-pozostale-258984"}},"charity":null,"contact":{"id":"317e0f93-f02d-4af0-a90b-3f5cd155838d","emails":[{"address":"name@example.com"}],"phones":[{"number":"+33 1 99 00 00 00","number_label":"+33 1 99 00 00 01","number_label_masked":"*** *** 0100"}]},"product":{"rating":null,"reviews":null},"rebates":{"bundles":[]},"category":{"id":"258984","name":"Pozostałe","tree":"navigation-pl"},"delivery":{"summary":[{"icon":{"id":"PIN"},"name":{"icon":null,"text":"Lokalizacja","featured":false},"badge":null,"value":{"text":"Łubniany, woj. opolskie","text_color":null,"context_info":null},"action":null,"labels":[]}]},"location":{"city":"Łubniany","country":"Polska","province":"opolskie","country_code":"PL"},"campaigns":{"summary":[]},"watchlist":{"is_watched":false},"automotive":{},"info_boxes":[],"parameters":[{"id":null,"name":"Faktura","values":[{"id":null,"url":null,"value_label":"Wystawiam fakturę VAT"}]}],"attachments":[],"breadcrumbs":[{"id":"954b95b6-43cf-4104-8354-dea4d9b10ddf","url":"https://allegro.pl","name":"Allegro","type":"DEPARTMENT"},{"id":"4bd97d96-f0ff-46cb-a52c-2992bd972bb1","url":"https://allegro.pl/dzial/firma","name":"Firma i usługi","type":"DEPARTMENT"},{"id":"258972","url":"https://allegro.pl/kategoria/uslugi-258972","name":"Usługi","type":"CATEGORY"},{"id":"258984","url":"https://allegro.pl/kategoria/uslugi-pozostale-258984","name":"Pozostałe","type":"CATEGORY"}],"publication":{"ended_at":null,"ending_at":"2023-11-24T10:51:33Z","starting_at":null,"availability":null},"installments":null,"selling_mode":{"tax":null,"cart":null,"auction":null,"buy_now":null,"restricted":null,"advertisement":{"price":{"amount":"6.00","currency":"PLN","before_exchange":null},"price_prefix_label":null},"one_click_buy":null},"view_counter":null,"product_series":null,"parameters_groups":{"title":"Parametry","groups":[{"icon":null,"name":null,"parameters":[{"id":null,"name":"Faktura","values":[{"id":null,"url":null,"value_label":"Wystawiam fakturę VAT"}]}],"description":null}]},"assortment_category":{"id":"258984","name":"Pozostałe"},"assortment_category_path":[{"id":"954b95b6-43cf-4104-8354-dea4d9b10ddf","name":"Allegro"},{"id":"4bd97d96-f0ff-46cb-a52c-2992bd972bb1","name":"Firma i usługi"},{"id":"258972","name":"Usługi"},{"id":"258984","name":"Pozostałe"}]},"price":"6.00","route":"allegro.pl/ogloszenie/:offerId","title":"Metody płatności","erotic":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Allegro Product","description":"Allegro Product API. Extract full product page data from allegro.pl by URL (`/produkt/`, `/oferta/`, `/ogloszenie/`). Browser rendering, 3 credits per call. Pair with Allegro Search (3 credits) for listing discovery.\n\n**Credit cost:** 3 credits per call","operationId":"post-allegro-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full allegro.pl product or offer URL to extract structured PDP data.\n\n**Accepted URL formats:**\n\n```\nhttps://allegro.pl/produkt/slug-uuid?offerId=123\n```\n\n```\nhttps://allegro.pl/oferta/slug-offerId\n```\n\n```\nhttps://allegro.pl/ogloszenie/slug-offerId\n```\n\n**Example:**\n\n    https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391\n\n**Notes:**\n- Paste any `listing_url` returned by [Allegro Search](https://www.piloterr.com/library/allegro-search).\n- Supports `/produkt/`, `/oferta/` and `/ogloszenie/` paths on allegro.pl.\n- Inactive or removed listings may return partial data.","schema":{"type":"string","description":"Full allegro.pl product or offer URL to extract structured PDP data.\n\n**Accepted URL formats:**\n\n```\nhttps://allegro.pl/produkt/slug-uuid?offerId=123\n```\n\n```\nhttps://allegro.pl/oferta/slug-offerId\n```\n\n```\nhttps://allegro.pl/ogloszenie/slug-offerId\n```\n\n**Example:**\n\n    https://allegro.pl/produkt/mufa-ocynkowana-ticka-zlaczka-mufowa-fi-125-do-rur-spiro-wentylacja-6357bbc1-df4f-48ec-8e99-b346a1326f3c?offerId=16509668391\n\n**Notes:**\n- Paste any `listing_url` returned by [Allegro Search](https://www.piloterr.com/library/allegro-search).\n- Supports `/produkt/`, `/oferta/` and `/ogloszenie/` paths on allegro.pl.\n- Inactive or removed listings may return partial data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"url":{"type":"string"},"bars":{"type":"array","items":{}},"icon":{"type":"string"},"name":{"type":"string"},"skin":{"type":"string"},"type":{"type":"integer"},"brand":{"nullable":true},"image":{"type":"string"},"offer":{"type":"object","properties":{"id":{"type":"string"},"seo":{"type":"object","properties":{"title":{"type":"string"},"noindex":{"type":"boolean"},"nofollow":{"type":"boolean"},"canonical":{"type":"object","properties":{"url":{"type":"string"}}},"description":{"type":"string"}}},"name":{"type":"string"},"view":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"ended":{"nullable":true},"future":{"nullable":true},"snapshot":{"nullable":true},"restricted":{"nullable":true}}},"coins":{"nullable":true},"stock":{"nullable":true},"images":{"type":"array","items":{"type":"object","properties":{"alt":{"type":"string"},"url":{"type":"string"}}}},"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"brand":{"type":"object","properties":{"logotype":{"nullable":true},"description":{"nullable":true}}},"login":{"type":"string"},"banner":{"nullable":true},"company":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"zip_code":{"type":"string"},"country_code":{"type":"string"}}},"verified":{"type":"boolean"},"representative_label":{"type":"string"},"tax_identification_number":{"type":"string"},"national_court_register_number":{"nullable":true},"statistical_identification_number":{"type":"string"}}},"contact":{"type":"object","properties":{"emails":{"type":"array","items":{}},"phones":{"type":"array","items":{}},"open_hours":{"type":"array","items":{"type":"object","properties":{"days_label":{"type":"string"},"hours_labels":{"type":"array","items":{"type":"string"}},"days_short_label":{"type":"string"}}}}}},"listing":{"type":"object","properties":{"url":{"type":"string"}}},"logotype":{"nullable":true},"vacation":{"nullable":true},"descriptions":{"type":"object","properties":{"main":{"nullable":true},"additional":{"nullable":true}}},"super_seller":{"nullable":true},"privacy_policy":{"nullable":true},"representation":{"nullable":true},"category_listing":{"type":"object","properties":{"url":{"type":"string"}}}}},"charity":{"nullable":true},"contact":{"type":"object","properties":{"id":{"type":"string"},"emails":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"}}}},"phones":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"number_label":{"type":"string"},"number_label_masked":{"type":"string"}}}}}},"product":{"type":"object","properties":{"rating":{"nullable":true},"reviews":{"nullable":true}}},"rebates":{"type":"object","properties":{"bundles":{"type":"array","items":{}}}},"category":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tree":{"type":"string"}}},"delivery":{"type":"object","properties":{"summary":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"object","properties":{"id":{"type":"string"}}},"name":{"type":"object","properties":{"icon":{"nullable":true},"text":{"type":"string"},"featured":{"type":"boolean"}}},"badge":{"nullable":true},"value":{"type":"object","properties":{"text":{"type":"string"},"text_color":{"nullable":true},"context_info":{"nullable":true}}},"action":{"nullable":true},"labels":{"type":"array","items":{}}}}}}},"location":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"},"country_code":{"type":"string"}}},"campaigns":{"type":"object","properties":{"summary":{"type":"array","items":{}}}},"watchlist":{"type":"object","properties":{"is_watched":{"type":"boolean"}}},"automotive":{"type":"object","properties":{}},"info_boxes":{"type":"array","items":{}},"parameters":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"url":{"nullable":true},"value_label":{"type":"string"}}}}}}},"attachments":{"type":"array","items":{}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"publication":{"type":"object","properties":{"ended_at":{"nullable":true},"ending_at":{"type":"string"},"starting_at":{"nullable":true},"availability":{"nullable":true}}},"installments":{"nullable":true},"selling_mode":{"type":"object","properties":{"tax":{"nullable":true},"cart":{"nullable":true},"auction":{"nullable":true},"buy_now":{"nullable":true},"restricted":{"nullable":true},"advertisement":{"type":"object","properties":{"price":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"before_exchange":{"nullable":true}}},"price_prefix_label":{"nullable":true}}},"one_click_buy":{"nullable":true}}},"view_counter":{"nullable":true},"product_series":{"nullable":true},"parameters_groups":{"type":"object","properties":{"title":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"icon":{"nullable":true},"name":{"nullable":true},"parameters":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"name":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"url":{"nullable":true},"value_label":{"type":"string"}}}}}}},"description":{"nullable":true}}}}}},"assortment_category":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"assortment_category_path":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}},"price":{"type":"string"},"route":{"type":"string"},"title":{"type":"string"},"erotic":{"type":"boolean"}}},"examples":{"Lookup by product URL (obejmy fi50 listing)":{"value":{"sku":"11917354378","url":"https://allegro.pl/ogloszenie/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek-11917354378","bars":[],"icon":"https://a.allegroimg.com/original/341ba4/cb3e84504cacb8b50a0f2c505a62/illustration-small-wallet-d2280e232b","name":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek","skin":"common","type":2,"brand":null,"image":"https://a.allegroimg.com/original/1109e9/c8450d474d65a25d8082ca52dbf3/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek","offer":{"id":"11917354378","seo":{"title":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek 11917354378 - Allegro.pl","noindex":false,"nofollow":false,"canonical":{"url":"https://allegro.pl/ogloszenie/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek-11917354378"},"description":"Kup teraz na Allegro.pl za 6 zł - obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek (11917354378). Allegro.pl - Radość zakupów i bezpieczeństwo dzięki Allegro Protect!"},"name":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek","view":{"url":"https://allegro.pl/ogloszenie/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek-11917354378","type":"ACTIVE","ended":null,"future":null,"snapshot":null,"restricted":null},"coins":null,"stock":null,"images":[{"alt":"obejmy fi50 fi51 fi52 i inne obejma uchwyty słupek","url":"https://a.allegroimg.com/original/1109e9/c8450d474d65a25d8082ca52dbf3/obejmy-fi50-fi51-fi52-i-inne-obejma-uchwyty-slupek"},{"alt":null,"url":"https://a.allegroimg.com/original/110924/2f2fc328416faa649198eb3b0f0d"},{"alt":null,"url":"https://a.allegroimg.com/original/11faf6/fff75cf143189a981197a7e54d8b"}],"seller":{"id":"46897551","name":"example-user","brand":{"logotype":null,"description":null},"login":"example-user","banner":null,"company":{"name":"FAREX","address":{"city":"Łubniany","street":"Dworcowa, 42","country":"Polska","zip_code":"46-024","country_code":"PL"},"verified":true,"representative_label":"ARTUR PUSCZ","tax_identification_number":"754-201-97-61","national_court_register_number":null,"statistical_identification_number":"532469268"},"contact":{"emails":[],"phones":[],"open_hours":[{"days_label":"poniedziałek - piątek","hours_labels":["08:00–18:00"],"days_short_label":"pon. - pt."},{"days_label":"sobota","hours_labels":["09:00–15:00"],"days_short_label":"sob."},{"days_label":"niedziela","hours_labels":["zamknięte"],"days_short_label":"nd."}]},"listing":{"url":"https://allegro.pl/uzytkownik/example-user"},"logotype":null,"vacation":null,"descriptions":{"main":null,"additional":null},"super_seller":null,"privacy_policy":null,"representation":null,"category_listing":{"url":"https://allegro.pl/uzytkownik/example-user/uslugi-pozostale-258984"}},"charity":null,"contact":{"id":"317e0f93-f02d-4af0-a90b-3f5cd155838d","emails":[{"address":"name@example.com"}],"phones":[{"number":"+33 1 99 00 00 00","number_label":"+33 1 99 00 00 01","number_label_masked":"*** *** 0100"}]},"product":{"rating":null,"reviews":null},"rebates":{"bundles":[]},"category":{"id":"258984","name":"Pozostałe","tree":"navigation-pl"},"delivery":{"summary":[{"icon":{"id":"PIN"},"name":{"icon":null,"text":"Lokalizacja","featured":false},"badge":null,"value":{"text":"Łubniany, woj. opolskie","text_color":null,"context_info":null},"action":null,"labels":[]}]},"location":{"city":"Łubniany","country":"Polska","province":"opolskie","country_code":"PL"},"campaigns":{"summary":[]},"watchlist":{"is_watched":false},"automotive":{},"info_boxes":[],"parameters":[{"id":null,"name":"Faktura","values":[{"id":null,"url":null,"value_label":"Wystawiam fakturę VAT"}]}],"attachments":[],"breadcrumbs":[{"id":"954b95b6-43cf-4104-8354-dea4d9b10ddf","url":"https://allegro.pl","name":"Allegro","type":"DEPARTMENT"},{"id":"4bd97d96-f0ff-46cb-a52c-2992bd972bb1","url":"https://allegro.pl/dzial/firma","name":"Firma i usługi","type":"DEPARTMENT"},{"id":"258972","url":"https://allegro.pl/kategoria/uslugi-258972","name":"Usługi","type":"CATEGORY"},{"id":"258984","url":"https://allegro.pl/kategoria/uslugi-pozostale-258984","name":"Pozostałe","type":"CATEGORY"}],"publication":{"ended_at":null,"ending_at":"2023-11-24T10:51:33Z","starting_at":null,"availability":null},"installments":null,"selling_mode":{"tax":null,"cart":null,"auction":null,"buy_now":null,"restricted":null,"advertisement":{"price":{"amount":"6.00","currency":"PLN","before_exchange":null},"price_prefix_label":null},"one_click_buy":null},"view_counter":null,"product_series":null,"parameters_groups":{"title":"Parametry","groups":[{"icon":null,"name":null,"parameters":[{"id":null,"name":"Faktura","values":[{"id":null,"url":null,"value_label":"Wystawiam fakturę VAT"}]}],"description":null}]},"assortment_category":{"id":"258984","name":"Pozostałe"},"assortment_category_path":[{"id":"954b95b6-43cf-4104-8354-dea4d9b10ddf","name":"Allegro"},{"id":"4bd97d96-f0ff-46cb-a52c-2992bd972bb1","name":"Firma i usługi"},{"id":"258972","name":"Usługi"},{"id":"258984","name":"Pozostałe"}]},"price":"6.00","route":"allegro.pl/ogloszenie/:offerId","title":"Metody płatności","erotic":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/datasets/linkedin/company":{"post":{"summary":"Dataset Linkedin Company","description":"Query the LinkedIn company dataset with Elasticsearch Query DSL. Filter by name, domain, industry, headcount, and country. POST-only, 1 credit per row returned.\n\n**Credit cost:** 1 credit per row","operationId":"datasets-linkedin-company","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"hits":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"_type":{"type":"string"},"_index":{"type":"string"},"_score":{"type":"number"},"_source":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"},"founded":{"type":"integer"},"tagline":{"type":"string"},"website":{"type":"string"},"industry":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"description":{"type":"string"},"staff_count":{"type":"integer"},"staff_range":{"type":"string"},"linkedin_url":{"type":"string"},"locations_list":{"type":"array","items":{}},"last_crawled_at":{"type":"string"},"headquarter_city":{"nullable":true},"headquarter_line1":{"nullable":true},"linkedin_id_alpha":{"type":"string"},"specialities_list":{"type":"array","items":{"type":"string"}},"headquarter_country":{"nullable":true},"linkedin_id_numeric":{"type":"integer"},"headquarter_postal_code":{"nullable":true}}}}}},"total":{"type":"integer"},"max_score":{"type":"number"},"search_metadata":{"type":"object","properties":{"credits":{"type":"object","properties":{"linkedin_company_count":{"type":"integer"}}},"account_id":{"type":"string"},"account_name":{"type":"string"}}}}},"examples":{"Search by company name - WebAPI Group":{"value":{"hits":[{"_id":"31","_type":"_doc","_index":"linkedin_company","_score":18.08,"_source":{"name":"WebAPI Group","domain":"webapi.group","founded":2022,"tagline":"We elevate your business, one API at a time.","website":"https://www.webapi.group/","industry":"Software Development","created_at":"2024-05-06T08:59:44.485+00:00","updated_at":"2026-01-01T14:18:57.406+00:00","description":"Unlock the full potential of web intelligence with our APIs.","staff_count":2,"staff_range":"1-10","linkedin_url":"https://www.linkedin.com/company/webapi-group","locations_list":[],"last_crawled_at":"2026-01-01T14:18:35.442+00:00","headquarter_city":null,"headquarter_line1":null,"linkedin_id_alpha":"webapi-group","specialities_list":["API","Scraping","Web","Web intelligence"],"headquarter_country":null,"linkedin_id_numeric":101119787,"headquarter_postal_code":null}}],"total":1,"max_score":18.08,"search_metadata":{"credits":{"linkedin_company_count":1},"account_id":"*","account_name":"*"}}},"Lookup by domain - openai.com":{"value":{"hits":[{"_id":"2842","_type":"_doc","_index":"linkedin_company","_score":18.084406,"_source":{"name":"OpenAI","domain":"openai.com","founded":2015,"tagline":"Creating safe AGI that benefits all of humanity.","website":"https://openai.com/","industry":"Research Services","description":"OpenAI is an AI research and deployment company.","staff_count":3848,"staff_range":"1k-5k","linkedin_url":"https://www.linkedin.com/company/openai","headquarter_city":"San Francisco","linkedin_id_alpha":"openai","specialities_list":["artificial intelligence machine learning"],"headquarter_country":"US","linkedin_id_numeric":11130470}}],"total":34,"max_score":18.084406}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ebay/search":{"get":{"summary":"eBay Search","description":"eBay Search API: search listings on supported eBay sites. Returns price, seller, and pagination (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"get-ebay-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword on www.ebay.com, or a search URL on a supported eBay site.\n\n**Example (keyword):**\n\n    laptop\n\n**Example (search URL):**\n\n    https://www.ebay.fr/sch/i.html?_nkw=ordinateur\n\n**Notes:**\n- A keyword always searches `www.ebay.com`.\n- A URL must start with `/sch`. An `/itm/` URL returns 400.\n- `ebay.be` and any other host return 400.","schema":{"type":"string","description":"Keyword on www.ebay.com, or a search URL on a supported eBay site.\n\n**Example (keyword):**\n\n    laptop\n\n**Example (search URL):**\n\n    https://www.ebay.fr/sch/i.html?_nkw=ordinateur\n\n**Notes:**\n- A keyword always searches `www.ebay.com`.\n- A URL must start with `/sch`. An `/itm/` URL returns 400.\n- `ebay.be` and any other host return 400."}},{"name":"page","in":"query","required":false,"description":"Page number, sent as _pgn. Default 1 for a keyword. On a URL, the page already in the URL is kept when this is empty. Below 1 returns 400.","schema":{"type":"number","description":"Page number, sent as _pgn. Default 1 for a keyword. On a URL, the page already in the URL is kept when this is empty. Below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"bids":{"nullable":true},"price":{"type":"number"},"title":{"type":"string"},"rating":{"nullable":true},"seller":{"type":"object","properties":{"name":{"type":"string"},"feedback":{"type":"string"},"positive_feedback_percent":{"type":"integer"}}},"item_id":{"type":"string"},"reviews":{"nullable":true},"currency":{"type":"string"},"location":{"nullable":true},"position":{"type":"integer"},"shipping":{"type":"string"},"subtitle":{"type":"string"},"watchers":{"nullable":true},"condition":{"type":"string"},"image_url":{"type":"string"},"old_price":{"type":"number"},"price_max":{"nullable":true},"time_left":{"nullable":true},"items_sold":{"type":"integer"},"buying_format":{"type":"string"},"is_best_offer":{"type":"boolean"},"price_display":{"type":"string"},"is_free_return":{"type":"boolean"},"is_new_listing":{"type":"boolean"},"discount_percent":{"type":"integer"},"old_price_display":{"type":"string"},"items_sold_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Dell Latitude 5520 on ebay.com":{"value":{"results":[{"url":"https://www.ebay.com/itm/336517253224","bids":null,"price":399.99,"title":"Dell Latitude 5520 i5 15.6\" Touchscreen Laptop 16GB 512GB SSD Win 11 Pro","rating":null,"seller":{"name":"aaa_pcs","feedback":"8.4K","positive_feedback_percent":100},"item_id":"336517253224","reviews":null,"currency":"USD","location":null,"position":31,"shipping":"Shipping not specified","subtitle":"Dell","watchers":null,"condition":"Excellent - Refurbished","image_url":"https://i.ebayimg.com/images/g/~n4AAeSwxEBpXWER/s-l140.webp","old_price":474.99,"price_max":null,"time_left":null,"items_sold":299,"buying_format":"Buy It Now","is_best_offer":false,"price_display":"$399.99","is_free_return":false,"is_new_listing":false,"discount_percent":16,"old_price_display":"$474.99","items_sold_display":"299 sold"}],"pagination":{"next":"https://www.ebay.com/sch/i.html?_nkw=laptop&_ipg=60&_pgn=2","page":1,"per_page":60,"total_pages":null,"total_results":190000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"eBay Search","description":"eBay Search API: search listings on supported eBay sites. Returns price, seller, and pagination (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"post-ebay-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword on www.ebay.com, or a search URL on a supported eBay site.\n\n**Example (keyword):**\n\n    laptop\n\n**Example (search URL):**\n\n    https://www.ebay.fr/sch/i.html?_nkw=ordinateur\n\n**Notes:**\n- A keyword always searches `www.ebay.com`.\n- A URL must start with `/sch`. An `/itm/` URL returns 400.\n- `ebay.be` and any other host return 400.","schema":{"type":"string","description":"Keyword on www.ebay.com, or a search URL on a supported eBay site.\n\n**Example (keyword):**\n\n    laptop\n\n**Example (search URL):**\n\n    https://www.ebay.fr/sch/i.html?_nkw=ordinateur\n\n**Notes:**\n- A keyword always searches `www.ebay.com`.\n- A URL must start with `/sch`. An `/itm/` URL returns 400.\n- `ebay.be` and any other host return 400."}},{"name":"page","in":"query","required":false,"description":"Page number, sent as _pgn. Default 1 for a keyword. On a URL, the page already in the URL is kept when this is empty. Below 1 returns 400.","schema":{"type":"number","description":"Page number, sent as _pgn. Default 1 for a keyword. On a URL, the page already in the URL is kept when this is empty. Below 1 returns 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"bids":{"nullable":true},"price":{"type":"number"},"title":{"type":"string"},"rating":{"nullable":true},"seller":{"type":"object","properties":{"name":{"type":"string"},"feedback":{"type":"string"},"positive_feedback_percent":{"type":"integer"}}},"item_id":{"type":"string"},"reviews":{"nullable":true},"currency":{"type":"string"},"location":{"nullable":true},"position":{"type":"integer"},"shipping":{"type":"string"},"subtitle":{"type":"string"},"watchers":{"nullable":true},"condition":{"type":"string"},"image_url":{"type":"string"},"old_price":{"type":"number"},"price_max":{"nullable":true},"time_left":{"nullable":true},"items_sold":{"type":"integer"},"buying_format":{"type":"string"},"is_best_offer":{"type":"boolean"},"price_display":{"type":"string"},"is_free_return":{"type":"boolean"},"is_new_listing":{"type":"boolean"},"discount_percent":{"type":"integer"},"old_price_display":{"type":"string"},"items_sold_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"nullable":true},"total_results":{"type":"integer"}}}}},"examples":{"Dell Latitude 5520 on ebay.com":{"value":{"results":[{"url":"https://www.ebay.com/itm/336517253224","bids":null,"price":399.99,"title":"Dell Latitude 5520 i5 15.6\" Touchscreen Laptop 16GB 512GB SSD Win 11 Pro","rating":null,"seller":{"name":"aaa_pcs","feedback":"8.4K","positive_feedback_percent":100},"item_id":"336517253224","reviews":null,"currency":"USD","location":null,"position":31,"shipping":"Shipping not specified","subtitle":"Dell","watchers":null,"condition":"Excellent - Refurbished","image_url":"https://i.ebayimg.com/images/g/~n4AAeSwxEBpXWER/s-l140.webp","old_price":474.99,"price_max":null,"time_left":null,"items_sold":299,"buying_format":"Buy It Now","is_best_offer":false,"price_display":"$399.99","is_free_return":false,"is_new_listing":false,"discount_percent":16,"old_price_display":"$474.99","items_sold_display":"299 sold"}],"pagination":{"next":"https://www.ebay.com/sch/i.html?_nkw=laptop&_ipg=60&_pgn=2","page":1,"per_page":60,"total_pages":null,"total_results":190000}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ebay/product":{"get":{"summary":"eBay Product","description":"eBay Product API: one listing on a supported eBay site, by URL or item id (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"get-ebay-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Item id, or an item URL on a supported eBay site.\n\n**Example (item id):**\n\n    257758922911\n\n**Example (item URL):**\n\n    https://www.ebay.de/itm/257758922911\n\n**Notes:**\n- A bare id is loaded on `www.ebay.com`.\n- A keyword or a `/sch` URL returns 400.\n- `ebay.be` and the placeholder id `123456` return 400.","schema":{"type":"string","description":"Item id, or an item URL on a supported eBay site.\n\n**Example (item id):**\n\n    257758922911\n\n**Example (item URL):**\n\n    https://www.ebay.de/itm/257758922911\n\n**Notes:**\n- A bare id is loaded on `www.ebay.com`.\n- A keyword or a `/sch` URL returns 400.\n- `ebay.be` and the placeholder id `123456` return 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"nullable":true},"url":{"type":"string"},"gtin":{"nullable":true},"brand":{"type":"string"},"model":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"position":{"type":"integer"}}}},"seller":{"type":"object","properties":{"name":{"type":"string"},"feedback":{"type":"string"},"thumbnail":{"type":"string"},"positive_feedback_percent":{"type":"integer"}}},"item_id":{"type":"string"},"returns":{"type":"object","properties":{"summary":{"type":"string"},"accepts_returns":{"type":"boolean"}}},"currency":{"type":"string"},"shipping":{"type":"object","properties":{"summary":{"type":"string"},"ships_to":{"type":"string"},"handling_time":{"nullable":true},"seller_location":{"nullable":true}}},"watchers":{"type":"integer"},"condition":{"type":"string"},"image_url":{"type":"string"},"items_sold":{"nullable":true},"description":{"nullable":true},"availability":{"type":"string"},"is_best_offer":{"type":"boolean"},"is_buy_it_now":{"type":"boolean"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"payment_methods":{"type":"array","items":{"type":"string"}},"quantity_available":{"nullable":true},"condition_description":{"type":"string"}}},"examples":{"Dell Latitude 5520 (336517253224)":{"value":{"mpn":null,"url":"https://www.ebay.com/itm/336517253224","gtin":null,"brand":"Dell","model":"Dell Latitude 5520","price":399.99,"title":"Dell Latitude 5520 i5 15.6\" Touchscreen Laptop 16GB 512GB SSD Win 11 Pro","images":[{"url":"https://i.ebayimg.com/images/g/~n4AAeSwxEBpXWER/s-l1600.png","position":1},{"url":"https://i.ebayimg.com/images/g/RPgAAOSwLcBieqIK/s-l1600.jpg","position":2},{"url":"https://i.ebayimg.com/images/g/76UAAeSwmRFqyRth/s-l1600.png","position":3}],"seller":{"name":"AAA PCs Store","feedback":"8442","thumbnail":"https://i.ebayimg.com/images/g/hBUAAOSw6WZndu3y/s-l64.jpg","positive_feedback_percent":100},"item_id":"336517253224","returns":{"summary":"30 days returns . Buyer pays for return shipping. If you use an eBay shipping label, it will be deducted from your refund amount . See details - for more information about returns","accepts_returns":true},"currency":"USD","shipping":{"summary":"May not ship to France. Read item description or contact seller for shipping options. See details for shipping Located in: Fort Myers, Florida, United States","ships_to":"Varies","handling_time":null,"seller_location":null},"watchers":383,"condition":"Excellent - Refurbished","image_url":"https://i.ebayimg.com/images/g/~n4AAeSwxEBpXWER/s-l1600.png","items_sold":null,"description":null,"availability":"InStock","is_best_offer":false,"is_buy_it_now":true,"price_display":"US $399.99","specifications":[{"name":"Processor","value":"Intel Core i5 11th Gen."},{"name":"Graphics Processing Type","value":"Integrated/On-Board Graphics"},{"name":"SSD Capacity","value":"512 GB"},{"name":"Most Suitable For","value":"Casual Computing, Graphic Design, Workstation"},{"name":"GPU","value":"Intel Iris Xe Graphics"},{"name":"Getting started with your laptop","value":"Essential Setup Guide included in the box!"},{"name":"SSD Speed","value":"This is an NVMe SSD installed which is x4 faster than SATA 3!"},{"name":"Release Year","value":"Refurbished in 2026. (New: RAM/SSD/OS)"}],"payment_methods":["PayPal","Google Pay","Visa","Master Card","Discover","Diners Club","PAYPAL_CREDIT"],"quantity_available":null,"condition_description":"AAA PCs is a partner of a Microsoft Authorized Refurbisher. (MAR) Your computer will ship securely"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"eBay Product","description":"eBay Product API: one listing on a supported eBay site, by URL or item id (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"post-ebay-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Item id, or an item URL on a supported eBay site.\n\n**Example (item id):**\n\n    257758922911\n\n**Example (item URL):**\n\n    https://www.ebay.de/itm/257758922911\n\n**Notes:**\n- A bare id is loaded on `www.ebay.com`.\n- A keyword or a `/sch` URL returns 400.\n- `ebay.be` and the placeholder id `123456` return 400.","schema":{"type":"string","description":"Item id, or an item URL on a supported eBay site.\n\n**Example (item id):**\n\n    257758922911\n\n**Example (item URL):**\n\n    https://www.ebay.de/itm/257758922911\n\n**Notes:**\n- A bare id is loaded on `www.ebay.com`.\n- A keyword or a `/sch` URL returns 400.\n- `ebay.be` and the placeholder id `123456` return 400."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return raw HTML.","schema":{"type":"boolean","description":"When true, return raw HTML."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mpn":{"nullable":true},"url":{"type":"string"},"gtin":{"nullable":true},"brand":{"type":"string"},"model":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"position":{"type":"integer"}}}},"seller":{"type":"object","properties":{"name":{"type":"string"},"feedback":{"type":"string"},"thumbnail":{"type":"string"},"positive_feedback_percent":{"type":"integer"}}},"item_id":{"type":"string"},"returns":{"type":"object","properties":{"summary":{"type":"string"},"accepts_returns":{"type":"boolean"}}},"currency":{"type":"string"},"shipping":{"type":"object","properties":{"summary":{"type":"string"},"ships_to":{"type":"string"},"handling_time":{"nullable":true},"seller_location":{"nullable":true}}},"watchers":{"type":"integer"},"condition":{"type":"string"},"image_url":{"type":"string"},"items_sold":{"nullable":true},"description":{"nullable":true},"availability":{"type":"string"},"is_best_offer":{"type":"boolean"},"is_buy_it_now":{"type":"boolean"},"price_display":{"type":"string"},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"payment_methods":{"type":"array","items":{"type":"string"}},"quantity_available":{"nullable":true},"condition_description":{"type":"string"}}},"examples":{"Dell Latitude 5520 (336517253224)":{"value":{"mpn":null,"url":"https://www.ebay.com/itm/336517253224","gtin":null,"brand":"Dell","model":"Dell Latitude 5520","price":399.99,"title":"Dell Latitude 5520 i5 15.6\" Touchscreen Laptop 16GB 512GB SSD Win 11 Pro","images":[{"url":"https://i.ebayimg.com/images/g/~n4AAeSwxEBpXWER/s-l1600.png","position":1},{"url":"https://i.ebayimg.com/images/g/RPgAAOSwLcBieqIK/s-l1600.jpg","position":2},{"url":"https://i.ebayimg.com/images/g/76UAAeSwmRFqyRth/s-l1600.png","position":3}],"seller":{"name":"AAA PCs Store","feedback":"8442","thumbnail":"https://i.ebayimg.com/images/g/hBUAAOSw6WZndu3y/s-l64.jpg","positive_feedback_percent":100},"item_id":"336517253224","returns":{"summary":"30 days returns . Buyer pays for return shipping. If you use an eBay shipping label, it will be deducted from your refund amount . See details - for more information about returns","accepts_returns":true},"currency":"USD","shipping":{"summary":"May not ship to France. Read item description or contact seller for shipping options. See details for shipping Located in: Fort Myers, Florida, United States","ships_to":"Varies","handling_time":null,"seller_location":null},"watchers":383,"condition":"Excellent - Refurbished","image_url":"https://i.ebayimg.com/images/g/~n4AAeSwxEBpXWER/s-l1600.png","items_sold":null,"description":null,"availability":"InStock","is_best_offer":false,"is_buy_it_now":true,"price_display":"US $399.99","specifications":[{"name":"Processor","value":"Intel Core i5 11th Gen."},{"name":"Graphics Processing Type","value":"Integrated/On-Board Graphics"},{"name":"SSD Capacity","value":"512 GB"},{"name":"Most Suitable For","value":"Casual Computing, Graphic Design, Workstation"},{"name":"GPU","value":"Intel Iris Xe Graphics"},{"name":"Getting started with your laptop","value":"Essential Setup Guide included in the box!"},{"name":"SSD Speed","value":"This is an NVMe SSD installed which is x4 faster than SATA 3!"},{"name":"Release Year","value":"Refurbished in 2026. (New: RAM/SSD/OS)"}],"payment_methods":["PayPal","Google Pay","Visa","Master Card","Discover","Diners Club","PAYPAL_CREDIT"],"quantity_available":null,"condition_description":"AAA PCs is a partner of a Microsoft Authorized Refurbisher. (MAR) Your computer will ship securely"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zoopla/search":{"get":{"summary":"Zoopla Search","description":"Search Zoopla listings from a search URL and retrieve prices, specs, photos, agency info, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-zoopla-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zoopla search results URL.\n\n**Example 1 (for-sale):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/\n\n**Example 2 (filtered search):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/?beds_min=2&price_max=160000&q=Manchester%2C%20Greater%20Manchester\n\n**Example 3 (to-rent):**\n\n    https://www.zoopla.co.uk/to-rent/property/london/\n\n**Notes:**\n- Supports for-sale, to-rent, and new-homes search URLs.\n- Filters and pagination parameters in the URL are respected.\n- Pagination via `?pn=2` in the URL.\n- Use each result's `url` with the Zoopla Property endpoint for full listing data.","schema":{"type":"string","description":"Full Zoopla search results URL.\n\n**Example 1 (for-sale):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/\n\n**Example 2 (filtered search):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/?beds_min=2&price_max=160000&q=Manchester%2C%20Greater%20Manchester\n\n**Example 3 (to-rent):**\n\n    https://www.zoopla.co.uk/to-rent/property/london/\n\n**Notes:**\n- Supports for-sale, to-rent, and new-homes search URLs.\n- Filters and pagination parameters in the URL are respected.\n- Pagination via `?pn=2` in the URL.\n- Use each result's `url` with the Zoopla Property endpoint for full listing data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"agency":{"type":"string"},"address":{"type":"string"},"square_ft":{"type":"integer"},"just_added":{"type":"boolean"},"description":{"type":"string"},"num_bedrooms":{"type":"integer"},"num_bathrooms":{"type":"integer"},"price_currency":{"type":"string"},"num_living_room":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Search homes for sale in Manchester":{"value":{"results":[{"url":"https://www.zoopla.co.uk/new-homes/details/71832056/","image":"https://lid.zoocdn.com/645/430/47fabc16bd9d4a08bf75ae1d2097af505b5914f0.jpg","price":132300,"agency":"Latimer Homes - Islington Wharf","address":"Old Mill Street, Manchester M4","square_ft":883,"just_added":false,"description":"Price shown is 35% share of £378,000 full market value.","num_bedrooms":2,"num_bathrooms":2,"price_currency":"Sterling pound £","num_living_room":null},{"url":"https://www.zoopla.co.uk/new-homes/details/72441029/","image":"https://lid.zoocdn.com/645/430/bdc475a4ce5f4d81dd023d14bf099df1155117bd.jpg","price":87000,"agency":"L&Q - Victoria Riverside","address":"Dantzic Street, Manchester M4","square_ft":null,"just_added":false,"description":"Reserve a 1 or 2 bedroom apartment between 1 – 30 June with a £99 reservation fee and unlock better interest rates with a ...","num_bedrooms":2,"num_bathrooms":2,"price_currency":"Sterling pound £","num_living_room":null},{"url":"https://www.zoopla.co.uk/for-sale/details/71163101/","image":"https://lid.zoocdn.com/645/430/0bd485d8f19088a91bdbf64d62d6493843f530ca.jpg","price":145000,"agency":"Ascend, Manchester","address":"Lexington Court, Broadway, Salford Quays M50","square_ft":null,"just_added":false,"description":"*Buy To Let Investors Only* - Tenanted at £975pcm Welcome to this charming apartment located in the desirable Lexington ...","num_bedrooms":2,"num_bathrooms":1,"price_currency":"Sterling pound £","num_living_room":1}],"pagination":{"next":2,"current":1,"other_pages":[],"total_pages":12,"has_next_page":true,"total_results":296}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zoopla Search","description":"Search Zoopla listings from a search URL and retrieve prices, specs, photos, agency info, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-zoopla-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zoopla search results URL.\n\n**Example 1 (for-sale):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/\n\n**Example 2 (filtered search):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/?beds_min=2&price_max=160000&q=Manchester%2C%20Greater%20Manchester\n\n**Example 3 (to-rent):**\n\n    https://www.zoopla.co.uk/to-rent/property/london/\n\n**Notes:**\n- Supports for-sale, to-rent, and new-homes search URLs.\n- Filters and pagination parameters in the URL are respected.\n- Pagination via `?pn=2` in the URL.\n- Use each result's `url` with the Zoopla Property endpoint for full listing data.","schema":{"type":"string","description":"Full Zoopla search results URL.\n\n**Example 1 (for-sale):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/\n\n**Example 2 (filtered search):**\n\n    https://www.zoopla.co.uk/for-sale/property/manchester/?beds_min=2&price_max=160000&q=Manchester%2C%20Greater%20Manchester\n\n**Example 3 (to-rent):**\n\n    https://www.zoopla.co.uk/to-rent/property/london/\n\n**Notes:**\n- Supports for-sale, to-rent, and new-homes search URLs.\n- Filters and pagination parameters in the URL are respected.\n- Pagination via `?pn=2` in the URL.\n- Use each result's `url` with the Zoopla Property endpoint for full listing data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"agency":{"type":"string"},"address":{"type":"string"},"square_ft":{"type":"integer"},"just_added":{"type":"boolean"},"description":{"type":"string"},"num_bedrooms":{"type":"integer"},"num_bathrooms":{"type":"integer"},"price_currency":{"type":"string"},"num_living_room":{"nullable":true}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}}}},"examples":{"Search homes for sale in Manchester":{"value":{"results":[{"url":"https://www.zoopla.co.uk/new-homes/details/71832056/","image":"https://lid.zoocdn.com/645/430/47fabc16bd9d4a08bf75ae1d2097af505b5914f0.jpg","price":132300,"agency":"Latimer Homes - Islington Wharf","address":"Old Mill Street, Manchester M4","square_ft":883,"just_added":false,"description":"Price shown is 35% share of £378,000 full market value.","num_bedrooms":2,"num_bathrooms":2,"price_currency":"Sterling pound £","num_living_room":null},{"url":"https://www.zoopla.co.uk/new-homes/details/72441029/","image":"https://lid.zoocdn.com/645/430/bdc475a4ce5f4d81dd023d14bf099df1155117bd.jpg","price":87000,"agency":"L&Q - Victoria Riverside","address":"Dantzic Street, Manchester M4","square_ft":null,"just_added":false,"description":"Reserve a 1 or 2 bedroom apartment between 1 – 30 June with a £99 reservation fee and unlock better interest rates with a ...","num_bedrooms":2,"num_bathrooms":2,"price_currency":"Sterling pound £","num_living_room":null},{"url":"https://www.zoopla.co.uk/for-sale/details/71163101/","image":"https://lid.zoocdn.com/645/430/0bd485d8f19088a91bdbf64d62d6493843f530ca.jpg","price":145000,"agency":"Ascend, Manchester","address":"Lexington Court, Broadway, Salford Quays M50","square_ft":null,"just_added":false,"description":"*Buy To Let Investors Only* - Tenanted at £975pcm Welcome to this charming apartment located in the desirable Lexington ...","num_bedrooms":2,"num_bathrooms":1,"price_currency":"Sterling pound £","num_living_room":1}],"pagination":{"next":2,"current":1,"other_pages":[],"total_pages":12,"has_next_page":true,"total_results":296}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zoopla/property":{"get":{"summary":"Zoopla Property","description":"Extract full property details from a Zoopla listing URL, including price, specs, photo gallery, EPC rating, coordinates, and agent data.\n\n**Credit cost:** 2 credits per call","operationId":"get-zoopla-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zoopla property detail URL.\n\n**Example:**\n\n    https://www.zoopla.co.uk/to-rent/details/73119609/\n\n**Notes:**\n- Only Zoopla `/details/` listing URLs are accepted.\n- Copy the listing URL from search results or from zoopla.co.uk.","schema":{"type":"string","description":"Full Zoopla property detail URL.\n\n**Example:**\n\n    https://www.zoopla.co.uk/to-rent/details/73119609/\n\n**Notes:**\n- Only Zoopla `/details/` listing URLs are accepted.\n- Copy the listing URL from search results or from zoopla.co.uk."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"}}},"price":{"type":"object","properties":{"amount":{"type":"integer"},"currency":{"type":"string"}}},"title":{"type":"string"},"address":{"type":"string"},"gallery":{"type":"array","items":{"type":"string"}},"epc_rating":{"type":"string"},"floor_area":{"type":"string"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"google_mape_source":{"type":"string"}}},"property_info":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"string"}}}},"property_tags":{"type":"array","items":{"type":"string"}},"num_of_bedrooms":{"type":"integer"},"num_of_bathrooms":{"type":"integer"},"num_of_receptions":{"type":"integer"},"property_description":{"type":"array","items":{"type":"string"}}}},"examples":{"Lookup Fontenoy Road, London SW12 rental":{"value":{"id":73119609,"url":"https://www.zoopla.co.uk/to-rent/details/73119609/","agent":{"url":"https://www.zoopla.co.uk/find-agents/branch/hamptons-balham-lettings-london-54599/","logo":"https://st.zoocdn.com/zoopla_static_agent_logo_(707660).png","name":"Hamptons - Balham Lettings"},"price":{"amount":6500,"currency":"£"},"title":"Fontenoy Road, London SW12, 5 bed flat to rent, £6,500 pcm - Zoopla","address":"Fontenoy Road, London SW12","gallery":["https://lid.zoocdn.com/u/1024/768/41b277e206b85594ff9640344cb1d4df52a22048.jpg","https://lid.zoocdn.com/u/1024/768/fa0ef0ead995190d7f854c950ac358fb0272fbd9.jpg","https://lid.zoocdn.com/u/1024/768/417db7998c57d84308c6dcfbccebb66011cd5b93.jpg","https://lid.zoocdn.com/u/1024/768/1a9cc9ab3fed00eede77a3901de105b50446e161.jpg","https://lid.zoocdn.com/u/1024/768/8ca19c24c10740ce508e03e072686e14066629f9.jpg","https://lid.zoocdn.com/u/1024/768/8d0cdcba31a54e110395faaa10140bd8184ec7a8.jpg","https://lid.zoocdn.com/u/1024/768/4a09b5ac1f71dc6b339b4be7ff9f655bdb2226ca.jpg","https://lid.zoocdn.com/u/1024/768/bc01fa503a73fa1e007273f8b03a8076dfab45fa.jpg","https://lid.zoocdn.com/u/1024/768/c4a0f0ce884e53d6c698df789353d1fa4d037e8c.jpg","https://lid.zoocdn.com/u/1024/768/36cea20cd192f588adc601d9ef1c6e5fda77c671.jpg","https://lid.zoocdn.com/u/1024/768/d330244ae643e466375da663b684e1f6f1c4655f.jpg","https://lid.zoocdn.com/u/1024/768/2b246e662f3c0992f86236e37cb485c7e86d975e.jpg","https://lid.zoocdn.com/u/1024/768/7fe30a1d9e4278de778a5c117838aebfdc17e8e1.jpg","https://lid.zoocdn.com/u/1024/768/0807ce99b23f81d385456e18e765f32f379db630.jpg","https://lid.zoocdn.com/u/1024/768/e8df2420da3f54ba7fc4b9b83407c64102d9fa11.jpg","https://lid.zoocdn.com/u/1024/768/83743465607df3e78bd41893459d95a616dd37b7.jpg"],"epc_rating":"EPC Rating: D","floor_area":"2,750 sq ft","coordinates":{"latitude":-0.142507,"longitude":51.438041,"google_mape_source":"https://maps.prod.zoopla.co.uk/styles/portal/static/-0.142507,51.438041,13/480x160@2x.webp?marker=-0.142507%2C51.438041%7Cmap-static-pin-purple-76.png%7Cscale%3A0.5&Expires=1780582851&Key-Pair-Id=K12772E47ES84B&Signature=nSNhcXjanmuhwLfG9-Xh2V0hCHkdpt91oJyafvbzlonR2QrQxoFMzwxEQVZFbQevSaMg2YrRqawY0ec28VArr~tYXXMl302hYtHS2fGa9-0bssugWjD4YRmOeUh0UEmeMJsQNP6zs7jEGM~fy2vh-WnBFI~l7HFh0bVlp679wzkVJu3KyJDDsdilV1mUstD1u8QAV7J1dNB4iHdVGMoUvZiiQrVqsD1x0llwYlM~~8lcLuRmb3bubJANrKfyqXx-cm0gCbjyRpAnMiCm9PgvwJhXIilKtwyjYVlug2FpAgA30qoWvfyXDk4A4cXpI8VSX~UkXqyDzZWVNH-TvXBqtQ__"},"property_info":[{"title":"Deposit","value":"£7,500"},{"title":"Council tax band","value":"G"},{"title":"Letting arrangements","value":"Ask agent"}],"property_tags":["EPC Rating: D"],"num_of_bedrooms":5,"num_of_bathrooms":3,"num_of_receptions":3,"property_description":["Family home","Off-street parking","5 double bedrooms","Central Balham location","Large garden","3 Bathrooms","Disabled features"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zoopla Property","description":"Extract full property details from a Zoopla listing URL, including price, specs, photo gallery, EPC rating, coordinates, and agent data.\n\n**Credit cost:** 2 credits per call","operationId":"post-zoopla-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zoopla property detail URL.\n\n**Example:**\n\n    https://www.zoopla.co.uk/to-rent/details/73119609/\n\n**Notes:**\n- Only Zoopla `/details/` listing URLs are accepted.\n- Copy the listing URL from search results or from zoopla.co.uk.","schema":{"type":"string","description":"Full Zoopla property detail URL.\n\n**Example:**\n\n    https://www.zoopla.co.uk/to-rent/details/73119609/\n\n**Notes:**\n- Only Zoopla `/details/` listing URLs are accepted.\n- Copy the listing URL from search results or from zoopla.co.uk."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"agent":{"type":"object","properties":{"url":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"}}},"price":{"type":"object","properties":{"amount":{"type":"integer"},"currency":{"type":"string"}}},"title":{"type":"string"},"address":{"type":"string"},"gallery":{"type":"array","items":{"type":"string"}},"epc_rating":{"type":"string"},"floor_area":{"type":"string"},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"google_mape_source":{"type":"string"}}},"property_info":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"string"}}}},"property_tags":{"type":"array","items":{"type":"string"}},"num_of_bedrooms":{"type":"integer"},"num_of_bathrooms":{"type":"integer"},"num_of_receptions":{"type":"integer"},"property_description":{"type":"array","items":{"type":"string"}}}},"examples":{"Lookup Fontenoy Road, London SW12 rental":{"value":{"id":73119609,"url":"https://www.zoopla.co.uk/to-rent/details/73119609/","agent":{"url":"https://www.zoopla.co.uk/find-agents/branch/hamptons-balham-lettings-london-54599/","logo":"https://st.zoocdn.com/zoopla_static_agent_logo_(707660).png","name":"Hamptons - Balham Lettings"},"price":{"amount":6500,"currency":"£"},"title":"Fontenoy Road, London SW12, 5 bed flat to rent, £6,500 pcm - Zoopla","address":"Fontenoy Road, London SW12","gallery":["https://lid.zoocdn.com/u/1024/768/41b277e206b85594ff9640344cb1d4df52a22048.jpg","https://lid.zoocdn.com/u/1024/768/fa0ef0ead995190d7f854c950ac358fb0272fbd9.jpg","https://lid.zoocdn.com/u/1024/768/417db7998c57d84308c6dcfbccebb66011cd5b93.jpg","https://lid.zoocdn.com/u/1024/768/1a9cc9ab3fed00eede77a3901de105b50446e161.jpg","https://lid.zoocdn.com/u/1024/768/8ca19c24c10740ce508e03e072686e14066629f9.jpg","https://lid.zoocdn.com/u/1024/768/8d0cdcba31a54e110395faaa10140bd8184ec7a8.jpg","https://lid.zoocdn.com/u/1024/768/4a09b5ac1f71dc6b339b4be7ff9f655bdb2226ca.jpg","https://lid.zoocdn.com/u/1024/768/bc01fa503a73fa1e007273f8b03a8076dfab45fa.jpg","https://lid.zoocdn.com/u/1024/768/c4a0f0ce884e53d6c698df789353d1fa4d037e8c.jpg","https://lid.zoocdn.com/u/1024/768/36cea20cd192f588adc601d9ef1c6e5fda77c671.jpg","https://lid.zoocdn.com/u/1024/768/d330244ae643e466375da663b684e1f6f1c4655f.jpg","https://lid.zoocdn.com/u/1024/768/2b246e662f3c0992f86236e37cb485c7e86d975e.jpg","https://lid.zoocdn.com/u/1024/768/7fe30a1d9e4278de778a5c117838aebfdc17e8e1.jpg","https://lid.zoocdn.com/u/1024/768/0807ce99b23f81d385456e18e765f32f379db630.jpg","https://lid.zoocdn.com/u/1024/768/e8df2420da3f54ba7fc4b9b83407c64102d9fa11.jpg","https://lid.zoocdn.com/u/1024/768/83743465607df3e78bd41893459d95a616dd37b7.jpg"],"epc_rating":"EPC Rating: D","floor_area":"2,750 sq ft","coordinates":{"latitude":-0.142507,"longitude":51.438041,"google_mape_source":"https://maps.prod.zoopla.co.uk/styles/portal/static/-0.142507,51.438041,13/480x160@2x.webp?marker=-0.142507%2C51.438041%7Cmap-static-pin-purple-76.png%7Cscale%3A0.5&Expires=1780582851&Key-Pair-Id=K12772E47ES84B&Signature=nSNhcXjanmuhwLfG9-Xh2V0hCHkdpt91oJyafvbzlonR2QrQxoFMzwxEQVZFbQevSaMg2YrRqawY0ec28VArr~tYXXMl302hYtHS2fGa9-0bssugWjD4YRmOeUh0UEmeMJsQNP6zs7jEGM~fy2vh-WnBFI~l7HFh0bVlp679wzkVJu3KyJDDsdilV1mUstD1u8QAV7J1dNB4iHdVGMoUvZiiQrVqsD1x0llwYlM~~8lcLuRmb3bubJANrKfyqXx-cm0gCbjyRpAnMiCm9PgvwJhXIilKtwyjYVlug2FpAgA30qoWvfyXDk4A4cXpI8VSX~UkXqyDzZWVNH-TvXBqtQ__"},"property_info":[{"title":"Deposit","value":"£7,500"},{"title":"Council tax band","value":"G"},{"title":"Letting arrangements","value":"Ask agent"}],"property_tags":["EPC Rating: D"],"num_of_bedrooms":5,"num_of_bathrooms":3,"num_of_receptions":3,"property_description":["Family home","Off-street parking","5 double bedrooms","Central Balham location","Large garden","3 Bathrooms","Disabled features"]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zillow/search":{"get":{"summary":"Zillow Search","description":"Search Zillow listings from a search or map URL and retrieve prices, beds, baths, coordinates, and listing status.\n\n**Credit cost:** 3 credits per call","operationId":"get-zillow-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zillow search or map results URL.\n\n**Example 1 (city search URL):**\n\n    https://www.zillow.com/staten-island-ny/\n\n**Example 2 (map search URL):**\n\n    https://www.zillow.com/homes/for_sale/Staten-Island-NY_rb/\n\n**Notes:**\n- Only Zillow URLs are accepted (search pages, map results, filtered browse URLs).\n- Pagination and filter parameters present in the URL are respected.\n- Use each result's `detail_url` with the Zillow Property endpoint.","schema":{"type":"string","description":"Full Zillow search or map results URL.\n\n**Example 1 (city search URL):**\n\n    https://www.zillow.com/staten-island-ny/\n\n**Example 2 (map search URL):**\n\n    https://www.zillow.com/homes/for_sale/Staten-Island-NY_rb/\n\n**Notes:**\n- Only Zillow URLs are accepted (search pages, map results, filtered browse URLs).\n- Pagination and filter parameters present in the URL are respected.\n- Use each result's `detail_url` with the Zillow Property endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"area":{"type":"integer"},"beds":{"type":"integer"},"list":{"type":"boolean"},"zpid":{"type":"string"},"baths":{"type":"integer"},"pgapt":{"type":"string"},"price":{"type":"string"},"sgapt":{"type":"string"},"address":{"type":"string"},"img_src":{"type":"string"},"pals_id":{"type":"string"},"lat_long":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"has_image":{"type":"boolean"},"zestimate":{"type":"integer"},"detail_url":{"type":"string"},"broker_name":{"type":"string"},"status_text":{"type":"string"},"status_type":{"type":"string"},"address_city":{"type":"string"},"has3_d_model":{"type":"boolean"},"address_state":{"type":"string"},"address_street":{"type":"string"},"address_zipcode":{"type":"string"},"country_currency":{"type":"string"},"unformatted_price":{"type":"integer"},"raw_home_status_cd":{"type":"string"},"is_showcase_listing":{"type":"boolean"},"marketing_status_simplified_cd":{"type":"string"}}}}}},"examples":{"Search homes in Staten Island, NY":{"value":{"results":[{"id":"32361983","area":2500,"beds":4,"list":true,"zpid":"32361983","baths":3,"pgapt":"ForSale","price":"$699,000","sgapt":"For Sale (Broker)","address":"20 Kyle Ct, Staten Island, NY 10312","img_src":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-p_e.jpg","pals_id":"479004_501695","lat_long":{"latitude":40.557384,"longitude":-74.19698},"has_image":true,"zestimate":695900,"detail_url":"https://www.zillow.com/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/","broker_name":"Listing by: Real Broker NY LLC","status_text":"House for sale","status_type":"FOR_SALE","address_city":"Staten Island","has3_d_model":true,"address_state":"NY","address_street":"20 Kyle Ct","address_zipcode":"10312","country_currency":"$","unformatted_price":699000,"raw_home_status_cd":"ForSale","is_showcase_listing":true,"marketing_status_simplified_cd":"For Sale by Agent"},{"id":"32325469","area":1104,"beds":3,"list":true,"zpid":"32325469","baths":2,"pgapt":"ForSale","price":"$849,900","sgapt":"For Sale (Broker)","address":"43 Hickory Ave, Staten Island, NY 10305","img_src":"https://photos.zillowstatic.com/fp/3a517276d08c426dce24e27c116cac1a-p_e.jpg","pals_id":"820001_2602944","lat_long":{"latitude":40.59659,"longitude":-74.073944},"has_image":true,"zestimate":836200,"detail_url":"https://www.zillow.com/homedetails/43-Hickory-Ave-Staten-Island-NY-10305/32325469_zpid/","broker_name":"Listing by: Homes R Us Realty of NY, Inc.","status_text":"House for sale","status_type":"FOR_SALE","address_city":"Staten Island","has3_d_model":true,"address_state":"NY","address_street":"43 Hickory Ave","address_zipcode":"10305","country_currency":"$","unformatted_price":849900,"raw_home_status_cd":"ForSale","is_showcase_listing":true,"marketing_status_simplified_cd":"For Sale by Agent"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zillow Search","description":"Search Zillow listings from a search or map URL and retrieve prices, beds, baths, coordinates, and listing status.\n\n**Credit cost:** 3 credits per call","operationId":"post-zillow-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zillow search or map results URL.\n\n**Example 1 (city search URL):**\n\n    https://www.zillow.com/staten-island-ny/\n\n**Example 2 (map search URL):**\n\n    https://www.zillow.com/homes/for_sale/Staten-Island-NY_rb/\n\n**Notes:**\n- Only Zillow URLs are accepted (search pages, map results, filtered browse URLs).\n- Pagination and filter parameters present in the URL are respected.\n- Use each result's `detail_url` with the Zillow Property endpoint.","schema":{"type":"string","description":"Full Zillow search or map results URL.\n\n**Example 1 (city search URL):**\n\n    https://www.zillow.com/staten-island-ny/\n\n**Example 2 (map search URL):**\n\n    https://www.zillow.com/homes/for_sale/Staten-Island-NY_rb/\n\n**Notes:**\n- Only Zillow URLs are accepted (search pages, map results, filtered browse URLs).\n- Pagination and filter parameters present in the URL are respected.\n- Use each result's `detail_url` with the Zillow Property endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"area":{"type":"integer"},"beds":{"type":"integer"},"list":{"type":"boolean"},"zpid":{"type":"string"},"baths":{"type":"integer"},"pgapt":{"type":"string"},"price":{"type":"string"},"sgapt":{"type":"string"},"address":{"type":"string"},"img_src":{"type":"string"},"pals_id":{"type":"string"},"lat_long":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"has_image":{"type":"boolean"},"zestimate":{"type":"integer"},"detail_url":{"type":"string"},"broker_name":{"type":"string"},"status_text":{"type":"string"},"status_type":{"type":"string"},"address_city":{"type":"string"},"has3_d_model":{"type":"boolean"},"address_state":{"type":"string"},"address_street":{"type":"string"},"address_zipcode":{"type":"string"},"country_currency":{"type":"string"},"unformatted_price":{"type":"integer"},"raw_home_status_cd":{"type":"string"},"is_showcase_listing":{"type":"boolean"},"marketing_status_simplified_cd":{"type":"string"}}}}}},"examples":{"Search homes in Staten Island, NY":{"value":{"results":[{"id":"32361983","area":2500,"beds":4,"list":true,"zpid":"32361983","baths":3,"pgapt":"ForSale","price":"$699,000","sgapt":"For Sale (Broker)","address":"20 Kyle Ct, Staten Island, NY 10312","img_src":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-p_e.jpg","pals_id":"479004_501695","lat_long":{"latitude":40.557384,"longitude":-74.19698},"has_image":true,"zestimate":695900,"detail_url":"https://www.zillow.com/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/","broker_name":"Listing by: Real Broker NY LLC","status_text":"House for sale","status_type":"FOR_SALE","address_city":"Staten Island","has3_d_model":true,"address_state":"NY","address_street":"20 Kyle Ct","address_zipcode":"10312","country_currency":"$","unformatted_price":699000,"raw_home_status_cd":"ForSale","is_showcase_listing":true,"marketing_status_simplified_cd":"For Sale by Agent"},{"id":"32325469","area":1104,"beds":3,"list":true,"zpid":"32325469","baths":2,"pgapt":"ForSale","price":"$849,900","sgapt":"For Sale (Broker)","address":"43 Hickory Ave, Staten Island, NY 10305","img_src":"https://photos.zillowstatic.com/fp/3a517276d08c426dce24e27c116cac1a-p_e.jpg","pals_id":"820001_2602944","lat_long":{"latitude":40.59659,"longitude":-74.073944},"has_image":true,"zestimate":836200,"detail_url":"https://www.zillow.com/homedetails/43-Hickory-Ave-Staten-Island-NY-10305/32325469_zpid/","broker_name":"Listing by: Homes R Us Realty of NY, Inc.","status_text":"House for sale","status_type":"FOR_SALE","address_city":"Staten Island","has3_d_model":true,"address_state":"NY","address_street":"43 Hickory Ave","address_zipcode":"10305","country_currency":"$","unformatted_price":849900,"raw_home_status_cd":"ForSale","is_showcase_listing":true,"marketing_status_simplified_cd":"For Sale by Agent"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/zillow/property":{"get":{"summary":"Zillow Property","description":"Extract full property details from a Zillow homedetails URL, including specs, photos, schools, tax history, and agent attribution.\n\n**Credit cost:** 3 credits per call","operationId":"get-zillow-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zillow homedetails URL.\n\n**Example:**\n\n    https://www.zillow.com/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/\n\n**Notes:**\n- Only Zillow homedetails URLs are accepted (`/homedetails/.../{zpid}_zpid/`).\n- Copy the `detail_url` value returned by the Zillow Search endpoint.","schema":{"type":"string","description":"Full Zillow homedetails URL.\n\n**Example:**\n\n    https://www.zillow.com/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/\n\n**Notes:**\n- Only Zillow homedetails URLs are accepted (`/homedetails/.../{zpid}_zpid/`).\n- Copy the `detail_url` value returned by the Zillow Search endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"zpid":{"type":"integer"},"mlsid":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"county":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"caption":{"nullable":true},"subject_type":{"nullable":true},"mixed_sources":{"type":"object","properties":{"jpeg":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"}}}},"webp":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"}}}}}}}}},"address":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"zipcode":{"type":"string"},"community":{"nullable":true},"subdivision":{"type":"string"},"neighborhood":{"nullable":true},"street_address":{"type":"string"}}},"country":{"type":"string"},"hdp_url":{"type":"string"},"pals_id":{"type":"string"},"schools":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"grades":{"type":"string"},"rating":{"type":"integer"},"distance":{"type":"number"}}}},"zipcode":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"lot_size":{"type":"integer"},"bathrooms":{"type":"integer"},"home_type":{"type":"string"},"longitude":{"type":"number"},"zestimate":{"type":"integer"},"reso_facts":{"type":"object","properties":{"cooling":{"type":"array","items":{"type":"string"}},"heating":{"type":"array","items":{"type":"string"}},"stories":{"nullable":true},"basement":{"type":"string"},"bedrooms":{"type":"integer"},"lot_size":{"type":"string"},"bathrooms":{"type":"integer"},"has_garage":{"type":"boolean"},"year_built":{"type":"integer"},"living_area":{"type":"string"},"parking_features":{"type":"array","items":{"type":"string"}}}},"year_built":{"type":"integer"},"description":{"type":"string"},"home_status":{"type":"string"},"living_area":{"type":"integer"},"photo_count":{"type":"integer"},"tax_history":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer"},"value":{"type":"integer"},"tax_paid":{"type":"integer"},"tax_increase_rate":{"type":"number"},"value_increase_rate":{"type":"number"}}}},"has_vr_model":{"type":"boolean"},"parent_region":{"type":"object","properties":{"name":{"type":"string"}}},"price_history":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"time":{"type":"integer"},"event":{"type":"string"},"price":{"type":"integer"},"source":{"type":"string"},"buyer_agent":{"nullable":true},"seller_agent":{"nullable":true},"attribute_source":{"type":"object","properties":{"info_string1":{"type":"string"},"info_string2":{"type":"string"},"info_string3":{"type":"string"}}},"show_county_link":{"type":"boolean"},"posting_is_rental":{"type":"boolean"},"price_change_rate":{"type":"integer"},"price_per_square_foot":{"type":"integer"}}}},"brokerage_name":{"type":"string"},"days_on_zillow":{"type":"integer"},"favorite_count":{"type":"integer"},"lot_area_units":{"type":"string"},"lot_area_value":{"type":"integer"},"rent_zestimate":{"type":"integer"},"street_address":{"type":"string"},"time_on_zillow":{"type":"string"},"page_view_count":{"type":"integer"},"assigned_schools":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"level":{"type":"string"},"grades":{"type":"string"},"rating":{"type":"integer"},"distance":{"type":"number"},"school_id":{"type":"integer"},"enrollment":{"type":"integer"},"district_id":{"type":"integer"},"district_name":{"type":"string"},"themed_ratings":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"rating":{"type":"integer"}}}},"student_teacher_ratio":{"type":"number"},"student_counselor_ratio":{"type":"integer"},"percentage_of_full_time_teachers_who_are_certified":{"type":"integer"}}}},"attribution_info":{"type":"object","properties":{"mls_id":{"type":"string"},"mls_name":{"type":"string"},"agent_name":{"type":"string"},"broker_name":{"type":"string"},"listing_agents":{"type":"array","items":{"type":"object","properties":{"member_full_name":{"type":"string"},"member_state_license":{"nullable":true},"associated_agent_type":{"type":"string"}}}},"listing_offices":{"type":"array","items":{"type":"object","properties":{"office_name":{"type":"string"},"associated_office_type":{"type":"string"}}}},"attribution_title":{"type":"string"}}},"listing_sub_type":{"type":"object","properties":{"is_fsba":{"type":"boolean"},"is_fsbo":{"type":"boolean"},"is_pending":{"type":"boolean"},"is_new_home":{"type":"boolean"},"is_bank_owned":{"type":"boolean"},"is_open_house":{"type":"boolean"},"is_coming_soon":{"type":"boolean"},"is_for_auction":{"type":"boolean"},"is_foreclosure":{"type":"boolean"}}},"hi_res_image_link":{"type":"string"},"living_area_units":{"type":"string"},"living_area_value":{"type":"integer"},"abbreviated_address":{"type":"string"},"is_showcase_listing":{"type":"boolean"},"neighborhood_region":{"type":"object","properties":{"name":{"type":"string"}}},"listing_type_dimension":{"type":"string"},"property_type_dimension":{"type":"string"}}},"examples":{"Lookup 20 Kyle Ct, Staten Island":{"value":{"id":"UHJvcGVydHk6MzIzNjE5ODM=","city":"Staten Island","zpid":32361983,"mlsid":"501695","price":699000,"state":"NY","county":"Richmond County","photos":[{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-p_d.jpg","caption":null,"subject_type":null,"mixed_sources":{"jpeg":[{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_192.jpg","width":192},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_384.jpg","width":384},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_576.jpg","width":576},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_768.jpg","width":768},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_960.jpg","width":960},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1152.jpg","width":1152},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1344.jpg","width":1344},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1536.jpg","width":1536}],"webp":[{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_192.webp","width":192},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_384.webp","width":384},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_576.webp","width":576},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_768.webp","width":768},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_960.webp","width":960},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1152.webp","width":1152},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1344.webp","width":1344},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1536.webp","width":1536}]}},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-p_d.jpg","caption":null,"subject_type":null,"mixed_sources":{"jpeg":[{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_192.jpg","width":192},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_384.jpg","width":384},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_576.jpg","width":576},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_768.jpg","width":768},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_960.jpg","width":960},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1152.jpg","width":1152},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1344.jpg","width":1344},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1536.jpg","width":1536}],"webp":[{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_192.webp","width":192},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_384.webp","width":384},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_576.webp","width":576},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_768.webp","width":768},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_960.webp","width":960},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1152.webp","width":1152},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1344.webp","width":1344},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1536.webp","width":1536}]}}],"address":{"city":"Staten Island","state":"NY","zipcode":"10312","community":null,"subdivision":"Staten Island","neighborhood":null,"street_address":"20 Kyle Ct"},"country":"USA","hdp_url":"/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/","pals_id":"479004_501695","schools":[{"link":"https://www.greatschools.org/new-york/staten-island/2036-Ps-4-Maurice-Wollin/","name":"Ps 4 Maurice Wollin","grades":"PK-5","rating":8,"distance":0.4},{"link":"https://www.greatschools.org/new-york/staten-island/2919-Is-75-Frank-D-Paulo/","name":"Is 75 Frank D Paulo","grades":"6-8","rating":8,"distance":0.9}],"zipcode":"10312","bedrooms":4,"currency":"USD","latitude":40.557384,"lot_size":2773,"bathrooms":3,"home_type":"SINGLE_FAMILY","longitude":-74.19698,"zestimate":695900,"reso_facts":{"cooling":["A/C Unit","Central Air"],"heating":["Natural Gas","Other"],"stories":null,"basement":"None","bedrooms":4,"lot_size":"2,773 sqft","bathrooms":3,"has_garage":true,"year_built":1975,"living_area":"2,500 sqft","parking_features":["Other","Attached Garage","Garage Door Opener"]},"year_built":1975,"description":"Tucked at the end of a quiet loop in Village Greens, this is one of the rare four-bedrooms in the community.    If you know the South Shore, you know Village Greens. It's the Levitt-built community from the early 70s, the first planned townhouse development in New York City. Curved streets, no through traffic, a 13-acre park sitting in the middle with two Olympic-sized pools, tennis courts, and trail paths that wind through the whole place. Kyle Court is one of the cul-de-sacs off Dover Green, w...","home_status":"FOR_SALE","living_area":2500,"photo_count":25,"tax_history":[{"time":1748867492137,"value":38100,"tax_paid":5779,"tax_increase_rate":0.03251742,"value_increase_rate":0.16087751},{"time":1717331492137,"value":32820,"tax_paid":5597,"tax_increase_rate":0,"value_increase_rate":-0.056896552}],"has_vr_model":true,"parent_region":{"name":"Huguenot"},"price_history":[{"date":"2026-05-28","time":1779926400000,"event":"Listed for sale","price":699000,"source":"BNYMLS","buyer_agent":null,"seller_agent":null,"attribute_source":{"info_string1":"501695","info_string2":"BNYMLS","info_string3":"https://photos.zillowstatic.com/fp/f37ed42b0d788acca8559b8191bfb76f-zillow_web_logo_inf_11.jpg"},"show_county_link":false,"posting_is_rental":false,"price_change_rate":0,"price_per_square_foot":280}],"brokerage_name":"Real Broker NY LLC","days_on_zillow":4,"favorite_count":116,"lot_area_units":"Square Feet","lot_area_value":2773,"rent_zestimate":3783,"street_address":"20 Kyle Ct","time_on_zillow":"4 days","page_view_count":3347,"assigned_schools":[{"link":"https://www.greatschools.org/new-york/staten-island/2036-Ps-4-Maurice-Wollin/","name":"Ps 4 Maurice Wollin","type":"Public","level":"Primary","grades":"PK-5","rating":8,"distance":0.4,"school_id":49340,"enrollment":862,"district_id":6907,"district_name":"New York City Geographic District #31","themed_ratings":[{"name":"Test scores rating","type":"testScores","rating":8},{"name":"Academic progress rating","type":"academicProgress","rating":8}],"student_teacher_ratio":9.25,"student_counselor_ratio":375,"percentage_of_full_time_teachers_who_are_certified":100}],"attribution_info":{"mls_id":"501695","mls_name":"BNYMLS","agent_name":"Joseph Ranola","broker_name":"Real Broker NY LLC","listing_agents":[{"member_full_name":"Joseph Ranola","member_state_license":null,"associated_agent_type":"listAgent"}],"listing_offices":[{"office_name":"Real Broker NY LLC","associated_office_type":"listOffice"}],"attribution_title":"Listing by:"},"listing_sub_type":{"is_fsba":true,"is_fsbo":false,"is_pending":false,"is_new_home":false,"is_bank_owned":false,"is_open_house":false,"is_coming_soon":false,"is_for_auction":false,"is_foreclosure":false},"hi_res_image_link":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-p_f.jpg","living_area_units":"Square Feet","living_area_value":2500,"abbreviated_address":"20 Kyle Ct","is_showcase_listing":true,"neighborhood_region":{"name":"Huguenot"},"listing_type_dimension":"For Sale by Agent","property_type_dimension":"Single Family"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Zillow Property","description":"Extract full property details from a Zillow homedetails URL, including specs, photos, schools, tax history, and agent attribution.\n\n**Credit cost:** 3 credits per call","operationId":"post-zillow-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Zillow homedetails URL.\n\n**Example:**\n\n    https://www.zillow.com/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/\n\n**Notes:**\n- Only Zillow homedetails URLs are accepted (`/homedetails/.../{zpid}_zpid/`).\n- Copy the `detail_url` value returned by the Zillow Search endpoint.","schema":{"type":"string","description":"Full Zillow homedetails URL.\n\n**Example:**\n\n    https://www.zillow.com/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/\n\n**Notes:**\n- Only Zillow homedetails URLs are accepted (`/homedetails/.../{zpid}_zpid/`).\n- Copy the `detail_url` value returned by the Zillow Search endpoint."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"city":{"type":"string"},"zpid":{"type":"integer"},"mlsid":{"type":"string"},"price":{"type":"integer"},"state":{"type":"string"},"county":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"caption":{"nullable":true},"subject_type":{"nullable":true},"mixed_sources":{"type":"object","properties":{"jpeg":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"}}}},"webp":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"}}}}}}}}},"address":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"zipcode":{"type":"string"},"community":{"nullable":true},"subdivision":{"type":"string"},"neighborhood":{"nullable":true},"street_address":{"type":"string"}}},"country":{"type":"string"},"hdp_url":{"type":"string"},"pals_id":{"type":"string"},"schools":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"grades":{"type":"string"},"rating":{"type":"integer"},"distance":{"type":"number"}}}},"zipcode":{"type":"string"},"bedrooms":{"type":"integer"},"currency":{"type":"string"},"latitude":{"type":"number"},"lot_size":{"type":"integer"},"bathrooms":{"type":"integer"},"home_type":{"type":"string"},"longitude":{"type":"number"},"zestimate":{"type":"integer"},"reso_facts":{"type":"object","properties":{"cooling":{"type":"array","items":{"type":"string"}},"heating":{"type":"array","items":{"type":"string"}},"stories":{"nullable":true},"basement":{"type":"string"},"bedrooms":{"type":"integer"},"lot_size":{"type":"string"},"bathrooms":{"type":"integer"},"has_garage":{"type":"boolean"},"year_built":{"type":"integer"},"living_area":{"type":"string"},"parking_features":{"type":"array","items":{"type":"string"}}}},"year_built":{"type":"integer"},"description":{"type":"string"},"home_status":{"type":"string"},"living_area":{"type":"integer"},"photo_count":{"type":"integer"},"tax_history":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer"},"value":{"type":"integer"},"tax_paid":{"type":"integer"},"tax_increase_rate":{"type":"number"},"value_increase_rate":{"type":"number"}}}},"has_vr_model":{"type":"boolean"},"parent_region":{"type":"object","properties":{"name":{"type":"string"}}},"price_history":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"time":{"type":"integer"},"event":{"type":"string"},"price":{"type":"integer"},"source":{"type":"string"},"buyer_agent":{"nullable":true},"seller_agent":{"nullable":true},"attribute_source":{"type":"object","properties":{"info_string1":{"type":"string"},"info_string2":{"type":"string"},"info_string3":{"type":"string"}}},"show_county_link":{"type":"boolean"},"posting_is_rental":{"type":"boolean"},"price_change_rate":{"type":"integer"},"price_per_square_foot":{"type":"integer"}}}},"brokerage_name":{"type":"string"},"days_on_zillow":{"type":"integer"},"favorite_count":{"type":"integer"},"lot_area_units":{"type":"string"},"lot_area_value":{"type":"integer"},"rent_zestimate":{"type":"integer"},"street_address":{"type":"string"},"time_on_zillow":{"type":"string"},"page_view_count":{"type":"integer"},"assigned_schools":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"level":{"type":"string"},"grades":{"type":"string"},"rating":{"type":"integer"},"distance":{"type":"number"},"school_id":{"type":"integer"},"enrollment":{"type":"integer"},"district_id":{"type":"integer"},"district_name":{"type":"string"},"themed_ratings":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"rating":{"type":"integer"}}}},"student_teacher_ratio":{"type":"number"},"student_counselor_ratio":{"type":"integer"},"percentage_of_full_time_teachers_who_are_certified":{"type":"integer"}}}},"attribution_info":{"type":"object","properties":{"mls_id":{"type":"string"},"mls_name":{"type":"string"},"agent_name":{"type":"string"},"broker_name":{"type":"string"},"listing_agents":{"type":"array","items":{"type":"object","properties":{"member_full_name":{"type":"string"},"member_state_license":{"nullable":true},"associated_agent_type":{"type":"string"}}}},"listing_offices":{"type":"array","items":{"type":"object","properties":{"office_name":{"type":"string"},"associated_office_type":{"type":"string"}}}},"attribution_title":{"type":"string"}}},"listing_sub_type":{"type":"object","properties":{"is_fsba":{"type":"boolean"},"is_fsbo":{"type":"boolean"},"is_pending":{"type":"boolean"},"is_new_home":{"type":"boolean"},"is_bank_owned":{"type":"boolean"},"is_open_house":{"type":"boolean"},"is_coming_soon":{"type":"boolean"},"is_for_auction":{"type":"boolean"},"is_foreclosure":{"type":"boolean"}}},"hi_res_image_link":{"type":"string"},"living_area_units":{"type":"string"},"living_area_value":{"type":"integer"},"abbreviated_address":{"type":"string"},"is_showcase_listing":{"type":"boolean"},"neighborhood_region":{"type":"object","properties":{"name":{"type":"string"}}},"listing_type_dimension":{"type":"string"},"property_type_dimension":{"type":"string"}}},"examples":{"Lookup 20 Kyle Ct, Staten Island":{"value":{"id":"UHJvcGVydHk6MzIzNjE5ODM=","city":"Staten Island","zpid":32361983,"mlsid":"501695","price":699000,"state":"NY","county":"Richmond County","photos":[{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-p_d.jpg","caption":null,"subject_type":null,"mixed_sources":{"jpeg":[{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_192.jpg","width":192},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_384.jpg","width":384},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_576.jpg","width":576},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_768.jpg","width":768},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_960.jpg","width":960},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1152.jpg","width":1152},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1344.jpg","width":1344},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1536.jpg","width":1536}],"webp":[{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_192.webp","width":192},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_384.webp","width":384},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_576.webp","width":576},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_768.webp","width":768},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_960.webp","width":960},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1152.webp","width":1152},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1344.webp","width":1344},{"url":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-cc_ft_1536.webp","width":1536}]}},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-p_d.jpg","caption":null,"subject_type":null,"mixed_sources":{"jpeg":[{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_192.jpg","width":192},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_384.jpg","width":384},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_576.jpg","width":576},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_768.jpg","width":768},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_960.jpg","width":960},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1152.jpg","width":1152},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1344.jpg","width":1344},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1536.jpg","width":1536}],"webp":[{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_192.webp","width":192},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_384.webp","width":384},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_576.webp","width":576},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_768.webp","width":768},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_960.webp","width":960},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1152.webp","width":1152},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1344.webp","width":1344},{"url":"https://photos.zillowstatic.com/fp/f0ae3c55f8feaba0c3a41b4cfe9c8c9a-cc_ft_1536.webp","width":1536}]}}],"address":{"city":"Staten Island","state":"NY","zipcode":"10312","community":null,"subdivision":"Staten Island","neighborhood":null,"street_address":"20 Kyle Ct"},"country":"USA","hdp_url":"/homedetails/20-Kyle-Ct-Staten-Island-NY-10312/32361983_zpid/","pals_id":"479004_501695","schools":[{"link":"https://www.greatschools.org/new-york/staten-island/2036-Ps-4-Maurice-Wollin/","name":"Ps 4 Maurice Wollin","grades":"PK-5","rating":8,"distance":0.4},{"link":"https://www.greatschools.org/new-york/staten-island/2919-Is-75-Frank-D-Paulo/","name":"Is 75 Frank D Paulo","grades":"6-8","rating":8,"distance":0.9}],"zipcode":"10312","bedrooms":4,"currency":"USD","latitude":40.557384,"lot_size":2773,"bathrooms":3,"home_type":"SINGLE_FAMILY","longitude":-74.19698,"zestimate":695900,"reso_facts":{"cooling":["A/C Unit","Central Air"],"heating":["Natural Gas","Other"],"stories":null,"basement":"None","bedrooms":4,"lot_size":"2,773 sqft","bathrooms":3,"has_garage":true,"year_built":1975,"living_area":"2,500 sqft","parking_features":["Other","Attached Garage","Garage Door Opener"]},"year_built":1975,"description":"Tucked at the end of a quiet loop in Village Greens, this is one of the rare four-bedrooms in the community.    If you know the South Shore, you know Village Greens. It's the Levitt-built community from the early 70s, the first planned townhouse development in New York City. Curved streets, no through traffic, a 13-acre park sitting in the middle with two Olympic-sized pools, tennis courts, and trail paths that wind through the whole place. Kyle Court is one of the cul-de-sacs off Dover Green, w...","home_status":"FOR_SALE","living_area":2500,"photo_count":25,"tax_history":[{"time":1748867492137,"value":38100,"tax_paid":5779,"tax_increase_rate":0.03251742,"value_increase_rate":0.16087751},{"time":1717331492137,"value":32820,"tax_paid":5597,"tax_increase_rate":0,"value_increase_rate":-0.056896552}],"has_vr_model":true,"parent_region":{"name":"Huguenot"},"price_history":[{"date":"2026-05-28","time":1779926400000,"event":"Listed for sale","price":699000,"source":"BNYMLS","buyer_agent":null,"seller_agent":null,"attribute_source":{"info_string1":"501695","info_string2":"BNYMLS","info_string3":"https://photos.zillowstatic.com/fp/f37ed42b0d788acca8559b8191bfb76f-zillow_web_logo_inf_11.jpg"},"show_county_link":false,"posting_is_rental":false,"price_change_rate":0,"price_per_square_foot":280}],"brokerage_name":"Real Broker NY LLC","days_on_zillow":4,"favorite_count":116,"lot_area_units":"Square Feet","lot_area_value":2773,"rent_zestimate":3783,"street_address":"20 Kyle Ct","time_on_zillow":"4 days","page_view_count":3347,"assigned_schools":[{"link":"https://www.greatschools.org/new-york/staten-island/2036-Ps-4-Maurice-Wollin/","name":"Ps 4 Maurice Wollin","type":"Public","level":"Primary","grades":"PK-5","rating":8,"distance":0.4,"school_id":49340,"enrollment":862,"district_id":6907,"district_name":"New York City Geographic District #31","themed_ratings":[{"name":"Test scores rating","type":"testScores","rating":8},{"name":"Academic progress rating","type":"academicProgress","rating":8}],"student_teacher_ratio":9.25,"student_counselor_ratio":375,"percentage_of_full_time_teachers_who_are_certified":100}],"attribution_info":{"mls_id":"501695","mls_name":"BNYMLS","agent_name":"Joseph Ranola","broker_name":"Real Broker NY LLC","listing_agents":[{"member_full_name":"Joseph Ranola","member_state_license":null,"associated_agent_type":"listAgent"}],"listing_offices":[{"office_name":"Real Broker NY LLC","associated_office_type":"listOffice"}],"attribution_title":"Listing by:"},"listing_sub_type":{"is_fsba":true,"is_fsbo":false,"is_pending":false,"is_new_home":false,"is_bank_owned":false,"is_open_house":false,"is_coming_soon":false,"is_for_auction":false,"is_foreclosure":false},"hi_res_image_link":"https://photos.zillowstatic.com/fp/b57fe9b7438cd7ee0a05df7753c78812-p_f.jpg","living_area_units":"Square Feet","living_area_value":2500,"abbreviated_address":"20 Kyle Ct","is_showcase_listing":true,"neighborhood_region":{"name":"Huguenot"},"listing_type_dimension":"For Sale by Agent","property_type_dimension":"Single Family"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/yellowpages/search":{"get":{"summary":"Yellowpages Search","description":"Search Yellow Pages businesses from a full search URL and retrieve names, phones, addresses, ratings, opening hours, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-yellowpages-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yellow Pages search URL.\n\n**Example 1 (category + city):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers\n\n**Example 2 (page 2):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers?page=2\n\n**Notes:**\n- Only `yellowpages.com` search listing URLs are accepted.\n- Copy the full URL from yellowpages.com, including city slug, category, and `?page=` for pagination.\n- Yellow Pages search pages are JavaScript SPAs; this endpoint uses website rendering to scrape business cards.\n- Pass each result's `url` to the Yellowpages Business endpoint for full profile data.","schema":{"type":"string","description":"Full Yellow Pages search URL.\n\n**Example 1 (category + city):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers\n\n**Example 2 (page 2):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers?page=2\n\n**Notes:**\n- Only `yellowpages.com` search listing URLs are accepted.\n- Copy the full URL from yellowpages.com, including city slug, category, and `?page=` for pagination.\n- Yellow Pages search pages are JavaScript SPAs; this endpoint uses website rendering to scrape business cards.\n- Pass each result's `url` to the Yellowpages Business endpoint for full profile data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"postal_code":{"type":"string"},"rating_value":{"type":"number"},"review_count":{"type":"integer"},"opening_hours":{"type":"array","items":{"type":"string"}},"address_region":{"type":"string"},"street_address":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search plumbers in Los Angeles":{"value":{"results":[{"url":"https://www.yellowpages.com/los-angeles-ca/mip/anawalt-lumber-13945594?lid=1002108313121","name":"Anawalt Lumber","phone":"(844) 699-3144","postal_code":"90064","rating_value":4.8,"review_count":5,"opening_hours":["Mo-Fr 06:00-20:00","Sa 08:00-20:00","Su 09:00-18:00"],"address_region":"CA","street_address":"11060 W Pico Blvd","address_country":"US","address_locality":"Los Angeles"},{"url":"https://www.yellowpages.com/los-angeles-ca/mip/emergency-rooter-542379108?lid=1002116238752","name":"Emergency Rooter","phone":"(424) 252-2969","postal_code":"90019","rating_value":4.5,"review_count":2,"opening_hours":["Mo-Su"],"address_region":"CA","street_address":"1319 S La Brea Ave","address_country":"US","address_locality":"Los Angeles"},{"url":"https://www.yellowpages.com/los-angeles-ca/mip/rooter-star-546734508?lid=1002194168683","name":"Rooter Star","phone":"(888) 574-3053","postal_code":"90019","rating_value":4.33,"review_count":3,"address_region":"CA","street_address":"1319 S La Brea Ave","address_country":"US","address_locality":"Los Angeles"}],"pagination":{"next":2,"current":1,"next_url":"https://www.yellowpages.com/los-angeles-ca/plumbers?page=2","per_page":30,"other_pages":[2,3,4,5],"total_count":1401,"total_pages":47,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Yellowpages Search","description":"Search Yellow Pages businesses from a full search URL and retrieve names, phones, addresses, ratings, opening hours, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-yellowpages-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yellow Pages search URL.\n\n**Example 1 (category + city):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers\n\n**Example 2 (page 2):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers?page=2\n\n**Notes:**\n- Only `yellowpages.com` search listing URLs are accepted.\n- Copy the full URL from yellowpages.com, including city slug, category, and `?page=` for pagination.\n- Yellow Pages search pages are JavaScript SPAs; this endpoint uses website rendering to scrape business cards.\n- Pass each result's `url` to the Yellowpages Business endpoint for full profile data.","schema":{"type":"string","description":"Full Yellow Pages search URL.\n\n**Example 1 (category + city):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers\n\n**Example 2 (page 2):**\n\n    https://www.yellowpages.com/los-angeles-ca/plumbers?page=2\n\n**Notes:**\n- Only `yellowpages.com` search listing URLs are accepted.\n- Copy the full URL from yellowpages.com, including city slug, category, and `?page=` for pagination.\n- Yellow Pages search pages are JavaScript SPAs; this endpoint uses website rendering to scrape business cards.\n- Pass each result's `url` to the Yellowpages Business endpoint for full profile data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"postal_code":{"type":"string"},"rating_value":{"type":"number"},"review_count":{"type":"integer"},"opening_hours":{"type":"array","items":{"type":"string"}},"address_region":{"type":"string"},"street_address":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search plumbers in Los Angeles":{"value":{"results":[{"url":"https://www.yellowpages.com/los-angeles-ca/mip/anawalt-lumber-13945594?lid=1002108313121","name":"Anawalt Lumber","phone":"(844) 699-3144","postal_code":"90064","rating_value":4.8,"review_count":5,"opening_hours":["Mo-Fr 06:00-20:00","Sa 08:00-20:00","Su 09:00-18:00"],"address_region":"CA","street_address":"11060 W Pico Blvd","address_country":"US","address_locality":"Los Angeles"},{"url":"https://www.yellowpages.com/los-angeles-ca/mip/emergency-rooter-542379108?lid=1002116238752","name":"Emergency Rooter","phone":"(424) 252-2969","postal_code":"90019","rating_value":4.5,"review_count":2,"opening_hours":["Mo-Su"],"address_region":"CA","street_address":"1319 S La Brea Ave","address_country":"US","address_locality":"Los Angeles"},{"url":"https://www.yellowpages.com/los-angeles-ca/mip/rooter-star-546734508?lid=1002194168683","name":"Rooter Star","phone":"(888) 574-3053","postal_code":"90019","rating_value":4.33,"review_count":3,"address_region":"CA","street_address":"1319 S La Brea Ave","address_country":"US","address_locality":"Los Angeles"}],"pagination":{"next":2,"current":1,"next_url":"https://www.yellowpages.com/los-angeles-ca/plumbers?page=2","per_page":30,"other_pages":[2,3,4,5],"total_count":1401,"total_pages":47,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/yellowpages/business":{"get":{"summary":"Yellowpages Business","description":"Extract a full Yellow Pages business profile from a listing URL, including phone, website, categories, and ratings via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-yellowpages-business","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yellow Pages business listing URL.\n\n**Example:**\n\n    https://www.yellowpages.com/los-angeles-ca/mip/anawalt-lumber-13945594?lid=1002108313121\n\n**Notes:**\n- Only `/mip/` business profile URLs on yellowpages.com are accepted.\n- Query parameters such as `?lid=` are supported.\n- Business profile pages are JavaScript SPAs; this endpoint uses website rendering to extract phone, website, categories, and ratings.\n- Copy the listing URL from search results or from yellowpages.com.","schema":{"type":"string","description":"Full Yellow Pages business listing URL.\n\n**Example:**\n\n    https://www.yellowpages.com/los-angeles-ca/mip/anawalt-lumber-13945594?lid=1002108313121\n\n**Notes:**\n- Only `/mip/` business profile URLs on yellowpages.com are accepted.\n- Query parameters such as `?lid=` are supported.\n- Business profile pages are JavaScript SPAs; this endpoint uses website rendering to extract phone, website, categories, and ratings.\n- Copy the listing URL from search results or from yellowpages.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"phone":{"type":"string"},"rating":{"type":"string"},"address":{"type":"string"},"website":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"rating_count":{"type":"integer"}}},"examples":{"Lookup Ritz Plumbing, Los Angeles":{"value":{"name":"Ritz Plumbing Heating, Air & Electrical","phone":"323 452-4915","rating":"five","address":"1355 S La Brea Ave, Los Angeles, CA 90019","website":"http://www.ritzplumbinginc.org","categories":["Plumbers","Air Conditioning Contractors & Systems","Air Conditioning Service & Repair","Plumbers","Air Conditioning Contractors & Systems","Air Conditioning Service & Repair","Building Contractors","Building Contractors-Commercial & Industrial","Electricians","Furnace Repair & Cleaning","Furnaces-Heating","Heating Contractors & Specialties","Heating Equipment & Systems","Plumbing Contractors-Commercial & Industrial","Plumbing-Drain & Sewer Cleaning","Sewer Contractors","Water Heaters"],"rating_count":3}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Yellowpages Business","description":"Extract a full Yellow Pages business profile from a listing URL, including phone, website, categories, and ratings via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-yellowpages-business","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Yellow Pages business listing URL.\n\n**Example:**\n\n    https://www.yellowpages.com/los-angeles-ca/mip/anawalt-lumber-13945594?lid=1002108313121\n\n**Notes:**\n- Only `/mip/` business profile URLs on yellowpages.com are accepted.\n- Query parameters such as `?lid=` are supported.\n- Business profile pages are JavaScript SPAs; this endpoint uses website rendering to extract phone, website, categories, and ratings.\n- Copy the listing URL from search results or from yellowpages.com.","schema":{"type":"string","description":"Full Yellow Pages business listing URL.\n\n**Example:**\n\n    https://www.yellowpages.com/los-angeles-ca/mip/anawalt-lumber-13945594?lid=1002108313121\n\n**Notes:**\n- Only `/mip/` business profile URLs on yellowpages.com are accepted.\n- Query parameters such as `?lid=` are supported.\n- Business profile pages are JavaScript SPAs; this endpoint uses website rendering to extract phone, website, categories, and ratings.\n- Copy the listing URL from search results or from yellowpages.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"phone":{"type":"string"},"rating":{"type":"string"},"address":{"type":"string"},"website":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"rating_count":{"type":"integer"}}},"examples":{"Lookup Ritz Plumbing, Los Angeles":{"value":{"name":"Ritz Plumbing Heating, Air & Electrical","phone":"323 452-4915","rating":"five","address":"1355 S La Brea Ave, Los Angeles, CA 90019","website":"http://www.ritzplumbinginc.org","categories":["Plumbers","Air Conditioning Contractors & Systems","Air Conditioning Service & Repair","Plumbers","Air Conditioning Contractors & Systems","Air Conditioning Service & Repair","Building Contractors","Building Contractors-Commercial & Industrial","Electricians","Furnace Repair & Cleaning","Furnaces-Heating","Heating Contractors & Specialties","Heating Equipment & Systems","Plumbing Contractors-Commercial & Industrial","Plumbing-Drain & Sewer Cleaning","Sewer Contractors","Water Heaters"],"rating_count":3}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/thomasnet/search":{"get":{"summary":"Thomasnet Search","description":"Search Thomasnet suppliers from a search or category URL and get company listings, filters, name suggestions, and pagination.\n\n**Credit cost:** 3 credits per call","operationId":"get-thomasnet-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Thomasnet search URL from your browser.\n\n**Example 1 (keyword search):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=Table+Forks\n\n**Example 2 (product category):**\n\n    https://www.thomasnet.com/suppliers/table-forks-31172406\n\n**Example 3 (page 2):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=dz&page_number=2\n\n**Example 4 (older search page):**\n\n    https://www.thomasnet.com/compsearch.html?searchterm=stainless+steel\n\n**Notes:**\n- Only URLs on thomasnet.com are accepted.\n- Copy the full URL from your browser after running a search on thomasnet.com.\n- To go to the next page, change `page_number` in the URL or use the next page link on Thomasnet.\n- Use each result's `url` with **Thomasnet Company** to get the full supplier profile.","schema":{"type":"string","description":"Full Thomasnet search URL from your browser.\n\n**Example 1 (keyword search):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=Table+Forks\n\n**Example 2 (product category):**\n\n    https://www.thomasnet.com/suppliers/table-forks-31172406\n\n**Example 3 (page 2):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=dz&page_number=2\n\n**Example 4 (older search page):**\n\n    https://www.thomasnet.com/compsearch.html?searchterm=stainless+steel\n\n**Notes:**\n- Only URLs on thomasnet.com are accepted.\n- Copy the full URL from your browser after running a search on thomasnet.com.\n- To go to the next page, change `page_number` in the URL or use the next page link on Thomasnet.\n- Use each result's `url` with **Thomasnet Company** to get the full supplier profile."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"count":{"type":"integer"},"label":{"type":"string"},"section":{"type":"string"}}}},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"rank":{"type":"string"},"tier":{"type":"string"},"type":{"type":"string"},"videos":{"nullable":true},"address":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"zip4":{"nullable":true},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"nullable":true},"address3":{"nullable":true},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_name":{"type":"string"}}},"heading":{"nullable":true},"website":{"type":"string"},"distance":{"nullable":true},"headings":{"type":"array","items":{"type":"object","properties":{"heading_id":{"type":"string"},"natural_name":{"type":"string"}}}},"logo_url":{"nullable":true},"pdm_text":{"type":"string"},"products":{"nullable":true},"tgrams_id":{"type":"string"},"is_claimed":{"type":"boolean"},"logo_title":{"type":"string"},"description":{"type":"string"},"annual_sales":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"names":{"type":"array","items":{"type":"string"}}}}},"catalog_type":{"nullable":true},"year_founded":{"type":"string"},"is_advertiser":{"type":"boolean"},"primary_phone":{"type":"string"},"heading_brands":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"is_top_responder":{"nullable":true},"number_employees":{"type":"string"},"other_activities":{"type":"array","items":{"type":"string"}},"xometry_verified":{"type":"boolean"},"is_multi_location":{"type":"boolean"},"main_location_name":{"nullable":true},"main_location_tgrams_id":{"nullable":true}}}},"pagination":{"type":"object","properties":{"current":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"search_term":{"type":"string"},"company_name_matches":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tier":{"type":"string"},"type":{"type":"string"},"social":{"nullable":true},"address":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"zip4":{"nullable":true},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"nullable":true},"address3":{"nullable":true},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_name":{"type":"string"}}},"heading":{"nullable":true},"website":{"nullable":true},"headings":{"nullable":true},"logo_url":{"nullable":true},"premiums":{"nullable":true},"personnel":{"nullable":true},"tgrams_id":{"type":"string"},"is_claimed":{"type":"boolean"},"logo_title":{"type":"string"},"description":{"type":"string"},"annual_sales":{"type":"string"},"catalog_type":{"nullable":true},"year_founded":{"type":"string"},"is_advertiser":{"type":"boolean"},"primary_phone":{"type":"string"},"location_types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"is_top_responder":{"nullable":true},"number_employees":{"type":"string"},"other_activities":{"nullable":true},"xometry_verified":{"type":"boolean"},"is_multi_location":{"type":"boolean"},"main_location_name":{"nullable":true},"is_affiliation_page":{"type":"boolean"},"description_by_company":{"nullable":true},"main_location_tgrams_id":{"nullable":true}}}}}},"examples":{"Search suppliers for keyword dz":{"value":{"filters":[{"id":"Any Glass","count":1,"label":"Any Glass","section":"Materials"},{"id":"Any Plastic","count":1,"label":"Any Plastic","section":"Materials"},{"id":"Any Rubber (Elastomer)","count":1,"label":"Any Rubber (Elastomer)","section":"Materials"},{"id":"Any Stainless Steel","count":1,"label":"Any Stainless Steel","section":"Materials"},{"id":"C","count":1,"label":"Custom Manufacturer","section":"Company Type"}],"results":[{"url":"https://www.thomasnet.com/company/terriss-consolidated-industries-inc-574321/profile","name":"Terriss Consolidated Industries, Inc.","rank":"53.83929","tier":"NONE","type":"M","videos":null,"address":{"zip":"07712","city":"Asbury Park","zip4":null,"state":"NJ","county":null,"country":"USA","address1":"807 Summerfield Ave.","address2":null,"address3":null,"latitude":40.24707252,"longitude":-74.0496745,"state_name":"New Jersey"},"heading":null,"website":"https://www.terriss.com/","distance":null,"headings":[{"heading_id":"88501200","natural_name":"Tubes"}],"logo_url":null,"pdm_text":"Manufacturer & stocking distributor of Pyrex® glass, screw top & round bottom culture tubes. Available in 13 mm x 100 mm to 25 mm x 200 mm size with 10 ml <em>dz</em> to 75 ml <em>dz</em> capacity, black phenolic plastic cap & PTFE liner.","products":null,"tgrams_id":"574321","is_claimed":false,"logo_title":"Terriss Consolidated Industries, Inc. Company Logo","description":"Manufacturer & stocking distributor of biodegradable products, scientific instruments & laboratory supplies & stainless steel products. Products include lubricants, label dispensers, magnetic stirrers, microscopes, stoppers, brushes, test kits, thermometers, torque testers, voltage regulators, culture tubes, vacuum testers, turbidity meters, viscometers & hydrometers. Agitators, containers, dippers, enclosures, funnels, gaskets, mixers, fittings, pumps, scoops, scrapers, tubes, valves, tanks & waste receptacles are also available. Applications include food, beverage, chemical, pharmaceutical, water & wastewater industries.","annual_sales":"$1 - 4.9 Mil","capabilities":[{"type":"MATERIAL","names":["Any Glass","Any Plastic","Any Rubber (Elastomer)","Any Stainless Steel","Garbage and Trash","Plastic","Rod","Stainless Steel","Test Tubes"]}],"catalog_type":null,"year_founded":"1895","is_advertiser":false,"primary_phone":"(732) 988-0909","heading_brands":[{"name":"Schott"}],"is_top_responder":null,"number_employees":"10-49","other_activities":["C","D","S"],"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"main_location_tgrams_id":null},{"url":"https://www.thomasnet.com/company/zepole-supply-co-20088400/profile","name":"Zepole Supply Co.","rank":"51.568188","tier":"NONE","type":"D","videos":null,"address":{"zip":"60440","city":"Bolingbrook","zip4":null,"state":"IL","county":null,"country":"USA","address1":"506 E. North Frontage Rd","address2":null,"address3":null,"latitude":41.69832555,"longitude":-88.0778819,"state_name":"Illinois"},"heading":null,"website":"https://zepole.com/","distance":null,"headings":[{"heading_id":"31172406","natural_name":"Table Forks"}],"logo_url":null,"pdm_text":"Flatware distributor providing a full line of products for the restaurant industry. Stainless steel forks are offered in four different styles including Barcelona, Delta, Dominion and Windsor. Barcelona forks are provided in dessert / salad and Euro size type table forks and are constructed of 18/0 stainless and offered in 3 <em>dz</em>./bx. packaging. Delta style forks are available in dinner and salad fork type and provided in a 3 <em>dz</em>./cs. package. Dominion and Windsor style forks are provided in a packaging of 50 <em>dz</em>./cs., and are constructed of 18/0 chrome with a medium weight in dinner or salad type table forks.","products":null,"tgrams_id":"20088400","is_claimed":false,"logo_title":"Zepole Supply Co. Company Logo","description":"A distributor of shelves and shelving units for the baking industry. These units are constructed of chrome plated wire shelves and are available in 18 inches and 24 inches wide configurations. Both sizes are available in units measuring from 36 inches to 72 inches high. These units have a weight capacity of 600 to 800 lb. per shelf or 2000 lb. per assembled unit. Chrome plated posts for shelving units can be found here as well, constructed of 16 gauge round steel tubing.","annual_sales":"Under $1 Mil","capabilities":null,"catalog_type":null,"year_founded":"2007","is_advertiser":false,"primary_phone":"(630) 783-1239","heading_brands":null,"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"main_location_tgrams_id":null}],"pagination":{"current":1,"per_page":2,"total_pages":1,"has_next_page":false,"total_results":2},"search_term":"dz","company_name_matches":[{"url":"https://www.thomasnet.com/company/dz-technologies-inc-30478368/profile","name":"DZ Technologies, Inc.","tier":"NONE","type":"S","social":null,"address":{"zip":"75379","city":"Dallas","zip4":null,"state":"TX","county":null,"country":"USA","address1":"P.O. Box 796593","address2":null,"address3":null,"latitude":32.78380685,"longitude":-96.801006,"state_name":"Texas"},"heading":null,"website":null,"headings":null,"logo_url":null,"premiums":null,"personnel":null,"tgrams_id":"30478368","is_claimed":false,"logo_title":"DZ Technologies, Inc. Company Logo","description":"Turnkey electronic hardware & software design services for systems & board level products. Industries include telecommunications, petroleum, traffic, transportation & medical.","annual_sales":"Under $1 Mil","catalog_type":null,"year_founded":"2003","is_advertiser":false,"primary_phone":"(214) 557-2436","location_types":[{"id":999,"name":"No Location Type Found"}],"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"is_affiliation_page":false,"description_by_company":null,"main_location_tgrams_id":null},{"url":"https://www.thomasnet.com/company/dz-flooring-30204802/profile","name":"DZ Flooring","tier":"NONE","type":"S","social":null,"address":{"zip":"60641","city":"Chicago","zip4":null,"state":"IL","county":null,"country":"USA","address1":"2929 N. Luna","address2":null,"address3":null,"latitude":41.94615613,"longitude":-87.7470686,"state_name":"Illinois"},"heading":null,"website":"Http://www.dzflooring.com","headings":null,"logo_url":null,"premiums":null,"personnel":null,"tgrams_id":"30204802","is_claimed":false,"logo_title":"DZ Flooring Company Logo","description":"Flooring Contractor, Commercial & Residential Applications. Hardwood Flooring Install, Inspection, & Finishing. Also Painting, Ceramic Flooring, & Brick Paving.","annual_sales":"Under $1 Mil","catalog_type":null,"year_founded":null,"is_advertiser":false,"primary_phone":"(773) 968-4649","location_types":[{"id":999,"name":"No Location Type Found"}],"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"is_affiliation_page":false,"description_by_company":null,"main_location_tgrams_id":null}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Thomasnet Search","description":"Search Thomasnet suppliers from a search or category URL and get company listings, filters, name suggestions, and pagination.\n\n**Credit cost:** 3 credits per call","operationId":"post-thomasnet-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Thomasnet search URL from your browser.\n\n**Example 1 (keyword search):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=Table+Forks\n\n**Example 2 (product category):**\n\n    https://www.thomasnet.com/suppliers/table-forks-31172406\n\n**Example 3 (page 2):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=dz&page_number=2\n\n**Example 4 (older search page):**\n\n    https://www.thomasnet.com/compsearch.html?searchterm=stainless+steel\n\n**Notes:**\n- Only URLs on thomasnet.com are accepted.\n- Copy the full URL from your browser after running a search on thomasnet.com.\n- To go to the next page, change `page_number` in the URL or use the next page link on Thomasnet.\n- Use each result's `url` with **Thomasnet Company** to get the full supplier profile.","schema":{"type":"string","description":"Full Thomasnet search URL from your browser.\n\n**Example 1 (keyword search):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=Table+Forks\n\n**Example 2 (product category):**\n\n    https://www.thomasnet.com/suppliers/table-forks-31172406\n\n**Example 3 (page 2):**\n\n    https://www.thomasnet.com/suppliers/search?searchterm=dz&page_number=2\n\n**Example 4 (older search page):**\n\n    https://www.thomasnet.com/compsearch.html?searchterm=stainless+steel\n\n**Notes:**\n- Only URLs on thomasnet.com are accepted.\n- Copy the full URL from your browser after running a search on thomasnet.com.\n- To go to the next page, change `page_number` in the URL or use the next page link on Thomasnet.\n- Use each result's `url` with **Thomasnet Company** to get the full supplier profile."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"count":{"type":"integer"},"label":{"type":"string"},"section":{"type":"string"}}}},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"rank":{"type":"string"},"tier":{"type":"string"},"type":{"type":"string"},"videos":{"nullable":true},"address":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"zip4":{"nullable":true},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"nullable":true},"address3":{"nullable":true},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_name":{"type":"string"}}},"heading":{"nullable":true},"website":{"type":"string"},"distance":{"nullable":true},"headings":{"type":"array","items":{"type":"object","properties":{"heading_id":{"type":"string"},"natural_name":{"type":"string"}}}},"logo_url":{"nullable":true},"pdm_text":{"type":"string"},"products":{"nullable":true},"tgrams_id":{"type":"string"},"is_claimed":{"type":"boolean"},"logo_title":{"type":"string"},"description":{"type":"string"},"annual_sales":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"names":{"type":"array","items":{"type":"string"}}}}},"catalog_type":{"nullable":true},"year_founded":{"type":"string"},"is_advertiser":{"type":"boolean"},"primary_phone":{"type":"string"},"heading_brands":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"is_top_responder":{"nullable":true},"number_employees":{"type":"string"},"other_activities":{"type":"array","items":{"type":"string"}},"xometry_verified":{"type":"boolean"},"is_multi_location":{"type":"boolean"},"main_location_name":{"nullable":true},"main_location_tgrams_id":{"nullable":true}}}},"pagination":{"type":"object","properties":{"current":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"},"total_results":{"type":"integer"}}},"search_term":{"type":"string"},"company_name_matches":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"tier":{"type":"string"},"type":{"type":"string"},"social":{"nullable":true},"address":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"zip4":{"nullable":true},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"nullable":true},"address3":{"nullable":true},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_name":{"type":"string"}}},"heading":{"nullable":true},"website":{"nullable":true},"headings":{"nullable":true},"logo_url":{"nullable":true},"premiums":{"nullable":true},"personnel":{"nullable":true},"tgrams_id":{"type":"string"},"is_claimed":{"type":"boolean"},"logo_title":{"type":"string"},"description":{"type":"string"},"annual_sales":{"type":"string"},"catalog_type":{"nullable":true},"year_founded":{"type":"string"},"is_advertiser":{"type":"boolean"},"primary_phone":{"type":"string"},"location_types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"is_top_responder":{"nullable":true},"number_employees":{"type":"string"},"other_activities":{"nullable":true},"xometry_verified":{"type":"boolean"},"is_multi_location":{"type":"boolean"},"main_location_name":{"nullable":true},"is_affiliation_page":{"type":"boolean"},"description_by_company":{"nullable":true},"main_location_tgrams_id":{"nullable":true}}}}}},"examples":{"Search suppliers for keyword dz":{"value":{"filters":[{"id":"Any Glass","count":1,"label":"Any Glass","section":"Materials"},{"id":"Any Plastic","count":1,"label":"Any Plastic","section":"Materials"},{"id":"Any Rubber (Elastomer)","count":1,"label":"Any Rubber (Elastomer)","section":"Materials"},{"id":"Any Stainless Steel","count":1,"label":"Any Stainless Steel","section":"Materials"},{"id":"C","count":1,"label":"Custom Manufacturer","section":"Company Type"}],"results":[{"url":"https://www.thomasnet.com/company/terriss-consolidated-industries-inc-574321/profile","name":"Terriss Consolidated Industries, Inc.","rank":"53.83929","tier":"NONE","type":"M","videos":null,"address":{"zip":"07712","city":"Asbury Park","zip4":null,"state":"NJ","county":null,"country":"USA","address1":"807 Summerfield Ave.","address2":null,"address3":null,"latitude":40.24707252,"longitude":-74.0496745,"state_name":"New Jersey"},"heading":null,"website":"https://www.terriss.com/","distance":null,"headings":[{"heading_id":"88501200","natural_name":"Tubes"}],"logo_url":null,"pdm_text":"Manufacturer & stocking distributor of Pyrex® glass, screw top & round bottom culture tubes. Available in 13 mm x 100 mm to 25 mm x 200 mm size with 10 ml <em>dz</em> to 75 ml <em>dz</em> capacity, black phenolic plastic cap & PTFE liner.","products":null,"tgrams_id":"574321","is_claimed":false,"logo_title":"Terriss Consolidated Industries, Inc. Company Logo","description":"Manufacturer & stocking distributor of biodegradable products, scientific instruments & laboratory supplies & stainless steel products. Products include lubricants, label dispensers, magnetic stirrers, microscopes, stoppers, brushes, test kits, thermometers, torque testers, voltage regulators, culture tubes, vacuum testers, turbidity meters, viscometers & hydrometers. Agitators, containers, dippers, enclosures, funnels, gaskets, mixers, fittings, pumps, scoops, scrapers, tubes, valves, tanks & waste receptacles are also available. Applications include food, beverage, chemical, pharmaceutical, water & wastewater industries.","annual_sales":"$1 - 4.9 Mil","capabilities":[{"type":"MATERIAL","names":["Any Glass","Any Plastic","Any Rubber (Elastomer)","Any Stainless Steel","Garbage and Trash","Plastic","Rod","Stainless Steel","Test Tubes"]}],"catalog_type":null,"year_founded":"1895","is_advertiser":false,"primary_phone":"(732) 988-0909","heading_brands":[{"name":"Schott"}],"is_top_responder":null,"number_employees":"10-49","other_activities":["C","D","S"],"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"main_location_tgrams_id":null},{"url":"https://www.thomasnet.com/company/zepole-supply-co-20088400/profile","name":"Zepole Supply Co.","rank":"51.568188","tier":"NONE","type":"D","videos":null,"address":{"zip":"60440","city":"Bolingbrook","zip4":null,"state":"IL","county":null,"country":"USA","address1":"506 E. North Frontage Rd","address2":null,"address3":null,"latitude":41.69832555,"longitude":-88.0778819,"state_name":"Illinois"},"heading":null,"website":"https://zepole.com/","distance":null,"headings":[{"heading_id":"31172406","natural_name":"Table Forks"}],"logo_url":null,"pdm_text":"Flatware distributor providing a full line of products for the restaurant industry. Stainless steel forks are offered in four different styles including Barcelona, Delta, Dominion and Windsor. Barcelona forks are provided in dessert / salad and Euro size type table forks and are constructed of 18/0 stainless and offered in 3 <em>dz</em>./bx. packaging. Delta style forks are available in dinner and salad fork type and provided in a 3 <em>dz</em>./cs. package. Dominion and Windsor style forks are provided in a packaging of 50 <em>dz</em>./cs., and are constructed of 18/0 chrome with a medium weight in dinner or salad type table forks.","products":null,"tgrams_id":"20088400","is_claimed":false,"logo_title":"Zepole Supply Co. Company Logo","description":"A distributor of shelves and shelving units for the baking industry. These units are constructed of chrome plated wire shelves and are available in 18 inches and 24 inches wide configurations. Both sizes are available in units measuring from 36 inches to 72 inches high. These units have a weight capacity of 600 to 800 lb. per shelf or 2000 lb. per assembled unit. Chrome plated posts for shelving units can be found here as well, constructed of 16 gauge round steel tubing.","annual_sales":"Under $1 Mil","capabilities":null,"catalog_type":null,"year_founded":"2007","is_advertiser":false,"primary_phone":"(630) 783-1239","heading_brands":null,"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"main_location_tgrams_id":null}],"pagination":{"current":1,"per_page":2,"total_pages":1,"has_next_page":false,"total_results":2},"search_term":"dz","company_name_matches":[{"url":"https://www.thomasnet.com/company/dz-technologies-inc-30478368/profile","name":"DZ Technologies, Inc.","tier":"NONE","type":"S","social":null,"address":{"zip":"75379","city":"Dallas","zip4":null,"state":"TX","county":null,"country":"USA","address1":"P.O. Box 796593","address2":null,"address3":null,"latitude":32.78380685,"longitude":-96.801006,"state_name":"Texas"},"heading":null,"website":null,"headings":null,"logo_url":null,"premiums":null,"personnel":null,"tgrams_id":"30478368","is_claimed":false,"logo_title":"DZ Technologies, Inc. Company Logo","description":"Turnkey electronic hardware & software design services for systems & board level products. Industries include telecommunications, petroleum, traffic, transportation & medical.","annual_sales":"Under $1 Mil","catalog_type":null,"year_founded":"2003","is_advertiser":false,"primary_phone":"(214) 557-2436","location_types":[{"id":999,"name":"No Location Type Found"}],"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"is_affiliation_page":false,"description_by_company":null,"main_location_tgrams_id":null},{"url":"https://www.thomasnet.com/company/dz-flooring-30204802/profile","name":"DZ Flooring","tier":"NONE","type":"S","social":null,"address":{"zip":"60641","city":"Chicago","zip4":null,"state":"IL","county":null,"country":"USA","address1":"2929 N. Luna","address2":null,"address3":null,"latitude":41.94615613,"longitude":-87.7470686,"state_name":"Illinois"},"heading":null,"website":"Http://www.dzflooring.com","headings":null,"logo_url":null,"premiums":null,"personnel":null,"tgrams_id":"30204802","is_claimed":false,"logo_title":"DZ Flooring Company Logo","description":"Flooring Contractor, Commercial & Residential Applications. Hardwood Flooring Install, Inspection, & Finishing. Also Painting, Ceramic Flooring, & Brick Paving.","annual_sales":"Under $1 Mil","catalog_type":null,"year_founded":null,"is_advertiser":false,"primary_phone":"(773) 968-4649","location_types":[{"id":999,"name":"No Location Type Found"}],"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"is_affiliation_page":false,"description_by_company":null,"main_location_tgrams_id":null}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/thomasnet/company":{"get":{"summary":"Thomasnet Company","description":"Get a full Thomasnet supplier profile from a company URL, including contact details, product categories, and business information.\n\n**Credit cost:** 3 credits per call","operationId":"get-thomasnet-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Thomasnet company profile URL from your browser.\n\n**Example:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile\n\n**Example with search context:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile?searchterm=Table+Forks&heading=31172406\n\n**Notes:**\n- Only company profile URLs on thomasnet.com are accepted (pages containing `/company/` and `/profile`).\n- Extra parameters in the URL are optional. You can copy the link exactly as shown on Thomasnet.\n- You can paste a profile URL from search results or open the company page on thomasnet.com and copy the address bar.","schema":{"type":"string","description":"Full Thomasnet company profile URL from your browser.\n\n**Example:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile\n\n**Example with search context:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile?searchterm=Table+Forks&heading=31172406\n\n**Notes:**\n- Only company profile URLs on thomasnet.com are accepted (pages containing `/company/` and `/profile`).\n- Extra parameters in the URL are optional. You can copy the link exactly as shown on Thomasnet.\n- You can paste a profile URL from search results or open the company page on thomasnet.com and copy the address bar."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"ads":{"nullable":true},"url":{"type":"string"},"name":{"type":"string"},"news":{"nullable":true},"tier":{"type":"string"},"type":{"type":"string"},"brands":{"nullable":true},"social":{"nullable":true},"videos":{"nullable":true},"address":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"zip4":{"nullable":true},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"nullable":true},"address3":{"nullable":true},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_name":{"type":"string"}}},"heading":{"type":"object","properties":{"url":{"nullable":true},"name":{"type":"string"},"family_id":{"type":"string"},"heading_id":{"type":"string"},"description":{"type":"string"},"family_name":{"type":"string"},"natural_name":{"type":"string"}}},"website":{"type":"string"},"families":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"headings":{"type":"array","items":{"type":"object","properties":{"url":{"nullable":true},"name":{"type":"string"},"heading_id":{"type":"string"},"description":{"type":"string"},"family_name":{"type":"string"}}}},"logo_url":{"nullable":true},"premiums":{"nullable":true},"products":{"nullable":true},"personnel":{"nullable":true},"tgrams_id":{"type":"string"},"company_ad":{"nullable":true},"is_claimed":{"type":"boolean"},"logo_title":{"type":"string"},"description":{"type":"string"},"whitepapers":{"nullable":true},"annual_sales":{"type":"string"},"catalog_type":{"nullable":true},"year_founded":{"type":"string"},"is_advertiser":{"type":"boolean"},"primary_phone":{"type":"string"},"heading_brands":{"nullable":true},"location_types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"other_headings":{"type":"array","items":{"type":"object","properties":{"url":{"nullable":true},"name":{"type":"string"},"heading_id":{"type":"string"},"description":{"nullable":true},"natural_name":{"type":"string"}}}},"is_top_responder":{"nullable":true},"number_employees":{"type":"string"},"other_activities":{"nullable":true},"xometry_verified":{"type":"boolean"},"is_multi_location":{"type":"boolean"},"main_location_name":{"nullable":true},"is_affiliation_page":{"type":"boolean"},"affiliated_member_of":{"nullable":true},"certification_totals":{"nullable":true},"additional_information":{"nullable":true},"description_by_company":{"nullable":true},"affiliation_contact_url":{"nullable":true},"main_location_tgrams_id":{"nullable":true},"affiliation_company_label":{"nullable":true},"affiliation_featured_members":{"nullable":true}}},"products":{"type":"object","properties":{"products":{"type":"array","items":{}},"categories":{"type":"array","items":{}},"capabilities":{"type":"array","items":{}},"configurators":{"type":"array","items":{}}}},"search_term":{"type":"string"},"business_details":{"type":"object","properties":{"first_column_sections":{"type":"array","items":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"text":{"type":"string"},"emit_web_traxs_event":{"type":"boolean"}}}},"label":{"type":"string"}}}},"second_column_sections":{"type":"array","items":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}},"label":{"type":"string"}}}}}},"navigation_headings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url_slug":{"type":"string"},"natural_name":{"type":"string"}}}}}},"examples":{"Lookup Zepole Supply Co. profile":{"value":{"company":{"ads":null,"url":"https://www.thomasnet.com/company/zepole-supply-co-20088400/profile","name":"Zepole Supply Co.","news":null,"tier":"NONE","type":"D","brands":null,"social":null,"videos":null,"address":{"zip":"60440","city":"Bolingbrook","zip4":null,"state":"IL","county":null,"country":"USA","address1":"506 E. North Frontage Rd","address2":null,"address3":null,"latitude":41.69832555,"longitude":-88.0778819,"state_name":"Illinois"},"heading":{"url":null,"name":"Forks: Table","family_id":"157835","heading_id":"31172406","description":"Flatware distributor providing a full line of products for the restaurant industry. Stainless steel forks are offered in four different styles including Barcelona, Delta, Dominion and Windsor. Barcelona forks are provided in dessert / salad and Euro size type table forks and are constructed of 18/0 stainless and offered in 3 dz./bx. packaging. Delta style forks are available in dinner and salad fork type and provided in a 3 dz./cs. package. Dominion and Windsor style forks are provided in a packaging of 50 dz./cs., and are constructed of 18/0 chrome with a medium weight in dinner or salad type table forks.","family_name":"Forks","natural_name":"Table Forks"},"website":"https://zepole.com/","families":[{"id":"157336","name":"Cabinets"},{"id":"160228","name":"Dinnerware"},{"id":"157835","name":"Forks"},{"id":"160407","name":"Fryers"},{"id":"151794","name":"Mixers"},{"id":"152555","name":"Ovens"},{"id":"160044","name":"Restaurant Equipment"},{"id":"157902","name":"Shelves and Shelving"},{"id":"153364","name":"Stoves"}],"headings":[{"url":null,"name":"Bakery Shelving","heading_id":"96112289","description":"A distributor of shelves and shelving units for the baking industry. These units are constructed of chrome plated wire shelves and are available in 18 inches and 24 inches wide configurations. Both sizes are available in units measuring from 36 inches to 72 inches high. These units have a weight capacity of 600 to 800 lb. per shelf or 2000 lb. per assembled unit. Chrome plated posts for shelving units can be found here as well, constructed of 16 gauge round steel tubing.","family_name":"Shelves and Shelving"},{"url":null,"name":"Cabinets","heading_id":"9387309","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Cabinets"},{"url":null,"name":"Dinnerware","heading_id":"23232200","description":"Distributor of various dinnerware products including pitchers, platters, china (some porcelain), plastic and glass beverage ware, stainless flatware, salt and pepper shakers and mills as well as steak knives.","family_name":"Dinnerware"},{"url":null,"name":"Forks: Table","heading_id":"31172406","description":"Flatware distributor providing a full line of products for the restaurant industry. Stainless steel forks are offered in four different styles including Barcelona, Delta, Dominion and Windsor. Barcelona forks are provided in dessert / salad and Euro size type table forks and are constructed of 18/0 stainless and offered in 3 dz./bx. packaging. Delta style forks are available in dinner and salad fork type and provided in a 3 dz./cs. package. Dominion and Windsor style forks are provided in a packaging of 50 dz./cs., and are constructed of 18/0 chrome with a medium weight in dinner or salad type table forks.","family_name":"Forks"},{"url":null,"name":"Fryers: Deep","heading_id":"31442403","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Fryers"},{"url":null,"name":"Mixers","heading_id":"51700409","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Mixers"},{"url":null,"name":"Ovens","heading_id":"55174007","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Ovens"},{"url":null,"name":"Ovens: Convection","heading_id":"55340301","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Ovens"},{"url":null,"name":"Ranges","heading_id":"66144056","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Stoves"},{"url":null,"name":"Restaurant Equipment: Used","heading_id":"97003385","description":"Distributor of both new and used restaurant equipment. Offering a complete selection of cooking equipment, furniture, restaurant supplies, storage equipment, sinks, china, flatware, glassware, display and mechandising cases, refrigeration, janitorial equipment and supplies, fryers and dining room furniture and supplies.","family_name":"Restaurant Equipment"}],"logo_url":null,"premiums":null,"products":null,"personnel":null,"tgrams_id":"20088400","company_ad":null,"is_claimed":false,"logo_title":"Zepole Supply Co. Company Logo","description":"A distributor of shelves and shelving units for the baking industry. These units are constructed of chrome plated wire shelves and are available in 18 inches and 24 inches wide configurations. Both sizes are available in units measuring from 36 inches to 72 inches high. These units have a weight capacity of 600 to 800 lb. per shelf or 2000 lb. per assembled unit. Chrome plated posts for shelving units can be found here as well, constructed of 16 gauge round steel tubing.","whitepapers":null,"annual_sales":"Under $1 Mil","catalog_type":null,"year_founded":"2007","is_advertiser":false,"primary_phone":"(630) 783-1239","heading_brands":null,"location_types":[{"id":999,"name":"No Location Type Found"}],"other_headings":[{"url":null,"name":"Forks: Table","heading_id":"31172406","description":null,"natural_name":"Table Forks"}],"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"is_affiliation_page":false,"affiliated_member_of":null,"certification_totals":null,"additional_information":null,"description_by_company":null,"affiliation_contact_url":null,"main_location_tgrams_id":null,"affiliation_company_label":null,"affiliation_featured_members":null},"products":{"products":[],"categories":[],"capabilities":[],"configurators":[]},"search_term":"Table Forks","business_details":{"first_column_sections":[{"items":[{"url":"https://zepole.com/","text":"Homepage","emit_web_traxs_event":false},{"url":null,"text":"Forks: Table","emit_web_traxs_event":false}],"label":"Website"},{"items":[{"text":"Distributor"}],"label":"Primary Company Type"},{"items":[{"text":null}],"label":"Additional Activities"},{"items":[],"label":"Key Personnel","limit":5}],"second_column_sections":[{"items":[{"text":"Under $1 Mil"}],"label":"Annual Sales:"},{"items":[{"text":"1-9"}],"label":"No of Employees:"},{"items":[{"text":"2007"}],"label":"Year Founded:"}]},"navigation_headings":[{"id":"31161201","url_slug":"forks","natural_name":"Forks"},{"id":"31172406","url_slug":"table-forks","natural_name":"Table Forks"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Thomasnet Company","description":"Get a full Thomasnet supplier profile from a company URL, including contact details, product categories, and business information.\n\n**Credit cost:** 3 credits per call","operationId":"post-thomasnet-company","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Thomasnet company profile URL from your browser.\n\n**Example:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile\n\n**Example with search context:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile?searchterm=Table+Forks&heading=31172406\n\n**Notes:**\n- Only company profile URLs on thomasnet.com are accepted (pages containing `/company/` and `/profile`).\n- Extra parameters in the URL are optional. You can copy the link exactly as shown on Thomasnet.\n- You can paste a profile URL from search results or open the company page on thomasnet.com and copy the address bar.","schema":{"type":"string","description":"Full Thomasnet company profile URL from your browser.\n\n**Example:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile\n\n**Example with search context:**\n\n    https://www.thomasnet.com/company/zepole-supply-co-20088400/profile?searchterm=Table+Forks&heading=31172406\n\n**Notes:**\n- Only company profile URLs on thomasnet.com are accepted (pages containing `/company/` and `/profile`).\n- Extra parameters in the URL are optional. You can copy the link exactly as shown on Thomasnet.\n- You can paste a profile URL from search results or open the company page on thomasnet.com and copy the address bar."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"ads":{"nullable":true},"url":{"type":"string"},"name":{"type":"string"},"news":{"nullable":true},"tier":{"type":"string"},"type":{"type":"string"},"brands":{"nullable":true},"social":{"nullable":true},"videos":{"nullable":true},"address":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"zip4":{"nullable":true},"state":{"type":"string"},"county":{"nullable":true},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"nullable":true},"address3":{"nullable":true},"latitude":{"type":"number"},"longitude":{"type":"number"},"state_name":{"type":"string"}}},"heading":{"type":"object","properties":{"url":{"nullable":true},"name":{"type":"string"},"family_id":{"type":"string"},"heading_id":{"type":"string"},"description":{"type":"string"},"family_name":{"type":"string"},"natural_name":{"type":"string"}}},"website":{"type":"string"},"families":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"headings":{"type":"array","items":{"type":"object","properties":{"url":{"nullable":true},"name":{"type":"string"},"heading_id":{"type":"string"},"description":{"type":"string"},"family_name":{"type":"string"}}}},"logo_url":{"nullable":true},"premiums":{"nullable":true},"products":{"nullable":true},"personnel":{"nullable":true},"tgrams_id":{"type":"string"},"company_ad":{"nullable":true},"is_claimed":{"type":"boolean"},"logo_title":{"type":"string"},"description":{"type":"string"},"whitepapers":{"nullable":true},"annual_sales":{"type":"string"},"catalog_type":{"nullable":true},"year_founded":{"type":"string"},"is_advertiser":{"type":"boolean"},"primary_phone":{"type":"string"},"heading_brands":{"nullable":true},"location_types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"other_headings":{"type":"array","items":{"type":"object","properties":{"url":{"nullable":true},"name":{"type":"string"},"heading_id":{"type":"string"},"description":{"nullable":true},"natural_name":{"type":"string"}}}},"is_top_responder":{"nullable":true},"number_employees":{"type":"string"},"other_activities":{"nullable":true},"xometry_verified":{"type":"boolean"},"is_multi_location":{"type":"boolean"},"main_location_name":{"nullable":true},"is_affiliation_page":{"type":"boolean"},"affiliated_member_of":{"nullable":true},"certification_totals":{"nullable":true},"additional_information":{"nullable":true},"description_by_company":{"nullable":true},"affiliation_contact_url":{"nullable":true},"main_location_tgrams_id":{"nullable":true},"affiliation_company_label":{"nullable":true},"affiliation_featured_members":{"nullable":true}}},"products":{"type":"object","properties":{"products":{"type":"array","items":{}},"categories":{"type":"array","items":{}},"capabilities":{"type":"array","items":{}},"configurators":{"type":"array","items":{}}}},"search_term":{"type":"string"},"business_details":{"type":"object","properties":{"first_column_sections":{"type":"array","items":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"text":{"type":"string"},"emit_web_traxs_event":{"type":"boolean"}}}},"label":{"type":"string"}}}},"second_column_sections":{"type":"array","items":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}},"label":{"type":"string"}}}}}},"navigation_headings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url_slug":{"type":"string"},"natural_name":{"type":"string"}}}}}},"examples":{"Lookup Zepole Supply Co. profile":{"value":{"company":{"ads":null,"url":"https://www.thomasnet.com/company/zepole-supply-co-20088400/profile","name":"Zepole Supply Co.","news":null,"tier":"NONE","type":"D","brands":null,"social":null,"videos":null,"address":{"zip":"60440","city":"Bolingbrook","zip4":null,"state":"IL","county":null,"country":"USA","address1":"506 E. North Frontage Rd","address2":null,"address3":null,"latitude":41.69832555,"longitude":-88.0778819,"state_name":"Illinois"},"heading":{"url":null,"name":"Forks: Table","family_id":"157835","heading_id":"31172406","description":"Flatware distributor providing a full line of products for the restaurant industry. Stainless steel forks are offered in four different styles including Barcelona, Delta, Dominion and Windsor. Barcelona forks are provided in dessert / salad and Euro size type table forks and are constructed of 18/0 stainless and offered in 3 dz./bx. packaging. Delta style forks are available in dinner and salad fork type and provided in a 3 dz./cs. package. Dominion and Windsor style forks are provided in a packaging of 50 dz./cs., and are constructed of 18/0 chrome with a medium weight in dinner or salad type table forks.","family_name":"Forks","natural_name":"Table Forks"},"website":"https://zepole.com/","families":[{"id":"157336","name":"Cabinets"},{"id":"160228","name":"Dinnerware"},{"id":"157835","name":"Forks"},{"id":"160407","name":"Fryers"},{"id":"151794","name":"Mixers"},{"id":"152555","name":"Ovens"},{"id":"160044","name":"Restaurant Equipment"},{"id":"157902","name":"Shelves and Shelving"},{"id":"153364","name":"Stoves"}],"headings":[{"url":null,"name":"Bakery Shelving","heading_id":"96112289","description":"A distributor of shelves and shelving units for the baking industry. These units are constructed of chrome plated wire shelves and are available in 18 inches and 24 inches wide configurations. Both sizes are available in units measuring from 36 inches to 72 inches high. These units have a weight capacity of 600 to 800 lb. per shelf or 2000 lb. per assembled unit. Chrome plated posts for shelving units can be found here as well, constructed of 16 gauge round steel tubing.","family_name":"Shelves and Shelving"},{"url":null,"name":"Cabinets","heading_id":"9387309","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Cabinets"},{"url":null,"name":"Dinnerware","heading_id":"23232200","description":"Distributor of various dinnerware products including pitchers, platters, china (some porcelain), plastic and glass beverage ware, stainless flatware, salt and pepper shakers and mills as well as steak knives.","family_name":"Dinnerware"},{"url":null,"name":"Forks: Table","heading_id":"31172406","description":"Flatware distributor providing a full line of products for the restaurant industry. Stainless steel forks are offered in four different styles including Barcelona, Delta, Dominion and Windsor. Barcelona forks are provided in dessert / salad and Euro size type table forks and are constructed of 18/0 stainless and offered in 3 dz./bx. packaging. Delta style forks are available in dinner and salad fork type and provided in a 3 dz./cs. package. Dominion and Windsor style forks are provided in a packaging of 50 dz./cs., and are constructed of 18/0 chrome with a medium weight in dinner or salad type table forks.","family_name":"Forks"},{"url":null,"name":"Fryers: Deep","heading_id":"31442403","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Fryers"},{"url":null,"name":"Mixers","heading_id":"51700409","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Mixers"},{"url":null,"name":"Ovens","heading_id":"55174007","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Ovens"},{"url":null,"name":"Ovens: Convection","heading_id":"55340301","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Ovens"},{"url":null,"name":"Ranges","heading_id":"66144056","description":"Distributor of restaurant equipment & supplies including bakery, bar, cooking, counter, concession, dining room, display, serving, food preparation, fryer, floor, production, maintenance, janitorial, cleaning, refrigeration, serving, display, transport, holding, storage, ventilation & warehousing equipment as well as furniture, fixtures, kitchenware, merchandising cases, tabletops & sinks.","family_name":"Stoves"},{"url":null,"name":"Restaurant Equipment: Used","heading_id":"97003385","description":"Distributor of both new and used restaurant equipment. Offering a complete selection of cooking equipment, furniture, restaurant supplies, storage equipment, sinks, china, flatware, glassware, display and mechandising cases, refrigeration, janitorial equipment and supplies, fryers and dining room furniture and supplies.","family_name":"Restaurant Equipment"}],"logo_url":null,"premiums":null,"products":null,"personnel":null,"tgrams_id":"20088400","company_ad":null,"is_claimed":false,"logo_title":"Zepole Supply Co. Company Logo","description":"A distributor of shelves and shelving units for the baking industry. These units are constructed of chrome plated wire shelves and are available in 18 inches and 24 inches wide configurations. Both sizes are available in units measuring from 36 inches to 72 inches high. These units have a weight capacity of 600 to 800 lb. per shelf or 2000 lb. per assembled unit. Chrome plated posts for shelving units can be found here as well, constructed of 16 gauge round steel tubing.","whitepapers":null,"annual_sales":"Under $1 Mil","catalog_type":null,"year_founded":"2007","is_advertiser":false,"primary_phone":"(630) 783-1239","heading_brands":null,"location_types":[{"id":999,"name":"No Location Type Found"}],"other_headings":[{"url":null,"name":"Forks: Table","heading_id":"31172406","description":null,"natural_name":"Table Forks"}],"is_top_responder":null,"number_employees":"1-9","other_activities":null,"xometry_verified":false,"is_multi_location":false,"main_location_name":null,"is_affiliation_page":false,"affiliated_member_of":null,"certification_totals":null,"additional_information":null,"description_by_company":null,"affiliation_contact_url":null,"main_location_tgrams_id":null,"affiliation_company_label":null,"affiliation_featured_members":null},"products":{"products":[],"categories":[],"capabilities":[],"configurators":[]},"search_term":"Table Forks","business_details":{"first_column_sections":[{"items":[{"url":"https://zepole.com/","text":"Homepage","emit_web_traxs_event":false},{"url":null,"text":"Forks: Table","emit_web_traxs_event":false}],"label":"Website"},{"items":[{"text":"Distributor"}],"label":"Primary Company Type"},{"items":[{"text":null}],"label":"Additional Activities"},{"items":[],"label":"Key Personnel","limit":5}],"second_column_sections":[{"items":[{"text":"Under $1 Mil"}],"label":"Annual Sales:"},{"items":[{"text":"1-9"}],"label":"No of Employees:"},{"items":[{"text":"2007"}],"label":"Year Founded:"}]},"navigation_headings":[{"id":"31161201","url_slug":"forks","natural_name":"Forks"},{"id":"31172406","url_slug":"table-forks","natural_name":"Table Forks"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/patreon/search":{"get":{"summary":"Patreon Search","description":"Search Patreon creators by keyword and retrieve campaign cards with patron counts, post counts, and profile URLs.\n\n**Credit cost:** 1 credit per call","operationId":"get-patreon-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword to find Patreon creators.\n\n**Example:**\n\n    creator\n\n**Notes:**\n- Returns matching creator pages with patron counts, post counts, and profile URLs.\n- Use `pagination.next` or increment the page parameter to fetch additional results.","schema":{"type":"string","description":"Search keyword to find Patreon creators.\n\n**Example:**\n\n    creator\n\n**Notes:**\n- Returns matching creator pages with patron counts, post counts, and profile URLs.\n- Use `pagination.next` or increment the page parameter to fetch additional results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"thumb":{"type":"string"},"avatar":{"type":"string"},"is_nsfw":{"type":"boolean"},"summary":{"nullable":true},"post_count":{"type":"integer"},"creator_name":{"type":"string"},"patron_count":{"nullable":true},"creation_name":{"type":"string"},"primary_theme_color":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"prev":{"type":"string"},"hits_total":{"type":"integer"},"pages_total":{"type":"integer"},"has_next_page":{"type":"boolean"},"has_prev_page":{"type":"boolean"}}}}},"examples":{"Search creators by keyword":{"value":{"query":"creator","results":[{"id":"6730893","url":"https://www.patreon.com/mrtini23","name":"MrTini23","thumb":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/6730893/45f72094d4704e4ebc38656dc63a91e3/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=NjIGYFK6C8zd6-nfelA2hysljSu-2dnpLQWzvOz1TRw%3D","avatar":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/6730893/45f72094d4704e4ebc38656dc63a91e3/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=NjIGYFK6C8zd6-nfelA2hysljSu-2dnpLQWzvOz1TRw%3D","is_nsfw":false,"summary":null,"post_count":14,"creator_name":"MrTini23","patron_count":null,"creation_name":"Retro Football Manager Content Creator","primary_theme_color":"35236"},{"id":"3634516","url":"https://www.patreon.com/cfemen","name":"cfemen","thumb":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/d98be5b6694e45c58ba758d186b5a0b1/eyJ3IjoyNDB9/1.jpg?token-time=2145916800&token-hash=Ohlsjl91t-EeaBRJyM0CbV3Z81ried7BEwlqQ5xYgOw%3D","avatar":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/d98be5b6694e45c58ba758d186b5a0b1/eyJ3IjoyNDB9/1.jpg?token-time=2145916800&token-hash=Ohlsjl91t-EeaBRJyM0CbV3Z81ried7BEwlqQ5xYgOw%3D","is_nsfw":false,"summary":null,"post_count":1,"creator_name":"cfemen","patron_count":10465,"creation_name":"Game Content Creator","primary_theme_color":"36491"},{"id":"10175206","url":"https://www.patreon.com/JoshDaly","name":"JoshDaly","thumb":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/10175206/e0ce470692e845af8cf5671d2612cb6a/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=sMkJSJgskUydmu0ZZ73OrpoOHo2PYwfEPQvjU9ClJ54%3D","avatar":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/10175206/e0ce470692e845af8cf5671d2612cb6a/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=sMkJSJgskUydmu0ZZ73OrpoOHo2PYwfEPQvjU9ClJ54%3D","is_nsfw":false,"summary":null,"post_count":1379,"creator_name":"JoshDaly","patron_count":9052,"creation_name":"Youtube Content Creator ","primary_theme_color":"419450"}],"pagination":{"next":"https://www.patreon.com/api/search?query=creator&page%5Bnumber%5D=3","page":2,"prev":"https://www.patreon.com/api/search?query=creator&page%5Bnumber%5D=1","hits_total":66,"pages_total":4,"has_next_page":true,"has_prev_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Patreon Search","description":"Search Patreon creators by keyword and retrieve campaign cards with patron counts, post counts, and profile URLs.\n\n**Credit cost:** 1 credit per call","operationId":"post-patreon-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword to find Patreon creators.\n\n**Example:**\n\n    creator\n\n**Notes:**\n- Returns matching creator pages with patron counts, post counts, and profile URLs.\n- Use `pagination.next` or increment the page parameter to fetch additional results.","schema":{"type":"string","description":"Search keyword to find Patreon creators.\n\n**Example:**\n\n    creator\n\n**Notes:**\n- Returns matching creator pages with patron counts, post counts, and profile URLs.\n- Use `pagination.next` or increment the page parameter to fetch additional results."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"thumb":{"type":"string"},"avatar":{"type":"string"},"is_nsfw":{"type":"boolean"},"summary":{"nullable":true},"post_count":{"type":"integer"},"creator_name":{"type":"string"},"patron_count":{"nullable":true},"creation_name":{"type":"string"},"primary_theme_color":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"prev":{"type":"string"},"hits_total":{"type":"integer"},"pages_total":{"type":"integer"},"has_next_page":{"type":"boolean"},"has_prev_page":{"type":"boolean"}}}}},"examples":{"Search creators by keyword":{"value":{"query":"creator","results":[{"id":"6730893","url":"https://www.patreon.com/mrtini23","name":"MrTini23","thumb":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/6730893/45f72094d4704e4ebc38656dc63a91e3/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=NjIGYFK6C8zd6-nfelA2hysljSu-2dnpLQWzvOz1TRw%3D","avatar":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/6730893/45f72094d4704e4ebc38656dc63a91e3/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=NjIGYFK6C8zd6-nfelA2hysljSu-2dnpLQWzvOz1TRw%3D","is_nsfw":false,"summary":null,"post_count":14,"creator_name":"MrTini23","patron_count":null,"creation_name":"Retro Football Manager Content Creator","primary_theme_color":"35236"},{"id":"3634516","url":"https://www.patreon.com/cfemen","name":"cfemen","thumb":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/d98be5b6694e45c58ba758d186b5a0b1/eyJ3IjoyNDB9/1.jpg?token-time=2145916800&token-hash=Ohlsjl91t-EeaBRJyM0CbV3Z81ried7BEwlqQ5xYgOw%3D","avatar":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/d98be5b6694e45c58ba758d186b5a0b1/eyJ3IjoyNDB9/1.jpg?token-time=2145916800&token-hash=Ohlsjl91t-EeaBRJyM0CbV3Z81ried7BEwlqQ5xYgOw%3D","is_nsfw":false,"summary":null,"post_count":1,"creator_name":"cfemen","patron_count":10465,"creation_name":"Game Content Creator","primary_theme_color":"36491"},{"id":"10175206","url":"https://www.patreon.com/JoshDaly","name":"JoshDaly","thumb":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/10175206/e0ce470692e845af8cf5671d2612cb6a/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=sMkJSJgskUydmu0ZZ73OrpoOHo2PYwfEPQvjU9ClJ54%3D","avatar":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/10175206/e0ce470692e845af8cf5671d2612cb6a/eyJ3IjoyNDB9/3.jpg?token-time=2145916800&token-hash=sMkJSJgskUydmu0ZZ73OrpoOHo2PYwfEPQvjU9ClJ54%3D","is_nsfw":false,"summary":null,"post_count":1379,"creator_name":"JoshDaly","patron_count":9052,"creation_name":"Youtube Content Creator ","primary_theme_color":"419450"}],"pagination":{"next":"https://www.patreon.com/api/search?query=creator&page%5Bnumber%5D=3","page":2,"prev":"https://www.patreon.com/api/search?query=creator&page%5Bnumber%5D=1","hits_total":66,"pages_total":4,"has_next_page":true,"has_prev_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/patreon/profile/info":{"get":{"summary":"Patreon Profile Info","description":"Retrieve a Patreon creator profile with patron counts, membership tiers, campaign summary, and creator metadata.\n\n**Credit cost:** 1 credit per call","operationId":"get-patreon-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Patreon profile URL or creator vanity name.\n\n**Example 1 (URL):**\n\n    https://www.patreon.com/example-user\n\n**Example 2 (vanity name):**\n\n    example-user\n\n**Notes:**\n- Returns campaign metadata, membership tiers, patron counts, and creator details.","schema":{"type":"string","description":"Patreon profile URL or creator vanity name.\n\n**Example 1 (URL):**\n\n    https://www.patreon.com/example-user\n\n**Example 2 (vanity name):**\n\n    example-user\n\n**Notes:**\n- Returns campaign metadata, membership tiers, patron counts, and creator details."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"cover":{"type":"string"},"avatar":{"type":"string"},"creator":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"about":{"nullable":true},"avatar":{"type":"string"},"full_name":{"type":"string"},"social_connections":{"nullable":true}}},"is_nsfw":{"type":"boolean"},"rewards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"nullable":true},"title":{"nullable":true},"published":{"nullable":true},"description":{"type":"string"},"amount_cents":{"type":"integer"},"patron_count":{"nullable":true}}}},"summary":{"type":"string"},"currency":{"type":"string"},"one_liner":{"nullable":true},"created_at":{"type":"string"},"is_monthly":{"type":"boolean"},"patron_count":{"type":"integer"},"published_at":{"type":"string"},"creation_name":{"type":"string"},"creation_count":{"type":"integer"},"paid_member_count":{"type":"integer"}}},"examples":{"Creator profile (example-user)":{"value":{"id":"3634516","url":"https://www.patreon.com/example-user","name":"example-user","cover":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/05abe7b533cd49ce8f90861640dbf103/eyJ3IjoxOTIwLCJ3ZSI6MX0%3D/1.png?token-hash=OCk-mHrSLXw3-sfqTDL8wo6qUmWkZFRXt8e-tuhBd1w%3D&token-time=1783123200","avatar":"https://c10.patreonusercontent.com/placeholder/example-user.jpg","creator":{"id":"28139295","url":"https://www.patreon.com/example-user","about":null,"avatar":"https://c10.patreonusercontent.com/placeholder/example-user.jpg","full_name":"Alex Martin","social_connections":null},"is_nsfw":false,"rewards":[{"id":"-1","url":null,"title":null,"published":null,"description":"Everyone","amount_cents":0,"patron_count":null},{"id":"10560365","url":"https://www.patreon.com/checkout/example-user?rid=10560365","title":"Free","published":true,"description":"","amount_cents":0,"patron_count":null},{"id":"4315392","url":"https://www.patreon.com/checkout/example-user?rid=4315392","title":"Supporter","published":true,"description":"<ul><li><p style=\"\">Patron-only posts and messages</p></li><li><p style=\"\">Get all already-made patreon content ( attached to the Patreon posts )</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p></li></ul>","amount_cents":200,"patron_count":null},{"id":"4315390","url":"https://www.patreon.com/checkout/example-user?rid=4315390","title":"Support Lvl. 2","published":true,"description":"<p style=\"\"> </p><ul><li><p style=\"\">\"Coop\" features, you wanna use Mods together with your buddy and need to auth. him? let me know and he will get a free auth.</p></li><li><p style=\"\">Current Exclusive HD2 content</p></li><li><p style=\"\">Request a update for content that is not working anymore</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p></li></ul>","amount_cents":500,"patron_count":null},{"id":"4315391","url":"https://www.patreon.com/checkout/example-user?rid=4315391","title":"Support Lvl. 3","published":true,"description":"<p style=\"\">  </p><ul><li><p style=\"\">\"Coop\" features, you wanna use Mods together with your buddy and need to auth. him? let me know and he will get a free auth.</p></li><li><p style=\"\">Current Exclusive HD2 content</p></li><li><p style=\"\">Requesting updates for content that is no longer updated.</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p></li></ul>","amount_cents":1000,"patron_count":null},{"id":"4315480","url":"https://www.patreon.com/checkout/example-user?rid=4315480","title":"God-Like Supporter","published":true,"description":"<ul><li><p style=\"\">\"Coop\" features, you wanna use Mods together with your buddy and need to auth. him? let me know and he will get a free auth.</p></li><li><p style=\"\">Current Exclusive HD2 content</p></li><li><p style=\"\">Requesting updates for content that is no longer updated.</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p><p style=\"\"></p></li></ul>","amount_cents":1500,"patron_count":null},{"id":"24890070","url":"https://www.patreon.com/checkout/example-user?rid=24890070","title":"Gir","published":true,"description":"<ul><li><p style=\"\">Everything from all the previous tiers + you are awesome if you choose that to support me!</p></li><li><p style=\"\">Custom role on the discord ( forever )</p></li></ul>","amount_cents":5000,"patron_count":null},{"id":"25911340","url":"https://www.patreon.com/checkout/example-user?rid=25911340","title":"Aegis","published":true,"description":"<ul><li><p style=\"\">Everything from all the previous tiers + you are awesome if you choose that to support me!</p></li><li><p style=\"\">Custom role on the discord ( forever )</p></li><li><p style=\"\">Longterm Role  &amp; Access ( forever )</p><p style=\"\"></p></li></ul>","amount_cents":6900,"patron_count":null}],"summary":"<p style=\"\">Hi!</p><p style=\"\">Welcome to my patreon page, im creating free content at Fearless-Revolution <a href=\"https://fearlessrevolution.com/memberlist.php?mode=viewprofile&amp;u=27276\" rel=\"noopener noreferrer nofollow\">https://fearlessrevolution.com/memberlist.php?mode...</a></p><p style=\"\"></p><p style=\"\">Maybe if you like my work and want to help me, i would be very happy to get some support :)</p><p style=\"\">Mainly I will use this money to buy new games to have the possibility to make more content for just released games.</p><p style=\"\">Im not sure about patreon rewards for now, but I will offer something if I have enough patreons! (probably requests for singeplayer games or early access to tables)</p><p style=\"\"></p><p style=\"\">Note: I will always do free content, but I made so much content over the years, its impossible for me to update them all :/ coz this I will probably only update content if its an Patreon request! (text is work in progress)</p>","currency":"USD","one_liner":null,"created_at":"2019-12-14T20:49:52.000+00:00","is_monthly":true,"patron_count":10844,"published_at":"2019-12-14T21:06:30.000+00:00","creation_name":"Game Content Creator","creation_count":1,"paid_member_count":3209}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Patreon Profile Info","description":"Retrieve a Patreon creator profile with patron counts, membership tiers, campaign summary, and creator metadata.\n\n**Credit cost:** 1 credit per call","operationId":"post-patreon-profile-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Patreon profile URL or creator vanity name.\n\n**Example 1 (URL):**\n\n    https://www.patreon.com/example-user\n\n**Example 2 (vanity name):**\n\n    example-user\n\n**Notes:**\n- Returns campaign metadata, membership tiers, patron counts, and creator details.","schema":{"type":"string","description":"Patreon profile URL or creator vanity name.\n\n**Example 1 (URL):**\n\n    https://www.patreon.com/example-user\n\n**Example 2 (vanity name):**\n\n    example-user\n\n**Notes:**\n- Returns campaign metadata, membership tiers, patron counts, and creator details."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"cover":{"type":"string"},"avatar":{"type":"string"},"creator":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"about":{"nullable":true},"avatar":{"type":"string"},"full_name":{"type":"string"},"social_connections":{"nullable":true}}},"is_nsfw":{"type":"boolean"},"rewards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"nullable":true},"title":{"nullable":true},"published":{"nullable":true},"description":{"type":"string"},"amount_cents":{"type":"integer"},"patron_count":{"nullable":true}}}},"summary":{"type":"string"},"currency":{"type":"string"},"one_liner":{"nullable":true},"created_at":{"type":"string"},"is_monthly":{"type":"boolean"},"patron_count":{"type":"integer"},"published_at":{"type":"string"},"creation_name":{"type":"string"},"creation_count":{"type":"integer"},"paid_member_count":{"type":"integer"}}},"examples":{"Creator profile (example-user)":{"value":{"id":"3634516","url":"https://www.patreon.com/example-user","name":"example-user","cover":"https://c10.patreonusercontent.com/4/patreon-media/p/campaign/3634516/05abe7b533cd49ce8f90861640dbf103/eyJ3IjoxOTIwLCJ3ZSI6MX0%3D/1.png?token-hash=OCk-mHrSLXw3-sfqTDL8wo6qUmWkZFRXt8e-tuhBd1w%3D&token-time=1783123200","avatar":"https://c10.patreonusercontent.com/placeholder/example-user.jpg","creator":{"id":"28139295","url":"https://www.patreon.com/example-user","about":null,"avatar":"https://c10.patreonusercontent.com/placeholder/example-user.jpg","full_name":"Alex Martin","social_connections":null},"is_nsfw":false,"rewards":[{"id":"-1","url":null,"title":null,"published":null,"description":"Everyone","amount_cents":0,"patron_count":null},{"id":"10560365","url":"https://www.patreon.com/checkout/example-user?rid=10560365","title":"Free","published":true,"description":"","amount_cents":0,"patron_count":null},{"id":"4315392","url":"https://www.patreon.com/checkout/example-user?rid=4315392","title":"Supporter","published":true,"description":"<ul><li><p style=\"\">Patron-only posts and messages</p></li><li><p style=\"\">Get all already-made patreon content ( attached to the Patreon posts )</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p></li></ul>","amount_cents":200,"patron_count":null},{"id":"4315390","url":"https://www.patreon.com/checkout/example-user?rid=4315390","title":"Support Lvl. 2","published":true,"description":"<p style=\"\"> </p><ul><li><p style=\"\">\"Coop\" features, you wanna use Mods together with your buddy and need to auth. him? let me know and he will get a free auth.</p></li><li><p style=\"\">Current Exclusive HD2 content</p></li><li><p style=\"\">Request a update for content that is not working anymore</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p></li></ul>","amount_cents":500,"patron_count":null},{"id":"4315391","url":"https://www.patreon.com/checkout/example-user?rid=4315391","title":"Support Lvl. 3","published":true,"description":"<p style=\"\">  </p><ul><li><p style=\"\">\"Coop\" features, you wanna use Mods together with your buddy and need to auth. him? let me know and he will get a free auth.</p></li><li><p style=\"\">Current Exclusive HD2 content</p></li><li><p style=\"\">Requesting updates for content that is no longer updated.</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p></li></ul>","amount_cents":1000,"patron_count":null},{"id":"4315480","url":"https://www.patreon.com/checkout/example-user?rid=4315480","title":"God-Like Supporter","published":true,"description":"<ul><li><p style=\"\">\"Coop\" features, you wanna use Mods together with your buddy and need to auth. him? let me know and he will get a free auth.</p></li><li><p style=\"\">Current Exclusive HD2 content</p></li><li><p style=\"\">Requesting updates for content that is no longer updated.</p></li><li><p style=\"\">Thank you for the support!</p></li><li><p style=\"\">Write me a patreon message if you have any kind of problem, so I can assist!</p><p style=\"\"></p></li></ul>","amount_cents":1500,"patron_count":null},{"id":"24890070","url":"https://www.patreon.com/checkout/example-user?rid=24890070","title":"Gir","published":true,"description":"<ul><li><p style=\"\">Everything from all the previous tiers + you are awesome if you choose that to support me!</p></li><li><p style=\"\">Custom role on the discord ( forever )</p></li></ul>","amount_cents":5000,"patron_count":null},{"id":"25911340","url":"https://www.patreon.com/checkout/example-user?rid=25911340","title":"Aegis","published":true,"description":"<ul><li><p style=\"\">Everything from all the previous tiers + you are awesome if you choose that to support me!</p></li><li><p style=\"\">Custom role on the discord ( forever )</p></li><li><p style=\"\">Longterm Role  &amp; Access ( forever )</p><p style=\"\"></p></li></ul>","amount_cents":6900,"patron_count":null}],"summary":"<p style=\"\">Hi!</p><p style=\"\">Welcome to my patreon page, im creating free content at Fearless-Revolution <a href=\"https://fearlessrevolution.com/memberlist.php?mode=viewprofile&amp;u=27276\" rel=\"noopener noreferrer nofollow\">https://fearlessrevolution.com/memberlist.php?mode...</a></p><p style=\"\"></p><p style=\"\">Maybe if you like my work and want to help me, i would be very happy to get some support :)</p><p style=\"\">Mainly I will use this money to buy new games to have the possibility to make more content for just released games.</p><p style=\"\">Im not sure about patreon rewards for now, but I will offer something if I have enough patreons! (probably requests for singeplayer games or early access to tables)</p><p style=\"\"></p><p style=\"\">Note: I will always do free content, but I made so much content over the years, its impossible for me to update them all :/ coz this I will probably only update content if its an Patreon request! (text is work in progress)</p>","currency":"USD","one_liner":null,"created_at":"2019-12-14T20:49:52.000+00:00","is_monthly":true,"patron_count":10844,"published_at":"2019-12-14T21:06:30.000+00:00","creation_name":"Game Content Creator","creation_count":1,"paid_member_count":3209}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/newegg/search":{"get":{"summary":"Newegg Search","description":"Search Newegg by keyword or search URL. Returns item numbers, dollar prices, stock, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-newegg-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a newegg.com search URL.\n\nExamples:\n\n```\nlogitech keyboard\n```\n\n```\nhttps://www.newegg.com/p/pl?d=logitech+keyboard\n```","schema":{"type":"string","description":"Keyword or a newegg.com search URL.\n\nExamples:\n\n```\nlogitech keyboard\n```\n\n```\nhttps://www.newegg.com/p/pl?d=logitech+keyboard\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Example: 2.","schema":{"type":"number","description":"Page number, starting at 1. Example: 2."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"product_id":{"type":"string"},"item_number":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"keyword":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Newegg search for logitech keyboard":{"value":{"results":[{"url":"https://www.newegg.com/logitech-mk320-920-002836-usb-rf-wireless/p/N82E16823126188","brand":"Logitech","price":36.99,"title":"Logitech MK320 Wireless Desktop Keyboard and Mouse Combo","rating":3.7,"currency":"USD","in_stock":true,"product_id":"N82E16823126188","item_number":"23-126-188","review_count":289,"price_display":"$36.99"}],"pagination":{"next":"https://www.newegg.com/p/pl?d=logitech+keyboard&page=2","page":1,"keyword":"logitech keyboard","per_page":44,"total_pages":20,"total_results":1529}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Newegg Search","description":"Search Newegg by keyword or search URL. Returns item numbers, dollar prices, stock, and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-newegg-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a newegg.com search URL.\n\nExamples:\n\n```\nlogitech keyboard\n```\n\n```\nhttps://www.newegg.com/p/pl?d=logitech+keyboard\n```","schema":{"type":"string","description":"Keyword or a newegg.com search URL.\n\nExamples:\n\n```\nlogitech keyboard\n```\n\n```\nhttps://www.newegg.com/p/pl?d=logitech+keyboard\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, starting at 1. Example: 2.","schema":{"type":"number","description":"Page number, starting at 1. Example: 2."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"product_id":{"type":"string"},"item_number":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"keyword":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Newegg search for logitech keyboard":{"value":{"results":[{"url":"https://www.newegg.com/logitech-mk320-920-002836-usb-rf-wireless/p/N82E16823126188","brand":"Logitech","price":36.99,"title":"Logitech MK320 Wireless Desktop Keyboard and Mouse Combo","rating":3.7,"currency":"USD","in_stock":true,"product_id":"N82E16823126188","item_number":"23-126-188","review_count":289,"price_display":"$36.99"}],"pagination":{"next":"https://www.newegg.com/p/pl?d=logitech+keyboard&page=2","page":1,"keyword":"logitech keyboard","per_page":44,"total_pages":20,"total_results":1529}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/newegg/product":{"get":{"summary":"Newegg Product","description":"Read a Newegg product from an item number, catalog id, or URL. Returns price, specs, images, and seller.\n\n**Credit cost:** 2 credits per call","operationId":"get-newegg-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Item number, catalog id, or product URL.\n\nExample:\n\n```\nN82E16823126188\n```","schema":{"type":"string","description":"Item number, catalog id, or product URL.\n\nExample:\n\n```\nN82E16823126188\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"product_id":{"type":"string"},"item_number":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Logitech MK320 on Newegg":{"value":{"url":"https://www.newegg.com/logitech-mk320-920-002836-usb-rf-wireless/p/N82E16823126188","brand":"Logitech","price":32.99,"title":"Logitech MK320 Wireless Desktop Keyboard and Mouse Combo","currency":"USD","in_stock":true,"product_id":"N82E16823126188","item_number":"9SIA1CZEDK9378","price_display":"$32.99"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Newegg Product","description":"Read a Newegg product from an item number, catalog id, or URL. Returns price, specs, images, and seller.\n\n**Credit cost:** 2 credits per call","operationId":"post-newegg-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Item number, catalog id, or product URL.\n\nExample:\n\n```\nN82E16823126188\n```","schema":{"type":"string","description":"Item number, catalog id, or product URL.\n\nExample:\n\n```\nN82E16823126188\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw HTML. The string false stays false.","schema":{"type":"boolean","description":"When true, return the raw HTML. The string false stays false."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"product_id":{"type":"string"},"item_number":{"type":"string"},"price_display":{"type":"string"}}},"examples":{"Logitech MK320 on Newegg":{"value":{"url":"https://www.newegg.com/logitech-mk320-920-002836-usb-rf-wireless/p/N82E16823126188","brand":"Logitech","price":32.99,"title":"Logitech MK320 Wireless Desktop Keyboard and Mouse Combo","currency":"USD","in_stock":true,"product_id":"N82E16823126188","item_number":"9SIA1CZEDK9378","price_display":"$32.99"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/lidl/search":{"get":{"summary":"Lidl Search","description":"Lidl Search API: search product listings by keyword or URL across Lidl online shops in 27 countries. Parses Nuxt SSR payload from HTML; returns prices, ratings, brand and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-lidl-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Lidl search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.lidl.de/q/search?q=bohrer\n```\n\nUse **Lidl Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full Lidl search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.lidl.de/q/search?q=bohrer\n```\n\nUse **Lidl Product** on any result `url` or `product_id` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is a keyword (default: `fr`).\n\n**Examples:** `de`, `pl`, `gb`, `nl-be`, `fr-be`\n\nIgnored when `query` is a full Lidl URL.","schema":{"type":"string","description":"Target country when `query` is a keyword (default: `fr`).\n\n**Examples:** `de`, `pl`, `gb`, `nl-be`, `fr-be`\n\nIgnored when `query` is a full Lidl URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number (default: 1). Lidl paginates by offset (`48` items per page).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (default: 1). Lidl paginates by offset (`48` items per page)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"locale":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"discount_percentage":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'perceuse' on lidl.fr (page 1)":{"value":{"results":[{"url":"https://www.lidl.fr/p/parkside-set-perceuse-a-percussion-psbm-750-c3/p100400894","brand":"PARKSIDE®","price":20,"title":"PARKSIDE® Set perceuse à percussion PSBM 750 C3","locale":"fr-fr","rating":4,"currency":"EUR","image_url":"https://www.lidl.fr/assets/gcp941ea783e919400f859ed3e1193f144f.jpg","old_price":51.99,"product_id":"100400894","review_count":26,"discount_percentage":61}],"pagination":{"next":"https://www.lidl.fr/q/search?q=perceuse&offset=48&fetchsize=48","page":1,"per_page":48,"total_pages":4,"total_results":147}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Lidl Search","description":"Lidl Search API: search product listings by keyword or URL across Lidl online shops in 27 countries. Parses Nuxt SSR payload from HTML; returns prices, ratings, brand and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-lidl-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Lidl search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.lidl.de/q/search?q=bohrer\n```\n\nUse **Lidl Product** on any result `url` or `product_id` for full PDP data.","schema":{"type":"string","description":"Search keyword or full Lidl search URL.\n\n**Examples:**\n\n```\nperceuse\n```\n\n```\nhttps://www.lidl.de/q/search?q=bohrer\n```\n\nUse **Lidl Product** on any result `url` or `product_id` for full PDP data."}},{"name":"region","in":"query","required":false,"description":"Target country when `query` is a keyword (default: `fr`).\n\n**Examples:** `de`, `pl`, `gb`, `nl-be`, `fr-be`\n\nIgnored when `query` is a full Lidl URL.","schema":{"type":"string","description":"Target country when `query` is a keyword (default: `fr`).\n\n**Examples:** `de`, `pl`, `gb`, `nl-be`, `fr-be`\n\nIgnored when `query` is a full Lidl URL."}},{"name":"page","in":"query","required":false,"description":"1-based page number (default: 1). Lidl paginates by offset (`48` items per page).","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (default: 1). Lidl paginates by offset (`48` items per page)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"locale":{"type":"string"},"rating":{"type":"integer"},"currency":{"type":"string"},"image_url":{"type":"string"},"old_price":{"type":"number"},"product_id":{"type":"string"},"review_count":{"type":"integer"},"discount_percentage":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'perceuse' on lidl.fr (page 1)":{"value":{"results":[{"url":"https://www.lidl.fr/p/parkside-set-perceuse-a-percussion-psbm-750-c3/p100400894","brand":"PARKSIDE®","price":20,"title":"PARKSIDE® Set perceuse à percussion PSBM 750 C3","locale":"fr-fr","rating":4,"currency":"EUR","image_url":"https://www.lidl.fr/assets/gcp941ea783e919400f859ed3e1193f144f.jpg","old_price":51.99,"product_id":"100400894","review_count":26,"discount_percentage":61}],"pagination":{"next":"https://www.lidl.fr/q/search?q=perceuse&offset=48&fetchsize=48","page":1,"per_page":48,"total_pages":4,"total_results":147}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/kroger/search":{"get":{"summary":"Kroger Search","description":"Search Kroger groceries by keyword and page the results. Prices come from the default pickup store returned in the response. A location id you pass is not applied.\n\n**Credit cost:** 2 credits per call","operationId":"get-kroger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a full Kroger search URL.\n\n**Examples:**\n\n```\nmilk\n```\n\n```\nhttps://www.kroger.com/search?query=milk&searchType=default_search\n```","schema":{"type":"string","description":"Keyword or a full Kroger search URL.\n\n**Examples:**\n\n```\nmilk\n```\n\n```\nhttps://www.kroger.com/search?query=milk&searchType=default_search\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, 1-based.","schema":{"type":"number","description":"Page number, 1-based."}},{"name":"location_id","in":"query","required":false,"description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced.","schema":{"type":"string","description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When true, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"size":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"sponsored":{"type":"boolean"},"was_price":{"nullable":true},"store_name":{"type":"string"},"location_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Whole milk gallon":{"value":{"results":[{"id":"0001111040101","url":"https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101","size":"1 gal","brand":"Kroger","image":"https://www.kroger.com/product/images/large/front/0001111040101","price":3.19,"title":"Kroger® Vitamin D Whole Milk Gallon","rating":2.85,"currency":"USD","sponsored":false,"was_price":null,"store_name":"Rolla","location_id":"02100537","review_count":102,"price_display":"$3.19","unit_price_display":"$0.02/fl oz"}],"pagination":{"next":"https://www.kroger.com/search?query=milk&searchType=default_search&page=2","page":1,"per_page":27,"total_pages":6,"total_results":161}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Kroger Search","description":"Search Kroger groceries by keyword and page the results. Prices come from the default pickup store returned in the response. A location id you pass is not applied.\n\n**Credit cost:** 2 credits per call","operationId":"post-kroger-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or a full Kroger search URL.\n\n**Examples:**\n\n```\nmilk\n```\n\n```\nhttps://www.kroger.com/search?query=milk&searchType=default_search\n```","schema":{"type":"string","description":"Keyword or a full Kroger search URL.\n\n**Examples:**\n\n```\nmilk\n```\n\n```\nhttps://www.kroger.com/search?query=milk&searchType=default_search\n```"}},{"name":"page","in":"query","required":false,"description":"Page number, 1-based.","schema":{"type":"number","description":"Page number, 1-based."}},{"name":"location_id","in":"query","required":false,"description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced.","schema":{"type":"string","description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When true, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"size":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"sponsored":{"type":"boolean"},"was_price":{"nullable":true},"store_name":{"type":"string"},"location_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"unit_price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Whole milk gallon":{"value":{"results":[{"id":"0001111040101","url":"https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101","size":"1 gal","brand":"Kroger","image":"https://www.kroger.com/product/images/large/front/0001111040101","price":3.19,"title":"Kroger® Vitamin D Whole Milk Gallon","rating":2.85,"currency":"USD","sponsored":false,"was_price":null,"store_name":"Rolla","location_id":"02100537","review_count":102,"price_display":"$3.19","unit_price_display":"$0.02/fl oz"}],"pagination":{"next":"https://www.kroger.com/search?query=milk&searchType=default_search&page=2","page":1,"per_page":27,"total_pages":6,"total_results":161}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/kroger/product":{"get":{"summary":"Kroger Product","description":"Read one Kroger product by UPC. The sheet uses the same default store as search. You get the shelf price and the previous price when Kroger shows one.\n\n**Credit cost:** 2 credits per call","operationId":"get-kroger-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Kroger product URL or UPC.\n\n**Examples:**\n\n```\n0001111040101\n```\n\n```\nhttps://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101\n```","schema":{"type":"string","description":"Kroger product URL or UPC.\n\n**Examples:**\n\n```\n0001111040101\n```\n\n```\nhttps://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101\n```"}},{"name":"location_id","in":"query","required":false,"description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced.","schema":{"type":"string","description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When true, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"size":{"type":"string"},"aisle":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"was_price":{"nullable":true},"store_name":{"type":"string"},"description":{"type":"string"},"location_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"store_address":{"type":"string"},"unit_price_display":{"type":"string"}}},"examples":{"Whole milk gallon":{"value":{"id":"0001111040101","url":"https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101","size":"1 gal","aisle":"DAIRY 100","brand":"Kroger","image":"https://www.kroger.com/product/images/large/front/0001111040101","price":3.19,"title":"Kroger® Vitamin D Whole Milk Gallon","rating":2.85,"currency":"USD","in_stock":true,"was_price":null,"store_name":"Rolla","description":"Kroger® Vitamin D Whole Milk Gallon is full of refreshing goodness. Enriched with Vitamin D to brighten your day and strengthen your bones. A healthier alternative for your breakfast without compromising on flavor. Kroger® – Trusted for the everyday moments that matter. 1 gal Jug of Kroger® Vitamin D Whole Milk Gallon Gives you Vitamin D for bone health Perfect for breakfast or baking A great addition to coffee Kroger® quality you can trust","location_id":"02100537","review_count":102,"price_display":"$3.19","store_address":"605 W 4Th St, Rolla, MO 65401","unit_price_display":"$0.02/fl oz"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Kroger Product","description":"Read one Kroger product by UPC. The sheet uses the same default store as search. You get the shelf price and the previous price when Kroger shows one.\n\n**Credit cost:** 2 credits per call","operationId":"post-kroger-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Kroger product URL or UPC.\n\n**Examples:**\n\n```\n0001111040101\n```\n\n```\nhttps://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101\n```","schema":{"type":"string","description":"Kroger product URL or UPC.\n\n**Examples:**\n\n```\n0001111040101\n```\n\n```\nhttps://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101\n```"}},{"name":"location_id","in":"query","required":false,"description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced.","schema":{"type":"string","description":"Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return rendered HTML instead of JSON.","schema":{"type":"boolean","description":"When true, return rendered HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"size":{"type":"string"},"aisle":{"type":"string"},"brand":{"type":"string"},"image":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"rating":{"type":"number"},"currency":{"type":"string"},"in_stock":{"type":"boolean"},"was_price":{"nullable":true},"store_name":{"type":"string"},"description":{"type":"string"},"location_id":{"type":"string"},"review_count":{"type":"integer"},"price_display":{"type":"string"},"store_address":{"type":"string"},"unit_price_display":{"type":"string"}}},"examples":{"Whole milk gallon":{"value":{"id":"0001111040101","url":"https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101","size":"1 gal","aisle":"DAIRY 100","brand":"Kroger","image":"https://www.kroger.com/product/images/large/front/0001111040101","price":3.19,"title":"Kroger® Vitamin D Whole Milk Gallon","rating":2.85,"currency":"USD","in_stock":true,"was_price":null,"store_name":"Rolla","description":"Kroger® Vitamin D Whole Milk Gallon is full of refreshing goodness. Enriched with Vitamin D to brighten your day and strengthen your bones. A healthier alternative for your breakfast without compromising on flavor. Kroger® – Trusted for the everyday moments that matter. 1 gal Jug of Kroger® Vitamin D Whole Milk Gallon Gives you Vitamin D for bone health Perfect for breakfast or baking A great addition to coffee Kroger® quality you can trust","location_id":"02100537","review_count":102,"price_display":"$3.19","store_address":"605 W 4Th St, Rolla, MO 65401","unit_price_display":"$0.02/fl oz"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/kijiji/search":{"get":{"summary":"Kijiji Search","description":"Search Kijiji with a results URL or a city and category. Language can be English or French. Page through classified ads.\n\n**Credit cost:** 1 credit per call","operationId":"get-kijiji-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Kijiji results URL.\n\nA keyword searches Canada. A city or category URL is fetched as given.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/b-bikes/city-of-toronto/c644l1700273\n```\n\n```\nhttps://www.kijiji.ca/b-velos/ville-de-toronto/c644l1700273\n```\n\n```\nbike\n```","schema":{"type":"string","description":"Keyword or full Kijiji results URL.\n\nA keyword searches Canada. A city or category URL is fetched as given.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/b-bikes/city-of-toronto/c644l1700273\n```\n\n```\nhttps://www.kijiji.ca/b-velos/ville-de-toronto/c644l1700273\n```\n\n```\nbike\n```"}},{"name":"page","in":"query","required":false,"description":"Results page, starting at 1. Page 2 of the City of Toronto bikes search returns a different set of listing ids. When page stays at 1, a page-N segment already present in the URL is kept.","schema":{"type":"number","description":"Results page, starting at 1. Page 2 of the City of Toronto bikes search returns a different set of listing ids. When page stays at 1, a page-N segment already present in the URL is kept."}},{"name":"language","in":"query","required":false,"description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA. `fr` sets fr-CA. French cards print prices like `10,00 $`.","schema":{"type":"string","default":"en","description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA. `fr` sets fr-CA. French cards print prices like `10,00 $`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"posted_at":{"type":"string"},"description":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"CCM bicycle, City of Toronto":{"value":{"results":[{"id":"1733496971","url":"https://www.kijiji.ca/v-mountain-bike/city-of-toronto/ccm-bicycle-as-is/1733496971","image":"https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/1b/1bfdcc30-19d6-472c-a01d-23161e93f5cc?rule=kijijica-200-jpg","price":35,"title":"CCM bicycle as is","address":"Coneflower Cres, Toronto, M2R 2Y9","currency":"CAD","location":"City of Toronto","posted_at":"2026-02-21T21:26:06.000Z","description":"This is a CCM bicycle with sturdy tires, perfect for urban commutes or leisurely rides. It's in used condition, ready for a new home.","price_display":"$35.00"}],"pagination":{"next":"https://www.kijiji.ca/b-bikes/city-of-toronto/page-2/c644l1700273","page":1,"per_page":40,"total_pages":127,"total_results":5067}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Kijiji Search","description":"Search Kijiji with a results URL or a city and category. Language can be English or French. Page through classified ads.\n\n**Credit cost:** 1 credit per call","operationId":"post-kijiji-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or full Kijiji results URL.\n\nA keyword searches Canada. A city or category URL is fetched as given.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/b-bikes/city-of-toronto/c644l1700273\n```\n\n```\nhttps://www.kijiji.ca/b-velos/ville-de-toronto/c644l1700273\n```\n\n```\nbike\n```","schema":{"type":"string","description":"Keyword or full Kijiji results URL.\n\nA keyword searches Canada. A city or category URL is fetched as given.\n\n**Examples:**\n\n```\nhttps://www.kijiji.ca/b-bikes/city-of-toronto/c644l1700273\n```\n\n```\nhttps://www.kijiji.ca/b-velos/ville-de-toronto/c644l1700273\n```\n\n```\nbike\n```"}},{"name":"page","in":"query","required":false,"description":"Results page, starting at 1. Page 2 of the City of Toronto bikes search returns a different set of listing ids. When page stays at 1, a page-N segment already present in the URL is kept.","schema":{"type":"number","description":"Results page, starting at 1. Page 2 of the City of Toronto bikes search returns a different set of listing ids. When page stays at 1, a page-N segment already present in the URL is kept."}},{"name":"language","in":"query","required":false,"description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA. `fr` sets fr-CA. French cards print prices like `10,00 $`.","schema":{"type":"string","default":"en","description":"Locale sent to Kijiji as the siteLocale cookie. `en` sets en-CA. `fr` sets fr-CA. French cards print prices like `10,00 $`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"address":{"type":"string"},"currency":{"type":"string"},"location":{"type":"string"},"posted_at":{"type":"string"},"description":{"type":"string"},"price_display":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"CCM bicycle, City of Toronto":{"value":{"results":[{"id":"1733496971","url":"https://www.kijiji.ca/v-mountain-bike/city-of-toronto/ccm-bicycle-as-is/1733496971","image":"https://media.kijiji.ca/api/v1/ca-prod-fsbo-ads/images/1b/1bfdcc30-19d6-472c-a01d-23161e93f5cc?rule=kijijica-200-jpg","price":35,"title":"CCM bicycle as is","address":"Coneflower Cres, Toronto, M2R 2Y9","currency":"CAD","location":"City of Toronto","posted_at":"2026-02-21T21:26:06.000Z","description":"This is a CCM bicycle with sturdy tires, perfect for urban commutes or leisurely rides. It's in used condition, ready for a new home.","price_display":"$35.00"}],"pagination":{"next":"https://www.kijiji.ca/b-bikes/city-of-toronto/page-2/c644l1700273","page":1,"per_page":40,"total_pages":127,"total_results":5067}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/indeed/job/search":{"get":{"summary":"Indeed Job Search","description":"Indeed Job Search API. Search fr.indeed.com job listings by keyword or URL. Browser rendering returns cards with salary snippets and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"get-indeed-job-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, Indeed `/jobs` URL or SEO search URL on fr.indeed.com (default domain).\n\n**Examples:**\n\n```\ndeveloppeur python\n```\n\n```\nhttps://fr.indeed.com/jobs?q=developpeur+python&l=Paris\n```\n\nUse `job_key` from results with [Indeed Job Info](https://www.piloterr.com/library/indeed-job-info).","schema":{"type":"string","description":"Keyword, Indeed `/jobs` URL or SEO search URL on fr.indeed.com (default domain).\n\n**Examples:**\n\n```\ndeveloppeur python\n```\n\n```\nhttps://fr.indeed.com/jobs?q=developpeur+python&l=Paris\n```\n\nUse `job_key` from results with [Indeed Job Info](https://www.piloterr.com/library/indeed-job-info)."}},{"name":"page","in":"query","required":false,"description":"1-based page number (10 results per page). Default: `1`.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (10 results per page). Default: `1`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"salary":{"nullable":true},"job_key":{"type":"string"},"location":{"type":"string"},"sponsored":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string"}},"company_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"count":{"type":"integer"},"has_next":{"type":"boolean"},"per_page":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'developpeur python' on fr.indeed.com (page 1)":{"value":{"results":[{"url":"https://fr.indeed.com/viewjob?jk=3d8672f2a39f7104","title":"Développeur éditique - Confirmé (H/F)","salary":null,"job_key":"3d8672f2a39f7104","location":"Montreuil (93)","sponsored":true,"attributes":["CDI"],"company_name":"GROUPE VILAVI"},{"url":"https://fr.indeed.com/viewjob?jk=2c4fb3fb8fcafad3","title":"Business Développeur BtoB – Transition Énergétique (H/F/X)","salary":{"text":"36 000 € par an"},"job_key":"2c4fb3fb8fcafad3","location":"Télétravail partiel à 75017 Paris 17e","sponsored":true,"attributes":["Temps plein + 1"],"company_name":"JOVYN"}],"pagination":{"next":null,"page":1,"count":15,"has_next":false,"per_page":10,"total_results":1264}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Indeed Job Search","description":"Indeed Job Search API. Search fr.indeed.com job listings by keyword or URL. Browser rendering returns cards with salary snippets and pagination.\n\n**Credit cost:** 2 credits per call","operationId":"post-indeed-job-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword, Indeed `/jobs` URL or SEO search URL on fr.indeed.com (default domain).\n\n**Examples:**\n\n```\ndeveloppeur python\n```\n\n```\nhttps://fr.indeed.com/jobs?q=developpeur+python&l=Paris\n```\n\nUse `job_key` from results with [Indeed Job Info](https://www.piloterr.com/library/indeed-job-info).","schema":{"type":"string","description":"Keyword, Indeed `/jobs` URL or SEO search URL on fr.indeed.com (default domain).\n\n**Examples:**\n\n```\ndeveloppeur python\n```\n\n```\nhttps://fr.indeed.com/jobs?q=developpeur+python&l=Paris\n```\n\nUse `job_key` from results with [Indeed Job Info](https://www.piloterr.com/library/indeed-job-info)."}},{"name":"page","in":"query","required":false,"description":"1-based page number (10 results per page). Default: `1`.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (10 results per page). Default: `1`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"salary":{"nullable":true},"job_key":{"type":"string"},"location":{"type":"string"},"sponsored":{"type":"boolean"},"attributes":{"type":"array","items":{"type":"string"}},"company_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"count":{"type":"integer"},"has_next":{"type":"boolean"},"per_page":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'developpeur python' on fr.indeed.com (page 1)":{"value":{"results":[{"url":"https://fr.indeed.com/viewjob?jk=3d8672f2a39f7104","title":"Développeur éditique - Confirmé (H/F)","salary":null,"job_key":"3d8672f2a39f7104","location":"Montreuil (93)","sponsored":true,"attributes":["CDI"],"company_name":"GROUPE VILAVI"},{"url":"https://fr.indeed.com/viewjob?jk=2c4fb3fb8fcafad3","title":"Business Développeur BtoB – Transition Énergétique (H/F/X)","salary":{"text":"36 000 € par an"},"job_key":"2c4fb3fb8fcafad3","location":"Télétravail partiel à 75017 Paris 17e","sponsored":true,"attributes":["Temps plein + 1"],"company_name":"JOVYN"}],"pagination":{"next":null,"page":1,"count":15,"has_next":false,"per_page":10,"total_results":1264}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/indeed/job/info":{"get":{"summary":"Indeed Job Info","description":"Indeed Job Info API. Fetch a full job posting by viewjob URL, sponsored click URL or job key. Browser rendering returns description and structured salary.\n\n**Credit cost:** 2 credits per call","operationId":"get-indeed-job-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Indeed job URL, sponsored SERP click URL or 16-char `jk` job key.\n\n**Examples:**\n\n```\n585181841cb618e0\n```\n\n```\nhttps://fr.indeed.com/viewjob?jk=585181841cb618e0\n```\n\nBare `jk` values resolve on **fr.indeed.com**.","schema":{"type":"string","description":"Indeed job URL, sponsored SERP click URL or 16-char `jk` job key.\n\n**Examples:**\n\n```\n585181841cb618e0\n```\n\n```\nhttps://fr.indeed.com/viewjob?jk=585181841cb618e0\n```\n\nBare `jk` values resolve on **fr.indeed.com**."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"salary":{"nullable":true},"job_key":{"type":"string"},"benefits":{"nullable":true},"job_type":{"type":"string"},"location":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"remote_work":{"nullable":true},"company_name":{"type":"string"},"posted_today":{"type":"boolean"},"urgently_hiring":{"type":"boolean"},"remote_work_type":{"nullable":true}}},"examples":{"Get Indeed job info for Java developer (jk=585181841cb618e0)":{"value":{"url":"https://fr.indeed.com/viewjob?jk=585181841cb618e0","title":"Ingénieur Développeur Java F/H","salary":null,"job_key":"585181841cb618e0","benefits":null,"job_type":"CDI, Temps plein","location":"Paris (75)","company_url":"https://fr.indeed.com/cmp/Groupe-Intm?campaignid=mobvjcmp&from=mobviewjob&tk=1jsl3p16gjvko800&fromjk=585181841cb618e0","description":"<div>\n <p>Depuis 2004, le Groupe INTM, entreprise de conseil et de services du numérique, accompagne ses clients dans leurs grands <b>projets de transformation</b>, visant à répondre à leurs enjeux stratégiques et opérationnels tout en positionnant<b> la technologie au service de l’entreprise et de l’humain.</b><br>\n   Grâce à la confiance mutuelle entre le Groupe INTM, ses collaborateurs et ses clients, nous connaissons une forte croissance appuyée par des <b>alliances</b> et des référencements…","remote_work":null,"company_name":"INTM","posted_today":false,"urgently_hiring":false,"remote_work_type":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Indeed Job Info","description":"Indeed Job Info API. Fetch a full job posting by viewjob URL, sponsored click URL or job key. Browser rendering returns description and structured salary.\n\n**Credit cost:** 2 credits per call","operationId":"post-indeed-job-info","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Indeed job URL, sponsored SERP click URL or 16-char `jk` job key.\n\n**Examples:**\n\n```\n585181841cb618e0\n```\n\n```\nhttps://fr.indeed.com/viewjob?jk=585181841cb618e0\n```\n\nBare `jk` values resolve on **fr.indeed.com**.","schema":{"type":"string","description":"Indeed job URL, sponsored SERP click URL or 16-char `jk` job key.\n\n**Examples:**\n\n```\n585181841cb618e0\n```\n\n```\nhttps://fr.indeed.com/viewjob?jk=585181841cb618e0\n```\n\nBare `jk` values resolve on **fr.indeed.com**."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"salary":{"nullable":true},"job_key":{"type":"string"},"benefits":{"nullable":true},"job_type":{"type":"string"},"location":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"remote_work":{"nullable":true},"company_name":{"type":"string"},"posted_today":{"type":"boolean"},"urgently_hiring":{"type":"boolean"},"remote_work_type":{"nullable":true}}},"examples":{"Get Indeed job info for Java developer (jk=585181841cb618e0)":{"value":{"url":"https://fr.indeed.com/viewjob?jk=585181841cb618e0","title":"Ingénieur Développeur Java F/H","salary":null,"job_key":"585181841cb618e0","benefits":null,"job_type":"CDI, Temps plein","location":"Paris (75)","company_url":"https://fr.indeed.com/cmp/Groupe-Intm?campaignid=mobvjcmp&from=mobviewjob&tk=1jsl3p16gjvko800&fromjk=585181841cb618e0","description":"<div>\n <p>Depuis 2004, le Groupe INTM, entreprise de conseil et de services du numérique, accompagne ses clients dans leurs grands <b>projets de transformation</b>, visant à répondre à leurs enjeux stratégiques et opérationnels tout en positionnant<b> la technologie au service de l’entreprise et de l’humain.</b><br>\n   Grâce à la confiance mutuelle entre le Groupe INTM, ses collaborateurs et ses clients, nous connaissons une forte croissance appuyée par des <b>alliances</b> et des référencements…","remote_work":null,"company_name":"INTM","posted_today":false,"urgently_hiring":false,"remote_work_type":null}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/indeed/company/search":{"get":{"summary":"Indeed Company Search","description":"Indeed Company Search API. Search fr.indeed.com employer profiles by keyword or URL. Browser rendering returns ratings, industry and profile links.\n\n**Credit cost:** 2 credits per call","operationId":"get-indeed-company-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company keyword or full Indeed companies search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://fr.indeed.com/companies/search?q=airbus\n```\n\nUse `company_url` from results with [Indeed Company Info](https://www.piloterr.com/library/indeed-company-info).","schema":{"type":"string","description":"Company keyword or full Indeed companies search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://fr.indeed.com/companies/search?q=airbus\n```\n\nUse `company_url` from results with [Indeed Company Info](https://www.piloterr.com/library/indeed-company-info)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"rating":{"type":"number"},"industry":{"type":"string"},"jobs_url":{"type":"string"},"logo_url":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"reviews_url":{"type":"string"},"company_name":{"type":"string"},"salaries_url":{"type":"string"},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"count":{"type":"integer"},"has_next":{"type":"boolean"}}}}},"examples":{"Search 'airbus' on fr.indeed.com":{"value":{"results":[{"rating":4.1,"industry":"Aérospatiale et défense","jobs_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1/jobs","logo_url":"https://d2q79iu7y748jz.cloudfront.net/s/_squarelogo/64x64/7316c9e8fcda3af83c7321068c2f3a01","company_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1","description":"We look to recruit, develop, grow and retain the best, and welcome ALL as an equal opportunity employer.","reviews_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1/reviews","company_name":"Airbus","salaries_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1/salaries","reviews_count":2324},{"rating":5,"industry":"ONG et associations à but non lucratif","jobs_url":"https://fr.indeed.com/cmp/Cse-Airbus/jobs","logo_url":null,"company_url":"https://fr.indeed.com/cmp/Cse-Airbus","description":null,"reviews_url":"https://fr.indeed.com/cmp/Cse-Airbus/reviews","company_name":"CSE AIRBUS","salaries_url":"https://fr.indeed.com/cmp/Cse-Airbus/salaries","reviews_count":1}],"pagination":{"next":null,"count":6,"has_next":false}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Indeed Company Search","description":"Indeed Company Search API. Search fr.indeed.com employer profiles by keyword or URL. Browser rendering returns ratings, industry and profile links.\n\n**Credit cost:** 2 credits per call","operationId":"post-indeed-company-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Company keyword or full Indeed companies search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://fr.indeed.com/companies/search?q=airbus\n```\n\nUse `company_url` from results with [Indeed Company Info](https://www.piloterr.com/library/indeed-company-info).","schema":{"type":"string","description":"Company keyword or full Indeed companies search URL.\n\n**Examples:**\n\n```\nairbus\n```\n\n```\nhttps://fr.indeed.com/companies/search?q=airbus\n```\n\nUse `company_url` from results with [Indeed Company Info](https://www.piloterr.com/library/indeed-company-info)."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML as `{\\\"result\\\": \\\"...\\\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"rating":{"type":"number"},"industry":{"type":"string"},"jobs_url":{"type":"string"},"logo_url":{"type":"string"},"company_url":{"type":"string"},"description":{"type":"string"},"reviews_url":{"type":"string"},"company_name":{"type":"string"},"salaries_url":{"type":"string"},"reviews_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"count":{"type":"integer"},"has_next":{"type":"boolean"}}}}},"examples":{"Search 'airbus' on fr.indeed.com":{"value":{"results":[{"rating":4.1,"industry":"Aérospatiale et défense","jobs_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1/jobs","logo_url":"https://d2q79iu7y748jz.cloudfront.net/s/_squarelogo/64x64/7316c9e8fcda3af83c7321068c2f3a01","company_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1","description":"We look to recruit, develop, grow and retain the best, and welcome ALL as an equal opportunity employer.","reviews_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1/reviews","company_name":"Airbus","salaries_url":"https://fr.indeed.com/cmp/Airbus-e4b213b1/salaries","reviews_count":2324},{"rating":5,"industry":"ONG et associations à but non lucratif","jobs_url":"https://fr.indeed.com/cmp/Cse-Airbus/jobs","logo_url":null,"company_url":"https://fr.indeed.com/cmp/Cse-Airbus","description":null,"reviews_url":"https://fr.indeed.com/cmp/Cse-Airbus/reviews","company_name":"CSE AIRBUS","salaries_url":"https://fr.indeed.com/cmp/Cse-Airbus/salaries","reviews_count":1}],"pagination":{"next":null,"count":6,"has_next":false}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/idealo/product":{"get":{"summary":"Idealo Product","description":"Get an Idealo product from Spain, France, or Germany. URL or product id. Offers, shipping, specs, and images via WebUnlocker (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"get-idealo-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Idealo product URL, or a numeric product id.\n\n**Example 1 (Spain):**\n\n    https://www.idealo.es/precios/205227870/asics-novablast-5-1011b974.html\n\n**Example 2 (France):**\n\n    https://www.idealo.fr/prix/201455182/somfy-tahoma-switch-sc-1870595.html\n\n**Example 3 (Germany):**\n\n    https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html\n\n**Example 4 (id + country):**\n\n    205227870\n\n**Notes:**\n- URLs must be `/precios/`, `/prix/`, or `/OffersOfProduct/` on idealo.es / .fr / .de.\n- A numeric id uses `country` (`es` default).","schema":{"type":"string","description":"Full Idealo product URL, or a numeric product id.\n\n**Example 1 (Spain):**\n\n    https://www.idealo.es/precios/205227870/asics-novablast-5-1011b974.html\n\n**Example 2 (France):**\n\n    https://www.idealo.fr/prix/201455182/somfy-tahoma-switch-sc-1870595.html\n\n**Example 3 (Germany):**\n\n    https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html\n\n**Example 4 (id + country):**\n\n    205227870\n\n**Notes:**\n- URLs must be `/precios/`, `/prix/`, or `/OffersOfProduct/` on idealo.es / .fr / .de.\n- A numeric id uses `country` (`es` default)."}},{"name":"country","in":"query","required":false,"description":"Region when `query` is a numeric product id.\n\n- `es`: `/precios/{id}` (default)\n- `fr`: `/prix/{id}`\n- `de`: `/preisvergleich/OffersOfProduct/{id}`\n\nIgnored when `query` is already a URL. Other values return `400`.","schema":{"type":"string","description":"Region when `query` is a numeric product id.\n\n- `es`: `/precios/{id}` (default)\n- `fr`: `/prix/{id}`\n- `de`: `/preisvergleich/OffersOfProduct/{id}`\n\nIgnored when `query` is already a URL. Other values return `400`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"integer"},"currency":{"type":"string"},"offer_count":{"type":"integer"}}},"specs":{"type":"object","properties":{"Drop":{"type":"string"},"Para":{"type":"string"},"Serie":{"type":"string"},"Cierre":{"type":"string"},"Para uso":{"type":"string"},"Atención":{"type":"string"},"Superficie":{"type":"string"},"Entresuelas":{"type":"string"},"Propiedades":{"type":"string"},"Equipamiento":{"type":"string"},"Material exterior":{"type":"string"},"Material interior":{"type":"string"},"Tipos de producto":{"type":"string"},"Técnica de carrera":{"type":"string"},"Materiales de la suela":{"type":"string"},"Sistemas de amortiguación":{"type":"string"},"Características de la suela":{"type":"string"},"Características de la plantilla":{"type":"string"}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"offers":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"price":{"type":"integer"},"shop_id":{"type":"string"},"currency":{"type":"string"},"shipping":{"type":"integer"}}}},"rating":{"type":"number"},"country":{"type":"string"},"description":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Asics Novablast 5 on idealo.es":{"value":{"id":"205227870","sku":"205227870","url":"https://www.idealo.es/precios/205227870/asics-novablast-5-1011b974.html","brand":"Asics","price":{"max":225.01,"min":105,"currency":"EUR","offer_count":163},"specs":{"Drop":"8 mm","Para":"hombre","Serie":"Asics Novablast","Cierre":"cordones","Para uso":"entrenamiento, carrera","Atención":"Las ofertas pueden incluir productos de diferentes tallas","Superficie":"todoterreno","Entresuelas":"BOUNCE, espuma","Propiedades":"amortiguación, ligeras, transpirable","Equipamiento":"reflectantes, talón reforzado","Material exterior":"textil","Material interior":"malla","Tipos de producto":"Zapatillas con amortiguación, Zapatillas running ligeras","Técnica de carrera":"apoyo con el retropié","Materiales de la suela":"espuma, AHAR","Sistemas de amortiguación":"FF Blast Plus, FF Blast, FF BLAST PLUS ECO","Características de la suela":"amortiguación","Características de la plantilla":"transpirable"},"title":"Asics Novablast 5 (1011B974)","images":["https://cdn.idealo.com/folder/Product/205274/0/205274075/s11_produktbild_max/asics-novablast-5-1011b974-500-greyish-purple-coral-reef.jpg","https://cdn.idealo.com/folder/Product/208662/4/208662404/s11_produktbild_max/asics-novablast-5-1011b974-black-cobalt-burst.jpg","https://cdn.idealo.com/folder/Product/206583/8/206583866/s11_produktbild_max/asics-novablast-5-men-midnight-orange-glow.jpg","https://cdn.idealo.com/folder/Product/205359/1/205359157/s11_produktbild_max/asics-novablast-5-1011b974-002-black-carrier-grey.jpg"],"offers":[{"url":"https://www.idealo.es/relocator/relocate?categoryId=22875&offerKey=6a184d7d786523382f943b3456543900&pos=1&price=105.00&productid=205227870&sid=285299&type=offer","shop":"amazon.es","price":105,"shop_id":"285299","currency":"EUR","shipping":0},{"url":"https://www.idealo.es/relocator/relocate?categoryId=22875&offerKey=002a5a5f7de0d6b2a3911ce153a7ca0e&pos=2&price=105.00&productid=205227870&sid=307375&type=offer","shop":"runnerinn.com (ES)","price":105,"shop_id":"307375","currency":"EUR","shipping":1.99},{"url":"https://www.idealo.es/relocator/relocate?categoryId=22875&offerKey=02c7a21a790598e4b569c08a502a679a&pos=3&price=105.00&productid=205227870&sid=307375&type=offer","shop":"runnerinn.com (ES)","price":105,"shop_id":"307375","currency":"EUR","shipping":1.99}],"rating":4.9,"country":"es","description":"Zapatillas running Asics  Novablast 5 (1011B974) al mejor precio en idealo.es ! | ✓ Guía para comprar online ✓ Análisis y opiniones ✓ Las mejores ofertas y precios baratos","review_count":10}},"Somfy Tahoma Switch on idealo.fr":{"value":{"id":"201455182","sku":"3660849580308","url":"https://www.idealo.fr/prix/201455182/somfy-tahoma-switch-sc-1870595.html","brand":"Somfy","price":{"max":210.67,"min":131.95,"currency":"EUR","offer_count":9},"specs":{"Smart Home":"Compatible avec Alexa, Google Assistant/Home","Alimentation":"Sur secteur","Connectivité":"ZigBee","Compatible avec":"Amazon Alexa","Type de produit":"Box domotique","Gamme de fréquence":"868 MHz","Appareil connectable":"Alarmes","Domaine d'application":"Sécurité","Portée du signal max.":"100 m"},"title":"Somfy Tahoma Switch SC 1870595","images":["https://cdn.idealo.com/folder/Product/201455/1/201455182/s4_produktbild_max/somfy-tahoma-switch-sc-1870595.jpg"],"offers":[{"url":"https://www.idealo.fr/relocator/relocate?categoryId=25795&offerKey=04c31981f5e107fc268c3fdf2e8683ac&pos=1&price=131.95&productid=201455182&sid=318774&type=offer","shop":"Cdiscount.com (Marketplace)","price":131.95,"shop_id":"318774","currency":"EUR","shipping":8.95},{"url":"https://www.idealo.fr/relocator/relocate?categoryId=25795&offerKey=78c8e170eb06edfaef356f7b9d8c13fc&pos=2&price=142.07&productid=201455182&sid=328380&type=offer","shop":"galaxus.fr","price":142.07,"shop_id":"328380","currency":"EUR","shipping":0},{"url":"https://www.idealo.fr/relocator/relocate?categoryId=25795&offerKey=73b6cbc2d67262c98110d8b5e3f23792&pos=3&price=149.00&productid=201455182&sid=291209&type=offer","shop":"manomano.fr","price":149,"shop_id":"291209","currency":"EUR","shipping":0}],"rating":4.32,"country":"fr","description":"Somfy  Tahoma Switch SC 1870595 - Centrales domotiques | à partir de 131,95 € | Comparer les prix avec idealo.fr ! ✓ Conseils d’achat ✓ Comparatifs ✓ Avis & Tests produits","review_count":150}},"Asics Gel-NYC on idealo.de":{"value":{"id":"202763575","sku":"202763575","url":"https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html","brand":"Asics","price":{"max":248.73,"min":95,"currency":"EUR","offer_count":706},"specs":{"Serie":"Asics GEL-NYC","Siegel":"bluesign","Für wen":"Herren","Schuhsohle":"Kautschuk","Verschluss":"mit Schnürung","Innenfutter":"Synthetik","Obermaterial":"Mesh","Produkttypen":"Low-Top-Sneaker, Retro-Sneaker","Ausstattungen":"EVA-Zwischensohle, Zehenschutzkappe","Schuhtechnologie":"Asics Gel Cushioning (Gel-Dämpfung)","Bitte beachten Sie":"Die Angebote können verschiedene Größen beinhalten.","Komforteigenschaften":"dämpfend, rutschfest, gepolstert, atmungsaktiv, Stabilität"},"title":"Asics Gel-NYC (1201A789)","images":["https://cdn.idealo.com/folder/Product/202763/6/202763608/s1_produktbild_max/asics-gel-nyc-1201a789-graphite-grey-black.jpg","https://cdn.idealo.com/folder/Product/202763/5/202763585/s1_produktbild_max/asics-gel-nyc-1201a789-cream-oyster-grey.jpg","https://cdn.idealo.com/folder/Product/211914/2/211914221/s1_produktbild_max/asics-gel-nyc-1201a789-twilight-blue-gravel.jpg","https://cdn.idealo.com/folder/Product/203255/9/203255974/s1_produktbild_max/asics-gel-nyc-1201a789-midnight-blue-midnight.jpg"],"offers":[{"url":"https://www.idealo.de/relocator/relocate?categoryId=18817&offerKey=fa266dc9a90aa95f8414b5888796fd2e&pos=1&price=95.00&productid=202763575&sid=315835&type=offer","shop":"footlocker.de","price":95,"shop_id":"315835","currency":"EUR","shipping":4.99},{"url":"https://www.idealo.de/relocator/relocate?categoryId=18817&offerKey=acd86460aff0e09b45631d57f3669d88&pos=2&price=99.90&productid=202763575&sid=335301&type=offer","shop":"oz-sneaker.de","price":99.9,"shop_id":"335301","currency":"EUR","shipping":0},{"url":"https://www.idealo.de/relocator/relocate?categoryId=18817&offerKey=5fd6e31310b15149c694e741f25b865f&pos=3&price=100.00&productid=202763575&sid=315835&type=offer","shop":"footlocker.de","price":100,"shop_id":"315835","currency":"EUR","shipping":4.99}],"rating":4.63,"country":"de","description":"Bereits ab 95,00 € ✓ Große Shopvielfalt ✓ Testberichte & Meinungen ✓ | Jetzt Asics  Gel-NYC (1201A789)  günstig kaufen bei idealo.de","review_count":27}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Idealo Product","description":"Get an Idealo product from Spain, France, or Germany. URL or product id. Offers, shipping, specs, and images via WebUnlocker (3 credits).\n\n**Credit cost:** 3 credits per call","operationId":"post-idealo-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Idealo product URL, or a numeric product id.\n\n**Example 1 (Spain):**\n\n    https://www.idealo.es/precios/205227870/asics-novablast-5-1011b974.html\n\n**Example 2 (France):**\n\n    https://www.idealo.fr/prix/201455182/somfy-tahoma-switch-sc-1870595.html\n\n**Example 3 (Germany):**\n\n    https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html\n\n**Example 4 (id + country):**\n\n    205227870\n\n**Notes:**\n- URLs must be `/precios/`, `/prix/`, or `/OffersOfProduct/` on idealo.es / .fr / .de.\n- A numeric id uses `country` (`es` default).","schema":{"type":"string","description":"Full Idealo product URL, or a numeric product id.\n\n**Example 1 (Spain):**\n\n    https://www.idealo.es/precios/205227870/asics-novablast-5-1011b974.html\n\n**Example 2 (France):**\n\n    https://www.idealo.fr/prix/201455182/somfy-tahoma-switch-sc-1870595.html\n\n**Example 3 (Germany):**\n\n    https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html\n\n**Example 4 (id + country):**\n\n    205227870\n\n**Notes:**\n- URLs must be `/precios/`, `/prix/`, or `/OffersOfProduct/` on idealo.es / .fr / .de.\n- A numeric id uses `country` (`es` default)."}},{"name":"country","in":"query","required":false,"description":"Region when `query` is a numeric product id.\n\n- `es`: `/precios/{id}` (default)\n- `fr`: `/prix/{id}`\n- `de`: `/preisvergleich/OffersOfProduct/{id}`\n\nIgnored when `query` is already a URL. Other values return `400`.","schema":{"type":"string","description":"Region when `query` is a numeric product id.\n\n- `es`: `/precios/{id}` (default)\n- `fr`: `/prix/{id}`\n- `de`: `/preisvergleich/OffersOfProduct/{id}`\n\nIgnored when `query` is already a URL. Other values return `400`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"url":{"type":"string"},"brand":{"type":"string"},"price":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"integer"},"currency":{"type":"string"},"offer_count":{"type":"integer"}}},"specs":{"type":"object","properties":{"Drop":{"type":"string"},"Para":{"type":"string"},"Serie":{"type":"string"},"Cierre":{"type":"string"},"Para uso":{"type":"string"},"Atención":{"type":"string"},"Superficie":{"type":"string"},"Entresuelas":{"type":"string"},"Propiedades":{"type":"string"},"Equipamiento":{"type":"string"},"Material exterior":{"type":"string"},"Material interior":{"type":"string"},"Tipos de producto":{"type":"string"},"Técnica de carrera":{"type":"string"},"Materiales de la suela":{"type":"string"},"Sistemas de amortiguación":{"type":"string"},"Características de la suela":{"type":"string"},"Características de la plantilla":{"type":"string"}}},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"offers":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"shop":{"type":"string"},"price":{"type":"integer"},"shop_id":{"type":"string"},"currency":{"type":"string"},"shipping":{"type":"integer"}}}},"rating":{"type":"number"},"country":{"type":"string"},"description":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Asics Novablast 5 on idealo.es":{"value":{"id":"205227870","sku":"205227870","url":"https://www.idealo.es/precios/205227870/asics-novablast-5-1011b974.html","brand":"Asics","price":{"max":225.01,"min":105,"currency":"EUR","offer_count":163},"specs":{"Drop":"8 mm","Para":"hombre","Serie":"Asics Novablast","Cierre":"cordones","Para uso":"entrenamiento, carrera","Atención":"Las ofertas pueden incluir productos de diferentes tallas","Superficie":"todoterreno","Entresuelas":"BOUNCE, espuma","Propiedades":"amortiguación, ligeras, transpirable","Equipamiento":"reflectantes, talón reforzado","Material exterior":"textil","Material interior":"malla","Tipos de producto":"Zapatillas con amortiguación, Zapatillas running ligeras","Técnica de carrera":"apoyo con el retropié","Materiales de la suela":"espuma, AHAR","Sistemas de amortiguación":"FF Blast Plus, FF Blast, FF BLAST PLUS ECO","Características de la suela":"amortiguación","Características de la plantilla":"transpirable"},"title":"Asics Novablast 5 (1011B974)","images":["https://cdn.idealo.com/folder/Product/205274/0/205274075/s11_produktbild_max/asics-novablast-5-1011b974-500-greyish-purple-coral-reef.jpg","https://cdn.idealo.com/folder/Product/208662/4/208662404/s11_produktbild_max/asics-novablast-5-1011b974-black-cobalt-burst.jpg","https://cdn.idealo.com/folder/Product/206583/8/206583866/s11_produktbild_max/asics-novablast-5-men-midnight-orange-glow.jpg","https://cdn.idealo.com/folder/Product/205359/1/205359157/s11_produktbild_max/asics-novablast-5-1011b974-002-black-carrier-grey.jpg"],"offers":[{"url":"https://www.idealo.es/relocator/relocate?categoryId=22875&offerKey=6a184d7d786523382f943b3456543900&pos=1&price=105.00&productid=205227870&sid=285299&type=offer","shop":"amazon.es","price":105,"shop_id":"285299","currency":"EUR","shipping":0},{"url":"https://www.idealo.es/relocator/relocate?categoryId=22875&offerKey=002a5a5f7de0d6b2a3911ce153a7ca0e&pos=2&price=105.00&productid=205227870&sid=307375&type=offer","shop":"runnerinn.com (ES)","price":105,"shop_id":"307375","currency":"EUR","shipping":1.99},{"url":"https://www.idealo.es/relocator/relocate?categoryId=22875&offerKey=02c7a21a790598e4b569c08a502a679a&pos=3&price=105.00&productid=205227870&sid=307375&type=offer","shop":"runnerinn.com (ES)","price":105,"shop_id":"307375","currency":"EUR","shipping":1.99}],"rating":4.9,"country":"es","description":"Zapatillas running Asics  Novablast 5 (1011B974) al mejor precio en idealo.es ! | ✓ Guía para comprar online ✓ Análisis y opiniones ✓ Las mejores ofertas y precios baratos","review_count":10}},"Somfy Tahoma Switch on idealo.fr":{"value":{"id":"201455182","sku":"3660849580308","url":"https://www.idealo.fr/prix/201455182/somfy-tahoma-switch-sc-1870595.html","brand":"Somfy","price":{"max":210.67,"min":131.95,"currency":"EUR","offer_count":9},"specs":{"Smart Home":"Compatible avec Alexa, Google Assistant/Home","Alimentation":"Sur secteur","Connectivité":"ZigBee","Compatible avec":"Amazon Alexa","Type de produit":"Box domotique","Gamme de fréquence":"868 MHz","Appareil connectable":"Alarmes","Domaine d'application":"Sécurité","Portée du signal max.":"100 m"},"title":"Somfy Tahoma Switch SC 1870595","images":["https://cdn.idealo.com/folder/Product/201455/1/201455182/s4_produktbild_max/somfy-tahoma-switch-sc-1870595.jpg"],"offers":[{"url":"https://www.idealo.fr/relocator/relocate?categoryId=25795&offerKey=04c31981f5e107fc268c3fdf2e8683ac&pos=1&price=131.95&productid=201455182&sid=318774&type=offer","shop":"Cdiscount.com (Marketplace)","price":131.95,"shop_id":"318774","currency":"EUR","shipping":8.95},{"url":"https://www.idealo.fr/relocator/relocate?categoryId=25795&offerKey=78c8e170eb06edfaef356f7b9d8c13fc&pos=2&price=142.07&productid=201455182&sid=328380&type=offer","shop":"galaxus.fr","price":142.07,"shop_id":"328380","currency":"EUR","shipping":0},{"url":"https://www.idealo.fr/relocator/relocate?categoryId=25795&offerKey=73b6cbc2d67262c98110d8b5e3f23792&pos=3&price=149.00&productid=201455182&sid=291209&type=offer","shop":"manomano.fr","price":149,"shop_id":"291209","currency":"EUR","shipping":0}],"rating":4.32,"country":"fr","description":"Somfy  Tahoma Switch SC 1870595 - Centrales domotiques | à partir de 131,95 € | Comparer les prix avec idealo.fr ! ✓ Conseils d’achat ✓ Comparatifs ✓ Avis & Tests produits","review_count":150}},"Asics Gel-NYC on idealo.de":{"value":{"id":"202763575","sku":"202763575","url":"https://www.idealo.de/preisvergleich/OffersOfProduct/202763575_-gel-nyc-1201a789-asics.html","brand":"Asics","price":{"max":248.73,"min":95,"currency":"EUR","offer_count":706},"specs":{"Serie":"Asics GEL-NYC","Siegel":"bluesign","Für wen":"Herren","Schuhsohle":"Kautschuk","Verschluss":"mit Schnürung","Innenfutter":"Synthetik","Obermaterial":"Mesh","Produkttypen":"Low-Top-Sneaker, Retro-Sneaker","Ausstattungen":"EVA-Zwischensohle, Zehenschutzkappe","Schuhtechnologie":"Asics Gel Cushioning (Gel-Dämpfung)","Bitte beachten Sie":"Die Angebote können verschiedene Größen beinhalten.","Komforteigenschaften":"dämpfend, rutschfest, gepolstert, atmungsaktiv, Stabilität"},"title":"Asics Gel-NYC (1201A789)","images":["https://cdn.idealo.com/folder/Product/202763/6/202763608/s1_produktbild_max/asics-gel-nyc-1201a789-graphite-grey-black.jpg","https://cdn.idealo.com/folder/Product/202763/5/202763585/s1_produktbild_max/asics-gel-nyc-1201a789-cream-oyster-grey.jpg","https://cdn.idealo.com/folder/Product/211914/2/211914221/s1_produktbild_max/asics-gel-nyc-1201a789-twilight-blue-gravel.jpg","https://cdn.idealo.com/folder/Product/203255/9/203255974/s1_produktbild_max/asics-gel-nyc-1201a789-midnight-blue-midnight.jpg"],"offers":[{"url":"https://www.idealo.de/relocator/relocate?categoryId=18817&offerKey=fa266dc9a90aa95f8414b5888796fd2e&pos=1&price=95.00&productid=202763575&sid=315835&type=offer","shop":"footlocker.de","price":95,"shop_id":"315835","currency":"EUR","shipping":4.99},{"url":"https://www.idealo.de/relocator/relocate?categoryId=18817&offerKey=acd86460aff0e09b45631d57f3669d88&pos=2&price=99.90&productid=202763575&sid=335301&type=offer","shop":"oz-sneaker.de","price":99.9,"shop_id":"335301","currency":"EUR","shipping":0},{"url":"https://www.idealo.de/relocator/relocate?categoryId=18817&offerKey=5fd6e31310b15149c694e741f25b865f&pos=3&price=100.00&productid=202763575&sid=315835&type=offer","shop":"footlocker.de","price":100,"shop_id":"315835","currency":"EUR","shipping":4.99}],"rating":4.63,"country":"de","description":"Bereits ab 95,00 € ✓ Große Shopvielfalt ✓ Testberichte & Meinungen ✓ | Jetzt Asics  Gel-NYC (1201A789)  günstig kaufen bei idealo.de","review_count":27}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/idealista/search":{"get":{"summary":"Idealista Search","description":"Search Idealista listings from a search URL and retrieve prices, specs, photos, agency info, and pagination. Pass a province URL from `/v2/idealista/provinces` (`results[].url`) as `query`. Madrid is `https://www.idealista.com/venta-viviendas/madrid-provincia/`.\n\n**Credit cost:** 3 credits per call","operationId":"get-idealista-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Idealista search results URL.\n\n**Example 1 (neighborhood search):**\n\n    https://www.idealista.com/venta-viviendas/barcelona/ciutat-vella/la-barceloneta/\n\n**Example 2 (city search):**\n\n    https://www.idealista.com/venta-viviendas/madrid-madrid/\n\n**Notes:**\n- Only Idealista search URLs are accepted.\n- Pagination parameters in the URL are respected.\n- Use each result's `link` with the Idealista Property endpoint for full listing data.\n\nFull Idealista search URL. Pass a province URL from /v2/idealista/provinces (results[].url) as this value. Madrid: https://www.idealista.com/venta-viviendas/madrid-provincia/","schema":{"type":"string","description":"Full Idealista search results URL.\n\n**Example 1 (neighborhood search):**\n\n    https://www.idealista.com/venta-viviendas/barcelona/ciutat-vella/la-barceloneta/\n\n**Example 2 (city search):**\n\n    https://www.idealista.com/venta-viviendas/madrid-madrid/\n\n**Notes:**\n- Only Idealista search URLs are accepted.\n- Pagination parameters in the URL are respected.\n- Use each result's `link` with the Idealista Property endpoint for full listing data.\n\nFull Idealista search URL. Pass a province URL from /v2/idealista/provinces (results[].url) as this value. Madrid: https://www.idealista.com/venta-viviendas/madrid-provincia/"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"details":{"type":"array","items":{"type":"string"}},"picture":{"type":"string"},"currency":{"type":"string"},"description":{"type":"string"},"listing_company":{"type":"string"},"parking_included":{"type":"boolean"},"listing_company_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search homes for sale in La Barceloneta, Barcelona":{"value":{"results":[{"link":"https://www.idealista.com/fr/inmueble/111463799/","price":1650000,"title":"Appartement - Calle de Guzmán el Bueno, Gaztambide, Madrid","details":["4 ch.","190 m²","4ème étage logement sur rue avec ascenseur"],"picture":"https://img4.idealista.com/blur/480_360_mq/0/id.pro.es.image.master/e7/b4/e6/1437388651.jpg","currency":"€","description":"Appartement de Luxe à Chamberí - Madrid | 190 m² | 4 ChambresDécouvrez votre nouveau chez-vous dans l'un des quartiers les plus exclusifs de Madrid! Nous vous présentons cet appartement spectaculaire de 190 m², entièrement rénové à neuf, situé dans la prestigieuse rue Guzmán el Bueno, au cœur de Chamberí. Situé au qu","listing_company":"Hills Properties","parking_included":false,"listing_company_url":"https://www.idealista.com/fr/pro/hillspropertiesbcn/"},{"link":"https://www.idealista.com/fr/inmueble/109948217/","price":968000,"title":"Appartement - Calle de Gaztambide, 39, Gaztambide, Madrid","details":["3 ch.","126 m²","1er étage logement sur rue avec ascenseur"],"picture":"https://img4.idealista.com/blur/480_360_mq/0/id.pro.es.image.master/a9/12/99/1391364999.jpg","currency":"€","description":"Découvrez votre nouveau chez-vous au cœur du quartier de Gaztambide! Ce spectaculaire appartement, entièrement rénové et neuf, dispose de 126 m² construits qui offrent une ambiance lumineuse et accueillante. Avec 3 chambres et 2 salles de bain (dont une en suite), cet espace est idéal pour les familles ou pour ceux qui","listing_company":"Gilmar Chamberi - Argüelles","parking_included":false,"listing_company_url":"https://www.idealista.com/fr/pro/gilmarchamberi/"},{"link":"https://www.idealista.com/fr/inmueble/109948315/","price":1795000,"title":"Penthouse - Calle de Fernando el Católico, Gaztambide, Madrid","details":["4 ch.","230 m²","6ème étage logement sur rue avec ascenseur"],"picture":"https://img4.idealista.com/blur/480_360_mq/0/id.pro.es.image.master/b5/00/c4/1391354207.jpg","currency":"€","description":"Découvrez ce spectaculaire penthouse situé dans le quartier prisé de Gaztambide, dans le district de Chamberí, à Madrid. Une propriété qui combine élégance, espace et possibilités infinies dans l'un des quartiers les plus exclusifs de la capitale. Avec une superficie construite de 230 m² et une impressionnante terrasse","listing_company":"Gilmar Chamberi - Argüelles","parking_included":false,"listing_company_url":"https://www.idealista.com/fr/pro/gilmarchamberi/"}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6],"total_pages":6,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Idealista Search","description":"Search Idealista listings from a search URL and retrieve prices, specs, photos, agency info, and pagination. Pass a province URL from `/v2/idealista/provinces` (`results[].url`) as `query`. Madrid is `https://www.idealista.com/venta-viviendas/madrid-provincia/`.\n\n**Credit cost:** 3 credits per call","operationId":"post-idealista-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Idealista search results URL.\n\n**Example 1 (neighborhood search):**\n\n    https://www.idealista.com/venta-viviendas/barcelona/ciutat-vella/la-barceloneta/\n\n**Example 2 (city search):**\n\n    https://www.idealista.com/venta-viviendas/madrid-madrid/\n\n**Notes:**\n- Only Idealista search URLs are accepted.\n- Pagination parameters in the URL are respected.\n- Use each result's `link` with the Idealista Property endpoint for full listing data.\n\nFull Idealista search URL. Pass a province URL from /v2/idealista/provinces (results[].url) as this value. Madrid: https://www.idealista.com/venta-viviendas/madrid-provincia/","schema":{"type":"string","description":"Full Idealista search results URL.\n\n**Example 1 (neighborhood search):**\n\n    https://www.idealista.com/venta-viviendas/barcelona/ciutat-vella/la-barceloneta/\n\n**Example 2 (city search):**\n\n    https://www.idealista.com/venta-viviendas/madrid-madrid/\n\n**Notes:**\n- Only Idealista search URLs are accepted.\n- Pagination parameters in the URL are respected.\n- Use each result's `link` with the Idealista Property endpoint for full listing data.\n\nFull Idealista search URL. Pass a province URL from /v2/idealista/provinces (results[].url) as this value. Madrid: https://www.idealista.com/venta-viviendas/madrid-provincia/"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string"},"price":{"type":"integer"},"title":{"type":"string"},"details":{"type":"array","items":{"type":"string"}},"picture":{"type":"string"},"currency":{"type":"string"},"description":{"type":"string"},"listing_company":{"type":"string"},"parking_included":{"type":"boolean"},"listing_company_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"other_pages":{"type":"array","items":{"type":"integer"}},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search homes for sale in La Barceloneta, Barcelona":{"value":{"results":[{"link":"https://www.idealista.com/fr/inmueble/111463799/","price":1650000,"title":"Appartement - Calle de Guzmán el Bueno, Gaztambide, Madrid","details":["4 ch.","190 m²","4ème étage logement sur rue avec ascenseur"],"picture":"https://img4.idealista.com/blur/480_360_mq/0/id.pro.es.image.master/e7/b4/e6/1437388651.jpg","currency":"€","description":"Appartement de Luxe à Chamberí - Madrid | 190 m² | 4 ChambresDécouvrez votre nouveau chez-vous dans l'un des quartiers les plus exclusifs de Madrid! Nous vous présentons cet appartement spectaculaire de 190 m², entièrement rénové à neuf, situé dans la prestigieuse rue Guzmán el Bueno, au cœur de Chamberí. Situé au qu","listing_company":"Hills Properties","parking_included":false,"listing_company_url":"https://www.idealista.com/fr/pro/hillspropertiesbcn/"},{"link":"https://www.idealista.com/fr/inmueble/109948217/","price":968000,"title":"Appartement - Calle de Gaztambide, 39, Gaztambide, Madrid","details":["3 ch.","126 m²","1er étage logement sur rue avec ascenseur"],"picture":"https://img4.idealista.com/blur/480_360_mq/0/id.pro.es.image.master/a9/12/99/1391364999.jpg","currency":"€","description":"Découvrez votre nouveau chez-vous au cœur du quartier de Gaztambide! Ce spectaculaire appartement, entièrement rénové et neuf, dispose de 126 m² construits qui offrent une ambiance lumineuse et accueillante. Avec 3 chambres et 2 salles de bain (dont une en suite), cet espace est idéal pour les familles ou pour ceux qui","listing_company":"Gilmar Chamberi - Argüelles","parking_included":false,"listing_company_url":"https://www.idealista.com/fr/pro/gilmarchamberi/"},{"link":"https://www.idealista.com/fr/inmueble/109948315/","price":1795000,"title":"Penthouse - Calle de Fernando el Católico, Gaztambide, Madrid","details":["4 ch.","230 m²","6ème étage logement sur rue avec ascenseur"],"picture":"https://img4.idealista.com/blur/480_360_mq/0/id.pro.es.image.master/b5/00/c4/1391354207.jpg","currency":"€","description":"Découvrez ce spectaculaire penthouse situé dans le quartier prisé de Gaztambide, dans le district de Chamberí, à Madrid. Une propriété qui combine élégance, espace et possibilités infinies dans l'un des quartiers les plus exclusifs de la capitale. Avec une superficie construite de 230 m² et une impressionnante terrasse","listing_company":"Gilmar Chamberi - Argüelles","parking_included":false,"listing_company_url":"https://www.idealista.com/fr/pro/gilmarchamberi/"}],"pagination":{"next":2,"current":1,"other_pages":[2,3,4,5,6],"total_pages":6,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/idealista/property":{"get":{"summary":"Idealista Property","description":"Extract full property details from an Idealista listing URL, including price, specs, photos by room, features, energy rating, and advertiser data.\n\n**Credit cost:** 3 credits per call","operationId":"get-idealista-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Idealista property detail URL.\n\n**Example:**\n\n    https://www.idealista.com/fr/inmueble/111463799/\n\n**Notes:**\n- Only Idealista `/inmueble/` listing URLs are accepted.\n- Copy the listing URL from search results or from idealista.com.","schema":{"type":"string","description":"Full Idealista property detail URL.\n\n**Example:**\n\n    https://www.idealista.com/fr/inmueble/111463799/\n\n**Notes:**\n- Only Idealista `/inmueble/` listing URLs are accepted.\n- Copy the listing URL from search results or from idealista.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"plans":{"type":"array","items":{"type":"string"}},"price":{"type":"integer"},"title":{"type":"string"},"units":{"type":"array","items":{}},"images":{"type":"object","properties":{"Photo":{"type":"array","items":{"type":"string"}},"Salon":{"type":"array","items":{"type":"string"}},"Chambre":{"type":"array","items":{"type":"string"}},"Cuisine":{"type":"array","items":{"type":"string"}},"Salle de bains":{"type":"array","items":{"type":"string"}}}},"address":{"type":"array","items":{"type":"string"}},"updated":{"type":"string"},"currency":{"nullable":true},"features":{"type":"object","properties":{"Immeuble":{"type":"array","items":{"type":"string"}},"Équipement":{"type":"array","items":{"type":"string"}},"Caractéristiques":{"type":"array","items":{"type":"string"}},"Diagnostic de performance énergétique":{"type":"object","properties":{"emissions":{"type":"string"},"consumption":{"type":"string"}}}}},"location":{"type":"string"},"description":{"type":"string"},"advertiser_url":{"type":"string"},"advertiser_name":{"type":"string"}}},"examples":{"Lookup Calle de Guzmán el Bueno, Madrid":{"value":{"url":"https://www.idealista.com/fr/inmueble/111463799/","plans":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/40/06/bd/1437393638.jpg"],"price":1650000,"title":"Appartement à vendre - Calle de Guzmán el Bueno","units":[],"images":{"Photo":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/ef/d3/38/1437388712.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/f9/a7/7c/1437388648.jpg"],"Salon":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/e7/b4/e6/1437388651.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/d8/27/78/1437388731.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/7f/5e/d2/1437388732.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/cd/7a/2d/1437388727.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/13/a4/ec/1437388726.jpg"],"Chambre":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/4d/a4/f9/1437388711.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/32/0c/c6/1437388713.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/7d/0c/b8/1437388714.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/39/89/a8/1437388725.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/5a/ae/4c/1437388554.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/58/54/25/1437388553.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/3c/10/96/1437388708.jpg"],"Cuisine":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/ff/c9/ed/1437388730.jpg"],"Salle de bains":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/10/6f/0b/1437388710.jpg"]},"address":["Calle de Guzmán el Bueno","Quartier Gaztambide","District Chamberí","Madrid","Madrid capitale, Madrid"],"updated":"Annonce actualisée le 14 mai","currency":null,"features":{"Immeuble":["4ème étage logement sur rue","Avec ascenseur"],"Équipement":["Climatisation"],"Caractéristiques":["Surface construite 190 m²","4 chambres","3 salles de bains","Terrasse","D'occasion/en bon état","Armoires encastrées","Orientation ouest","Construit en 1862","Chauffage individuel: Gaz naturel"],"Diagnostic de performance énergétique":{"emissions":"D","consumption":"C"}},"location":"Gaztambide, Madrid","description":"Appartement de Luxe à Chamberí - Madrid | 190 m² | 4 Chambres\nDécouvrez votre nouveau chez-vous dans l'un des quartiers les plus exclusifs de Madrid! Nous vous présentons cet appartement spectaculaire de 190 m², entièrement rénové à neuf, situé dans la prestigieuse rue Guzmán el Bueno, au cœur de Chamberí. Situé au quatrième étage avec ascenseur, ce bien combine l'élégance classique d'un immeuble de 1862 avec toutes les commodités modernes dont vous avez besoin.\nCaractéristiques Principales\nCet appartement se distingue par sa distribution parfaite avec 4 chambres spacieuses et 3 salles de bains complètes, dont une suite parentale avec salle de bains privative. Le logement dispose de placards intégrés dans toutes les chambres, garantissant un rangement optimal. La cuisine est entièrement équipée d'appareils électroménagers intégrés de dernière génération, prête à être utilisée dès le premier jour.\nConfort et Luminosité\nL'excellente orientation ouest et la hauteur du quatrième étage garantissent une luminosité exceptionnelle dans tout le logement. De plus, il dispose d'une terrasse privée parfaite pour profiter de l'extérieur. Le bien comprend la climatisation et le chauffage par pompe à froid/chaud avec gaz naturel, assurant votre confort tout au long de l'année.\nEntièrement Meublé et Prêt à Habiter\nVous n'aurez rien à faire! L'appartement est entièrement meublé et décoré avec goût, prêt à emménager.\nEmplacement Privilégié\nChamberí est synonyme de qualité de vie. Votre nouveau chez-vous sera entouré de commerces de choix, de restaurants renommés, d'écoles prestigieuses et d'espaces verts. Les connexions de transport sont excellentes, facilitant vos déplacements dans toute la ville.\nIdéal pour résidence principale ou comme investissement de haut niveau. Contactez-nous pour une visite sans engagement!","advertiser_url":"https://www.idealista.com/fr/pro/hillspropertiesbcn/","advertiser_name":"Hills Properties"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Idealista Property","description":"Extract full property details from an Idealista listing URL, including price, specs, photos by room, features, energy rating, and advertiser data.\n\n**Credit cost:** 3 credits per call","operationId":"post-idealista-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Idealista property detail URL.\n\n**Example:**\n\n    https://www.idealista.com/fr/inmueble/111463799/\n\n**Notes:**\n- Only Idealista `/inmueble/` listing URLs are accepted.\n- Copy the listing URL from search results or from idealista.com.","schema":{"type":"string","description":"Full Idealista property detail URL.\n\n**Example:**\n\n    https://www.idealista.com/fr/inmueble/111463799/\n\n**Notes:**\n- Only Idealista `/inmueble/` listing URLs are accepted.\n- Copy the listing URL from search results or from idealista.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"plans":{"type":"array","items":{"type":"string"}},"price":{"type":"integer"},"title":{"type":"string"},"units":{"type":"array","items":{}},"images":{"type":"object","properties":{"Photo":{"type":"array","items":{"type":"string"}},"Salon":{"type":"array","items":{"type":"string"}},"Chambre":{"type":"array","items":{"type":"string"}},"Cuisine":{"type":"array","items":{"type":"string"}},"Salle de bains":{"type":"array","items":{"type":"string"}}}},"address":{"type":"array","items":{"type":"string"}},"updated":{"type":"string"},"currency":{"nullable":true},"features":{"type":"object","properties":{"Immeuble":{"type":"array","items":{"type":"string"}},"Équipement":{"type":"array","items":{"type":"string"}},"Caractéristiques":{"type":"array","items":{"type":"string"}},"Diagnostic de performance énergétique":{"type":"object","properties":{"emissions":{"type":"string"},"consumption":{"type":"string"}}}}},"location":{"type":"string"},"description":{"type":"string"},"advertiser_url":{"type":"string"},"advertiser_name":{"type":"string"}}},"examples":{"Lookup Calle de Guzmán el Bueno, Madrid":{"value":{"url":"https://www.idealista.com/fr/inmueble/111463799/","plans":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/40/06/bd/1437393638.jpg"],"price":1650000,"title":"Appartement à vendre - Calle de Guzmán el Bueno","units":[],"images":{"Photo":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/ef/d3/38/1437388712.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/f9/a7/7c/1437388648.jpg"],"Salon":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/e7/b4/e6/1437388651.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/d8/27/78/1437388731.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/7f/5e/d2/1437388732.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/cd/7a/2d/1437388727.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/13/a4/ec/1437388726.jpg"],"Chambre":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/4d/a4/f9/1437388711.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/32/0c/c6/1437388713.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/7d/0c/b8/1437388714.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/39/89/a8/1437388725.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/5a/ae/4c/1437388554.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/58/54/25/1437388553.jpg","https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/3c/10/96/1437388708.jpg"],"Cuisine":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/ff/c9/ed/1437388730.jpg"],"Salle de bains":["https://img4.idealista.com/blur/WEB_DETAIL/0/id.pro.es.image.master/10/6f/0b/1437388710.jpg"]},"address":["Calle de Guzmán el Bueno","Quartier Gaztambide","District Chamberí","Madrid","Madrid capitale, Madrid"],"updated":"Annonce actualisée le 14 mai","currency":null,"features":{"Immeuble":["4ème étage logement sur rue","Avec ascenseur"],"Équipement":["Climatisation"],"Caractéristiques":["Surface construite 190 m²","4 chambres","3 salles de bains","Terrasse","D'occasion/en bon état","Armoires encastrées","Orientation ouest","Construit en 1862","Chauffage individuel: Gaz naturel"],"Diagnostic de performance énergétique":{"emissions":"D","consumption":"C"}},"location":"Gaztambide, Madrid","description":"Appartement de Luxe à Chamberí - Madrid | 190 m² | 4 Chambres\nDécouvrez votre nouveau chez-vous dans l'un des quartiers les plus exclusifs de Madrid! Nous vous présentons cet appartement spectaculaire de 190 m², entièrement rénové à neuf, situé dans la prestigieuse rue Guzmán el Bueno, au cœur de Chamberí. Situé au quatrième étage avec ascenseur, ce bien combine l'élégance classique d'un immeuble de 1862 avec toutes les commodités modernes dont vous avez besoin.\nCaractéristiques Principales\nCet appartement se distingue par sa distribution parfaite avec 4 chambres spacieuses et 3 salles de bains complètes, dont une suite parentale avec salle de bains privative. Le logement dispose de placards intégrés dans toutes les chambres, garantissant un rangement optimal. La cuisine est entièrement équipée d'appareils électroménagers intégrés de dernière génération, prête à être utilisée dès le premier jour.\nConfort et Luminosité\nL'excellente orientation ouest et la hauteur du quatrième étage garantissent une luminosité exceptionnelle dans tout le logement. De plus, il dispose d'une terrasse privée parfaite pour profiter de l'extérieur. Le bien comprend la climatisation et le chauffage par pompe à froid/chaud avec gaz naturel, assurant votre confort tout au long de l'année.\nEntièrement Meublé et Prêt à Habiter\nVous n'aurez rien à faire! L'appartement est entièrement meublé et décoré avec goût, prêt à emménager.\nEmplacement Privilégié\nChamberí est synonyme de qualité de vie. Votre nouveau chez-vous sera entouré de commerces de choix, de restaurants renommés, d'écoles prestigieuses et d'espaces verts. Les connexions de transport sont excellentes, facilitant vos déplacements dans toute la ville.\nIdéal pour résidence principale ou comme investissement de haut niveau. Contactez-nous pour une visite sans engagement!","advertiser_url":"https://www.idealista.com/fr/pro/hillspropertiesbcn/","advertiser_name":"Hills Properties"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ikea/search":{"get":{"summary":"IKEA Search","description":"Search IKEA products from a search URL and retrieve prices, ratings, dimensions, images, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-ikea-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full IKEA search URL.\n\n**Example 1 (French search):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble\n\n**Example 2 (page 2):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble&page=2\n\n**Example 3 (UK search):**\n\n    https://www.ikea.com/gb/en/search/?q=desk\n\n**Notes:**\n- Only `ikea.com` `/search/` URLs with a `q` parameter are accepted.\n- Copy the full URL from ikea.com, including country and language segments (`/fr/fr/`, `/gb/en/`, etc.).\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the IKEA Product endpoint for full product data.","schema":{"type":"string","description":"Full IKEA search URL.\n\n**Example 1 (French search):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble\n\n**Example 2 (page 2):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble&page=2\n\n**Example 3 (UK search):**\n\n    https://www.ikea.com/gb/en/search/?q=desk\n\n**Notes:**\n- Only `ikea.com` `/search/` URLs with a `q` parameter are accepted.\n- Copy the full URL from ikea.com, including country and language segments (`/fr/fr/`, `/gb/en/`, etc.).\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the IKEA Product endpoint for full product data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"measure":{"type":"string"},"currency":{"type":"string"},"subtitle":{"type":"string"},"price_amount":{"type":"number"},"reviews_count":{"type":"integer"},"online_sellable":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search meubles on IKEA France":{"value":{"results":[{"id":"60282186","url":"https://www.ikea.com/fr/fr/p/lack-etagere-blanc-60282186/","image":"https://www.ikea.com/fr/fr/images/products/lack-etagere-blanc__0246565_pe385541_s5.jpg","price":"69,99€","title":"LACK","rating":4.8,"measure":"30x190 cm","currency":"EUR","subtitle":"Étagère","price_amount":69.99,"reviews_count":327,"online_sellable":true},{"id":"20574587","url":"https://www.ikea.com/fr/fr/p/eket-element-2-portes-et-1-tablette-brun-motif-noyer-20574587/","image":"https://www.ikea.com/fr/fr/images/products/eket-element-2-portes-et-1-tablette-brun-motif-noyer__1373669_pe960035_s5.jpg","price":"105€","title":"EKET","rating":3.3,"measure":"70x35x70 cm","currency":"EUR","subtitle":"Élément 2 portes et 1 tablette","price_amount":105,"reviews_count":184,"online_sellable":true},{"id":"80275887","url":"https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-80275887/","image":"https://www.ikea.com/fr/fr/images/products/kallax-etagere-blanc__0644757_pe702939_s5.jpg","price":"74,99€","title":"KALLAX","rating":4.7,"measure":"77x147 cm","currency":"EUR","subtitle":"Étagère","price_amount":74.99,"reviews_count":2742,"online_sellable":true}],"pagination":{"next":2,"current":1,"next_url":"https://www.ikea.com/fr/fr/search/?q=meuble&page=2","per_page":24,"total_count":766,"total_pages":32,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"IKEA Search","description":"Search IKEA products from a search URL and retrieve prices, ratings, dimensions, images, and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-ikea-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full IKEA search URL.\n\n**Example 1 (French search):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble\n\n**Example 2 (page 2):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble&page=2\n\n**Example 3 (UK search):**\n\n    https://www.ikea.com/gb/en/search/?q=desk\n\n**Notes:**\n- Only `ikea.com` `/search/` URLs with a `q` parameter are accepted.\n- Copy the full URL from ikea.com, including country and language segments (`/fr/fr/`, `/gb/en/`, etc.).\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the IKEA Product endpoint for full product data.","schema":{"type":"string","description":"Full IKEA search URL.\n\n**Example 1 (French search):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble\n\n**Example 2 (page 2):**\n\n    https://www.ikea.com/fr/fr/search/?q=meuble&page=2\n\n**Example 3 (UK search):**\n\n    https://www.ikea.com/gb/en/search/?q=desk\n\n**Notes:**\n- Only `ikea.com` `/search/` URLs with a `q` parameter are accepted.\n- Copy the full URL from ikea.com, including country and language segments (`/fr/fr/`, `/gb/en/`, etc.).\n- Pagination via `?page=2` in the URL.\n- Use each result's `url` with the IKEA Product endpoint for full product data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"measure":{"type":"string"},"currency":{"type":"string"},"subtitle":{"type":"string"},"price_amount":{"type":"number"},"reviews_count":{"type":"integer"},"online_sellable":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search meubles on IKEA France":{"value":{"results":[{"id":"60282186","url":"https://www.ikea.com/fr/fr/p/lack-etagere-blanc-60282186/","image":"https://www.ikea.com/fr/fr/images/products/lack-etagere-blanc__0246565_pe385541_s5.jpg","price":"69,99€","title":"LACK","rating":4.8,"measure":"30x190 cm","currency":"EUR","subtitle":"Étagère","price_amount":69.99,"reviews_count":327,"online_sellable":true},{"id":"20574587","url":"https://www.ikea.com/fr/fr/p/eket-element-2-portes-et-1-tablette-brun-motif-noyer-20574587/","image":"https://www.ikea.com/fr/fr/images/products/eket-element-2-portes-et-1-tablette-brun-motif-noyer__1373669_pe960035_s5.jpg","price":"105€","title":"EKET","rating":3.3,"measure":"70x35x70 cm","currency":"EUR","subtitle":"Élément 2 portes et 1 tablette","price_amount":105,"reviews_count":184,"online_sellable":true},{"id":"80275887","url":"https://www.ikea.com/fr/fr/p/kallax-etagere-blanc-80275887/","image":"https://www.ikea.com/fr/fr/images/products/kallax-etagere-blanc__0644757_pe702939_s5.jpg","price":"74,99€","title":"KALLAX","rating":4.7,"measure":"77x147 cm","currency":"EUR","subtitle":"Étagère","price_amount":74.99,"reviews_count":2742,"online_sellable":true}],"pagination":{"next":2,"current":1,"next_url":"https://www.ikea.com/fr/fr/search/?q=meuble&page=2","per_page":24,"total_count":766,"total_pages":32,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/ikea/product":{"get":{"summary":"IKEA Product","description":"Extract full IKEA product details from a product URL, including price, gallery, variants, dimensions, and breadcrumb.\n\n**Credit cost:** 1 credit per call","operationId":"get-ikea-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full IKEA product page URL.\n\n**Example:**\n\n    https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/\n\n**Notes:**\n- Only `/p/` product URLs on ikea.com are accepted.\n- Copy the listing URL from search results or from ikea.com.\n- Variant URLs with `-s` suffix IDs are also supported.","schema":{"type":"string","description":"Full IKEA product page URL.\n\n**Example:**\n\n    https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/\n\n**Notes:**\n- Only `/p/` product URLs on ikea.com are accepted.\n- Copy the listing URL from search results or from ikea.com.\n- Variant URLs with `-s` suffix IDs are also supported."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"measure":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"}}}},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"dimensions":{"type":"object","properties":{"depth":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"}}},"description":{"type":"string"},"price_amount":{"type":"integer"},"reviews_count":{"type":"integer"}}},"examples":{"Lookup GLADHÖJDEN sit/stand desk on IKEA France":{"value":{"id":"30493939","url":"https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/","image":"https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg","price":"149 €","title":"GLADHÖJDEN Bureau assis/debout, blanc, 100x60 cm","images":["https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg","https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159428_pe888477_s5.jpg","https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1167477_pe891584_s5.jpg","https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1470516_pe996887_s5.jpg"],"rating":4.1,"measure":"100x60cm","category":"Bureaux pour la maison","currency":"€","variants":[{"id":"30493939","url":"https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/","name":"Blanc","image":"https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg"},{"id":"20541610","url":"https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-gris-clair-anthracite-20541610/","name":"Gris clair/anthracite","image":"https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-gris-clair-anthracite__1159426_pe888475_s5.jpg"}],"breadcrumb":[{"url":"https://www.ikea.com/fr/fr/cat/produits-products/","name":"Produits"},{"url":"https://www.ikea.com/fr/fr/cat/bureaux-chaises-de-bureau-fu004/","name":"Bureaux & chaises de bureau"},{"url":"https://www.ikea.com/fr/fr/cat/bureaux-et-support-pc-tablettes-20649/","name":"Bureaux et support PC/tablettes"},{"url":"https://www.ikea.com/fr/fr/cat/bureaux-pour-la-maison-20651/","name":"Bureaux pour la maison"},{"url":null,"name":"GLADHÖJDENBureau assis/debout"}],"dimensions":{"depth":"100 cm","width":"10 kg","height":"60 cm"},"description":"Vous travaillez depuis la maison ? Ce bureau assis/debout permet de passer la journée bien installé. Grâce un vérin à gaz, le bureau monte et descend facilement et en silence. Vous êtes ainsi toujours dans une bonne position de travail.","price_amount":149,"reviews_count":9}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"IKEA Product","description":"Extract full IKEA product details from a product URL, including price, gallery, variants, dimensions, and breadcrumb.\n\n**Credit cost:** 1 credit per call","operationId":"post-ikea-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full IKEA product page URL.\n\n**Example:**\n\n    https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/\n\n**Notes:**\n- Only `/p/` product URLs on ikea.com are accepted.\n- Copy the listing URL from search results or from ikea.com.\n- Variant URLs with `-s` suffix IDs are also supported.","schema":{"type":"string","description":"Full IKEA product page URL.\n\n**Example:**\n\n    https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/\n\n**Notes:**\n- Only `/p/` product URLs on ikea.com are accepted.\n- Copy the listing URL from search results or from ikea.com.\n- Variant URLs with `-s` suffix IDs are also supported."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"measure":{"type":"string"},"category":{"type":"string"},"currency":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"}}}},"breadcrumb":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}}}},"dimensions":{"type":"object","properties":{"depth":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"}}},"description":{"type":"string"},"price_amount":{"type":"integer"},"reviews_count":{"type":"integer"}}},"examples":{"Lookup GLADHÖJDEN sit/stand desk on IKEA France":{"value":{"id":"30493939","url":"https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/","image":"https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg","price":"149 €","title":"GLADHÖJDEN Bureau assis/debout, blanc, 100x60 cm","images":["https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg","https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159428_pe888477_s5.jpg","https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1167477_pe891584_s5.jpg","https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1470516_pe996887_s5.jpg"],"rating":4.1,"measure":"100x60cm","category":"Bureaux pour la maison","currency":"€","variants":[{"id":"30493939","url":"https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-blanc-30493939/","name":"Blanc","image":"https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-blanc__1159429_pe888476_s5.jpg"},{"id":"20541610","url":"https://www.ikea.com/fr/fr/p/gladhoejden-bureau-assis-debout-gris-clair-anthracite-20541610/","name":"Gris clair/anthracite","image":"https://www.ikea.com/fr/fr/images/products/gladhoejden-bureau-assis-debout-gris-clair-anthracite__1159426_pe888475_s5.jpg"}],"breadcrumb":[{"url":"https://www.ikea.com/fr/fr/cat/produits-products/","name":"Produits"},{"url":"https://www.ikea.com/fr/fr/cat/bureaux-chaises-de-bureau-fu004/","name":"Bureaux & chaises de bureau"},{"url":"https://www.ikea.com/fr/fr/cat/bureaux-et-support-pc-tablettes-20649/","name":"Bureaux et support PC/tablettes"},{"url":"https://www.ikea.com/fr/fr/cat/bureaux-pour-la-maison-20651/","name":"Bureaux pour la maison"},{"url":null,"name":"GLADHÖJDENBureau assis/debout"}],"dimensions":{"depth":"100 cm","width":"10 kg","height":"60 cm"},"description":"Vous travaillez depuis la maison ? Ce bureau assis/debout permet de passer la journée bien installé. Grâce un vérin à gaz, le bureau monte et descend facilement et en silence. Vous êtes ainsi toujours dans une bonne position de travail.","price_amount":149,"reviews_count":9}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/shopping":{"get":{"summary":"Google Shopping","description":"Search Google Shopping and retrieve structured product listings with prices, ratings, merchants, and product IDs.\n\n**Credit cost:** 1 credit per call","operationId":"get-google-shopping","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product search query on Google Shopping. Use a product name, brand, or category.\n\n**Examples:**\n- `playstation 5`: consoles and bundles\n- `sony wh-1000xm5`: a specific model\n- `iphone 16`: latest iPhone listings\n\n**Example:**\n\n    playstation 5","schema":{"type":"string","description":"Product search query on Google Shopping. Use a product name, brand, or category.\n\n**Examples:**\n- `playstation 5`: consoles and bundles\n- `sony wh-1000xm5`: a specific model\n- `iphone 16`: latest iPhone listings\n\n**Example:**\n\n    playstation 5"}},{"name":"page","in":"query","required":false,"description":"Page number of Shopping results. Each page returns about 20 products. There is no `num` parameter.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of Shopping results. Each page returns about 20 products. There is no `num` parameter.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google Shopping country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google Shopping country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google Shopping interface language.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google Shopping interface language.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"location","in":"query","required":false,"description":"City or region used to localize Shopping results. Simulates a search from that location and generates the UULE parameter automatically.\n\n**Examples:**\n```\nNew York, United States\n```\n\n```\nParis, France\n```\n\n```\nBerlin, Germany\n```","schema":{"type":"string","description":"City or region used to localize Shopping results. Simulates a search from that location and generates the UULE parameter automatically.\n\n**Examples:**\n```\nNew York, United States\n```\n\n```\nParis, France\n```\n\n```\nBerlin, Germany\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string (UULE) for precise geo-targeting. Use `location` instead if you do not already have an encoded value.","schema":{"type":"string","description":"Google-encoded location string (UULE) for precise geo-targeting. Use `location` instead if you do not already have an encoded value."}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"organic_results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"source":{"type":"string"},"reviews":{"type":"integer"},"position":{"type":"integer"},"thumbnail":{"type":"string"},"product_id":{"type":"string"},"product_link":{"type":"string"},"extracted_price":{"type":"integer"},"multiple_sources":{"type":"boolean"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"page":{"type":"integer"},"type":{"type":"string"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}}}},"examples":{"Search 'playstation 5'. US/English":{"value":{"organic_results":[{"price":"$119.00","title":"Sony PlayStation 5 Pro Console","rating":4.5,"source":"UpTrade","reviews":780,"position":1,"thumbnail":"https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcPs5-pro","product_id":"17823632577842932598","product_link":"https://www.google.com/shopping/product/17823632577842932598","extracted_price":119,"multiple_sources":true},{"price":"$649.99","title":"PlayStation 5 Digital Console Marvel's Wolverine Limited Edition Bundle","rating":null,"source":"GameStop","reviews":null,"position":2,"thumbnail":"https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcWolverine","product_id":"9908583768713725158","product_link":"https://www.google.com/shopping/product/9908583768713725158","extracted_price":649.99,"multiple_sources":true},{"price":"$499.00","title":"Certified Refurbished PlayStation 5 Digital Edition Console Slim","rating":null,"source":"PlayStation","reviews":null,"position":3,"thumbnail":"https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcPs5-slim","product_id":"7126033585643939278","product_link":"https://www.google.com/shopping/product/7126033585643939278","extracted_price":499,"multiple_sources":false}],"search_parameters":{"q":"playstation 5","gl":"us","hl":"en","page":1,"type":"shopping","uule":null,"engine":"google","location":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Shopping","description":"Search Google Shopping and retrieve structured product listings with prices, ratings, merchants, and product IDs.\n\n**Credit cost:** 1 credit per call","operationId":"post-google-shopping","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Product search query on Google Shopping. Use a product name, brand, or category.\n\n**Examples:**\n- `playstation 5`: consoles and bundles\n- `sony wh-1000xm5`: a specific model\n- `iphone 16`: latest iPhone listings\n\n**Example:**\n\n    playstation 5","schema":{"type":"string","description":"Product search query on Google Shopping. Use a product name, brand, or category.\n\n**Examples:**\n- `playstation 5`: consoles and bundles\n- `sony wh-1000xm5`: a specific model\n- `iphone 16`: latest iPhone listings\n\n**Example:**\n\n    playstation 5"}},{"name":"page","in":"query","required":false,"description":"Page number of Shopping results. Each page returns about 20 products. There is no `num` parameter.\n\n- `1`: First page (default)\n- `2`: Second page, etc.","schema":{"type":"number","default":"1","description":"Page number of Shopping results. Each page returns about 20 products. There is no `num` parameter.\n\n- `1`: First page (default)\n- `2`: Second page, etc."}},{"name":"gl","in":"query","required":false,"description":"Two-letter country code for the Google Shopping country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us","schema":{"type":"string","default":"us","description":"Two-letter country code for the Google Shopping country context.\n\n- `us`: United States (default)\n- `fr`: France\n- `gb`: United Kingdom\n- `de`: Germany\n\n**Example:**\n\n    us"}},{"name":"hl","in":"query","required":false,"description":"Two-letter language code for the Google Shopping interface language.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en","schema":{"type":"string","default":"en","description":"Two-letter language code for the Google Shopping interface language.\n\n- `en`: English (default)\n- `fr`: French\n- `de`: German\n- `es`: Spanish\n\n**Example:**\n\n    en"}},{"name":"location","in":"query","required":false,"description":"City or region used to localize Shopping results. Simulates a search from that location and generates the UULE parameter automatically.\n\n**Examples:**\n```\nNew York, United States\n```\n\n```\nParis, France\n```\n\n```\nBerlin, Germany\n```","schema":{"type":"string","description":"City or region used to localize Shopping results. Simulates a search from that location and generates the UULE parameter automatically.\n\n**Examples:**\n```\nNew York, United States\n```\n\n```\nParis, France\n```\n\n```\nBerlin, Germany\n```"}},{"name":"uule","in":"query","required":false,"description":"Google-encoded location string (UULE) for precise geo-targeting. Use `location` instead if you do not already have an encoded value.","schema":{"type":"string","description":"Google-encoded location string (UULE) for precise geo-targeting. Use `location` instead if you do not already have an encoded value."}},{"name":"safe","in":"query","required":false,"description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default.","schema":{"type":"string","description":"Adult content filter. `active` enables Google SafeSearch; `off` disables it. Omit to use Google default."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"organic_results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string"},"title":{"type":"string"},"rating":{"type":"number"},"source":{"type":"string"},"reviews":{"type":"integer"},"position":{"type":"integer"},"thumbnail":{"type":"string"},"product_id":{"type":"string"},"product_link":{"type":"string"},"extracted_price":{"type":"integer"},"multiple_sources":{"type":"boolean"}}}},"search_parameters":{"type":"object","properties":{"q":{"type":"string"},"gl":{"type":"string"},"hl":{"type":"string"},"page":{"type":"integer"},"type":{"type":"string"},"uule":{"nullable":true},"engine":{"type":"string"},"location":{"nullable":true}}}}},"examples":{"Search 'playstation 5'. US/English":{"value":{"organic_results":[{"price":"$119.00","title":"Sony PlayStation 5 Pro Console","rating":4.5,"source":"UpTrade","reviews":780,"position":1,"thumbnail":"https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcPs5-pro","product_id":"17823632577842932598","product_link":"https://www.google.com/shopping/product/17823632577842932598","extracted_price":119,"multiple_sources":true},{"price":"$649.99","title":"PlayStation 5 Digital Console Marvel's Wolverine Limited Edition Bundle","rating":null,"source":"GameStop","reviews":null,"position":2,"thumbnail":"https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcWolverine","product_id":"9908583768713725158","product_link":"https://www.google.com/shopping/product/9908583768713725158","extracted_price":649.99,"multiple_sources":true},{"price":"$499.00","title":"Certified Refurbished PlayStation 5 Digital Edition Console Slim","rating":null,"source":"PlayStation","reviews":null,"position":3,"thumbnail":"https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcPs5-slim","product_id":"7126033585643939278","product_link":"https://www.google.com/shopping/product/7126033585643939278","extracted_price":499,"multiple_sources":false}],"search_parameters":{"q":"playstation 5","gl":"us","hl":"en","page":1,"type":"shopping","uule":null,"engine":"google","location":null}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/maps":{"get":{"summary":"Google Maps","description":"Extract comprehensive company data from Google Maps for enhanced business insights.\n\n**Credit cost:** 3 credits per call","operationId":"get-google-maps","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Business name or keyword to search for relevant data.","schema":{"type":"string","description":"Business name or keyword to search for relevant data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"rating":{"type":"number"},"address":{"type":"string"},"website":{"type":"string"},"coordinates":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"phone_number":{"type":"string"},"user_reviews":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string"},"rating":{"type":"integer"},"comment":{"type":"string"}}}}}}}}},"examples":{"Example":{"value":{"status":"OK","results":[{"name":"Restaurant Example 1","rating":4.5,"address":"123 Sample Street, Toulouse","website":"http://www.restaurantexample1.com","coordinates":{"lat":43.6,"lng":1.45},"phone_number":"+33 1 23 45 67 89","user_reviews":[{"user":"John Doe","rating":5,"comment":"Amazing food and ambiance."},{"user":"Jane Smith","rating":4,"comment":"Good service, but a bit pricey."}]},{"name":"Restaurant Example 2","rating":4,"address":"456 Demo Avenue, Toulouse","website":"http://www.restaurantexample2.com","coordinates":{"lat":43.605,"lng":1.455},"phone_number":"+33 1 98 76 54 32","user_reviews":[{"user":"Alice Brown","rating":5,"comment":"Fantastic vegetarian options!"},{"user":"Bob White","rating":3.5,"comment":"Nice place, but the food took a while to arrive."}]},{"name":"Restaurant Example 3","rating":3.8,"address":"789 Example Boulevard, Toulouse","website":"http://www.restaurantexample3.com","coordinates":{"lat":43.61,"lng":1.46},"phone_number":"+33 1 11 22 33 44","user_reviews":[{"user":"Charlie Black","rating":4,"comment":"Unique dishes and friendly staff."},{"user":"Dana Green","rating":3.5,"comment":"Could improve on cleanliness."}]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Maps","description":"Extract comprehensive company data from Google Maps for enhanced business insights.\n\n**Credit cost:** 3 credits per call","operationId":"post-google-maps","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Business name or keyword to search for relevant data.","schema":{"type":"string","description":"Business name or keyword to search for relevant data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"rating":{"type":"number"},"address":{"type":"string"},"website":{"type":"string"},"coordinates":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"phone_number":{"type":"string"},"user_reviews":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string"},"rating":{"type":"integer"},"comment":{"type":"string"}}}}}}}}},"examples":{"Example":{"value":{"status":"OK","results":[{"name":"Restaurant Example 1","rating":4.5,"address":"123 Sample Street, Toulouse","website":"http://www.restaurantexample1.com","coordinates":{"lat":43.6,"lng":1.45},"phone_number":"+33 1 23 45 67 89","user_reviews":[{"user":"John Doe","rating":5,"comment":"Amazing food and ambiance."},{"user":"Jane Smith","rating":4,"comment":"Good service, but a bit pricey."}]},{"name":"Restaurant Example 2","rating":4,"address":"456 Demo Avenue, Toulouse","website":"http://www.restaurantexample2.com","coordinates":{"lat":43.605,"lng":1.455},"phone_number":"+33 1 98 76 54 32","user_reviews":[{"user":"Alice Brown","rating":5,"comment":"Fantastic vegetarian options!"},{"user":"Bob White","rating":3.5,"comment":"Nice place, but the food took a while to arrive."}]},{"name":"Restaurant Example 3","rating":3.8,"address":"789 Example Boulevard, Toulouse","website":"http://www.restaurantexample3.com","coordinates":{"lat":43.61,"lng":1.46},"phone_number":"+33 1 11 22 33 44","user_reviews":[{"user":"Charlie Black","rating":4,"comment":"Unique dishes and friendly staff."},{"user":"Dana Green","rating":3.5,"comment":"Could improve on cleanliness."}]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/google/jobs":{"get":{"summary":"Google Jobs","description":"Extract job listings from Google Careers for enhanced recruitment and market analysis.\n\n**Credit cost:** 1 credit per call","operationId":"get-google-jobs","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Job search term or keyword for querying Google job listings.","schema":{"type":"string","description":"Job search term or keyword for querying Google job listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"location":{"type":"string"},"description":{"type":"string"}}}},"examples":{"Example":{"value":[{"title":"Software Engineer","category":"Engineering","location":"Mountain View, CA","description":"Develop and maintain software applications that impact millions of users."},{"title":"Data Scientist","category":"Data Analytics","location":"New York, NY","description":"Analyze large-scale datasets to derive meaningful insights and contribute to data-driven decision making."},{"title":"Product Manager","category":"Product Management","location":"San Francisco, CA","description":"Lead cross-functional teams to build and launch products that solve real customer problems."}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Google Jobs","description":"Extract job listings from Google Careers for enhanced recruitment and market analysis.\n\n**Credit cost:** 1 credit per call","operationId":"post-google-jobs","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Job search term or keyword for querying Google job listings.","schema":{"type":"string","description":"Job search term or keyword for querying Google job listings."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"location":{"type":"string"},"description":{"type":"string"}}}},"examples":{"Example":{"value":[{"title":"Software Engineer","category":"Engineering","location":"Mountain View, CA","description":"Develop and maintain software applications that impact millions of users."},{"title":"Data Scientist","category":"Data Analytics","location":"New York, NY","description":"Analyze large-scale datasets to derive meaningful insights and contribute to data-driven decision making."},{"title":"Product Manager","category":"Product Management","location":"San Francisco, CA","description":"Lead cross-functional teams to build and launch products that solve real customer problems."}]}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/costco/search":{"get":{"summary":"Costco Search","description":"Costco Search API: search product listings by keyword or URL across 13 regional Costco sites. Returns prices, availability, review counts and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-costco-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full regional search URL.\n\n**Examples:**\n\n```\nhome\n```\n\n```\nhome + region=fr\n```\n\n```\nhttps://www.costco.co.uk/search?text=sonos\n```\n\n```\nhttps://www.costco.ca/CatalogSearch?keyword=home&currentPage=2\n```\n\nFull URLs auto-detect region and pagination format. Use **Costco Product** on any result `url` for PDP details.","schema":{"type":"string","description":"Search keyword or full regional search URL.\n\n**Examples:**\n\n```\nhome\n```\n\n```\nhome + region=fr\n```\n\n```\nhttps://www.costco.co.uk/search?text=sonos\n```\n\n```\nhttps://www.costco.ca/CatalogSearch?keyword=home&currentPage=2\n```\n\nFull URLs auto-detect region and pagination format. Use **Costco Product** on any result `url` for PDP details."}},{"name":"region","in":"query","required":false,"description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```","schema":{"type":"string","description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```"}},{"name":"page","in":"query","required":false,"description":"1-based page number override. Uses `currentPage` (most regions) or `page` (UK) when rebuilding pagination URLs.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override. Uses `currentPage` (most regions) or `page` (UK) when rebuilding pagination URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"region":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"region":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'home' on costco.com (page 1)":{"value":{"results":[{"url":"https://www.costco.com/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn.product.4000266385.html","price":40.99,"title":"Mohawk Home 6MM Thick 9.4in X 47.8in 22 MIL Waterproof Luxury Vinyl Plank Flooring (15.65 sq ft/ctn)","region":"www.costco.com","currency":"USD","image_url":"https://bfasset.costco-static.com/U447IH35/as/6wxn2893r8g35r5p98jnkw2v/4000266385-847_tudoroak_1?auto=webp&format=jpg","product_id":"4000266385","availability":"delivery","review_count":84}],"pagination":{"next":"https://www.costco.com/s?keyword=home&currentPage=2","page":1,"region":"www.costco.com","per_page":24,"total_pages":36,"total_results":860}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Costco Search","description":"Costco Search API: search product listings by keyword or URL across 13 regional Costco sites. Returns prices, availability, review counts and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-costco-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full regional search URL.\n\n**Examples:**\n\n```\nhome\n```\n\n```\nhome + region=fr\n```\n\n```\nhttps://www.costco.co.uk/search?text=sonos\n```\n\n```\nhttps://www.costco.ca/CatalogSearch?keyword=home&currentPage=2\n```\n\nFull URLs auto-detect region and pagination format. Use **Costco Product** on any result `url` for PDP details.","schema":{"type":"string","description":"Search keyword or full regional search URL.\n\n**Examples:**\n\n```\nhome\n```\n\n```\nhome + region=fr\n```\n\n```\nhttps://www.costco.co.uk/search?text=sonos\n```\n\n```\nhttps://www.costco.ca/CatalogSearch?keyword=home&currentPage=2\n```\n\nFull URLs auto-detect region and pagination format. Use **Costco Product** on any result `url` for PDP details."}},{"name":"region","in":"query","required":false,"description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```","schema":{"type":"string","description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```"}},{"name":"page","in":"query","required":false,"description":"1-based page number override. Uses `currentPage` (most regions) or `page` (UK) when rebuilding pagination URLs.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number override. Uses `currentPage` (most regions) or `page` (UK) when rebuilding pagination URLs."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"number"},"title":{"type":"string"},"region":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"}}}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"page":{"type":"integer"},"region":{"type":"string"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'home' on costco.com (page 1)":{"value":{"results":[{"url":"https://www.costco.com/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn.product.4000266385.html","price":40.99,"title":"Mohawk Home 6MM Thick 9.4in X 47.8in 22 MIL Waterproof Luxury Vinyl Plank Flooring (15.65 sq ft/ctn)","region":"www.costco.com","currency":"USD","image_url":"https://bfasset.costco-static.com/U447IH35/as/6wxn2893r8g35r5p98jnkw2v/4000266385-847_tudoroak_1?auto=webp&format=jpg","product_id":"4000266385","availability":"delivery","review_count":84}],"pagination":{"next":"https://www.costco.com/s?keyword=home&currentPage=2","page":1,"region":"www.costco.com","per_page":24,"total_pages":36,"total_results":860}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/costco/product":{"get":{"summary":"Costco Product","description":"Costco Product API: fetch full product page data from a product ID or URL across regional Costco sites. Returns pricing, availability, ratings, images and breadcrumbs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-costco-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Costco product ID or full product URL.\n\n**Examples:**\n\n```\n4000266385\n```\n\n```\n4000268598 + region=ca\n```\n\n```\nhttps://www.costco.com/p/-/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn/4000266385\n```\n\n```\nhttps://www.costco.ca/nom.produit.product.4000268598.html\n```","schema":{"type":"string","description":"Costco product ID or full product URL.\n\n**Examples:**\n\n```\n4000266385\n```\n\n```\n4000268598 + region=ca\n```\n\n```\nhttps://www.costco.com/p/-/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn/4000266385\n```\n\n```\nhttps://www.costco.ca/nom.produit.product.4000268598.html\n```"}},{"name":"region","in":"query","required":false,"description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```","schema":{"type":"string","description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"item_number":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Product 4000266385 on costco.com":{"value":{"url":"https://www.costco.com/p/-/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn/4000266385","name":"Mohawk Home 6MM Thick 9.4in X 47.8in 22 MIL Waterproof Luxury Vinyl Plank Flooring (15.65 sq ft/ctn)","brand":"Mohawk Home","price":47.99,"images":["https://bfasset.costco-static.com/U447IH35/as/44xhpxq9ttr6nhpr4trsx53/4000266385-847_bloomingtonoak_1?auto=webp&format=jpg","https://bfasset.costco-static.com/U447IH35/as/6wxn2893r8g35r5p98jnkw2v/4000266385-847_tudoroak_1?auto=webp&format=jpg&width=727&height=727&fit=bounds&canvas=727%2C727"],"rating":3.68,"region":"www.costco.com","currency":"USD","image_url":"https://bfasset.costco-static.com/U447IH35/as/44xhpxq9ttr6nhpr4trsx53/4000266385-847_bloomingtonoak_1?auto=webp&format=jpg","product_id":"4000266385","breadcrumbs":["Home Improvement","Flooring","Vinyl Flooring"],"description":"SplashDefense® 100% Waterproof and Water-tight Joints;CleanProtect® Technology with Antimicrobial Properties Built in to Protect the Floor;Wide Plank Vinyl Flooring, 5mm Thick Plank + 1mm Attached Pad for Fast, Easy Installation and No Underlayment Required","item_number":"1806569","availability":"in_stock","review_count":84}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Costco Product","description":"Costco Product API: fetch full product page data from a product ID or URL across regional Costco sites. Returns pricing, availability, ratings, images and breadcrumbs via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-costco-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Costco product ID or full product URL.\n\n**Examples:**\n\n```\n4000266385\n```\n\n```\n4000268598 + region=ca\n```\n\n```\nhttps://www.costco.com/p/-/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn/4000266385\n```\n\n```\nhttps://www.costco.ca/nom.produit.product.4000268598.html\n```","schema":{"type":"string","description":"Costco product ID or full product URL.\n\n**Examples:**\n\n```\n4000266385\n```\n\n```\n4000268598 + region=ca\n```\n\n```\nhttps://www.costco.com/p/-/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn/4000266385\n```\n\n```\nhttps://www.costco.ca/nom.produit.product.4000268598.html\n```"}},{"name":"region","in":"query","required":false,"description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```","schema":{"type":"string","description":"Regional Costco site. Accepts a region code (`us`, `fr`, `ca`, `uk`, …) or full host (`www.costco.fr`). Defaults to US (`www.costco.com`) when omitted.\n\n**Examples:**\n\n```\nfr\n```\n\n```\nca\n```\n\n```\nwww.costco.co.uk\n```"}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string"},"price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"region":{"type":"string"},"currency":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"breadcrumbs":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"item_number":{"type":"string"},"availability":{"type":"string"},"review_count":{"type":"integer"}}},"examples":{"Product 4000266385 on costco.com":{"value":{"url":"https://www.costco.com/p/-/mohawk-home-6mm-thick-94in-x-478in-22-mil-waterproof-luxury-vinyl-plank-flooring-1565-sq-ftctn/4000266385","name":"Mohawk Home 6MM Thick 9.4in X 47.8in 22 MIL Waterproof Luxury Vinyl Plank Flooring (15.65 sq ft/ctn)","brand":"Mohawk Home","price":47.99,"images":["https://bfasset.costco-static.com/U447IH35/as/44xhpxq9ttr6nhpr4trsx53/4000266385-847_bloomingtonoak_1?auto=webp&format=jpg","https://bfasset.costco-static.com/U447IH35/as/6wxn2893r8g35r5p98jnkw2v/4000266385-847_tudoroak_1?auto=webp&format=jpg&width=727&height=727&fit=bounds&canvas=727%2C727"],"rating":3.68,"region":"www.costco.com","currency":"USD","image_url":"https://bfasset.costco-static.com/U447IH35/as/44xhpxq9ttr6nhpr4trsx53/4000266385-847_bloomingtonoak_1?auto=webp&format=jpg","product_id":"4000266385","breadcrumbs":["Home Improvement","Flooring","Vinyl Flooring"],"description":"SplashDefense® 100% Waterproof and Water-tight Joints;CleanProtect® Technology with Antimicrobial Properties Built in to Protect the Floor;Wide Plank Vinyl Flooring, 5mm Thick Plank + 1mm Attached Pad for Fast, Easy Installation and No Underlayment Required","item_number":"1806569","availability":"in_stock","review_count":84}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autotrader/search":{"get":{"summary":"Autotrader Search","description":"Search AutoTrader UK listings from a car-search URL and retrieve prices, specs, photos, seller info, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-autotrader-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoTrader UK car search URL.\n\n**Example 1 (used cars near London):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=1\n\n**Example 2 (page 2):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=2\n\n**Notes:**\n- Only `autotrader.co.uk` `/car-search` URLs are accepted.\n- Copy the full URL from autotrader.co.uk, including filters (`postcode`, `make`, `price`, etc.).\n- Pagination via `?page=2` in the URL.\n- AutoTrader search pages are JavaScript SPAs; this endpoint uses website rendering to scrape the rendered listing cards.\n- Use each result's `url` with the AutoTrader Ad endpoint for full vehicle data.","schema":{"type":"string","description":"Full AutoTrader UK car search URL.\n\n**Example 1 (used cars near London):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=1\n\n**Example 2 (page 2):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=2\n\n**Notes:**\n- Only `autotrader.co.uk` `/car-search` URLs are accepted.\n- Copy the full URL from autotrader.co.uk, including filters (`postcode`, `make`, `price`, etc.).\n- Pagination via `?page=2` in the URL.\n- AutoTrader search pages are JavaScript SPAs; this endpoint uses website rendering to scrape the rendered listing cards.\n- Use each result's `url` with the AutoTrader Ad endpoint for full vehicle data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"year":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"mileage":{"type":"string"},"location":{"type":"string"},"subtitle":{"type":"string"},"seller_type":{"type":"string"},"price_amount":{"type":"integer"},"attention_grabber":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search used cars near W1F 8EB London":{"value":{"results":[{"id":"202605302836426","url":"https://www.autotrader.co.uk/car-details/202605302836426?journey=FEATURED_LISTING_JOURNEY&sort=relevance&twcs=true&searchId=3e386cc3-ab04-4465-bc96-dc0210e1801f&page=1&postcode=W1F%208EB&advertising-location=at_cars&fromsra&backLinkQueryParams=channel%3Dcars%26postcode%3DW1F%25208EB%26price_search_type%3Dtotal%26sort%3Drelevance%26page%3D1%26flrfc%3D1","year":"2007 (07 reg)","image":"https://m.atcdn.co.uk/a/media/w480/a75ac2d47f854a5ebaf070a25c3fe883.jpg","price":"£2,500","title":"Ford Focus1.8 Sport S 5dr","images":["https://m.atcdn.co.uk/a/media/w480/a75ac2d47f854a5ebaf070a25c3fe883.jpg","https://m.atcdn.co.uk/a/media/w480/5f16246bee0e45d68ea4af8ee80b0d41.jpg"],"mileage":"93,018 miles","location":"Leicester","subtitle":"1.8 Sport S 5dr","seller_type":"dealer","price_amount":2500,"attention_grabber":"FULL SERVICE HISTORY+2 KEYS!!!"},{"id":"202606053041984","url":"https://www.autotrader.co.uk/car-details/202606053041984?sort=relevance&twcs=true&searchId=3e386cc3-ab04-4465-bc96-dc0210e1801f&page=1&postcode=W1F%208EB&advertising-location=at_cars&fromsra&backLinkQueryParams=channel%3Dcars%26postcode%3DW1F%25208EB%26price_search_type%3Dtotal%26sort%3Drelevance%26page%3D1%26flrfc%3D1","year":"2014 (14 reg)","image":"https://m.atcdn.co.uk/a/media/w480/27178641a4bc471ebd9a6ea3d1d388fe.jpg","price":"£3,795","title":"Toyota Prius1.5 CVT 4dr","images":["https://m.atcdn.co.uk/a/media/w480/27178641a4bc471ebd9a6ea3d1d388fe.jpg","https://m.atcdn.co.uk/a/media/w480/8834d446806d446c826019ae2ad60870.jpg"],"mileage":"82,000 miles","location":"Sidcup","subtitle":"1.5 CVT 4dr","seller_type":"dealer","price_amount":3795,"attention_grabber":"LOW MILEAGE|CHEAP INSURANCE"},{"id":"202605182478887","url":"https://www.autotrader.co.uk/car-details/202605182478887?sort=relevance&twcs=true&searchId=3e386cc3-ab04-4465-bc96-dc0210e1801f&page=1&postcode=W1F%208EB&advertising-location=at_cars&fromsra&backLinkQueryParams=channel%3Dcars%26postcode%3DW1F%25208EB%26price_search_type%3Dtotal%26sort%3Drelevance%26page%3D1%26flrfc%3D1","year":"2013 (13 reg)","image":"https://m.atcdn.co.uk/a/media/w480/e8979c3380f24cf6a9a36a09206eafd4.jpg","price":"£500","title":"Ford Fiesta1.0T EcoBoost Zetec Euro 5 (s/s) 3dr","images":["https://m.atcdn.co.uk/a/media/w480/e8979c3380f24cf6a9a36a09206eafd4.jpg","https://m.atcdn.co.uk/a/media/w480/216166463ac64cd8957e5ee02b4479d1.jpg"],"mileage":"89,000 miles","location":"Hughenden","subtitle":"1.0T EcoBoost Zetec Euro 5 (s/s) 3dr","seller_type":"dealer","price_amount":500,"attention_grabber":"Spares or repairs"}],"pagination":{"next":2,"current":1,"next_url":"https://www.autotrader.co.uk/car-search?page=2","per_page":25,"total_count":464626,"total_pages":18586,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Autotrader Search","description":"Search AutoTrader UK listings from a car-search URL and retrieve prices, specs, photos, seller info, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-autotrader-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoTrader UK car search URL.\n\n**Example 1 (used cars near London):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=1\n\n**Example 2 (page 2):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=2\n\n**Notes:**\n- Only `autotrader.co.uk` `/car-search` URLs are accepted.\n- Copy the full URL from autotrader.co.uk, including filters (`postcode`, `make`, `price`, etc.).\n- Pagination via `?page=2` in the URL.\n- AutoTrader search pages are JavaScript SPAs; this endpoint uses website rendering to scrape the rendered listing cards.\n- Use each result's `url` with the AutoTrader Ad endpoint for full vehicle data.","schema":{"type":"string","description":"Full AutoTrader UK car search URL.\n\n**Example 1 (used cars near London):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=1\n\n**Example 2 (page 2):**\n\n    https://www.autotrader.co.uk/car-search?channel=cars&postcode=W1F%208EB&price_search_type=total&sort=relevance&page=2\n\n**Notes:**\n- Only `autotrader.co.uk` `/car-search` URLs are accepted.\n- Copy the full URL from autotrader.co.uk, including filters (`postcode`, `make`, `price`, etc.).\n- Pagination via `?page=2` in the URL.\n- AutoTrader search pages are JavaScript SPAs; this endpoint uses website rendering to scrape the rendered listing cards.\n- Use each result's `url` with the AutoTrader Ad endpoint for full vehicle data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"year":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"mileage":{"type":"string"},"location":{"type":"string"},"subtitle":{"type":"string"},"seller_type":{"type":"string"},"price_amount":{"type":"integer"},"attention_grabber":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"integer"},"current":{"type":"integer"},"next_url":{"type":"string"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search used cars near W1F 8EB London":{"value":{"results":[{"id":"202605302836426","url":"https://www.autotrader.co.uk/car-details/202605302836426?journey=FEATURED_LISTING_JOURNEY&sort=relevance&twcs=true&searchId=3e386cc3-ab04-4465-bc96-dc0210e1801f&page=1&postcode=W1F%208EB&advertising-location=at_cars&fromsra&backLinkQueryParams=channel%3Dcars%26postcode%3DW1F%25208EB%26price_search_type%3Dtotal%26sort%3Drelevance%26page%3D1%26flrfc%3D1","year":"2007 (07 reg)","image":"https://m.atcdn.co.uk/a/media/w480/a75ac2d47f854a5ebaf070a25c3fe883.jpg","price":"£2,500","title":"Ford Focus1.8 Sport S 5dr","images":["https://m.atcdn.co.uk/a/media/w480/a75ac2d47f854a5ebaf070a25c3fe883.jpg","https://m.atcdn.co.uk/a/media/w480/5f16246bee0e45d68ea4af8ee80b0d41.jpg"],"mileage":"93,018 miles","location":"Leicester","subtitle":"1.8 Sport S 5dr","seller_type":"dealer","price_amount":2500,"attention_grabber":"FULL SERVICE HISTORY+2 KEYS!!!"},{"id":"202606053041984","url":"https://www.autotrader.co.uk/car-details/202606053041984?sort=relevance&twcs=true&searchId=3e386cc3-ab04-4465-bc96-dc0210e1801f&page=1&postcode=W1F%208EB&advertising-location=at_cars&fromsra&backLinkQueryParams=channel%3Dcars%26postcode%3DW1F%25208EB%26price_search_type%3Dtotal%26sort%3Drelevance%26page%3D1%26flrfc%3D1","year":"2014 (14 reg)","image":"https://m.atcdn.co.uk/a/media/w480/27178641a4bc471ebd9a6ea3d1d388fe.jpg","price":"£3,795","title":"Toyota Prius1.5 CVT 4dr","images":["https://m.atcdn.co.uk/a/media/w480/27178641a4bc471ebd9a6ea3d1d388fe.jpg","https://m.atcdn.co.uk/a/media/w480/8834d446806d446c826019ae2ad60870.jpg"],"mileage":"82,000 miles","location":"Sidcup","subtitle":"1.5 CVT 4dr","seller_type":"dealer","price_amount":3795,"attention_grabber":"LOW MILEAGE|CHEAP INSURANCE"},{"id":"202605182478887","url":"https://www.autotrader.co.uk/car-details/202605182478887?sort=relevance&twcs=true&searchId=3e386cc3-ab04-4465-bc96-dc0210e1801f&page=1&postcode=W1F%208EB&advertising-location=at_cars&fromsra&backLinkQueryParams=channel%3Dcars%26postcode%3DW1F%25208EB%26price_search_type%3Dtotal%26sort%3Drelevance%26page%3D1%26flrfc%3D1","year":"2013 (13 reg)","image":"https://m.atcdn.co.uk/a/media/w480/e8979c3380f24cf6a9a36a09206eafd4.jpg","price":"£500","title":"Ford Fiesta1.0T EcoBoost Zetec Euro 5 (s/s) 3dr","images":["https://m.atcdn.co.uk/a/media/w480/e8979c3380f24cf6a9a36a09206eafd4.jpg","https://m.atcdn.co.uk/a/media/w480/216166463ac64cd8957e5ee02b4479d1.jpg"],"mileage":"89,000 miles","location":"Hughenden","subtitle":"1.0T EcoBoost Zetec Euro 5 (s/s) 3dr","seller_type":"dealer","price_amount":500,"attention_grabber":"Spares or repairs"}],"pagination":{"next":2,"current":1,"next_url":"https://www.autotrader.co.uk/car-search?page=2","per_page":25,"total_count":464626,"total_pages":18586,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autotrader/ad":{"get":{"summary":"Autotrader Ad","description":"Extract full vehicle details from an AutoTrader UK car-details URL, including price, specs, gallery, seller, and description via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-autotrader-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoTrader UK car details URL.\n\n**Example:**\n\n    https://www.autotrader.co.uk/car-details/202606053030491\n\n**Notes:**\n- Only `/car-details/{id}` listing URLs on autotrader.co.uk are accepted.\n- Query parameters in the URL are ignored; the listing ID in the path is used.\n- AutoTrader advert pages are JavaScript SPAs; this endpoint uses website rendering to scrape price, specs, gallery, seller, and description from the rendered page.\n- Copy the listing URL from search results or from autotrader.co.uk.","schema":{"type":"string","description":"Full AutoTrader UK car details URL.\n\n**Example:**\n\n    https://www.autotrader.co.uk/car-details/202606053030491\n\n**Notes:**\n- Only `/car-details/{id}` listing URLs on autotrader.co.uk are accepted.\n- Query parameters in the URL are ignored; the listing ID in the path is used.\n- AutoTrader advert pages are JavaScript SPAs; this endpoint uses website rendering to scrape price, specs, gallery, seller, and description from the rendered page.\n- Copy the listing URL from search results or from autotrader.co.uk."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"phone":{"type":"string"},"rating":{"type":"number"},"location":{"type":"string"}}},"subtitle":{"nullable":true},"description":{"type":"string"},"price_amount":{"type":"integer"},"specifications":{"type":"object","properties":{"doors":{"type":"string"},"seats":{"type":"string"},"engine":{"type":"string"},"gearbox":{"type":"string"},"mileage":{"type":"string"},"body_type":{"type":"string"},"fuel_type":{"type":"string"},"body_colour":{"type":"string"},"registration":{"type":"string"},"emission_class":{"type":"string"}}},"reserve_available":{"type":"boolean"}}},"examples":{"Lookup 2011 Vauxhall Astra at Example Motors":{"value":{"id":"202606053030491","url":"https://www.autotrader.co.uk/car-details/202606053030491","image":"https://m.atcdn.co.uk/a/media/w800/ed2eccf887a74d7b99442845d25c21ce.jpg","price":"£2,499","title":"2011 Vauxhall Astra","images":["https://m.atcdn.co.uk/a/media/w800/ed2eccf887a74d7b99442845d25c21ce.jpg","https://m.atcdn.co.uk/a/media/w600/d0da32981b3e414e9cc118f4002bc0a2.jpg","https://m.atcdn.co.uk/a/media/w600/cba1aac371534b4581d54ebab50826e8.jpg","https://m.atcdn.co.uk/a/media/w600/b15422acf30941a39b601108d047f179.jpg","https://m.atcdn.co.uk/a/media/w600/32e08ec56ffe447a9f1a340b4113f3d4.jpg","https://m.atcdn.co.uk/a/media/w600/066c40651e4b4f949613f505839db631.jpg","https://m.atcdn.co.uk/a/media/w600/4343522b4f70426a9dcbc818364351d0.jpg"],"seller":{"name":"Example Motors","type":"dealer","phone":"555-0100","rating":4.8,"location":"Slough"},"subtitle":null,"description":"Example Motors present this Beautiful Vauxhall  Astra 1.4L petrol !!! A GREAT SPEC CAR with Low miles and ONLY 2 OWNERS FROM NEW !! Drives very smoothly and super comfortable to be in. Both engine and gearbox are smooth. Cheap to insure  and tax. Overall  a very economical car!\n\n● ELECTRIC HANDBRAKE \n● RUNS ANS DRIVED SMOOTHLY \n● Very low miles\n● ULEZ COMPLIANT ✅️ \n● We charge an admin fee of £199\n●  SERVICE HISTORY \n● Long MOT\n●AUTOMATIC \n● 2 KEYS 🔑 \n● Electric Hand Brake\n● Cruise Control \n● Tem...","price_amount":2499,"specifications":{"doors":"5","seats":"5","engine":"1.4L","gearbox":"Manual","mileage":"59,000 miles","body_type":"Hatchback","fuel_type":"Petrol","body_colour":"Silver","registration":"2011 (11 reg)","emission_class":"Euro 5"},"reserve_available":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Autotrader Ad","description":"Extract full vehicle details from an AutoTrader UK car-details URL, including price, specs, gallery, seller, and description via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-autotrader-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AutoTrader UK car details URL.\n\n**Example:**\n\n    https://www.autotrader.co.uk/car-details/202606053030491\n\n**Notes:**\n- Only `/car-details/{id}` listing URLs on autotrader.co.uk are accepted.\n- Query parameters in the URL are ignored; the listing ID in the path is used.\n- AutoTrader advert pages are JavaScript SPAs; this endpoint uses website rendering to scrape price, specs, gallery, seller, and description from the rendered page.\n- Copy the listing URL from search results or from autotrader.co.uk.","schema":{"type":"string","description":"Full AutoTrader UK car details URL.\n\n**Example:**\n\n    https://www.autotrader.co.uk/car-details/202606053030491\n\n**Notes:**\n- Only `/car-details/{id}` listing URLs on autotrader.co.uk are accepted.\n- Query parameters in the URL are ignored; the listing ID in the path is used.\n- AutoTrader advert pages are JavaScript SPAs; this endpoint uses website rendering to scrape price, specs, gallery, seller, and description from the rendered page.\n- Copy the listing URL from search results or from autotrader.co.uk."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"price":{"type":"string"},"title":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"phone":{"type":"string"},"rating":{"type":"number"},"location":{"type":"string"}}},"subtitle":{"nullable":true},"description":{"type":"string"},"price_amount":{"type":"integer"},"specifications":{"type":"object","properties":{"doors":{"type":"string"},"seats":{"type":"string"},"engine":{"type":"string"},"gearbox":{"type":"string"},"mileage":{"type":"string"},"body_type":{"type":"string"},"fuel_type":{"type":"string"},"body_colour":{"type":"string"},"registration":{"type":"string"},"emission_class":{"type":"string"}}},"reserve_available":{"type":"boolean"}}},"examples":{"Lookup 2011 Vauxhall Astra at Example Motors":{"value":{"id":"202606053030491","url":"https://www.autotrader.co.uk/car-details/202606053030491","image":"https://m.atcdn.co.uk/a/media/w800/ed2eccf887a74d7b99442845d25c21ce.jpg","price":"£2,499","title":"2011 Vauxhall Astra","images":["https://m.atcdn.co.uk/a/media/w800/ed2eccf887a74d7b99442845d25c21ce.jpg","https://m.atcdn.co.uk/a/media/w600/d0da32981b3e414e9cc118f4002bc0a2.jpg","https://m.atcdn.co.uk/a/media/w600/cba1aac371534b4581d54ebab50826e8.jpg","https://m.atcdn.co.uk/a/media/w600/b15422acf30941a39b601108d047f179.jpg","https://m.atcdn.co.uk/a/media/w600/32e08ec56ffe447a9f1a340b4113f3d4.jpg","https://m.atcdn.co.uk/a/media/w600/066c40651e4b4f949613f505839db631.jpg","https://m.atcdn.co.uk/a/media/w600/4343522b4f70426a9dcbc818364351d0.jpg"],"seller":{"name":"Example Motors","type":"dealer","phone":"555-0100","rating":4.8,"location":"Slough"},"subtitle":null,"description":"Example Motors present this Beautiful Vauxhall  Astra 1.4L petrol !!! A GREAT SPEC CAR with Low miles and ONLY 2 OWNERS FROM NEW !! Drives very smoothly and super comfortable to be in. Both engine and gearbox are smooth. Cheap to insure  and tax. Overall  a very economical car!\n\n● ELECTRIC HANDBRAKE \n● RUNS ANS DRIVED SMOOTHLY \n● Very low miles\n● ULEZ COMPLIANT ✅️ \n● We charge an admin fee of £199\n●  SERVICE HISTORY \n● Long MOT\n●AUTOMATIC \n● 2 KEYS 🔑 \n● Electric Hand Brake\n● Cruise Control \n● Tem...","price_amount":2499,"specifications":{"doors":"5","seats":"5","engine":"1.4L","gearbox":"Manual","mileage":"59,000 miles","body_type":"Hatchback","fuel_type":"Petrol","body_colour":"Silver","registration":"2011 (11 reg)","emission_class":"Euro 5"},"reserve_available":false}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autoeurope/search":{"get":{"summary":"Auto Europe Search","description":"Quote a rental car on Auto Europe. Pass pickup, pickup date, and dropoff date. Region chooses the country site and its currency. The whole quote comes back on one page.\n\n**Credit cost:** 1 credit per call","operationId":"get-autoeurope-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"pickup","in":"query","required":true,"description":"Pickup place or airport code.\n\n**Example:** CDG","schema":{"type":"string","description":"Pickup place or airport code.\n\n**Example:** CDG"}},{"name":"pickup_date","in":"query","required":true,"description":"Pickup date, YYYY-MM-DD.\n\n**Example:** 2026-11-06","schema":{"type":"string","description":"Pickup date, YYYY-MM-DD.\n\n**Example:** 2026-11-06"}},{"name":"dropoff_date","in":"query","required":true,"description":"Return date, YYYY-MM-DD, after pickup_date.\n\n**Example:** 2026-11-09","schema":{"type":"string","description":"Return date, YYYY-MM-DD, after pickup_date.\n\n**Example:** 2026-11-09"}},{"name":"region","in":"query","required":false,"description":"Country site. Default fr. Example: fr. A code such as de or uk, or a full Auto Europe URL. There is no page parameter.","schema":{"type":"string","description":"Country site. Default fr. Example: fr. A code such as de or uk, or a full Auto Europe URL. There is no page parameter."}},{"name":"dropoff","in":"query","required":false,"description":"Return place when it differs from pickup.","schema":{"type":"string","description":"Return place when it differs from pickup."}},{"name":"pickup_time","in":"query","required":false,"description":"Pickup time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Pickup time HH:MM. Default 10:00."}},{"name":"dropoff_time","in":"query","required":false,"description":"Return time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Return time HH:MM. Default 10:00."}},{"name":"driver_age","in":"query","required":false,"description":"Driver age from 18 to 99. Default 40.","schema":{"type":"number","description":"Driver age from 18 to 99. Default 40."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw quote HTML instead of JSON.","schema":{"type":"boolean","default":"false","description":"When true, return the raw quote HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"sipp":{"type":"string"},"doors":{"type":"integer"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"min_age":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"supplier":{"type":"string"},"is_luxury":{"type":"boolean"},"on_airport":{"type":"boolean"},"passengers":{"type":"integer"},"pickup_city":{"type":"string"},"pickup_date":{"type":"string"},"pickup_time":{"type":"string"},"rental_days":{"type":"integer"},"dropoff_city":{"type":"string"},"dropoff_date":{"type":"string"},"dropoff_time":{"type":"string"},"transmission":{"type":"string"},"price_display":{"type":"string"},"category_label":{"type":"string"},"pickup_country":{"type":"string"},"dropoff_country":{"type":"string"},"pickup_location":{"type":"string"},"air_conditioning":{"type":"boolean"},"dropoff_location":{"type":"string"},"unlimited_mileage":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"CDG, 6-9 Nov 2026, Fiat 500":{"value":{"results":[{"id":"3CD30DE2D9BE4CE8FC28E20D2702FCC7","name":"Fiat 500","sipp":"MBMR","doors":3,"image":"https://cdn.autoeurope.com/images/vehicles/jpg/medium/Fiat500_3.jpg","price":80.63,"region":"fr","min_age":26,"category":"mini","currency":"EUR","supplier":"EUROPCAR OPAQUE","is_luxury":false,"on_airport":true,"passengers":4,"pickup_city":"PARIS","pickup_date":"2026-11-06","pickup_time":"10:00","rental_days":3,"dropoff_city":"PARIS","dropoff_date":"2026-11-09","dropoff_time":"10:00","transmission":"manual","price_display":"€80.63","category_label":"Mini","pickup_country":"FR","dropoff_country":"FR","pickup_location":"Charles de Gaulle Airport - Terminal 1","air_conditioning":true,"dropoff_location":"Charles de Gaulle Airport - Terminal 1","unlimited_mileage":true}],"pagination":{"next":null,"page":1,"per_page":239,"total_pages":1,"total_results":239}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Auto Europe Search","description":"Quote a rental car on Auto Europe. Pass pickup, pickup date, and dropoff date. Region chooses the country site and its currency. The whole quote comes back on one page.\n\n**Credit cost:** 1 credit per call","operationId":"post-autoeurope-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"pickup","in":"query","required":true,"description":"Pickup place or airport code.\n\n**Example:** CDG","schema":{"type":"string","description":"Pickup place or airport code.\n\n**Example:** CDG"}},{"name":"pickup_date","in":"query","required":true,"description":"Pickup date, YYYY-MM-DD.\n\n**Example:** 2026-11-06","schema":{"type":"string","description":"Pickup date, YYYY-MM-DD.\n\n**Example:** 2026-11-06"}},{"name":"dropoff_date","in":"query","required":true,"description":"Return date, YYYY-MM-DD, after pickup_date.\n\n**Example:** 2026-11-09","schema":{"type":"string","description":"Return date, YYYY-MM-DD, after pickup_date.\n\n**Example:** 2026-11-09"}},{"name":"region","in":"query","required":false,"description":"Country site. Default fr. Example: fr. A code such as de or uk, or a full Auto Europe URL. There is no page parameter.","schema":{"type":"string","description":"Country site. Default fr. Example: fr. A code such as de or uk, or a full Auto Europe URL. There is no page parameter."}},{"name":"dropoff","in":"query","required":false,"description":"Return place when it differs from pickup.","schema":{"type":"string","description":"Return place when it differs from pickup."}},{"name":"pickup_time","in":"query","required":false,"description":"Pickup time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Pickup time HH:MM. Default 10:00."}},{"name":"dropoff_time","in":"query","required":false,"description":"Return time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Return time HH:MM. Default 10:00."}},{"name":"driver_age","in":"query","required":false,"description":"Driver age from 18 to 99. Default 40.","schema":{"type":"number","description":"Driver age from 18 to 99. Default 40."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw quote HTML instead of JSON.","schema":{"type":"boolean","default":"false","description":"When true, return the raw quote HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"sipp":{"type":"string"},"doors":{"type":"integer"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"min_age":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"supplier":{"type":"string"},"is_luxury":{"type":"boolean"},"on_airport":{"type":"boolean"},"passengers":{"type":"integer"},"pickup_city":{"type":"string"},"pickup_date":{"type":"string"},"pickup_time":{"type":"string"},"rental_days":{"type":"integer"},"dropoff_city":{"type":"string"},"dropoff_date":{"type":"string"},"dropoff_time":{"type":"string"},"transmission":{"type":"string"},"price_display":{"type":"string"},"category_label":{"type":"string"},"pickup_country":{"type":"string"},"dropoff_country":{"type":"string"},"pickup_location":{"type":"string"},"air_conditioning":{"type":"boolean"},"dropoff_location":{"type":"string"},"unlimited_mileage":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"next":{"nullable":true},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"CDG, 6-9 Nov 2026, Fiat 500":{"value":{"results":[{"id":"3CD30DE2D9BE4CE8FC28E20D2702FCC7","name":"Fiat 500","sipp":"MBMR","doors":3,"image":"https://cdn.autoeurope.com/images/vehicles/jpg/medium/Fiat500_3.jpg","price":80.63,"region":"fr","min_age":26,"category":"mini","currency":"EUR","supplier":"EUROPCAR OPAQUE","is_luxury":false,"on_airport":true,"passengers":4,"pickup_city":"PARIS","pickup_date":"2026-11-06","pickup_time":"10:00","rental_days":3,"dropoff_city":"PARIS","dropoff_date":"2026-11-09","dropoff_time":"10:00","transmission":"manual","price_display":"€80.63","category_label":"Mini","pickup_country":"FR","dropoff_country":"FR","pickup_location":"Charles de Gaulle Airport - Terminal 1","air_conditioning":true,"dropoff_location":"Charles de Gaulle Airport - Terminal 1","unlimited_mileage":true}],"pagination":{"next":null,"page":1,"per_page":239,"total_pages":1,"total_results":239}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/autoeurope/result":{"get":{"summary":"Auto Europe Result","description":"Read one vehicle from an Auto Europe quote. Pass the offer id from Search, with the same pickup and dates. You get the supplier, the SIPP code, and the package prices.\n\n**Credit cost:** 1 credit per call","operationId":"get-autoeurope-result","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"offer_id","in":"query","required":true,"description":"Vehicle id from search results[].id, or a package id of that vehicle.\n\n**Example:** 3CD30DE2D9BE4CE8FC28E20D2702FCC7","schema":{"type":"string","description":"Vehicle id from search results[].id, or a package id of that vehicle.\n\n**Example:** 3CD30DE2D9BE4CE8FC28E20D2702FCC7"}},{"name":"pickup","in":"query","required":true,"description":"Same pickup place as the search. Example: CDG","schema":{"type":"string","description":"Same pickup place as the search. Example: CDG"}},{"name":"pickup_date","in":"query","required":true,"description":"Same pickup date as the search, YYYY-MM-DD. Example: 2026-11-06","schema":{"type":"string","description":"Same pickup date as the search, YYYY-MM-DD. Example: 2026-11-06"}},{"name":"dropoff_date","in":"query","required":true,"description":"Same return date as the search, YYYY-MM-DD, after pickup_date. Example: 2026-11-09","schema":{"type":"string","description":"Same return date as the search, YYYY-MM-DD, after pickup_date. Example: 2026-11-09"}},{"name":"region","in":"query","required":false,"description":"Country site used for the search. Default fr. Example: fr. There is no page parameter.","schema":{"type":"string","description":"Country site used for the search. Default fr. Example: fr. There is no page parameter."}},{"name":"dropoff","in":"query","required":false,"description":"Return place when it differs from pickup.","schema":{"type":"string","description":"Return place when it differs from pickup."}},{"name":"pickup_time","in":"query","required":false,"description":"Pickup time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Pickup time HH:MM. Default 10:00."}},{"name":"dropoff_time","in":"query","required":false,"description":"Return time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Return time HH:MM. Default 10:00."}},{"name":"driver_age","in":"query","required":false,"description":"Driver age from 18 to 99. Default 40.","schema":{"type":"number","description":"Driver age from 18 to 99. Default 40."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw quote HTML instead of JSON.","schema":{"type":"boolean","default":"false","description":"When true, return the raw quote HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"sipp":{"type":"string"},"doors":{"type":"integer"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"max_age":{"type":"integer"},"min_age":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"packages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sipp":{"type":"string"},"price":{"type":"number"},"package":{"type":"string"},"location_name":{"type":"string"},"price_display":{"type":"string"}}}},"quote_id":{"type":"integer"},"supplier":{"type":"string"},"is_luxury":{"type":"boolean"},"inclusions":{"type":"array","items":{"type":"string"}},"on_airport":{"type":"boolean"},"passengers":{"type":"integer"},"fuel_policy":{"type":"string"},"pickup_city":{"type":"string"},"pickup_date":{"type":"string"},"pickup_time":{"type":"string"},"rental_days":{"type":"integer"},"dropoff_city":{"type":"string"},"dropoff_date":{"type":"string"},"dropoff_time":{"type":"string"},"transmission":{"type":"string"},"large_luggage":{"type":"integer"},"price_display":{"type":"string"},"small_luggage":{"type":"integer"},"supplier_logo":{"type":"string"},"category_label":{"type":"string"},"medium_luggage":{"type":"integer"},"pickup_country":{"type":"string"},"dropoff_country":{"type":"string"},"pickup_location":{"type":"string"},"air_conditioning":{"type":"boolean"},"dropoff_location":{"type":"string"},"security_deposit":{"type":"integer"},"supplier_location":{"type":"string"},"unlimited_mileage":{"type":"boolean"}}},"examples":{"CDG, 6-9 Nov 2026, Fiat 500":{"value":{"id":"3CD30DE2D9BE4CE8FC28E20D2702FCC7","name":"Fiat 500","sipp":"MBMR","doors":3,"image":"https://cdn.autoeurope.com/images/vehicles/jpg/medium/Fiat500_3.jpg","price":80.63,"region":"fr","max_age":99,"min_age":26,"category":"mini","currency":"EUR","packages":[{"id":"II-73-MBMR-0008235984","sipp":"MBMR","price":80.63,"package":"inclusive","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","price_display":"€80.63"},{"id":"II-73-MBMR-0008235985","sipp":"MBMR","price":80.63,"package":"inclusive","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 2D","price_display":"€80.63"},{"id":"IZ-74-MBMRZQ-0008235984","sipp":"MBMRZQ","price":96.63,"package":"ZQ","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","price_display":"€96.63"},{"id":"IZ-74-MBMRZQ-0008235985","sipp":"MBMRZQ","price":96.63,"package":"ZQ","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 2D","price_display":"€96.63"},{"id":"IZ-75-MBMRZR-0008235984","sipp":"MBMRZR","price":103.63,"package":"ZR","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","price_display":"€103.63"},{"id":"IZ-75-MBMRZR-0008235985","sipp":"MBMRZR","price":103.63,"package":"ZR","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 2D","price_display":"€103.63"}],"quote_id":454710552,"supplier":"EUROPCAR OPAQUE","is_luxury":false,"inclusions":["Supplément environnemental","Taxe routière","Supplément d'utilisation d'autoroute"],"on_airport":true,"passengers":4,"fuel_policy":"Réservoir plein - Réservoir plein","pickup_city":"PARIS","pickup_date":"2026-11-06","pickup_time":"10:00","rental_days":3,"dropoff_city":"PARIS","dropoff_date":"2026-11-09","dropoff_time":"10:00","transmission":"manual","large_luggage":0,"price_display":"€80.63","small_luggage":2,"supplier_logo":"https://www.globalmediaserver.com/img/suppLogo/europcaropaque.png","category_label":"Mini","medium_luggage":0,"pickup_country":"FR","dropoff_country":"FR","pickup_location":"Charles de Gaulle Airport - Terminal 1","air_conditioning":true,"dropoff_location":"Charles de Gaulle Airport - Terminal 1","security_deposit":500,"supplier_location":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","unlimited_mileage":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Auto Europe Result","description":"Read one vehicle from an Auto Europe quote. Pass the offer id from Search, with the same pickup and dates. You get the supplier, the SIPP code, and the package prices.\n\n**Credit cost:** 1 credit per call","operationId":"post-autoeurope-result","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"offer_id","in":"query","required":true,"description":"Vehicle id from search results[].id, or a package id of that vehicle.\n\n**Example:** 3CD30DE2D9BE4CE8FC28E20D2702FCC7","schema":{"type":"string","description":"Vehicle id from search results[].id, or a package id of that vehicle.\n\n**Example:** 3CD30DE2D9BE4CE8FC28E20D2702FCC7"}},{"name":"pickup","in":"query","required":true,"description":"Same pickup place as the search. Example: CDG","schema":{"type":"string","description":"Same pickup place as the search. Example: CDG"}},{"name":"pickup_date","in":"query","required":true,"description":"Same pickup date as the search, YYYY-MM-DD. Example: 2026-11-06","schema":{"type":"string","description":"Same pickup date as the search, YYYY-MM-DD. Example: 2026-11-06"}},{"name":"dropoff_date","in":"query","required":true,"description":"Same return date as the search, YYYY-MM-DD, after pickup_date. Example: 2026-11-09","schema":{"type":"string","description":"Same return date as the search, YYYY-MM-DD, after pickup_date. Example: 2026-11-09"}},{"name":"region","in":"query","required":false,"description":"Country site used for the search. Default fr. Example: fr. There is no page parameter.","schema":{"type":"string","description":"Country site used for the search. Default fr. Example: fr. There is no page parameter."}},{"name":"dropoff","in":"query","required":false,"description":"Return place when it differs from pickup.","schema":{"type":"string","description":"Return place when it differs from pickup."}},{"name":"pickup_time","in":"query","required":false,"description":"Pickup time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Pickup time HH:MM. Default 10:00."}},{"name":"dropoff_time","in":"query","required":false,"description":"Return time HH:MM. Default 10:00.","schema":{"type":"string","default":"10:00","description":"Return time HH:MM. Default 10:00."}},{"name":"driver_age","in":"query","required":false,"description":"Driver age from 18 to 99. Default 40.","schema":{"type":"number","description":"Driver age from 18 to 99. Default 40."}},{"name":"return_page_source","in":"query","required":false,"description":"When true, return the raw quote HTML instead of JSON.","schema":{"type":"boolean","default":"false","description":"When true, return the raw quote HTML instead of JSON."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"sipp":{"type":"string"},"doors":{"type":"integer"},"image":{"type":"string"},"price":{"type":"number"},"region":{"type":"string"},"max_age":{"type":"integer"},"min_age":{"type":"integer"},"category":{"type":"string"},"currency":{"type":"string"},"packages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sipp":{"type":"string"},"price":{"type":"number"},"package":{"type":"string"},"location_name":{"type":"string"},"price_display":{"type":"string"}}}},"quote_id":{"type":"integer"},"supplier":{"type":"string"},"is_luxury":{"type":"boolean"},"inclusions":{"type":"array","items":{"type":"string"}},"on_airport":{"type":"boolean"},"passengers":{"type":"integer"},"fuel_policy":{"type":"string"},"pickup_city":{"type":"string"},"pickup_date":{"type":"string"},"pickup_time":{"type":"string"},"rental_days":{"type":"integer"},"dropoff_city":{"type":"string"},"dropoff_date":{"type":"string"},"dropoff_time":{"type":"string"},"transmission":{"type":"string"},"large_luggage":{"type":"integer"},"price_display":{"type":"string"},"small_luggage":{"type":"integer"},"supplier_logo":{"type":"string"},"category_label":{"type":"string"},"medium_luggage":{"type":"integer"},"pickup_country":{"type":"string"},"dropoff_country":{"type":"string"},"pickup_location":{"type":"string"},"air_conditioning":{"type":"boolean"},"dropoff_location":{"type":"string"},"security_deposit":{"type":"integer"},"supplier_location":{"type":"string"},"unlimited_mileage":{"type":"boolean"}}},"examples":{"CDG, 6-9 Nov 2026, Fiat 500":{"value":{"id":"3CD30DE2D9BE4CE8FC28E20D2702FCC7","name":"Fiat 500","sipp":"MBMR","doors":3,"image":"https://cdn.autoeurope.com/images/vehicles/jpg/medium/Fiat500_3.jpg","price":80.63,"region":"fr","max_age":99,"min_age":26,"category":"mini","currency":"EUR","packages":[{"id":"II-73-MBMR-0008235984","sipp":"MBMR","price":80.63,"package":"inclusive","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","price_display":"€80.63"},{"id":"II-73-MBMR-0008235985","sipp":"MBMR","price":80.63,"package":"inclusive","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 2D","price_display":"€80.63"},{"id":"IZ-74-MBMRZQ-0008235984","sipp":"MBMRZQ","price":96.63,"package":"ZQ","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","price_display":"€96.63"},{"id":"IZ-74-MBMRZQ-0008235985","sipp":"MBMRZQ","price":96.63,"package":"ZQ","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 2D","price_display":"€96.63"},{"id":"IZ-75-MBMRZR-0008235984","sipp":"MBMRZR","price":103.63,"package":"ZR","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","price_display":"€103.63"},{"id":"IZ-75-MBMRZR-0008235985","sipp":"MBMRZR","price":103.63,"package":"ZR","location_name":"Aéroport de Paris-Charles-de-Gaulle, Terminal 2D","price_display":"€103.63"}],"quote_id":454710552,"supplier":"EUROPCAR OPAQUE","is_luxury":false,"inclusions":["Supplément environnemental","Taxe routière","Supplément d'utilisation d'autoroute"],"on_airport":true,"passengers":4,"fuel_policy":"Réservoir plein - Réservoir plein","pickup_city":"PARIS","pickup_date":"2026-11-06","pickup_time":"10:00","rental_days":3,"dropoff_city":"PARIS","dropoff_date":"2026-11-09","dropoff_time":"10:00","transmission":"manual","large_luggage":0,"price_display":"€80.63","small_luggage":2,"supplier_logo":"https://www.globalmediaserver.com/img/suppLogo/europcaropaque.png","category_label":"Mini","medium_luggage":0,"pickup_country":"FR","dropoff_country":"FR","pickup_location":"Charles de Gaulle Airport - Terminal 1","air_conditioning":true,"dropoff_location":"Charles de Gaulle Airport - Terminal 1","security_deposit":500,"supplier_location":"Aéroport de Paris-Charles-de-Gaulle, Terminal 1","unlimited_mileage":true}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/apartments/search":{"get":{"summary":"Apartments Search","description":"Search Apartments.com rentals from a full city or browse URL and retrieve prices, photos, addresses, phone numbers, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-apartments-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Apartments.com search or city browse URL.\n\n**Example 1 (New York, page 3):**\n\n    https://www.apartments.com/new-york-ny/3\n\n**Example 2 (page 1):**\n\n    https://www.apartments.com/new-york-ny/\n\n**Notes:**\n- Only `apartments.com` listing search URLs are accepted.\n- Copy the full URL from apartments.com, including city slug and page number in the path (`/new-york-ny/3`).\n- Pagination uses the page segment in the URL path (`/2/`, `/3/`, ...). `pagination.next_url` points to the next page.\n- Apartments.com search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the Apartments Property endpoint for full unit data.","schema":{"type":"string","description":"Full Apartments.com search or city browse URL.\n\n**Example 1 (New York, page 3):**\n\n    https://www.apartments.com/new-york-ny/3\n\n**Example 2 (page 1):**\n\n    https://www.apartments.com/new-york-ny/\n\n**Notes:**\n- Only `apartments.com` listing search URLs are accepted.\n- Copy the full URL from apartments.com, including city slug and page number in the path (`/new-york-ny/3`).\n- Pagination uses the page segment in the URL path (`/2/`, `/3/`, ...). `pagination.next_url` points to the next page.\n- Apartments.com search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the Apartments Property endpoint for full unit data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"address":{"type":"string"},"pricing":{"type":"array","items":{"type":"object","properties":{"beds":{"type":"string"},"price":{"type":"string"}}}},"has_video":{"type":"boolean"},"min_price":{"type":"integer"},"image_count":{"type":"integer"},"country_code":{"type":"string"},"property_type":{"type":"string"},"street_address":{"type":"string"},"has_virtual_tour":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"current":{"type":"integer"},"next_url":{"type":"string"},"total_count":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search rentals in New York, page 3":{"value":{"results":[{"id":"p6b4mes","url":"https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/","image":"https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/118/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","phone":"8555266751","title":"141 E 33rd St Unit SI FL16-ID43","address":"141 E 33rd St, New York, NY 10016","pricing":[{"beds":"2 Beds","price":"$7,210"}],"has_video":false,"min_price":7210,"image_count":23,"country_code":"US","property_type":"Apartment for Rent","street_address":"141 E 33rd St","has_virtual_tour":true},{"id":"kkt0hfb","url":"https://www.apartments.com/53-park-pl-new-york-ny-unit-si-fl3-id53/kkt0hfb/","image":"https://images1.apartments.com/i2/6wscRtCcX-3nE67ze4o41rAW9_6LCo0nJX22IYicrAk/118/53-park-pl-unit-si-fl3-id53-new-york-ny-building-photo.jpg?p=1","phone":"8555289504","title":"53 Park Pl Unit SI FL3-ID53","address":"53 Park Pl, New York, NY 10007","pricing":[{"beds":"Studio","price":"$5,110"}],"has_video":false,"min_price":5110,"image_count":28,"country_code":"US","property_type":"Apartment for Rent","street_address":"53 Park Pl","has_virtual_tour":true},{"id":"khk0kyc","url":"https://www.apartments.com/53-park-pl-new-york-ny-unit-si-fl10-id54/khk0kyc/","image":"https://images1.apartments.com/i2/P4YtFr_qFvkB4rsy5m33Qw2UUAu-hNz4xmlBmvbum8I/118/53-park-pl-unit-si-fl10-id54-new-york-ny-building-photo.jpg?p=1","phone":"5512272189","title":"53 Park Pl Unit SI FL10-ID54","address":"53 Park Pl, New York, NY 10007","pricing":[{"beds":"1 Bed","price":"$7,190"}],"has_video":false,"min_price":7190,"image_count":31,"country_code":"US","property_type":"Apartment for Rent","street_address":"53 Park Pl","has_virtual_tour":true}],"pagination":{"current":3,"next_url":"https://www.apartments.com/new-york-ny/4/","total_count":7775,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Apartments Search","description":"Search Apartments.com rentals from a full city or browse URL and retrieve prices, photos, addresses, phone numbers, and pagination via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-apartments-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Apartments.com search or city browse URL.\n\n**Example 1 (New York, page 3):**\n\n    https://www.apartments.com/new-york-ny/3\n\n**Example 2 (page 1):**\n\n    https://www.apartments.com/new-york-ny/\n\n**Notes:**\n- Only `apartments.com` listing search URLs are accepted.\n- Copy the full URL from apartments.com, including city slug and page number in the path (`/new-york-ny/3`).\n- Pagination uses the page segment in the URL path (`/2/`, `/3/`, ...). `pagination.next_url` points to the next page.\n- Apartments.com search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the Apartments Property endpoint for full unit data.","schema":{"type":"string","description":"Full Apartments.com search or city browse URL.\n\n**Example 1 (New York, page 3):**\n\n    https://www.apartments.com/new-york-ny/3\n\n**Example 2 (page 1):**\n\n    https://www.apartments.com/new-york-ny/\n\n**Notes:**\n- Only `apartments.com` listing search URLs are accepted.\n- Copy the full URL from apartments.com, including city slug and page number in the path (`/new-york-ny/3`).\n- Pagination uses the page segment in the URL path (`/2/`, `/3/`, ...). `pagination.next_url` points to the next page.\n- Apartments.com search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.\n- Pass each result's `url` to the Apartments Property endpoint for full unit data."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"address":{"type":"string"},"pricing":{"type":"array","items":{"type":"object","properties":{"beds":{"type":"string"},"price":{"type":"string"}}}},"has_video":{"type":"boolean"},"min_price":{"type":"integer"},"image_count":{"type":"integer"},"country_code":{"type":"string"},"property_type":{"type":"string"},"street_address":{"type":"string"},"has_virtual_tour":{"type":"boolean"}}}},"pagination":{"type":"object","properties":{"current":{"type":"integer"},"next_url":{"type":"string"},"total_count":{"type":"integer"},"has_next_page":{"type":"boolean"}}}}},"examples":{"Search rentals in New York, page 3":{"value":{"results":[{"id":"p6b4mes","url":"https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/","image":"https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/118/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","phone":"8555266751","title":"141 E 33rd St Unit SI FL16-ID43","address":"141 E 33rd St, New York, NY 10016","pricing":[{"beds":"2 Beds","price":"$7,210"}],"has_video":false,"min_price":7210,"image_count":23,"country_code":"US","property_type":"Apartment for Rent","street_address":"141 E 33rd St","has_virtual_tour":true},{"id":"kkt0hfb","url":"https://www.apartments.com/53-park-pl-new-york-ny-unit-si-fl3-id53/kkt0hfb/","image":"https://images1.apartments.com/i2/6wscRtCcX-3nE67ze4o41rAW9_6LCo0nJX22IYicrAk/118/53-park-pl-unit-si-fl3-id53-new-york-ny-building-photo.jpg?p=1","phone":"8555289504","title":"53 Park Pl Unit SI FL3-ID53","address":"53 Park Pl, New York, NY 10007","pricing":[{"beds":"Studio","price":"$5,110"}],"has_video":false,"min_price":5110,"image_count":28,"country_code":"US","property_type":"Apartment for Rent","street_address":"53 Park Pl","has_virtual_tour":true},{"id":"khk0kyc","url":"https://www.apartments.com/53-park-pl-new-york-ny-unit-si-fl10-id54/khk0kyc/","image":"https://images1.apartments.com/i2/P4YtFr_qFvkB4rsy5m33Qw2UUAu-hNz4xmlBmvbum8I/118/53-park-pl-unit-si-fl10-id54-new-york-ny-building-photo.jpg?p=1","phone":"5512272189","title":"53 Park Pl Unit SI FL10-ID54","address":"53 Park Pl, New York, NY 10007","pricing":[{"beds":"1 Bed","price":"$7,190"}],"has_video":false,"min_price":7190,"image_count":31,"country_code":"US","property_type":"Apartment for Rent","street_address":"53 Park Pl","has_virtual_tour":true}],"pagination":{"current":3,"next_url":"https://www.apartments.com/new-york-ny/4/","total_count":7775,"has_next_page":true}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/apartments/property":{"get":{"summary":"Apartments Property","description":"Extract a full Apartments.com rental listing from a property URL, including amenities, gallery, description, geolocation, and unit details via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-apartments-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Apartments.com property listing URL.\n\n**Example:**\n\n    https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/\n\n**Notes:**\n- Only property URLs on `apartments.com` with an ID slug (e.g. `/p6b4mes/`) are accepted.\n- Property detail pages are JavaScript SPAs; this endpoint uses website rendering to extract photos, amenities, description, and geolocation.\n- Copy the listing URL from search results or from apartments.com.","schema":{"type":"string","description":"Full Apartments.com property listing URL.\n\n**Example:**\n\n    https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/\n\n**Notes:**\n- Only property URLs on `apartments.com` with an ID slug (e.g. `/p6b4mes/`) are accepted.\n- Property detail pages are JavaScript SPAs; this endpoint uses website rendering to extract photos, amenities, description, and geolocation.\n- Copy the listing URL from search results or from apartments.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"units":{"type":"array","items":{}},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"bedrooms":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"string"},"rent_range":{"nullable":true},"description":{"type":"string"},"geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"square_feet":{"type":"string"}}},"examples":{"Lookup 141 E 33rd St, New York":{"value":{"id":"p6b4mes","url":"https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/","image":"https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/111/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-primary-photo.jpg?p=1","phone":"8555266751","title":"$7,210","units":[],"images":["https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/111/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-primary-photo.jpg?p=1","https://images1.apartments.com/i2/_LYYrJa6ncHlDFoi81j_UsjuW84Nvn4w9YGihAPQA3o/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","https://images1.apartments.com/i2/XSVQGO_3LitnwCCtEhZTwYhxNmk86nNac9DzNVS_eg8/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","https://images1.apartments.com/i2/KCjnNj_AfdQg2j-NlhNv0snlvJb2qptQy8_wG0jfEb4/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","https://images1.apartments.com/i2/Fof83ipViTC_uNqRZlf41AfpD7t1xs4eGFBN78nzXNY/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1"],"address":"New York, NY 10016","bedrooms":"2","amenities":["Wi-Fi","Air Conditioning","Heating","Dishwasher","Kitchen","Microwave","Oven","Refrigerator","Freezer","Furnished","Doorman","Elevator","Corporate Suites","Fitness Center"],"bathrooms":"1.5","rent_range":null,"description":"141 E 33rd St Unit SI FL16-ID43\n\n1 - 12 Month Lease , Available Aug 9\n\nFeel at home wherever you choose to live with Blueground. You’ll love this sophisticated Kips Bay furnished two bedroom apartment with its modern decor, fully equipped kitchen, and bright living room with great high floor views. Ideally located, you’re close to all the best that New York has to offer! (ID #NYC43)\n\nThe advertised rate of $7,210/month is the lowest available price, based on a 12 month(s) stay with a move-in date of August 9, 2026. \n\nRates vary depending on the duration of stay, season, and other parameters. For exact pricing and additional pricing components, please visit our website and enter your desired move-in and move-out dates. The rate is applicable when billed upfront; it can be higher if billed in multiple payments.\nBrokers are welcome to reach out.\n\nWere you looking for an unfurnished lease? Try Blueground instead and upgrade from unfurnished to furnished living:\n  - Furnished at rates comparable to unfurnished\n  - No setup or furniture costs - save thousands\n  - Move-in ready - save time, just bring your suitcase\n\nDesigned with you in mind\n\nGorgeous furniture, fully equipped kitchen, smart TV, and a premium wireless speaker are just a few of the amenities you’ll find inside this two bedroom apartment. Ideally located in New York, you’ll find a lot to love outside as well. When you’re ready to relax, you’ll be happy to discover every Blueground bedroom comes with superior quality mattresses, fully stocked linens, and cozy towels. We handle everything so you can simply show up and start living. \n\nSleeping arrangements\n\n      Queen Bed, 63in/160cm\n      Queen Bed, 63in/160cm\n\nAmenities\n\nBuilding amenities unique to this two bedroom apartment include an on-site:\n\n  - Doorman\n  - Dryer in building\n  - Elevator\n  - Washing machine in building\n  - Pets allowed\n\nArrival and ongoing support\n\nThe entire apartment is yours to enjoy!\n\nThroughout your stay, you’ll have access to our Client Experience team through the Blueground App. You can schedule additional cleanings, submit maintenance requests, and view our neighborhood recommendations with just a few taps.\n\nWe’ll share all details upon confirmation of your stay.\n\nIdeally Located\n\nThis furnished property is situated in Kips Bay. Stretching from the East River to Lexington Avenue, the peaceful neighborhood offers convenience and easy access to the rest of the city. Several hospitals are located here, making it a hub for medical care. Kips Bay offers dining options for every budget as well as numerous cinemas and fitness centers. During the weekends, locals stroll alongside the water, take the water taxi to another borough, or hang out in one of the parks, such as Bellevue South. From here, Rockefeller Center is only 20 minutes away by subway.\n\nOther things to note\n\nThis Blueground apartment has flexible lease options, allowing you to book it for one month, a year, or more.\nPets are welcome, though weight limits and breed restrictions apply and may incur fees.\nBrokes CYOF.\nWe take great pride in ensuring every photo displayed is shot in our own units with our actual furnishings. That said, we regularly refresh our decor and furniture arrangement, which may differ from what’s pictured.\n [SI]","geolocation":{"latitude":40.74576,"longitude":-73.97978},"square_feet":"850 sq ft"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Apartments Property","description":"Extract a full Apartments.com rental listing from a property URL, including amenities, gallery, description, geolocation, and unit details via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-apartments-property","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Apartments.com property listing URL.\n\n**Example:**\n\n    https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/\n\n**Notes:**\n- Only property URLs on `apartments.com` with an ID slug (e.g. `/p6b4mes/`) are accepted.\n- Property detail pages are JavaScript SPAs; this endpoint uses website rendering to extract photos, amenities, description, and geolocation.\n- Copy the listing URL from search results or from apartments.com.","schema":{"type":"string","description":"Full Apartments.com property listing URL.\n\n**Example:**\n\n    https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/\n\n**Notes:**\n- Only property URLs on `apartments.com` with an ID slug (e.g. `/p6b4mes/`) are accepted.\n- Property detail pages are JavaScript SPAs; this endpoint uses website rendering to extract photos, amenities, description, and geolocation.\n- Copy the listing URL from search results or from apartments.com."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"phone":{"type":"string"},"title":{"type":"string"},"units":{"type":"array","items":{}},"images":{"type":"array","items":{"type":"string"}},"address":{"type":"string"},"bedrooms":{"type":"string"},"amenities":{"type":"array","items":{"type":"string"}},"bathrooms":{"type":"string"},"rent_range":{"nullable":true},"description":{"type":"string"},"geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"square_feet":{"type":"string"}}},"examples":{"Lookup 141 E 33rd St, New York":{"value":{"id":"p6b4mes","url":"https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/","image":"https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/111/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-primary-photo.jpg?p=1","phone":"8555266751","title":"$7,210","units":[],"images":["https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/111/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-primary-photo.jpg?p=1","https://images1.apartments.com/i2/_LYYrJa6ncHlDFoi81j_UsjuW84Nvn4w9YGihAPQA3o/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","https://images1.apartments.com/i2/XSVQGO_3LitnwCCtEhZTwYhxNmk86nNac9DzNVS_eg8/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","https://images1.apartments.com/i2/KCjnNj_AfdQg2j-NlhNv0snlvJb2qptQy8_wG0jfEb4/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1","https://images1.apartments.com/i2/Fof83ipViTC_uNqRZlf41AfpD7t1xs4eGFBN78nzXNY/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1"],"address":"New York, NY 10016","bedrooms":"2","amenities":["Wi-Fi","Air Conditioning","Heating","Dishwasher","Kitchen","Microwave","Oven","Refrigerator","Freezer","Furnished","Doorman","Elevator","Corporate Suites","Fitness Center"],"bathrooms":"1.5","rent_range":null,"description":"141 E 33rd St Unit SI FL16-ID43\n\n1 - 12 Month Lease , Available Aug 9\n\nFeel at home wherever you choose to live with Blueground. You’ll love this sophisticated Kips Bay furnished two bedroom apartment with its modern decor, fully equipped kitchen, and bright living room with great high floor views. Ideally located, you’re close to all the best that New York has to offer! (ID #NYC43)\n\nThe advertised rate of $7,210/month is the lowest available price, based on a 12 month(s) stay with a move-in date of August 9, 2026. \n\nRates vary depending on the duration of stay, season, and other parameters. For exact pricing and additional pricing components, please visit our website and enter your desired move-in and move-out dates. The rate is applicable when billed upfront; it can be higher if billed in multiple payments.\nBrokers are welcome to reach out.\n\nWere you looking for an unfurnished lease? Try Blueground instead and upgrade from unfurnished to furnished living:\n  - Furnished at rates comparable to unfurnished\n  - No setup or furniture costs - save thousands\n  - Move-in ready - save time, just bring your suitcase\n\nDesigned with you in mind\n\nGorgeous furniture, fully equipped kitchen, smart TV, and a premium wireless speaker are just a few of the amenities you’ll find inside this two bedroom apartment. Ideally located in New York, you’ll find a lot to love outside as well. When you’re ready to relax, you’ll be happy to discover every Blueground bedroom comes with superior quality mattresses, fully stocked linens, and cozy towels. We handle everything so you can simply show up and start living. \n\nSleeping arrangements\n\n      Queen Bed, 63in/160cm\n      Queen Bed, 63in/160cm\n\nAmenities\n\nBuilding amenities unique to this two bedroom apartment include an on-site:\n\n  - Doorman\n  - Dryer in building\n  - Elevator\n  - Washing machine in building\n  - Pets allowed\n\nArrival and ongoing support\n\nThe entire apartment is yours to enjoy!\n\nThroughout your stay, you’ll have access to our Client Experience team through the Blueground App. You can schedule additional cleanings, submit maintenance requests, and view our neighborhood recommendations with just a few taps.\n\nWe’ll share all details upon confirmation of your stay.\n\nIdeally Located\n\nThis furnished property is situated in Kips Bay. Stretching from the East River to Lexington Avenue, the peaceful neighborhood offers convenience and easy access to the rest of the city. Several hospitals are located here, making it a hub for medical care. Kips Bay offers dining options for every budget as well as numerous cinemas and fitness centers. During the weekends, locals stroll alongside the water, take the water taxi to another borough, or hang out in one of the parks, such as Bellevue South. From here, Rockefeller Center is only 20 minutes away by subway.\n\nOther things to note\n\nThis Blueground apartment has flexible lease options, allowing you to book it for one month, a year, or more.\nPets are welcome, though weight limits and breed restrictions apply and may incur fees.\nBrokes CYOF.\nWe take great pride in ensuring every photo displayed is shot in our own units with our actual furnishings. That said, we regularly refresh our decor and furniture arrangement, which may differ from what’s pictured.\n [SI]","geolocation":{"latitude":40.74576,"longitude":-73.97978},"square_feet":"850 sq ft"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/alibaba/search":{"get":{"summary":"Alibaba Search","description":"Alibaba Search API. Query B2B product listings by keyword or search URL across 17 locale subdomains. Request mode returns prices, MOQ, seller data and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"get-alibaba-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Alibaba search URL.\n\n**Examples (keyword):**\n\n    neon\n\n**Examples (search URL):**\n\n```\nhttps://www.alibaba.com/trade/search?SearchText=neon\n```\n\n```\nhttps://portuguese.alibaba.com/search/page?SearchText=neon&pro=true\n```\n\n**Notes:**\n- Keyword alone defaults to `www.alibaba.com` (English).\n- Use `subdomain=french` to force a locale on keyword searches.\n- Full URLs keep the host locale; `subdomain` is ignored.\n- Pass each `listing_url` or `product_id` to [Alibaba Product](https://www.piloterr.com/library/alibaba-product).","schema":{"type":"string","description":"Search keyword or full Alibaba search URL.\n\n**Examples (keyword):**\n\n    neon\n\n**Examples (search URL):**\n\n```\nhttps://www.alibaba.com/trade/search?SearchText=neon\n```\n\n```\nhttps://portuguese.alibaba.com/search/page?SearchText=neon&pro=true\n```\n\n**Notes:**\n- Keyword alone defaults to `www.alibaba.com` (English).\n- Use `subdomain=french` to force a locale on keyword searches.\n- Full URLs keep the host locale; `subdomain` is ignored.\n- Pass each `listing_url` or `product_id` to [Alibaba Product](https://www.piloterr.com/library/alibaba-product)."}},{"name":"subdomain","in":"query","required":false,"description":"Locale subdomain for keyword searches when `query` is not a full URL.\n\n**Examples:**\n\n```\nfrench\n```\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nIgnored when `query` is a full Alibaba URL. Invalid values return `400`.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`.","schema":{"type":"string","description":"Locale subdomain for keyword searches when `query` is not a full URL.\n\n**Examples:**\n\n```\nfrench\n```\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nIgnored when `query` is a full Alibaba URL. Invalid values return `400`.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`."}},{"name":"page","in":"query","required":false,"description":"1-based page number (20 results per page). Default: `1`.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (20 results per page). Default: `1`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw open-s JSON as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw open-s JSON as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"image_url":{"type":"string"},"min_order":{"type":"string"},"price_max":{"type":"integer"},"price_min":{"type":"number"},"seller_id":{"type":"string"},"price_text":{"type":"string"},"product_id":{"type":"string"},"sold_count":{"type":"integer"},"listing_url":{"type":"string"},"seller_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"boolean"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'neon' with subdomain=portuguese (page 1)":{"value":{"results":[{"title":"Mais Vendido: Letreiro Luminoso de LED Personalizado com Logo para Negócios, Lojas, Interiores, Festas e Decoração de Casa – Letreiro Neon de LED em Acrílico Direto da Fábrica","category":"Luzes de Néon","image_url":"https://s.alicdn.com/@sc04/kf/Hdf89e9011f0f46b18ba7e388551bded5e.png_300x300.png","min_order":"1 Peça","price_max":30,"price_min":9.9,"seller_id":"247085343","price_text":"US $9.90-$30.00","product_id":"1601525671361","sold_count":21,"listing_url":"https://portuguese.alibaba.com/product-detail/Hot-Selling-Custom-LED-Logo-Light_1601525671361.html?s=p","seller_name":"Fujian Puchuang Information Technology Co., Ltd."},{"title":"Letreiros de Neon Personalizados, Luzes LED RGB Dimmáveis para Decoração de Parede, Quarto, Casamento, Aniversário, Bar, Logotipo da Empresa, Nome","category":"Luzes de Néon","image_url":"https://s.alicdn.com/@sc04/kf/Hc55da60b1b834209928da3bf1f3ee87a2.jpg_300x300.jpg","min_order":"1 Peça","price_max":22.5,"price_min":18.5,"seller_id":"242268971","price_text":"US $18.50-$22.50","product_id":"1600583937291","sold_count":303,"listing_url":"https://portuguese.alibaba.com/product-detail/Custom-Neon-Signs-Personalized-Dimmable-LED_1600583937291.html?s=p","seller_name":"Evermore Enterprise (Zhejiang) Ltd."},{"title":"Neon LED Strip 12V LED Strip Multicolor Neon Light Outdoor LED Strip Lights Decoração de luzes impermeáveis Flex Neon","category":"Luzes de Néon","image_url":"https://s.alicdn.com/@sc04/kf/H72f8a620855b4f5da867b2248bb8fd1ed.png_300x300.png","min_order":"10 Metros","price_min":0.35,"seller_id":"274667237","price_text":"US $0.35","product_id":"1601062675641","sold_count":1063,"listing_url":"https://portuguese.alibaba.com/product-detail/Neon-LED-Strip-12V-LED-Strip_1601062675641.html","seller_name":"Shenzhen Chengjie Lighting Co., Ltd."}],"pagination":{"next":true,"page":1,"per_page":20,"total_pages":2398,"total_results":47955}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Alibaba Search","description":"Alibaba Search API. Query B2B product listings by keyword or search URL across 17 locale subdomains. Request mode returns prices, MOQ, seller data and pagination.\n\n**Credit cost:** 1 credit per call","operationId":"post-alibaba-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full Alibaba search URL.\n\n**Examples (keyword):**\n\n    neon\n\n**Examples (search URL):**\n\n```\nhttps://www.alibaba.com/trade/search?SearchText=neon\n```\n\n```\nhttps://portuguese.alibaba.com/search/page?SearchText=neon&pro=true\n```\n\n**Notes:**\n- Keyword alone defaults to `www.alibaba.com` (English).\n- Use `subdomain=french` to force a locale on keyword searches.\n- Full URLs keep the host locale; `subdomain` is ignored.\n- Pass each `listing_url` or `product_id` to [Alibaba Product](https://www.piloterr.com/library/alibaba-product).","schema":{"type":"string","description":"Search keyword or full Alibaba search URL.\n\n**Examples (keyword):**\n\n    neon\n\n**Examples (search URL):**\n\n```\nhttps://www.alibaba.com/trade/search?SearchText=neon\n```\n\n```\nhttps://portuguese.alibaba.com/search/page?SearchText=neon&pro=true\n```\n\n**Notes:**\n- Keyword alone defaults to `www.alibaba.com` (English).\n- Use `subdomain=french` to force a locale on keyword searches.\n- Full URLs keep the host locale; `subdomain` is ignored.\n- Pass each `listing_url` or `product_id` to [Alibaba Product](https://www.piloterr.com/library/alibaba-product)."}},{"name":"subdomain","in":"query","required":false,"description":"Locale subdomain for keyword searches when `query` is not a full URL.\n\n**Examples:**\n\n```\nfrench\n```\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nIgnored when `query` is a full Alibaba URL. Invalid values return `400`.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`.","schema":{"type":"string","description":"Locale subdomain for keyword searches when `query` is not a full URL.\n\n**Examples:**\n\n```\nfrench\n```\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nIgnored when `query` is a full Alibaba URL. Invalid values return `400`.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`."}},{"name":"page","in":"query","required":false,"description":"1-based page number (20 results per page). Default: `1`.","schema":{"type":"number","minimum":1,"maximum":500,"description":"1-based page number (20 results per page). Default: `1`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw open-s JSON as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw open-s JSON as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"category":{"type":"string"},"image_url":{"type":"string"},"min_order":{"type":"string"},"price_max":{"type":"integer"},"price_min":{"type":"number"},"seller_id":{"type":"string"},"price_text":{"type":"string"},"product_id":{"type":"string"},"sold_count":{"type":"integer"},"listing_url":{"type":"string"},"seller_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"boolean"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Search 'neon' with subdomain=portuguese (page 1)":{"value":{"results":[{"title":"Mais Vendido: Letreiro Luminoso de LED Personalizado com Logo para Negócios, Lojas, Interiores, Festas e Decoração de Casa – Letreiro Neon de LED em Acrílico Direto da Fábrica","category":"Luzes de Néon","image_url":"https://s.alicdn.com/@sc04/kf/Hdf89e9011f0f46b18ba7e388551bded5e.png_300x300.png","min_order":"1 Peça","price_max":30,"price_min":9.9,"seller_id":"247085343","price_text":"US $9.90-$30.00","product_id":"1601525671361","sold_count":21,"listing_url":"https://portuguese.alibaba.com/product-detail/Hot-Selling-Custom-LED-Logo-Light_1601525671361.html?s=p","seller_name":"Fujian Puchuang Information Technology Co., Ltd."},{"title":"Letreiros de Neon Personalizados, Luzes LED RGB Dimmáveis para Decoração de Parede, Quarto, Casamento, Aniversário, Bar, Logotipo da Empresa, Nome","category":"Luzes de Néon","image_url":"https://s.alicdn.com/@sc04/kf/Hc55da60b1b834209928da3bf1f3ee87a2.jpg_300x300.jpg","min_order":"1 Peça","price_max":22.5,"price_min":18.5,"seller_id":"242268971","price_text":"US $18.50-$22.50","product_id":"1600583937291","sold_count":303,"listing_url":"https://portuguese.alibaba.com/product-detail/Custom-Neon-Signs-Personalized-Dimmable-LED_1600583937291.html?s=p","seller_name":"Evermore Enterprise (Zhejiang) Ltd."},{"title":"Neon LED Strip 12V LED Strip Multicolor Neon Light Outdoor LED Strip Lights Decoração de luzes impermeáveis Flex Neon","category":"Luzes de Néon","image_url":"https://s.alicdn.com/@sc04/kf/H72f8a620855b4f5da867b2248bb8fd1ed.png_300x300.png","min_order":"10 Metros","price_min":0.35,"seller_id":"274667237","price_text":"US $0.35","product_id":"1601062675641","sold_count":1063,"listing_url":"https://portuguese.alibaba.com/product-detail/Neon-LED-Strip-12V-LED-Strip_1601062675641.html","seller_name":"Shenzhen Chengjie Lighting Co., Ltd."}],"pagination":{"next":true,"page":1,"per_page":20,"total_pages":2398,"total_results":47955}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/alibaba/product":{"get":{"summary":"Alibaba Product","description":"Alibaba Product API. Fetch a full B2B product page by URL or product ID with optional locale subdomain. Browser rendering returns tiered pricing, seller profile and lead times.\n\n**Credit cost:** 2 credits per call","operationId":"get-alibaba-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Alibaba product URL or numeric product ID.\n\n**Examples (URL):**\n\n    https://www.alibaba.com/product-detail/Custom-Neon-Light-Acrylic-Neon-Sign_1601175379813.html\n\n**Examples (ID):**\n\n    1601175379813\n\nBare IDs resolve on `www.alibaba.com`. Use `subdomain=portuguese` for a localized PDP.\n\nDiscover `listing_url` values with [Alibaba Search](https://www.piloterr.com/library/alibaba-search).","schema":{"type":"string","description":"Full Alibaba product URL or numeric product ID.\n\n**Examples (URL):**\n\n    https://www.alibaba.com/product-detail/Custom-Neon-Light-Acrylic-Neon-Sign_1601175379813.html\n\n**Examples (ID):**\n\n    1601175379813\n\nBare IDs resolve on `www.alibaba.com`. Use `subdomain=portuguese` for a localized PDP.\n\nDiscover `listing_url` values with [Alibaba Search](https://www.piloterr.com/library/alibaba-search)."}},{"name":"subdomain","in":"query","required":false,"description":"Locale subdomain when `query` is a bare product ID, or to override the host on a product URL.\n\n**Examples:**\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nDefaults to `www` when omitted on numeric IDs.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`.","schema":{"type":"string","description":"Locale subdomain when `query` is a bare product ID, or to override the host on a product URL.\n\n**Examples:**\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nDefaults to `www` when omitted on numeric IDs.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"unit":{"type":"string"},"display":{"type":"string"},"quantity_prices":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"display":{"type":"string"},"price_usd":{"type":"number"},"max_quantity":{"type":"integer"},"min_quantity":{"type":"integer"}}}}}},"title":{"type":"string"},"trade":{"type":"object","properties":{"lead_time":{"type":"array","items":{"type":"object","properties":{"max_quantity":{"type":"integer"},"min_quantity":{"type":"integer"},"process_period_days":{"type":"integer"}}}},"sales_volume":{"type":"string"}}},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"years":{"type":"string"},"country":{"type":"string"},"company_id":{"type":"integer"},"profile_url":{"type":"string"},"company_name":{"type":"string"},"is_gold_supplier":{"type":"boolean"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"product_id":{"type":"integer"},"locale_host":{"type":"string"}}},"examples":{"Product 1601175379813 on portuguese.alibaba.com":{"value":{"url":"https://portuguese.alibaba.com/product-detail/Custom-Neon-Light-Acrylic-Neon-Sign_1601175379813.html","price":{"max":17.58,"min":13.16,"unit":"Peça","display":"€ 13,16- 17,58","quantity_prices":[{"price":17.58,"display":"€ 17,58","price_usd":19.9,"max_quantity":49,"min_quantity":1},{"price":16.7,"display":"€ 16,70","price_usd":18.9,"max_quantity":99,"min_quantity":50},{"price":15.81,"display":"€ 15,81","price_usd":17.9,"max_quantity":499,"min_quantity":100},{"price":13.16,"display":"€ 13,16","price_usd":14.9,"min_quantity":500}]},"title":"Letreiro Neon Personalizado em Acrílico, Letreiro LED Neon para Branding de Lojas, Letreiro Neon por Atacado, Letreiro Iluminado LED Personalizado","trade":{"lead_time":[{"max_quantity":50,"min_quantity":1,"process_period_days":3},{"max_quantity":500,"min_quantity":51,"process_period_days":7},{"max_quantity":1000,"min_quantity":501,"process_period_days":15}],"sales_volume":"890 vendido(s)"},"images":["https://sc04.alicdn.com/kf/Hb0b375797bc04466a0b0899d8c3c1349P.jpg","https://sc04.alicdn.com/kf/H6ce47c97d3f64748833a0d49e35f20efK.jpg","https://sc04.alicdn.com/kf/Hde96e67f4ee8446c93b4c05a0aeaec1bc.jpg","https://sc04.alicdn.com/kf/Hd15d7d3495f14440b8e4e9285d39250aS.jpg","https://sc04.alicdn.com/kf/H53b4d1aacb0344fbbe6b5e3b04099f1eg.jpg","https://sc04.alicdn.com/kf/Hf018053ccf77428484059bf8f4ba267d7.jpg"],"seller":{"years":"7","country":"CN","company_id":247837230,"profile_url":"https://custombox.en.alibaba.com/pt_PT/company_profile.html","company_name":"Shenzhen Boxin Electronics Co., Ltd.","is_gold_supplier":true},"attributes":[{"name":"Fonte de luz","value":"Tubo Do DIODO EMISSOR de, LEVOU Neon, Tiras de LED, Luz de néon"},{"name":"Fonte de alimentação","value":"Dc dc dc, Plugue, Transformador"},{"name":"Garantia","value":"2 Years, 2 Anos"},{"name":"Material","value":"Acrílico + luz neon"},{"name":"Classificação IP","value":"IP68"},{"name":"Tensão","value":"DC12V/24V"}],"product_id":1601175379813,"locale_host":"portuguese.alibaba.com"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Alibaba Product","description":"Alibaba Product API. Fetch a full B2B product page by URL or product ID with optional locale subdomain. Browser rendering returns tiered pricing, seller profile and lead times.\n\n**Credit cost:** 2 credits per call","operationId":"post-alibaba-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full Alibaba product URL or numeric product ID.\n\n**Examples (URL):**\n\n    https://www.alibaba.com/product-detail/Custom-Neon-Light-Acrylic-Neon-Sign_1601175379813.html\n\n**Examples (ID):**\n\n    1601175379813\n\nBare IDs resolve on `www.alibaba.com`. Use `subdomain=portuguese` for a localized PDP.\n\nDiscover `listing_url` values with [Alibaba Search](https://www.piloterr.com/library/alibaba-search).","schema":{"type":"string","description":"Full Alibaba product URL or numeric product ID.\n\n**Examples (URL):**\n\n    https://www.alibaba.com/product-detail/Custom-Neon-Light-Acrylic-Neon-Sign_1601175379813.html\n\n**Examples (ID):**\n\n    1601175379813\n\nBare IDs resolve on `www.alibaba.com`. Use `subdomain=portuguese` for a localized PDP.\n\nDiscover `listing_url` values with [Alibaba Search](https://www.piloterr.com/library/alibaba-search)."}},{"name":"subdomain","in":"query","required":false,"description":"Locale subdomain when `query` is a bare product ID, or to override the host on a product URL.\n\n**Examples:**\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nDefaults to `www` when omitted on numeric IDs.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`.","schema":{"type":"string","description":"Locale subdomain when `query` is a bare product ID, or to override the host on a product URL.\n\n**Examples:**\n\n```\nportuguese\n```\n\n```\nfrench.alibaba.com\n```\n\nDefaults to `www` when omitted on numeric IDs.\n\n`hebrew` is the Hebrew host (`language=he`). `polish` is not an Alibaba host and returns `400`."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the rendered HTML as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"price":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"unit":{"type":"string"},"display":{"type":"string"},"quantity_prices":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"display":{"type":"string"},"price_usd":{"type":"number"},"max_quantity":{"type":"integer"},"min_quantity":{"type":"integer"}}}}}},"title":{"type":"string"},"trade":{"type":"object","properties":{"lead_time":{"type":"array","items":{"type":"object","properties":{"max_quantity":{"type":"integer"},"min_quantity":{"type":"integer"},"process_period_days":{"type":"integer"}}}},"sales_volume":{"type":"string"}}},"images":{"type":"array","items":{"type":"string"}},"seller":{"type":"object","properties":{"years":{"type":"string"},"country":{"type":"string"},"company_id":{"type":"integer"},"profile_url":{"type":"string"},"company_name":{"type":"string"},"is_gold_supplier":{"type":"boolean"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"product_id":{"type":"integer"},"locale_host":{"type":"string"}}},"examples":{"Product 1601175379813 on portuguese.alibaba.com":{"value":{"url":"https://portuguese.alibaba.com/product-detail/Custom-Neon-Light-Acrylic-Neon-Sign_1601175379813.html","price":{"max":17.58,"min":13.16,"unit":"Peça","display":"€ 13,16- 17,58","quantity_prices":[{"price":17.58,"display":"€ 17,58","price_usd":19.9,"max_quantity":49,"min_quantity":1},{"price":16.7,"display":"€ 16,70","price_usd":18.9,"max_quantity":99,"min_quantity":50},{"price":15.81,"display":"€ 15,81","price_usd":17.9,"max_quantity":499,"min_quantity":100},{"price":13.16,"display":"€ 13,16","price_usd":14.9,"min_quantity":500}]},"title":"Letreiro Neon Personalizado em Acrílico, Letreiro LED Neon para Branding de Lojas, Letreiro Neon por Atacado, Letreiro Iluminado LED Personalizado","trade":{"lead_time":[{"max_quantity":50,"min_quantity":1,"process_period_days":3},{"max_quantity":500,"min_quantity":51,"process_period_days":7},{"max_quantity":1000,"min_quantity":501,"process_period_days":15}],"sales_volume":"890 vendido(s)"},"images":["https://sc04.alicdn.com/kf/Hb0b375797bc04466a0b0899d8c3c1349P.jpg","https://sc04.alicdn.com/kf/H6ce47c97d3f64748833a0d49e35f20efK.jpg","https://sc04.alicdn.com/kf/Hde96e67f4ee8446c93b4c05a0aeaec1bc.jpg","https://sc04.alicdn.com/kf/Hd15d7d3495f14440b8e4e9285d39250aS.jpg","https://sc04.alicdn.com/kf/H53b4d1aacb0344fbbe6b5e3b04099f1eg.jpg","https://sc04.alicdn.com/kf/Hf018053ccf77428484059bf8f4ba267d7.jpg"],"seller":{"years":"7","country":"CN","company_id":247837230,"profile_url":"https://custombox.en.alibaba.com/pt_PT/company_profile.html","company_name":"Shenzhen Boxin Electronics Co., Ltd.","is_gold_supplier":true},"attributes":[{"name":"Fonte de luz","value":"Tubo Do DIODO EMISSOR de, LEVOU Neon, Tiras de LED, Luz de néon"},{"name":"Fonte de alimentação","value":"Dc dc dc, Plugue, Transformador"},{"name":"Garantia","value":"2 Years, 2 Anos"},{"name":"Material","value":"Acrílico + luz neon"},{"name":"Classificação IP","value":"IP68"},{"name":"Tensão","value":"DC12V/24V"}],"product_id":1601175379813,"locale_host":"portuguese.alibaba.com"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aliexpress/search":{"get":{"summary":"AliExpress Search","description":"AliExpress Search API: search by keyword or wholesale URL and get product listings with prices, ratings, sold counts, and pagination as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-aliexpress-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full AliExpress search results URL.\n\n**Example (keyword):**\n\n    meta\n\nResolves to a wholesale search page such as `https://www.aliexpress.com/w/wholesale-meta.html`.\n\n**Example (wholesale URL):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?spm=a2g0o.productlist.search.0\n\n**Example (page 2):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?page=2\n\n**Accepted URL patterns:** `/w/`, `/wholesale`, `searchText=`, `/af/`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from aliexpress.com.\n- There is no `page` parameter: paginate by adding `?page=2` to the URL.\n- Use each result `listing_url` or `product_id` with **AliExpress Product** for full PDP and seller data.","schema":{"type":"string","description":"Search keyword or full AliExpress search results URL.\n\n**Example (keyword):**\n\n    meta\n\nResolves to a wholesale search page such as `https://www.aliexpress.com/w/wholesale-meta.html`.\n\n**Example (wholesale URL):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?spm=a2g0o.productlist.search.0\n\n**Example (page 2):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?page=2\n\n**Accepted URL patterns:** `/w/`, `/wholesale`, `searchText=`, `/af/`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from aliexpress.com.\n- There is no `page` parameter: paginate by adding `?page=2` to the URL.\n- Use each result `listing_url` or `product_id` with **AliExpress Product** for full PDP and seller data."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"sold_count":{"type":"integer"},"listing_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"boolean"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Wholesale search 'meta' on aliexpress.com":{"value":{"results":[{"price":36.99,"title":"Lunettes Intelligentes IA Meta AI Sans Fil à Changement de Couleur de Haute Qualité, Film Intelligent, Étanchéité IP65, Vidéo 2K, Traduction en Temps Réel","currency":"EUR","condition":"new","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/S4a87e08500774848bba251a21308e471l.jpg","product_id":"1005012335698677","sold_count":1,"listing_url":"https://www.aliexpress.com/item/1005012335698677.html"},{"price":654.92,"title":"Oculus Quest 3 d'origine, 8 Go de RAM + 512 Go de stockage, écran 4K+ Infinite Display, résolution 2064x2208, batterie 5060 mAh, autonomie de 2,2 heures","rating":4.8,"currency":"EUR","condition":"new","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/Sc8f0a4c26b164cd08ded129e317f5a5aL.png","product_id":"1005011541924400","sold_count":48,"listing_url":"https://www.aliexpress.com/item/1005011541924400.html"},{"price":8.39,"title":"HIBLOKS Ray-Ban Meta Wayfarer lunettes chargeur de câble de charge rapide pour RW4006/RW4008/RW4012/RW4010/RW4014 Portable sûr Type C","rating":4.5,"currency":"EUR","condition":"new","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/S51d4975962144f30af5853775400fa69P.jpg","product_id":"1005008808856805","sold_count":800,"listing_url":"https://www.aliexpress.com/item/1005008808856805.html"}],"pagination":{"next":true,"page":1,"per_page":60,"total_pages":94,"total_results":5624}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"AliExpress Search","description":"AliExpress Search API: search by keyword or wholesale URL and get product listings with prices, ratings, sold counts, and pagination as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-aliexpress-search","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Search keyword or full AliExpress search results URL.\n\n**Example (keyword):**\n\n    meta\n\nResolves to a wholesale search page such as `https://www.aliexpress.com/w/wholesale-meta.html`.\n\n**Example (wholesale URL):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?spm=a2g0o.productlist.search.0\n\n**Example (page 2):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?page=2\n\n**Accepted URL patterns:** `/w/`, `/wholesale`, `searchText=`, `/af/`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from aliexpress.com.\n- There is no `page` parameter: paginate by adding `?page=2` to the URL.\n- Use each result `listing_url` or `product_id` with **AliExpress Product** for full PDP and seller data.","schema":{"type":"string","description":"Search keyword or full AliExpress search results URL.\n\n**Example (keyword):**\n\n    meta\n\nResolves to a wholesale search page such as `https://www.aliexpress.com/w/wholesale-meta.html`.\n\n**Example (wholesale URL):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?spm=a2g0o.productlist.search.0\n\n**Example (page 2):**\n\n    https://www.aliexpress.com/w/wholesale-meta.html?page=2\n\n**Accepted URL patterns:** `/w/`, `/wholesale`, `searchText=`, `/af/`\n\n**Notes:**\n- Pass a keyword or copy the full search URL from aliexpress.com.\n- There is no `page` parameter: paginate by adding `?page=2` to the URL.\n- Use each result `listing_url` or `product_id` with **AliExpress Product** for full PDP and seller data."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of structured JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number"},"title":{"type":"string"},"currency":{"type":"string"},"condition":{"type":"string"},"image_url":{"type":"string"},"product_id":{"type":"string"},"sold_count":{"type":"integer"},"listing_url":{"type":"string"}}}},"pagination":{"type":"object","properties":{"next":{"type":"boolean"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_results":{"type":"integer"}}}}},"examples":{"Wholesale search 'meta' on aliexpress.com":{"value":{"results":[{"price":36.99,"title":"Lunettes Intelligentes IA Meta AI Sans Fil à Changement de Couleur de Haute Qualité, Film Intelligent, Étanchéité IP65, Vidéo 2K, Traduction en Temps Réel","currency":"EUR","condition":"new","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/S4a87e08500774848bba251a21308e471l.jpg","product_id":"1005012335698677","sold_count":1,"listing_url":"https://www.aliexpress.com/item/1005012335698677.html"},{"price":654.92,"title":"Oculus Quest 3 d'origine, 8 Go de RAM + 512 Go de stockage, écran 4K+ Infinite Display, résolution 2064x2208, batterie 5060 mAh, autonomie de 2,2 heures","rating":4.8,"currency":"EUR","condition":"new","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/Sc8f0a4c26b164cd08ded129e317f5a5aL.png","product_id":"1005011541924400","sold_count":48,"listing_url":"https://www.aliexpress.com/item/1005011541924400.html"},{"price":8.39,"title":"HIBLOKS Ray-Ban Meta Wayfarer lunettes chargeur de câble de charge rapide pour RW4006/RW4008/RW4012/RW4010/RW4014 Portable sûr Type C","rating":4.5,"currency":"EUR","condition":"new","image_url":"https://ae-pic-a1.aliexpress-media.com/kf/S51d4975962144f30af5853775400fa69P.jpg","product_id":"1005008808856805","sold_count":800,"listing_url":"https://www.aliexpress.com/item/1005008808856805.html"}],"pagination":{"next":true,"page":1,"per_page":60,"total_pages":94,"total_results":5624}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/aliexpress/product":{"get":{"summary":"AliExpress Product","description":"AliExpress Product API: scrape live `/item/` product pages from a full URL. Get title, images, seller identity, pricing, specs, delivery, and FAQs as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"get-aliexpress-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AliExpress product page URL (`/item/{id}.html`).\n\n**Example:**\n\n    https://www.aliexpress.com/item/1005009517624640.html\n\n**Example (locale subdomain with tracking params):**\n\n    https://es.aliexpress.com/item/1005012069266068.html?spm=...\n\n**Notes:**\n- Pass the full product URL (not just the numeric ID).\n- Locale subdomains are supported (`es.`, `fr.`, `de.`, …).\n- Query params (`spm`, `pdp_ext_f`, …) are preserved in `info.link`.\n- The page is fetched using the canonical `/item/` URL without query params.\n- **Rejected (400):** bundle/SSR URLs (`/ssr/`, `productIds=`), non-`/item/` URLs, non-AliExpress domains.\n- Use **AliExpress Search** to discover `listing_url` values first.","schema":{"type":"string","description":"Full AliExpress product page URL (`/item/{id}.html`).\n\n**Example:**\n\n    https://www.aliexpress.com/item/1005009517624640.html\n\n**Example (locale subdomain with tracking params):**\n\n    https://es.aliexpress.com/item/1005012069266068.html?spm=...\n\n**Notes:**\n- Pass the full product URL (not just the numeric ID).\n- Locale subdomains are supported (`es.`, `fr.`, `de.`, …).\n- Query params (`spm`, `pdp_ext_f`, …) are preserved in `info.link`.\n- The page is fetched using the canonical `/item/` URL without query params.\n- **Rejected (400):** bundle/SSR URLs (`/ssr/`, `productIds=`), non-`/item/` URLs, non-AliExpress domains.\n- Use **AliExpress Search** to discover `listing_url` values first."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"faqs":{"type":"array","items":{}},"info":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"rate":{"type":"integer"},"media":{"type":"array","items":{"type":"string"}},"reviews":{"type":"integer"},"seller_id":{"type":"string"},"product_id":{"type":"integer"},"sold_count":{"type":"integer"},"seller_name":{"type":"string"},"available_count":{"type":"integer"}}},"pricing":{"type":"object","properties":{"price":{"type":"number"},"discount":{"type":"string"},"original_price":{"type":"string"},"price_currency":{"type":"string"}}},"delivery":{"type":"object","properties":{"pickup_method":{"type":"string"},"shipping_cost":{"type":"number"},"estimated_delivery":{"type":"string"},"shipping_cost_currency":{"type":"string"}}},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Air purifier PDP on aliexpress.com":{"value":{"faqs":[],"info":{"link":"https://www.aliexpress.com/item/1005009517624640.html","name":"Purificateur d'air désodorisant 24 heures, utilisation continue, lumière LED à couleur changeante, Purification complète de l'air, dépoussiérage","rate":5,"media":["https://ae-pic-a1.aliexpress-media.com/kf/Se1f79370af2b4634bbfa9e1beadf9046C.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/Sf9d5548be5f64e4c8ea0840d1685dfe0a.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/S77e4c39b5540420ead87e47d010bb089M.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/S2f998e36cac0433e86b8d36d16228b42Q.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/Sae6e2b87c9014dbaa35c24ac5ff2df3c3.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/S4af2669e607b42d0b85641c3160b8e19U.jpeg_960x960q75.jpeg_.avif"],"reviews":1,"seller_id":"1104914437","product_id":1005009517624640,"sold_count":3,"seller_name":"Shop1104914437 Store","available_count":999},"pricing":{"price":13.19,"discount":"No discount","original_price":"No discount","price_currency":"EUR"},"delivery":{"pickup_method":"Pick-up points","shipping_cost":20.42,"estimated_delivery":"juillet 08 - 15","shipping_cost_currency":"EUR"},"specifications":[{"name":"Produit chimique à haute préoccupation","value":"Aucun"},{"name":"Nom de marque","value":"Docreate"},{"name":"Origine","value":"CN (Origine)"},{"name":"Product Name","value":"10W Air Revitaliser with Colour Changing  Light Refreshes Cleanses"},{"name":"Material","value":"ABS"},{"name":"Size","value":"18X17CM"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"AliExpress Product","description":"AliExpress Product API: scrape live `/item/` product pages from a full URL. Get title, images, seller identity, pricing, specs, delivery, and FAQs as JSON via browser rendering.\n\n**Credit cost:** 2 credits per call","operationId":"post-aliexpress-product","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"Full AliExpress product page URL (`/item/{id}.html`).\n\n**Example:**\n\n    https://www.aliexpress.com/item/1005009517624640.html\n\n**Example (locale subdomain with tracking params):**\n\n    https://es.aliexpress.com/item/1005012069266068.html?spm=...\n\n**Notes:**\n- Pass the full product URL (not just the numeric ID).\n- Locale subdomains are supported (`es.`, `fr.`, `de.`, …).\n- Query params (`spm`, `pdp_ext_f`, …) are preserved in `info.link`.\n- The page is fetched using the canonical `/item/` URL without query params.\n- **Rejected (400):** bundle/SSR URLs (`/ssr/`, `productIds=`), non-`/item/` URLs, non-AliExpress domains.\n- Use **AliExpress Search** to discover `listing_url` values first.","schema":{"type":"string","description":"Full AliExpress product page URL (`/item/{id}.html`).\n\n**Example:**\n\n    https://www.aliexpress.com/item/1005009517624640.html\n\n**Example (locale subdomain with tracking params):**\n\n    https://es.aliexpress.com/item/1005012069266068.html?spm=...\n\n**Notes:**\n- Pass the full product URL (not just the numeric ID).\n- Locale subdomains are supported (`es.`, `fr.`, `de.`, …).\n- Query params (`spm`, `pdp_ext_f`, …) are preserved in `info.link`.\n- The page is fetched using the canonical `/item/` URL without query params.\n- **Rejected (400):** bundle/SSR URLs (`/ssr/`, `productIds=`), non-`/item/` URLs, non-AliExpress domains.\n- Use **AliExpress Search** to discover `listing_url` values first."}},{"name":"return_page_source","in":"query","required":false,"description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`.","schema":{"type":"boolean","description":"When `true`, return the raw HTML page source as `{\"result\": \"...\"}` instead of parsed JSON. Defaults to `false`."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"faqs":{"type":"array","items":{}},"info":{"type":"object","properties":{"link":{"type":"string"},"name":{"type":"string"},"rate":{"type":"integer"},"media":{"type":"array","items":{"type":"string"}},"reviews":{"type":"integer"},"seller_id":{"type":"string"},"product_id":{"type":"integer"},"sold_count":{"type":"integer"},"seller_name":{"type":"string"},"available_count":{"type":"integer"}}},"pricing":{"type":"object","properties":{"price":{"type":"number"},"discount":{"type":"string"},"original_price":{"type":"string"},"price_currency":{"type":"string"}}},"delivery":{"type":"object","properties":{"pickup_method":{"type":"string"},"shipping_cost":{"type":"number"},"estimated_delivery":{"type":"string"},"shipping_cost_currency":{"type":"string"}}},"specifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"examples":{"Air purifier PDP on aliexpress.com":{"value":{"faqs":[],"info":{"link":"https://www.aliexpress.com/item/1005009517624640.html","name":"Purificateur d'air désodorisant 24 heures, utilisation continue, lumière LED à couleur changeante, Purification complète de l'air, dépoussiérage","rate":5,"media":["https://ae-pic-a1.aliexpress-media.com/kf/Se1f79370af2b4634bbfa9e1beadf9046C.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/Sf9d5548be5f64e4c8ea0840d1685dfe0a.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/S77e4c39b5540420ead87e47d010bb089M.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/S2f998e36cac0433e86b8d36d16228b42Q.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/Sae6e2b87c9014dbaa35c24ac5ff2df3c3.jpeg_960x960q75.jpeg_.avif","https://ae-pic-a1.aliexpress-media.com/kf/S4af2669e607b42d0b85641c3160b8e19U.jpeg_960x960q75.jpeg_.avif"],"reviews":1,"seller_id":"1104914437","product_id":1005009517624640,"sold_count":3,"seller_name":"Shop1104914437 Store","available_count":999},"pricing":{"price":13.19,"discount":"No discount","original_price":"No discount","price_currency":"EUR"},"delivery":{"pickup_method":"Pick-up points","shipping_cost":20.42,"estimated_delivery":"juillet 08 - 15","shipping_cost_currency":"EUR"},"specifications":[{"name":"Produit chimique à haute préoccupation","value":"Aucun"},{"name":"Nom de marque","value":"Docreate"},{"name":"Origine","value":"CN (Origine)"},{"name":"Product Name","value":"10W Air Revitaliser with Colour Changing  Light Refreshes Cleanses"},{"name":"Material","value":"ABS"},{"name":"Size","value":"18X17CM"}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v2/expedia/ad":{"get":{"summary":"Expedia Ad","description":"Fetch one Expedia hotel from its information URL: name, postal address, and amenity groups.\n\n**Credit cost:** 2 credits per call","operationId":"get-expedia-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"An Expedia hotel information URL. The response is one flat hotel. hotel_id comes from .h{id}.Hotel-Information when that pattern is in the URL, and is null otherwise. A destination, a non-Expedia URL, or an empty value returns 400.\n\nHotel URL\n\n```\nhttps://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information\n```","schema":{"type":"string","description":"An Expedia hotel information URL. The response is one flat hotel. hotel_id comes from .h{id}.Hotel-Information when that pattern is in the URL, and is null otherwise. A destination, a non-Expedia URL, or an empty value returns 400.\n\nHotel URL\n\n```\nhttps://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"}}},"hotel_id":{"type":"string"},"amenities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"items":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"Hilton New York Fashion District":{"value":{"url":"https://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information","name":"Hilton New York Fashion District","address":{"city":"New York","region":"NY","street":"152 W 26th Street","country":"USA","postal_code":"10001"},"hotel_id":"3117215","amenities":[{"name":"Internet","items":["Available in all rooms: Free WiFi"]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}},"post":{"summary":"Expedia Ad","description":"Fetch one Expedia hotel from its information URL: name, postal address, and amenity groups.\n\n**Credit cost:** 2 credits per call","operationId":"post-expedia-ad","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"An Expedia hotel information URL. The response is one flat hotel. hotel_id comes from .h{id}.Hotel-Information when that pattern is in the URL, and is null otherwise. A destination, a non-Expedia URL, or an empty value returns 400.\n\nHotel URL\n\n```\nhttps://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information\n```","schema":{"type":"string","description":"An Expedia hotel information URL. The response is one flat hotel. hotel_id comes from .h{id}.Hotel-Information when that pattern is in the URL, and is null otherwise. A destination, a non-Expedia URL, or an empty value returns 400.\n\nHotel URL\n\n```\nhttps://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information\n```"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"region":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"}}},"hotel_id":{"type":"string"},"amenities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"items":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"Hilton New York Fashion District":{"value":{"url":"https://www.expedia.com/New-York-Hotels-Hilton-New-York-Fashion-District.h3117215.Hotel-Information","name":"Hilton New York Fashion District","address":{"city":"New York","region":"NY","street":"152 W 26th Street","country":"USA","postal_code":"10001"},"hotel_id":"3117215","amenities":[{"name":"Internet","items":["Available in all rooms: Free WiFi"]}]}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}}},"components":{"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message."}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your API key. Include it in the x-api-key header for every request."}}}}