CourtListener Opinion API

openapi: 3.0.3
info:
  title: CourtListener REST Alerts Opinion API
  description: REST API providing programmatic access to US court opinions, PACER docket data, judge records, financial disclosures, oral argument audio, citation lookup and network analysis, search alerts, and case visualizations. Operated by the Free Law Project.
  version: '4.4'
  contact:
    name: Free Law Project
    url: https://free.law/contact/
    email: info@free.law
  license:
    name: Creative Commons Attribution-ShareAlike 4.0 International
    url: https://creativecommons.org/licenses/by-sa/4.0/
  termsOfService: https://free.law/terms/
servers:
- url: https://www.courtlistener.com/api/rest/v4
  description: CourtListener REST API v4 (current)
- url: https://www.courtlistener.com/api/rest/v1
  description: CourtListener REST API v1 (legacy)
security:
- tokenAuth: []
tags:
- name: Opinion
paths:
  /opinion/:
    get:
      summary: Pulls court opinions
      description: Returns a list of opinions
      operationId: getOpinion
      tags:
      - Opinion
      parameters:
      - name: format
        in: query
        description: response format for calls (XML,JSON,JSONP)
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: common delimited fields for return fields
        required: false
        schema:
          type: string
      - name: order_by
        in: query
        description: which field to order results by
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: number of records to limit response listing by (1000 max)
        required: false
        schema:
          type: string
      - name: absolute_url
        in: query
        description: pull the detail for an opinion
        required: false
        schema:
          type: string
      - name: blocked
        in: query
        description: Whether the opinion should be blocked from search engines
        required: false
        schema:
          type: string
      - name: citation_count
        in: query
        description: The number of times the opinion has been cited by other opinions
        required: false
        schema:
          type: string
      - name: court
        in: query
        description: The ID of the court where the opinion was written
        required: false
        schema:
          type: string
      - name: date_filed
        in: query
        description: The date the opinion was filed by the court
        required: false
        schema:
          type: string
      - name: date_modified
        in: query
        description: The date and time the opinion was last modified
        required: false
        schema:
          type: string
      - name: extracted_by_ocr
        in: query
        description: Whether the text of the opinion was extracted from an image using OCR
        required: false
        schema:
          type: string
      - name: precedential_status
        in: query
        description: Whether the opinion has precedential value
        required: false
        schema:
          type: string
      - name: time_retrieved
        in: query
        description: The date and time the opinion was added to our system
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/opinion'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
  schemas:
    opinion:
      type: object
      description: CourtListener opinion object
      properties:
        absolute_url:
          type: string
        blocked:
          type: boolean
        citation:
          type: array
        citation_count:
          type: integer
        court:
          type: string
        date_blocked:
          type: string
          format: date
        date_filed:
          type: string
          format: date
        date_modified:
          type: string
          format: date
        download_URL:
          type: string
        extracted_by_ocr:
          type: string
        id:
          type: integer
        judges:
          type: string
        local_path:
          type: string
        nature_of_suit:
          type: string
        pagerank:
          type: integer
          format: int64
        precedential_status:
          type: string
        resource_uri:
          type: string
        sha1:
          type: string
        source:
          type: string
        time_retrieved:
          type: string
          format: date
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Token-based authentication. Format: ''Token <your_token>'''
    basicAuth:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
externalDocs:
  description: CourtListener API Documentation
  url: https://wiki.free.law/c/courtlistener/help/api/rest/v4/overview