openapi: 3.0.1 info: title: Docket Alarm ChatGPT Plugin - U.S. Courts API description: API Specification for U.S. Courts version: "1.10" servers: - url: https://www.docketalarm.com - url: http://localhost:8080 paths: /api/v1/search/: get: summary: Search Docket Alarm with a GET request. operationId: search parameters: - name: login_token in: query required: true description: The authentication token. Required, but may be empty string when using HTTP Basic Auth. schema: type: string - name: q in: query required: true description: The search query. schema: type: string - name: o in: query description: Specifies the result order. Blank search by relevance; date_filed, oldest first; -date_filed, newest first; random; date_last_filing; and -date_last_filing. schema: type: string - name: limit in: query description: The number of results to be returned (50 max). schema: type: integer - name: offset in: query description: The offset into the search results to be returned. schema: type: integer - name: client_matter in: query description: Required. A matter note associated with the search, can be empty string. schema: type: string - name: _quiet in: query description: Show more condensed textual information, better for LLM searching. schema: type: boolean - name: snippet in: query description: Show snippet information about each case. schema: type: boolean responses: 200: description: Successful search content: application/json: schema: type: object properties: search_results: type: array items: type: object count: type: integer scroll: type: string # /snippet/: # get: # summary: Retrieve a short snippet of information about a search result. # operationId: snippet # parameters: # - in: query # name: client_matter # description: Required. A matter note associated with the search, can be empty string. # schema: # type: string # - in: query # name: q # description: The url encoded query that was applied in the search. Use another query to highlight a search result differently. # schema: # type: string # - in: query # name: court # description: Court name from search result. # schema: # type: string # - in: query # name: docket # description: The docket from the search result. # schema: # type: string # - in: query # name: number # description: The filing number (for document search results). # schema: # type: string # - in: query # name: exhibit # description: The exhibit (for document search results). # schema: # type: string # responses: # 200: # description: Snippet successfully retrieved. # content: # application/json: # schema: # type: object # properties: # snippet: # type: string # description: A snippet of the requested document. /api/v1/getdocket/: get: summary: Retrieve a Docket operationId: getdocket parameters: - name: login_token in: query required: true description: The authentication token. Required, but may be empty string when using HTTP Basic Auth. schema: type: string - name: client_matter in: query required: true description: Required. A matter note associated with the search, can be empty string. schema: type: string - name: court in: query required: true description: The name of the court, obtained from search/, searchpacer/ or a push notification. schema: type: string - name: docket in: query required: true description: The docket identifier, obtained from search/, searchpacer/ or a push notification. schema: type: string - name: cached in: query description: The cached parameter. Should generally set to true to get faster results. schema: type: boolean - name: normalize in: query description: If true, normalize judges, party names, law firm names, and attorney names. schema: type: boolean responses: 200: description: Successfully retrieved docket content: application/json: schema: type: object properties: info: type: object docket_report: type: array items: type: object parties: type: array items: type: object related: type: array items: type: object claims: type: array items: type: object