/api/v1/patent/rel_app_text/

Upstream view RelatedTextList (index rel_app_text, response key rel_app_texts). Any field may be null where the bulk data has no value. Default fields (f): patent_id, related_text. Default sort (s): [{"patent_id": "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/rel_app_text/

Response key

rel_app_texts

Default f

patent_id, related_text

Default s

[{"patent_id": "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/rel_app_text/ \
  --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/rel_app_text/", 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["rel_app_texts"][: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).

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