/cpsc/recalls

POST /api/cpsc/recalls

Price: 10 credits

Get a CPSC consumer product recall by recall number: products and units, hazards, injuries, remedies, manufacturers, importers, retailers, countries of manufacture, UPCs and images.

How to use it

Fetch a recall by its `id`, the recall number without the dash. `url` is the recall notice on cpsc.gov.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• recall_number string required — CPSC recall number, with or without the dash (examples: "26748", "26-748")

Response

• @type string (default: "CpscRecall")
• id string required
• record_id string nullable
• description string nullable
• url string nullable
• recall_date string nullable
• last_publish_date string nullable
• consumer_contact string nullable
• products array (default: [])
  • @type string (default: "CpscRecallProduct")
  • name string nullable
  • description string nullable
  • model string nullable
  • product_type string nullable
  • category_id string nullable
  • units string nullable
• images array (default: [])
  • @type string (default: "CpscRecallImage")
  • url string required
  • caption string nullable
• hazards array (default: [])
  • @type string (default: "CpscRecallHazard")
  • name string nullable
  • hazard_type string nullable
  • hazard_type_id string nullable
• injuries array (default: [])
• remedies array (default: [])
• remedy_options array (default: [])
• manufacturers array (default: [])
  • @type string (default: "CpscRecallCompany")
  • name string required
  • company_id string nullable
• importers array (default: [])
  • @type string (default: "CpscRecallCompany")
  • name string required
  • company_id string nullable
• distributors array (default: [])
  • @type string (default: "CpscRecallCompany")
  • name string required
  • company_id string nullable
• retailers array (default: [])
  • @type string (default: "CpscRecallCompany")
  • name string required
  • company_id string nullable
• manufacturer_countries array (default: [])
• upcs array (default: [])
• related_urls array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 recall with that recall number 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 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 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 Wait at least 30 seconds, then retry.

Response 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.