Download OpenAPI specification:Download
The Data Set API (DSAPI) allows the public users to discover and search USPTO exported data sets. This is a generic API that allows USPTO users to make any CSV based data files searchable through API. With the help of GET call, it returns the list of data fields that are searchable. With the help of POST call, data can be fetched based on the filters on the field names. Please note that POST call is used to search the actual data. The reason for the POST call is that it allows users to specify any complex search criteria without worry about the GET size limitations as well as encoding of the input parameters.
{- "total": 2,
- "apis": [
- {
- "apiKey": "oa_citations",
- "apiVersionNumber": "v1",
}, - {
- "apiKey": "cancer_moonshot",
- "apiVersionNumber": "v1",
}
]
}This GET API returns the list of all the searchable field names that are in the oa_citations. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.
| dataset required | string Default: "oa_citations" Name of the dataset. In this case, the default value is oa_citations |
| version required | string Default: "v1" Version of the dataset. |
"string"This API is based on Solr/Lucense Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.
| version required | string Default: "v1" Version of the dataset. |
| dataset required | string Default: "oa_citations" Name of the dataset. In this case, the default value is oa_citations |
| criteria required | string Default: "*:*" Uses Lucene Query Syntax in the format of propertyName:value, propertyName:[num1 TO num2] and date range format: propertyName:[yyyyMMdd TO yyyyMMdd]. In the response please see the 'docs' element which has the list of record objects. Each record structure would consist of all the fields and their corresponding values. |
| start | integer Default: 0 Starting record number. Default value is 0. |
| rows | integer Default: 100 Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset. |
[- {
- "property1": { },
- "property2": { }
}
]