# /usbif/products/search

`POST /api/usbif/products/search`

Price: 20 credits

Search the USB-IF certified product list — devices, cables, connectors, silicon and chargers that passed USB-IF compliance testing. Filters by text, company, retail or development segment, listing status, speed, declared feature, total port wattage and certification date, newest certification first. Each product carries its TID, model, company, category paths, speeds, features, port wattage and certification time.

## How to use it

Pass a returned `tid` to usbif/products for the device type, revision, supported USB specifications, power rails and cable length this list does not carry. Several `speeds` widen the match to any of them while several `features` must all be declared, so send one feature per call when either will do. About half of the products carry no `category`, so a `segment` filter drops them rather than classifying them.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `count` (integer, required) — Max number of products to return (min: 1)
- `keywords` (string, nullable) — Text contained in the product name, model number, company name or TID (examples: "Anker"; minLength: 1)
- `company_name` (string, nullable) — Text contained in the company name (examples: "Dell"; minLength: 1)
- `segment` (string, nullable) — Retail products or development tools (one of: "retail", "development")
- `status` (string, nullable) — Listing status (one of: "pass", "obsolete")
- `speeds` (array, nullable) — Speeds, matched against the product, cable and connector speed; any of them qualifies (one of: "full_speed", "high_speed", "low_speed", "usb_10gbps", "usb_20gbps", "usb_20gbps_usb4", "usb_3_1_2x1", "usb_40gbps", "usb_40gbps_usb4", "usb_5gbps", "usb_80gbps")
- `features` (array, nullable) — Features the product must all declare (one of: "alternate_mode", "audio_accessory", "audio_class", "audio_or_video_class", "battery_charging", "billboard_device_class", "bulk_data_transfers", "common_class_ccs", "communications_device_class", "debug", "debug_accessory", "device_firmware_upgrade_class", "displayport", "displayport_tunneling", "fast_role_swap", "full_speed", "hdmi", "hid_class", "high_speed", "imaging_class", "interrupt_data_transfers", "isochronous_data_transfers", "low_speed", "mass_storage_class_msc", "media_transfer_protocol_class", "monitor_class", "n_15v_fixed", "n_15v_prog", "n_20v_fixed", "n_20v_prog", "n_3a_cable", "n_5a_cable", "n_5v_fixed", "n_5v_prog", "n_9v_fixed", "n_9v_prog", "optional_apdo", "optional_pdo", "pcie_tunneling", "pd_consumer_or_provider", "pd_drp", "pd_provider_or_consumer", "personal_healthcare_class", "power_delivery_2_0", "pps", "pps_sink", "pps_source", "printer_device_class", "shared_capacity", "thunderbolt_3", "usb4", "usb_3_1_gen_2_type_c_plug", "usb_power_delivery", "usb_tunneling", "usb_type_c", "usb_type_c_sink", "usb_type_c_source", "vconn_powered_accessory", "video_class")
- `min_total_wattage` (number, nullable) — Lowest total power across the product's ports, W (examples: 60; min: 0)
- `max_total_wattage` (number, nullable) — Highest total power across the product's ports, W (examples: 240; min: 0)
- `certified_date_from` (string, nullable) — Earliest certification date (format: date; examples: "2025-01-01")
- `certified_date_to` (string, nullable) — Latest certification date (format: date; examples: "2025-12-31")

## Response

### 200 — Successful Response

- `@type` (string) (default: "UsbifProduct")
- `id` (string, required)
- `tid` (string, nullable)
- `name` (string, nullable)
- `model_number` (string, nullable)
- `company_name` (string, nullable)
- `status` (string, nullable)
- `segment` (string, nullable)
- `category` (string, nullable)
- `cable_marketing_category` (string, nullable)
- `silicon_marketing_category` (string, nullable)
- `power_marketing_category` (string, nullable)
- `e_marker_marketing_category` (string, nullable)
- `marketing_info` (string, nullable)
- `connector_type` (string, nullable)
- `max_speed` (string, nullable)
- `cable_max_speed` (string, nullable)
- `connector_max_speed` (string, nullable)
- `xid` (string, nullable)
- `total_wattage` (number, nullable)
- `features` (array) (default: [])
- `certified_at` (integer, nullable)

## Errors

### 422 — Validation Error

A date or wattage range is inverted, or a speed or feature is not in the catalogue

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

No certified product matched the filters

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.

