/api/v1/nber_subcategory/

Not in the snapshot yet: the routes answer 501 ERR_NOT_IMPLEMENTED.

Upstream view NBERSubCategoryList (index nber_subcategories, response key nber_subcategories). Dead upstream route: no data set exists behind it, upstream or here; 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): nber_subcategory_id, nber_subcategory_title, nber_category_id. Default sort (s): [{"nber_subcategory_id": "asc"}]. A lookup endpoint: q may be omitted to list every record.

Routes: GET POST /api/v1/nber_subcategory/ GET POST /api/v1/nber_subcategory/{pk}/
Response key: nber_subcategories
Default f: nber_subcategory_id, nber_subcategory_title, nber_category_id
Default s: [{"nber_subcategory_id": "asc"}]
Default o: {}
q: may be omitted (a lookup endpoint lists every record)
Detail key: nber_subcategory_id in the path; a "/" in a key is written ":"

Example

curl -s -G -H "X-Api-Key: $KEY" https://patentref.io/api/v1/nber_subcategory/ \
  --data-urlencode 'o={"size": 10}'

import json, os, requests

base_url = "https://patentref.io"
headers = {"X-Api-Key": os.environ["PATENTREF_KEY"]}
params = {"o": {"size": 10}}
r = requests.get(base_url + "/api/v1/nber_subcategory/", 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["nber_subcategories"][: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	Note
`nber_subcategory_id`	string	returned, not searchable
`nber_subcategory_title`	string	returned, not searchable
`nber_subcategory_num_patents`	integer	returned, not searchable
`nber_subcategory_num_assignees`	integer	returned, not searchable
`nber_subcategory_num_inventors`	integer	returned, not searchable
`nber_subcategory_first_seen_date`	string	returned, not searchable
`nber_subcategory_last_seen_date`	string	returned, not searchable
`nber_subcategory_years_active`	integer	returned, not searchable
`nber_category`	string (URL)	returned, not searchable	Link to the detail record: https://patentref.io/api/v1/nber_category/<id>/, with a "/" in the id written ":"; null when the id is null. Kind: none: the index has no search field for it, so a query on it matches nothing, as upstream; query the id field of the group instead. It comes back beside that id: f naming the id field or the whole group returns both, and f naming this link alone returns nothing.

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