Learn About Patents Around the World

 
 
 
IN THIS SECTION

U.S. Patent Citation Beta Endpoint

GET /api/v1/patent/us_patent_citation/
POST /api/v1/patent/us_patent_citation/
GET /api/v1/patent/us_patent_citation/{patent_id}/

This will search for patents 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 patent 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: {"patent_id": "10966293"}
f JSON formatted array of fields to include in the results. If not provided, defaults to patent_id, citation_patent_id, and citation_date.

String, optional 
Example: ["patent_id", "citation_patent_id"]
s JSON formatted array of objects to sort the results. If not provided, defaults to patent_id.

String, optional 
Example: [{"citation_date": "desc"}]
o

JSON formatted object of options to modify the results. Use these to page through results. Available options are: 
Size: Number of results to return. 
After: Displays results after a specified record, allows for paging through results. 

Size: Defaults to 100. 

After: Defaults to none.

String, optional 
Example: {"size": 50,"after": "10966293"}

An example of a complete API call using the GET verb is:

/api/v1/patent/us_patent_citation/?q={"_gte":{"citation_date":"2007-01-04"}}&f=["patent_id","citation_date"]

An example of the equivalent API call using the POST verb is:

/api/v1/patent/us_patent_citation/
with the body containing:
{"q":{"_gte":{"citation_date":"2007-01-04"}},"f":["patent_id","citation_date"]}

An example of an API call using the lookup endpoint is:

/api/v1/patent/us_patent_citation/10966293/

Examples

Return the patent id and the first-cited patent id of all patents before December 31, 1999:

/api/v1/patent/us_patent_citation/?q= {"_and":[{"citation_sequence":"1"},{"_lte":{"citation_date":"1999-12-31"}}]}&f= [ "patent_id", "citation_patent_id"]

Return the patent id and date of all patents cited by the applicant on a given patent, sorted by date:

/api/v1/patent/us_patent_citation/?q= {"_and":[{"patent_id":"9919704"},{"citation_category":"cited by applicant"}]}&f= ["citation_patent_id","citation_date"]&s= [{ "citation_date": "desc" }]

Return the patent id and citation category of ten of the patents that have cited a given patent:

/api/v1/patent/us_patent_citation/?q= {"citation_patent_id":"8664792"}&f= ["patent_id","citation_category"]&o={"size":10}

U.S. Patent Citation Field List

{"us_patent_citations": [
    {
      "patent_id": "keyword",
      "patent": "keyword",
      "citation_sequence": 1,
      "citation_patent_id": "keyword",
      "citation_patent": "keyword",
      "citation_wipo_kind": "keyword",
      "citation_category": "keyword",
      "citation_date": "1976-01-06",
      "citation_name": "keyword"
    }
  ]
}