- About
- Methods & Sources
- Community
API Endpoints menu
NBER Beta Endpoints
GET /api/v1/nber_category/?
POST /api/v1/nber_category/
GET /api/v1/nber_category/{nber_category_id}/
GET /api/v1/nber_subcategory/?
POST /api/v1/nber_subcategory/
GET /api/v1/nber_subcategory/{nber_subcategory_id}/
This will search for NBER categories or subcategories 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 NBER category ID or NBER subcategory ID and will use the default f, s, and o options.
A request may be submitted with an empty query string. This will return all records.
Name | Description | Defaults | Details |
---|---|---|---|
q | JSON formatted object containing the query parameters. See below for details on formatting this object. |
String, required |
|
f | JSON formatted array of fields to include in the results. | If not provided, NBER Category defaults to nber_category_id and nber_category_title, and NBER Subcategory defaults to nber_subcategory_id, nber_subcategory_title, nber_category_id. |
String, optional |
s | JSON formatted array of objects to sort the results. | If not provided, NBER Category defaults to nber_category_id, and NBER Subcategory defaults to nber_subcategory_id. |
String, optional |
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 |
Examples of complete API calls using the GET verb:
https://search.patentsview.org/api/v1/nber_category/?q={"nber_category_id":"1"}&f=["nber_category_title"]
https://search.patentsview.org/api/v1/nber_subcategory/?q={"nber_subcategory_id":"11"}&f=["nber_subcategory_id", "nber_subcategory_title", "nber_subcategory_num_patents"]
Examples of the equivalent API calls using the POST verb:
https://search.patentsview.org/api/v1/nber_category/
https://search.patentsview.org/api/v1/nber_subcategory/
with the bodies containing, respectively:
{"q":{"nber_category_id":"1"},"f":["nber_category_title"]}
{"q":{"nber_subcategory_id":"11"},"f":["nber_subcategory_id","nber_subcategory_title","nber_subcategory_num_patents"]}
An example of an API call using the lookup endpoint is:
https://search.patentsview.org/api/v1/nber_category/1//
https://search.patentsview.org/api/v1/nber_subcategory/11/
Examples
Return all NBER categories, sorted by NBER category ID in descending order:
https://search.patentsview.org/api/v1/nber_category/?q={}&s=[{"nber_category_id": "desc"}]
Return the ID and title of NBER subcategories with between 100,000 and 250,000 patents:
https://search.patentsview.org/api/v1/nber_subcategory/?q={"_and":[{"_gte":{"nber_subcategory_num_patents":"100000"}},{"_lte":{"nber_subcategory_num_patents":250000}}]}&f=["nber_subcategory_id", "nber_subcategory_title"]
NBER Category and Subcategory Field Lists
The endpoint's field list can be viewed at the bottom of the webpage on the API's Swagger interface.