What you get
| Field | Type |
|---|---|
title |
string |
price |
number |
currency |
string |
brand |
string |
model |
string |
location |
string |
rating |
number |
url |
string |
All 144 fields
Key fields
titlepricecurrencybrandmodellocationratingurlactionaffiliationavailability_codeavailability_express_stock_quantityavailability_has_stock_restrictionavailability_is_availableavailability_labelavailability_quantity_max_valueavailability_stock_quantityavailability_text_longavailability_text_shortcategorycategory2category3collection_labeldisposition_keyfile_nameglobal_rankimageimage_typenumberpositionprice_billing_price_raw_priceprice_currency_exchange_rateprice_currency_name_internationalprice_currency_symbolprice_vat_ratepriorityrelations_keyreview_countsales_ranksales_unit_codetexts_descriptiontexts_featurestexts_rich_descriptiontexts_sub_titlewishlist_urlbusiness_hours_actual_back_in_time_dbusiness_hours_actual_back_in_time_fbusiness_hours_actual_back_in_time_hbusiness_hours_actual_back_in_time_sbusiness_hours_url_route_descriptionchat_force_delay_secondsdepartments_fax_numberdepartments_labelfeedback_form_urllink_retourelink_servicemedia_urls_image_server_urlwhats_app_info_whats_app_link
Technical fields
a_stock_article_idavailability_datecampaigns_article_idcampaigns_end_date_datecampaigns_idcampaigns_namecampaigns_start_date_datecampaigns_urlcategory_iddisplay_namedownload_infoecommerce_event_item_indexecommerce_event_item_item_idecommerce_event_item_item_nameend_date_timezoneend_date_timezone_typefiles_idfiles_labelhas_audio_player_buttonhas_audioshas_discounthas_fsi_spin_datahas_giveawayhas_uvpidimage_article_idimage_heightimage_idimage_widthis_archivedis_bstockis_downloadis_express_shippableis_on_wishlistis_returnableis_voucheris_yamaha_agencyitem_has_audiositem_quantitymanufacturerparent_idprice_article_idprice_currency_billableprice_currency_idprice_currency_keyprice_currency_name_localprice_discountprice_includes_vatprice_retail_saving_percentageprice_saving_percentageprice_strike_price_raw_priceprimary_currency_billableprimary_currency_exchange_rateprimary_currency_idprimary_currency_keyprimary_currency_name_internationalprimary_currency_name_localprimary_currency_symbolprimary_includes_vatprimary_raw_priceprimary_vat_ratepromotion_namequantityrelations_idretail_currency_billableretail_currency_exchange_rateretail_currency_idretail_currency_keyretail_currency_name_internationalretail_currency_name_localretail_currency_symbolretail_includes_vatretail_raw_priceretail_vat_ratestart_date_timezonestart_date_timezone_typetexts_meta_tagsvariantbusiness_hours_actual_back_in_time_daysbusiness_hours_actual_back_in_time_ibusiness_hours_actual_back_in_time_mbusiness_hours_actual_back_in_time_ydepartment_iddepartments_iddepartments_mailtowhats_app_info_image_path
Sample records
1 of 3 saved records. This is a saved sample, not a live run.
title |
price |
currency |
brand |
model |
location |
|---|---|---|---|---|---|
| Harley Benton ST-20HSS SBK Standard Series | 111 | EUR | Harley Benton | ST-20HSS SBK Standard Series | product |
Scroll sideways to see more columns.
Inputs
-
categorytext · requiredFree text: any category the site serves, written with letters, digits, underscores and hyphens, up to 32 characters. A name the site does not serve is refused.
-
searchstringOptional. Text for the site's search box. Leave it out to read everything.
-
price_minstring | integerOptional. Omit it to leave this side open.
-
price_maxstring | integerOptional. Omit it to leave this side open.
-
sortchoiceOrder of the collection, as the site's own sort control offers it; omitted keeps the site's default order.
15 more inputs
-
feature_151choiceOptional. Filters the results.
-
feature_2122choiceOptional. Filters the results.
-
feature_2121choiceOptional. Filters the results.
-
feature_154choiceOptional. Filters the results.
-
feature_153choiceOptional. Filters the results.
-
manufacturerchoiceOptional. Filters by manufacturer.
-
feature_2120choiceOptional. Filters the results.
-
feature_2124choiceOptional. Filters the results.
-
feature_152choiceOptional. Filters the results.
-
ratingchoiceOptional. Filters by rating.
-
feature_2123choiceOptional. Filters the results.
-
marketingattributeschoiceOptional. Filters by marketingattributes.
-
feature_2131choiceOptional. Filters the results.
-
feature_2130choiceOptional. Filters the results.
-
vfchoiceOptional. Filters the results.
enrich_records is on by default and adds the fields that only appear on each record's detail page. Send false to read list fields only. See Run an API.
Request
POST https://api.cleanedweb.com/v1/catalog/public/apis/generated_e11f346108f62d7286e7795a/endpoints/generated_e11f346108f62d7286e7795a_search/run
curl -X POST https://api.cleanedweb.com/v1/catalog/public/apis/generated_e11f346108f62d7286e7795a/endpoints/generated_e11f346108f62d7286e7795a_search/run \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: UNIQUE_REQUEST_ID" \
-H "Content-Type: application/json" \
-d '{
"input": {
"category": "st-modelle",
"manufacturer": "Harley Benton"
},
"version": 1,
"max_items": 25
}'
Save the Idempotency-Key before you send, and reuse it only to retry the same request. The key needs the run scope. See Run a catalog API.
version pins major v1, whose newest minor (1.0) answers. Leave it out and the call runs on the latest major.
Changelog
-
v1.0 (major) ·
Use it from an AI agent
Open in your coding agent
Add CleanedWeb to your agent as an MCP server, such as a custom connector in Claude or ChatGPT, then sign in with your CleanedWeb account. An API key with the read and run scopes works too.
https://api.cleanedweb.com/mcp?profile=catalog
Then ask, for example: Use CleanedWeb to get 25 records from the Thomann Category Products API.
The agent finds the API, runs it and reads the records. Runs are charged like any other run.
Coverage
- Category
- Commerce
A run stops when the source has no more records, or when it reaches a limit you set: the number of records, the time, or your budget.
CleanedWeb is not affiliated with Thomann Music Products.