/patentscope/patents

POST /api/patentscope/patents

Price: 5 credits

Get a patent record by its PATENTSCOPE docId

How to use it

Get the full bibliographic record of a patent from WIPO PATENTSCOPE by its docId. For PCT/WO records the docId is the publication number (e.g. WO2019060539); for national-collection records use the docId returned by patentscope/patents/search (e.g. US318503467). Returns publication number/date/kind, grant number and date (on granted national records), title and abstract (with per-language translations), office, application and international filing data, IPC and CPC classifications, applicants, inventors, agents, priority claims, designated states and related family documents.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• patent string required — PATENTSCOPE docId. For PCT/WO records this equals the publication number (e.g. WO2019060539); for national-collection records it is the internal docId from search results (e.g. US318503467) (examples: "WO2019060539", "US318503467"; minLength: 3)
• lang string — Language for title and abstract (default: "en"; one of: "en", "fr", "de", "es", "pt", "ru", "ja", "zh", "ko", "ar")

Response

• @type string (default: "PatentscopePatent")
• doc_id string required
• publication_number string nullable
• publication_date string nullable
• publication_kind string nullable
• publication_language string nullable
• filing_language string nullable
• grant_number string nullable
• grant_date string nullable
• title_translations object (default: {})
  • * string
• abstract string nullable
• abstract_translations object (default: {})
  • * string
• office string nullable
• application_number string nullable
• application_date string nullable
• international_application_number string nullable
• international_filing_date string nullable
• ipc array (default: [])
• cpc array (default: [])
• applicants array (default: [])
  • @type string (default: "PatentscopePerson")
  • name string required
  • country_code string nullable
• inventors array (default: [])
  • @type string (default: "PatentscopePerson")
  • name string required
  • country_code string nullable
• agents array (default: [])
  • @type string (default: "PatentscopePerson")
  • name string required
  • country_code string nullable
• priority_claims array (default: [])
  • @type string (default: "PatentscopePriorityClaim")
  • application_number string nullable
  • date string nullable
  • country_code string nullable
• designated_states array (default: [])
• family_members array (default: [])
  • @type string (default: "PatentscopeFamilyMember")
  • publication_number string required
  • doc_id string nullable
• web_url string (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 — Patent not found 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.