/api/v1/patent/attorney/

Upstream view AttorneyList (index attorneys, response key attorneys). Any field may be null where the bulk data has no value. Default fields (f): attorney_id, attorney_name_first, attorney_name_last, attorney_organization. Default sort (s): [{"attorney_id": "asc"}]. 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/attorney/ GET POST /api/v1/patent/attorney/{pk}/
Response key: attorneys
Default f: attorney_id, attorney_name_first, attorney_name_last, attorney_organization
Default s: [{"attorney_id": "asc"}]
Default o: {}
q: required on the list route
Detail key: attorney_id in the path; a "/" in a key is written ":"

Example

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

import json, os, requests

base_url = "https://patentref.io"
headers = {"X-Api-Key": os.environ["PATENTREF_KEY"]}
params = {"q": {"_contains": {"attorney_organization": "Fish"}}}
r = requests.get(base_url + "/api/v1/patent/attorney/", 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["attorneys"][: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
`attorney_id`	string	keyword	yes
`attorney_name_first`	string	keyword	yes
`attorney_name_last`	string	keyword	yes
`attorney_organization`	string	text with a keyword form	yes
`attorney_first_seen_date`	string	date	yes
`attorney_last_seen_date`	string	date	yes
`attorney_num_inventors`	number	number	yes
`attorney_num_patents`	number	number	yes
`attorney_years_active`	number	number	yes

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