/cookpad/recipes

POST /api/cookpad/recipes

Price: 10 credits

Get one Cookpad recipe in any edition: title, description, photo, author, servings, ingredients with quantities, steps with photos, tips, keywords, bookmark, like, cooksnap and reaction counts, dates

How to use it

Premium recipes come back with is_premium true, only the first ingredients and no steps or tips: Cookpad shows the full recipe only to its premium members.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• recipe string required — Cookpad recipe id or recipe URL (examples: "26586482", "https://cookpad.com/jp/recipes/26586482", "https://cookpad.com/eng/recipes/25795649"; minLength: 1)

Response

• @type string (default: "CookpadRecipe")
• id string required
• url string required
• region string nullable
• description string nullable
• image string nullable
• is_premium boolean (default: false)
• author object nullable
  • @type string (default: "CookpadUserRef")
  • id string required
  • name string nullable
  • alias string nullable
  • image string nullable
  • url string required
• serving string nullable
• ingredients array (default: [])
  • @type string (default: "CookpadIngredient")
  • name string required
  • quantity string nullable
  • is_heading boolean (default: false)
• steps array (default: [])
  • @type string (default: "CookpadStep")
  • position integer required
  • text string nullable
  • images array (default: [])
• tips string nullable
• keywords array (default: [])
• cuisine string nullable
• bookmark_count integer nullable
• like_count integer nullable
• cooksnap_count integer nullable
• yummy_count integer nullable
• heart_count integer nullable
• clap_count integer nullable
• published_at integer nullable
• published_date integer nullable
• updated_date integer nullable

Errors

• 422 — recipe is not a Cookpad recipe id or URL 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 public Cookpad recipe under that id 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.