latestSwagger 2.0Terms of Use2026-08-10151137.9 KB

4212453c4c6a

patents

Search Patent Documents

post/patent/search

Request body

queryobject

Json query object

sizeinteger

Number of items per page

frominteger

Offset from the first result

includestring[]

Fields to be included in result

sortobject[]

Array of object mappings to specify field sorting

excludestring[]

Fields to be excluded from result

scrollstring

Scroll context time in minute (e.g. 1m)

scroll_idstring

For scroll based pagination, provide scroll_id from previous response body.

Example request

{
  "query": {
    "match": {
      "title": "Fidget Spinner"
    }
  },
  "size": 5,
  "include": [
    "biblio.invention_title",
    "legal_status",
    "biblio.priority_claims"
  ],
  "sort": [
    {
      "created": "desc"
    },
    {
      "year_published": "asc"
    }
  ]
}

Response

Valid response from the server

totalinteger

Total number of search results exists.

resultsinteger

Number of results in this response.