/kipris/designs/search

POST /api/kipris/designs/search

Price: 1 credit

Search Korean design collection

How to use it

Search the Korean industrial design collection on KIPRIS (the Korean IP office registry). Combine any of the filters (query, title, applicant, designer, rights_holder, agent, application_number, registration_number, locarno_class and application/registration date ranges in YYYYMMDD); all are combined with AND. Order by relevance (default) or application/registration date. Returns each match's title, classifications, applicants and designers, numbers and dates, legal status and drawing images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Free keyword searched across the design (examples: "chair")
• design_title string nullable — Words in the design title (examples: "yoga chair")
• applicant string nullable — Applicant name
• designer string nullable — Designer / creator name
• rights_holder string nullable — Registered rights holder name
• agent string nullable — Agent / attorney name
• application_number string nullable — Application number
• registration_number string nullable — Registration number
• locarno_class string nullable — Locarno classification code (examples: "06-01")
• application_date_from string nullable — Earliest application date (YYYYMMDD) (examples: "20190101")
• application_date_to string nullable — Latest application date (YYYYMMDD)
• registration_date_from string nullable — Earliest registration date (YYYYMMDD)
• registration_date_to string nullable — Latest registration date (YYYYMMDD)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "application_date", "registration_date")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "KiprisDesign")
• id string required
• title_en string nullable
• application_number string nullable
• application_date string nullable
• publication_date string nullable
• registration_number string nullable
• registration_date string nullable
• legal_status string nullable
• legal_status_detail string nullable
• locarno_class string nullable
• design_class array (default: [])
• description string nullable
• applicants array (default: [])
• designers array (default: [])
• designers_en array (default: [])
• agents array (default: [])
• rights_holders array (default: [])
• rights_holders_en array (default: [])
• image string nullable
• images 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 — The entity was not found, or a precondition failed 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.