/api/v1/patent/foreign_citation/

Upstream view ForeignCitationList (index foreign_citations, response key foreign_citations). Any field may be null where the bulk data has no value. Default fields (f): patent_id, citation_sequence, citation_number. Default sort (s): [{"patent_id": "asc", "citation_sequence": "asc"}]. Default options (o): {"pad_patent_id": false}. When the build in service does not carry this endpoint's data set it answers 501 with X-Status-Reason-Code ERR_NOT_IMPLEMENTED and X-Status-Reason naming the data set.

Routes: GET POST /api/v1/patent/foreign_citation/
Response key: foreign_citations
Default f: patent_id, citation_sequence, citation_number
Default s: [{"patent_id": "asc", "citation_sequence": "asc"}]
Default o: {"pad_patent_id": false}
q: required on the list route

Example

curl -s -G -H "X-Api-Key: $KEY" https://patentref.io/api/v1/patent/foreign_citation/ \
  --data-urlencode 'q={"patent_id": "10000000"}'

import json, os, requests

base_url = "https://patentref.io"
headers = {"X-Api-Key": os.environ["PATENTREF_KEY"]}
params = {"q": {"patent_id": "10000000"}}
r = requests.get(base_url + "/api/v1/patent/foreign_citation/", headers=headers,
                 params={k: json.dumps(v) for k, v in params.items()})
r.raise_for_status()
data = r.json()
print(data["total_hits"], data["foreign_citations"][:3])

Fields

Kind is how q treats the field (grammar, Field kinds). Sortable fields go in s. Nested fields are named with a dot in q and f; naming the group returns its upstream fields, and a field whose note says it is present only when f names it comes back only then. The rows of a group come in the order of their source (grammar, the response and paging).

Field	Type	Kind	Sortable	Note
`patent_id`	string	keyword	yes
`patent`	string (URL)	keyword		Link to the detail record: https://patentref.io/api/v1/patent/<id>/, with a "/" in the id written ":"; null when the id is null. Kind: keyword: in q this name matches the id behind the link (for example "H01" for cpc_current.cpc_class), not the URL.
`citation_number`	string	keyword	yes
`citation_sequence`	integer	number	yes
`citation_date`	string	date	yes
`citation_category`	string	keyword	yes
`citation_country`	string	keyword	yes	The two-letter office code printed on the grant: mostly the WIPO codes (GB, EP for the European Patent Office, WO for international applications), with "UK" on some older rows.

Machine-readable: this page's data as JSON, and the operation in openapi.json (operationId ForeignCitationList).