/api/v1/publication/

In data version 20261027.2 this endpoint answers 501 ERR_NOT_IMPLEMENTED: publications: pre-grant publications (/api/v1/publication/, /api/v1/publication/rel_app_text/ and the pg_claim, pg_brf_sum_text, pg_detail_desc_text and pg_draw_desc_text endpoints), deferred to a later build.

Upstream view PublicationList (index publications, response key publications). Deferred: pre-grant publications are not in this snapshot yet; the endpoint answers 501 with X-Status-Reason-Code ERR_NOT_IMPLEMENTED. Any field may be null where the bulk data has no value. Default fields (f): document_number, publication_title, publication_date. Default sort (s): [{"document_number": "asc"}]. Nested groups usable in q and f with dotted names: assignees, cpc_at_issue, cpc_current, foreign_priority, gov_interest_organizations, granted_pregrant_crosswalk, inventors, ipcr, pct_data, us_parties, us_related_documents, uspc_at_issue, wipo.

Routes

GET POST /api/v1/publication/ GET POST /api/v1/publication/{pk}/

Response key

publications

Default f

document_number, publication_title, publication_date

Default s

[{"document_number": "asc"}]

Default o

{}

q

required on the list route

Detail key

document_number in the path; a "/" in a key is written ":"

Nested groups

assignees, cpc_at_issue, cpc_current, foreign_priority, gov_interest_organizations, granted_pregrant_crosswalk, inventors, ipcr, pct_data, us_parties, us_related_documents, uspc_at_issue, wipo

Example

curl -s -G -H "X-Api-Key: $KEY" https://patentref.io/api/v1/publication/ \
  --data-urlencode 'q={"_and": [{"_eq": {"inventors.inventor_city": "Boston"}}, {"assignees.assignee_city": "Boston"}]}'

import json, os, requests

base_url = "https://patentref.io"
headers = {"X-Api-Key": os.environ["PATENTREF_KEY"]}
params = {"q": {"_and": [{"_eq": {"inventors.inventor_city": "Boston"}}, {"assignees.assignee_city": "Boston"}]}}
r = requests.get(base_url + "/api/v1/publication/", 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["publications"][:3])

More requests on this endpoint: test_pub_text_all.

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

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