openapi: 3.0.3
info:
  title: USPTO Bulk Data Storage System (BDSS) Appeals Patentsview API
  version: '1.0'
  description: 'USPTO ODP Bulk Data API. Exposes the Bulk Data Storage System (BDSS) — search and download

    patent and trademark bulk datasets (bibliographic, assignment, classification, office-action

    weekly archives) as Entire Datasets (10-year increments) or Delta Datasets (daily increments)

    in XML/JSON. Does not support general filter/limit/offset/order_by database queries.

    '
  contact:
    name: USPTO API Help
    email: APIhelp@uspto.gov
servers:
- url: https://api.uspto.gov
  description: USPTO Open Data Portal
security:
- ApiKeyAuth: []
tags:
- name: Patentsview
paths:
  /api/v1/patentsview/patents:
    get:
      summary: Query Patents
      operationId: queryPatents
      parameters:
      - name: q
        in: query
        schema:
          type: string
        description: JSON query expression
      - name: f
        in: query
        schema:
          type: string
        description: Comma-separated field list
      - name: s
        in: query
        schema:
          type: string
        description: Sort spec
      - name: o
        in: query
        schema:
          type: string
        description: Pagination options
      responses:
        '200':
          description: Patent records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatentsViewResponse'
      tags:
      - Patentsview
  /api/v1/patentsview/inventors:
    get:
      summary: Query Inventors
      operationId: queryInventors
      parameters:
      - name: q
        in: query
        schema:
          type: string
      - name: f
        in: query
        schema:
          type: string
      - name: o
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Inventor records (with disambiguation IDs)
          content:
            application/json:
              schema:
                type: object
      tags:
      - Patentsview
  /api/v1/patentsview/assignees:
    get:
      summary: Query Assignees
      operationId: queryAssignees
      parameters:
      - name: q
        in: query
        schema:
          type: string
      - name: f
        in: query
        schema:
          type: string
      - name: o
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Assignee records
          content:
            application/json:
              schema:
                type: object
      tags:
      - Patentsview
  /api/v1/patentsview/locations:
    get:
      summary: Query Locations
      operationId: queryLocations
      parameters:
      - name: q
        in: query
        schema:
          type: string
      - name: f
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Location records
          content:
            application/json:
              schema:
                type: object
      tags:
      - Patentsview
  /api/v1/patentsview/cpc_subsections:
    get:
      summary: Query CPC Subsections
      operationId: queryCpcSubsections
      parameters:
      - name: q
        in: query
        schema:
          type: string
      - name: f
        in: query
        schema:
          type: string
      responses:
        '200':
          description: CPC subsection records
          content:
            application/json:
              schema:
                type: object
      tags:
      - Patentsview
components:
  schemas:
    PatentsViewResponse:
      type: object
      properties:
        count:
          type: integer
        total_patent_count:
          type: integer
        patents:
          type: array
          items:
            type: object
            properties:
              patent_number:
                type: string
              patent_title:
                type: string
              patent_date:
                type: string
                format: date
              patent_type:
                type: string
              inventors:
                type: array
                items:
                  type: object
                  properties:
                    inventor_id:
                      type: string
                    inventor_first_name:
                      type: string
                    inventor_last_name:
                      type: string
              assignees:
                type: array
                items:
                  type: object
                  properties:
                    assignee_id:
                      type: string
                    assignee_organization:
                      type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY