Download Patent Examination Data

Download a bundled query response from the Patent Examination Data System.

download_peds(searchText = "*:*", filters = list("*:*"), outFile = NULL,
  start = 0, minMatch = "100%", overwrite = FALSE, waits = 50,
  wait = 10, endpoint = "https://ped.uspto.gov/api/queries/",
  compress = TRUE, load = TRUE, verbose = TRUE)

Arguments

searchText

Text to search for; "*:*" for none (default); see the FAQ on the PEDS site.

filters

A list of characters representing filter conditions in the form of "field:value" (e.g., list('appStatus:"Patented Case"')).

outFile

Name of the final JSON file, or directory in which to save files with parameter-hash names.

start

Initial record.

minMatch

Minimum number of terms required to match.

overwrite

Logical; overwrite any previous queries with the same body hash.

waits

Number of times to check for a completed bundle before giving up.

wait

Number of seconds to wait between retries (how long waits are).

endpoint

PEDs API endpoint.

compress

Logical; if FALSE, will not xz-compress the outFile.

load

Logical; if FALSE, will not return the downloaded content, or load in existing content.

verbose

Logical; if FALSE, will not print status messages.

Value

A list with an entry for each year in the set of patent metadata.

Examples

if (FALSE) {
# like case 3 in the API Documentation > API Tutorial on https://ped.uspto.gov/peds
download_peds(
  "firstNamedApplicant:(Google)",
  list('appStatus:"Patented Case"', "appFilingDate:[2013-01-01T00:00:00Z TO 2013-03-31T23:59:59Z]")
)
}