...

Member Sub-members Description

inventors^† inventor An array of all inventors

priority

Member	Description
ucid	CLAIMS Direct application ucid
country	Priority filing country
doc_number	Priority application number
kind	Priority kind code
date	Priority filing date

The earliest priority excluding provision provisional applications.

publications

Member	Description
ucid	CLAIMS Direct publication ucid
country	Country code
doc_number	Publication number
kind	Publication kind code
date	Publication date
lang	Publication language

An array of all publications tied to the root application number.

grant

Member	Description
ucid	CLAIMS Direct publication ucid
country	Country code
doc_number	Granted document number
kind	Grant kind code
date	Granted publication date
lang	Granted language of publication

The published granted patent.

national_grant

Member	Description
ucid	CLAIMS Direct publication ucid
country	Country code
doc_number	National granted document number
kind	National grant kind code
date	National grant publication date
lang	Nation grant language of publication

The published national granted patent

titles

Member	Description
lang	Language of title
title	Text content of title

The titles array condenses the title(s) of all stages into a language-distinct array.

simple_family^† ucid An array of ucids which make up a simple family.

extended_family^† ucid An array of ucids which make up the extended inpadoc family.

classifications^†

The classifications array contains all classifications condensed into a unique set per classification type.

claims_hierarchy^†

Member	Description
num	Claim number
type	Type of claim (`dependent` or `independent`)
refs	If a dependent claim, a list of claim numbers on which this claim depends

The claims_hierarchy member outlines the claim dependencies.

Technical Details

Request

There are two request endpoints to tws: an and dn (application number lookup and document number lookup respectively).

...

Method	GET
Path
Parameter		Values	Description
	@id	String: ex. US-5551212[,EP 0700000]	One of or more application or document numbers to retrieve. Multiple @ids are separate separated by the commacommas.
	@include-optional	Integer: ex. 1	The default response contains a subset of available content. To include all available content (as denoted above under Content), set this parameter to 1.
	@include	String: ex. inventors	Include only a subset of optional content.
	@exclude	String: ex. publications	Exclude particular content.
	@include-only	String: ex. effective	Includes only the content specified. The top-level ucid member is always included by default.
	@origin	String: ex. EP or WO	When the origin of an application input is either EP or WO, this parameter should be specified. If there are multiple @ids, input of origin-per-id is accomplished through subscripts. For example, assume two input ids /custom/tws/an?id=US13/123456,FR12345678 You could specify `origin` specifically for the FR document as follows: `&origin.2=EP` If `origin` is specified without a subscript and there are multiple input ids, the `origin` specified applies to all inputs.
	@date	Integer: ex. 19960101	If given, this parameter increases performance and confidence in the input-matching process. The same method of explicitly targeting a specific input with `origin` applies to `date` as well, e.g., `&date.1=19900101`

...

Member	Description
method	The endpoint used to create this response
time	Time in seconds of the entire request/response
status	Enumeration: `success` or `error`
error	In the case of `status=error`, a message will describe the error.

...