- About
- Methods & Sources
- Community
API Endpoints menu
Assignees Beta Endpoint
GET /api/v1/assignee/
POST /api/v1/assignee/
This will search for assignees matching the query string (q) and returning the data fields listed in the field string (f) sorted by the fields in the sort string (s) using options provided in the option string (o).
Either the HTTP GET, or POST method can be used; however, when the query parameters exceed a reasonable size (around 2,000 characters), then the POST method may be preferable. When using the POST method, the query parameters should be embedded within a JSON string within the request body.
Requests using the lookup endpoint must include a single assignee id and will use the default f, s, and o options.
Name | Description | Defaults | Details |
---|---|---|---|
q | JSON formatted object containing the query parameters. See below for details on formatting this object. | string, required example: {"inventor_id":"2335918"} |
|
f | JSON formatted array of fields to include in the results. | If not provided, defaults to assignee_id, name_first, name_last, and organization | string, optional example: ["organization", "last_seen_date"] |
s | JSON formatted array of objects to sort the results. | If not provided, defaults to assignee_id, ascending. | string, optional example: [{"last_seen_date": "desc"}] |
o |
JSON formatted object of options to modify the results. Use these to page through results. Available options are: |
Size: Defaults to 100. Offset: Defaults to 0. |
string, optional example: {"size": 100, "offset": 0} |
An example of a complete API call using the GET verb is:
https://search.patentsview.org/api/v1/assignee/?q={"_text_any":{"organization":"Race"}}&f=["assignee_id","organization","num_patents"]
An example of the equivalent API call using the POST verb is:
https://search.patentsview.org/api/v1/assignee /
with the body containing:
{"q": {"_text_any":{"organization":"Race"}}, "f": ["assignee_id","organization","num_patents"], "o": {}, "s": []}
An example of an API call using the lookup endpoint is:
https://search.patentsview.org/api/v1/patent/10757852/
Examples
Return all assignees seen since 2002.
https://search.patentsview.org/api/v1/assignee/?q={"_gte":{"last_seen_date":"2002-01-01"}}&f=["assignee_id", "organization", "last_seen_date", "assignee_years"]
Return all assignees with between 25,000 and 30,000 patents, sorted by those seen most recently.
https://search.patentsview.org/api/v1/assignee/?q={"_and":[{"_gte":{"num_patents":"25000"}}, {"_lte":{"num_patents":"30000"}}]}&f= ["assignee_id", "last_seen_date", "num_patents"]&s= [{"last_seen_date":"desc"}]
Assignee Field List
The endpoint's field list can be viewed at the bottom of the webpage on the API's Swagger interface.