Clarivate Derwent API

openapi: 3.2.0
info:
  contact:
    email: Derwent.support@clarivate.com
    name: Derwent API
  description: Derwent APIs provide seamless access to enriched patent data, enabling users to enhance their research capabilities and make faster, more informed decisions.
  termsOfService: https://clarivate.com/legal-center/terms-of-business/product-service-terms/
  title: Intellectual Property (IP) Data Derwent API
  version: 1.0.7
servers:
- url: https://api.clarivate.com
security:
- key: []
tags:
- name: Derwent API
paths:
  /ip/patents/derwent/document/images/{document_guid}:
    get:
      description: Fetch a list of the images associated with this document, as URLs
      operationId: derwentGetDocumentImages
      parameters:
      - description: Unique document ID
        in: path
        name: document_guid
        required: true
        schema:
          type: string
      - default: 380
        description: Requested image size in pixels
        in: query
        name: size
        schema:
          type: integer
      - default: true
        description: Return IP API wrapper URLs when true; return direct CLIPS URLs when false
        in: query
        name: wrap
        schema:
          type: boolean
      - default: gif
        description: Image format requested from CLIPS
        example: gif
        in: query
        name: format
        schema:
          type: string
      - default: normal
        description: 'Image type to retrieve. Supported values: normal, inline'
        example: inline
        in: query
        name: type
        schema:
          type: string
      - default: 0
        description: Front-page image flag. Use 1 for front-page images.
        example: 1
        in: query
        name: fponly
        schema:
          type: integer
      - description: DWPI image mode. Use 0 for DWPI front page or 1 for all DWPI images.
        example: 1
        in: query
        name: dwpi
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_url_list_derwent_api'
          description: Success
        '400':
          content:
            application/json:
              examples:
                invalidImageType:
                  summary: Invalid image type
                  value:
                    code: 2200
                    error: Invalid image type requested
              schema:
                oneOf:
                - properties:
                    code:
                      description: Application error code
                      type: integer
                    error:
                      description: Error message
                      type: string
                  required:
                  - code
                  - error
                  type: object
                - properties:
                    error:
                      description: Error message
                      type: string
                  required:
                  - error
                  type: object
          description: Invalid image request. Relevant Derwent error codes include 2200 for invalid values.
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              examples:
                insufficientEntitlements:
                  summary: Missing Derwent images entitlement
                  value:
                    code: 2400
                    error: Insufficient entitlements to access this resource
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: Derwent API to retrieve images for patents using jwt authentication
      tags:
      - Derwent API
    post:
      description: Fetch Derwent image URLs for one or more patent IDs or publication numbers, including all-image and inline-image requests.
      operationId: derwentPostDocumentImages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/derwent_images_request'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_url_list_derwent_api'
          description: Success
        '400':
          content:
            application/json:
              examples:
                countOutOfRange:
                  summary: ids/pn count out of range
                  value:
                    error: ids/pn count must be between 1 and 500
                idsAndPn:
                  summary: Both ids and pn supplied
                  value:
                    error: Provide either ids or pn, not both
                idsLimitExceeded:
                  summary: IDs limit exceeded
                  value:
                    code: 2300
                    error: The number of IDs in the request must not exceed {limit}
                invalidImageType:
                  summary: Invalid image type
                  value:
                    code: 2200
                    error: Invalid image type requested
                invalidRequestBody:
                  summary: Request body is not a JSON object
                  value:
                    error: Request body must be a JSON object
                invalidSize:
                  summary: Invalid size parameter
                  value:
                    error: Invalid size parameter value
                missingIdsOrPn:
                  summary: ids or pn required
                  value:
                    error: Provide ids or pn
                missingParams:
                  summary: Missing params list
                  value:
                    error: Missing params list
                pnsLimitExceeded:
                  summary: PNs limit exceeded
                  value:
                    code: 2300
                    error: The number of PNs in the request must not exceed {limit}
              schema:
                oneOf:
                - properties:
                    code:
                      description: Application error code
                      type: integer
                    error:
                      description: Error message
                      type: string
                  required:
                  - code
                  - error
                  type: object
                - properties:
                    error:
                      description: Error message
                      type: string
                  required:
                  - error
                  type: object
          description: Invalid image request. Relevant Derwent error codes include 2200 for invalid values and 2300 for request limits.
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              examples:
                insufficientEntitlements:
                  summary: Missing Derwent images entitlement
                  value:
                    code: 2400
                    error: Insufficient entitlements to access this resource
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: Derwent API to retrieve images for patents using jwt authentication using POST…
      tags:
      - Derwent API
  /patents/derwent/class-browse:
    post:
      description: Request to provide a class lookup service that supports hierarchical classification code lists for a given classification code, e.g., ipc8
      operationId: derwentClassBrowse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/class_browsing_request_derwent_api'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  classificationresponse:
                    properties:
                      classdescription:
                        items:
                          properties:
                            child_count:
                              description: Number of child classes
                              example: 37
                              type: integer
                            classes:
                              description: Classification code
                              example: A01B
                              type: string
                            level:
                              description: Classification level
                              example: 3
                              type: integer
                            value:
                              description: Description of the class
                              example: SOIL WORKING IN AGRICULTURE OR FORESTRY; PARTS, DETAILS, OR ACCESSORIES OF AGRICULTURAL MACHINES OR IMPLEMENTS, IN GENERAL...
                              type: string
                          required:
                          - classes
                          - level
                          - child_count
                          - value
                          type: object
                        type: array
                    type: object
                  duration:
                    description: Duration of the operation
                    example: '17'
                    type: string
                type: object
          description: Success
        '400':
          content:
            application/json:
              example:
                code: 1200
                error: Invalid request. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Invalid request
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                code: 10200
                error: Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: Derwent API to provide the ability to perform class browsing service to support…
      tags:
      - Derwent API
  /patents/derwent/class-search:
    post:
      description: Request to provide the ability to perform class searching service to support the search of keyword terms to retrieve matching 'classification codes', e.g., ipc8
      operationId: derwentClassSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/class_search_request_derwent_api'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  classificationresponse:
                    properties:
                      classdescription:
                        items:
                          properties:
                            child_count:
                              description: Number of child classes
                              example: 0
                              type: integer
                            classes:
                              description: Classification code
                              example: A61K003658
                              type: string
                            level:
                              description: Classification level
                              example: 0
                              type: integer
                            value:
                              description: Description of the class
                              example: Meliaceae (Chinaberry or Mahogany family), e.g. Azadirachta (neem)
                              type: string
                          required:
                          - classes
                          - level
                          - child_count
                          - value
                          type: object
                        type: array
                      searched:
                        description: Number of items searched
                        example: 0
                        type: integer
                      total:
                        description: Total number of results
                        example: 2
                        type: integer
                    type: object
                  duration:
                    description: Duration of the operation
                    example: '17'
                    type: string
                type: object
          description: Success
        '400':
          content:
            application/json:
              example:
                code: 1200
                error: Invalid request. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Invalid request
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                code: 10200
                error: Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: Derwent API to provide the ability to perform class searching service to…
      tags:
      - Derwent API
  /patents/derwent/combined-search:
    post:
      description: Request to provide the ability to search a combination of queries
      operationId: derwentCombinedSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/combined_search_request_derwent_api'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  body:
                    items:
                      properties:
                        field:
                          items:
                            properties:
                              form:
                                description: Field form
                                example: orig
                                type: string
                              name:
                                description: Field name
                                example: pn
                                type: string
                              value:
                                description: Field value
                                example: USRE50627E1
                                type: string
                            required:
                            - name
                            - form
                            - value
                            type: object
                          type: array
                        id:
                          description: Unique identifier for the record
                          example: USRE50627E120251007
                          type: string
                        rank:
                          description: Rank of the record
                          example: 1
                          type: integer
                      required:
                      - id
                      - rank
                      - field
                      type: object
                    type: array
                  header:
                    properties:
                      duration:
                        description: Duration of the operation in milliseconds
                        example: '605'
                        type: string
                      found:
                        description: Number of items found
                        example: 28880,4731,216523,6601581
                        type: string
                      searched:
                        description: Total number of items searched
                        example: 177472411
                        type: integer
                      size:
                        description: Number of items returned in this response
                        example: 30000
                        type: integer
                    type: object
                type: object
          description: Success
        '400':
          content:
            application/json:
              example:
                code: 1200
                error: Invalid request. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Invalid request
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                code: 10200
                error: Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: Derwent API to provide the ability to search with combination of queries
      tags:
      - Derwent API
  /patents/derwent/corporate-tree:
    post:
      description: Request to look-up entities as either code or terms within corporate tree resulting in tree structure
      operationId: derwentCorporateTree
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/corporate_tree_request_derwent_api'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  corporateTreeResponse:
                    properties:
                      corporationDescription:
                        items:
                          properties:
                            code:
                              description: Corporation code
                              example: MICROSOFT
                              type: string
                            docCount:
                              description: Document count
                              example: 0
                              type: integer
                            level:
                              description: Hierarchy level
                              example: 0
                              type: integer
                            spellings:
                              properties:
                                spelling:
                                  items:
                                    properties:
                                      mapid:
                                        description: Spelling map ID
                                        example: '9264041'
                                        type: string
                                      value:
                                        description: Spelling value
                                        example: FSLOGIX INC
                                        type: string
                                    required:
                                    - mapid
                                    - value
                                    type: object
                                  type: array
                              required:
                              - spelling
                              type: object
                            title:
                              properties:
                                value:
                                  description: Corporation title
                                  example: Microsoft Corporation
                                  type: string
                              required:
                              - value
                              type: object
                          required:
                          - code
                          - level
                          - docCount
                          - title
                          - spellings
                          type: object
                        type: array
                    type: object
                  duration:
                    description: Duration of the operation
                    example: '315'
                    type: string
                type: object
          description: Success
        '400':
          content:
            application/json:
              example:
                code: 1200
                error: Invalid request. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Invalid request
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this res

# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clarivate/refs/heads/main/openapi/clarivate-derwent-api-api-openapi.yml