About this endpoint
What it does
Searches US patent and trademark data using a text query and returns a ranked list of matching records. You can optionally filter by year, limit the number of results, request text inclusion, and constrain by jurisdiction.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| year | String | No | Optional year filter. Accepts an integer from 1976 to 2100 or null. |
| limit | Integer | No | Maximum number of results to return. Default: 25; minimum: 1; maximum: 200. |
| query | String | Yes | Search query text. Minimum length: 2 characters. |
| include_text | Boolean | No | Whether to include text in the search response. Default: true. |
| jurisdiction | String | No | Optional jurisdiction filter. Accepts a string with length 2 to 8 characters, or null. |
Response
Returns a JSON object with year (integer or null), count (integer), query (string), results (array of objects), components (object), attribution (array of objects), include_text (boolean), and jurisdiction (string or null) fields. The results array contains ranked hits, and each item includes id (string), payload (object), rank_score (number), and entity_type (string).
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| year | Integer | No | The requested year, or null. |
| count | Integer | Yes | Number of results returned. |
| query | String | Yes | The query used for the search. |
| results | Object Array | Yes | Ranked search hits. Each item includes:<br>id (string)<br>payload (object; additional properties allowed; shape depends on entity_type)<br>rank_score (number)<br>entity_type (string; examples include patent_text, patent_metadata, trademark) |
| components | Object | No | Counts broken down by result category. Contains:<br>trademark_count (integer)<br>patent_text_count (integer)<br>patent_metadata_count (integer)<br>patent_text_num_found (integer) |
| attribution | Object Array | No | Attribution entries. Each item includes:<br>url (string, URI format)<br>notice (string)<br>source (string)<br>dataset (string)<br>license (string) |
| include_text | Boolean | No | Echoes the include_text request value. |
| jurisdiction | String | No | Echoes the jurisdiction request value, or null. |