> ## Documentation Index
> Fetch the complete documentation index at: https://docs.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Discover the shared rating program library

> Free authenticated discovery, including locked and unlinked programs. Omit state to list every geographic scope; a supplied state matches that explicit state only and excludes unspecified scope. Null state does not imply nationwide support. Filters combine with AND. Sorted by name then ID; live offset pagination. No storage locations are exposed.



## OpenAPI

````yaml /openapi.json get /insurance/rating-programs
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /insurance/rating-programs:
    get:
      tags:
        - Rating programs
      summary: Discover the shared rating program library
      description: >-
        Free authenticated discovery, including locked and unlinked programs.
        Omit state to list every geographic scope; a supplied state matches that
        explicit state only and excludes unspecified scope. Null state does not
        imply nationwide support. Filters combine with AND. Sorted by name then
        ID; live offset pagination. No storage locations are exposed.
      operationId: listRatingPrograms
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
            description: Maximum number of items to return (1-200).
          required: false
          description: Maximum number of items to return (1-200).
          name: limit
          in: query
        - schema:
            type: string
            description: '`nextCursor` from the previous page.'
          required: false
          description: '`nextCursor` from the previous page.'
          name: cursor
          in: query
        - schema:
            type: string
            maxLength: 300
          required: false
          name: name
          in: query
        - schema:
            type: string
          required: false
          name: productId
          in: query
        - schema:
            type: string
            pattern: ^[A-Z]{2}$
          required: false
          name: state
          in: query
        - schema:
            type: string
          required: false
          name: carrierId
          in: query
      responses:
        '200':
          description: One page of programs with current caller access.
          content:
            application/json:
              schema:
                type: object
                properties:
                  programs:
                    type: array
                    items:
                      $ref: '#/components/schemas/V2RatingProgramSummary'
                  nextCursor:
                    type: string
                    nullable: true
                    description: Cursor for the next page, or null on the last page.
                required:
                  - programs
                  - nextCursor
                additionalProperties: false
        '400':
          description: Invalid request or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Program entitlement and user permission are required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Program, version or package not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Stored bundle identity differs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Input exceeds the size limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '422':
          description: Invalid inputs or business refusal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Rating capacity unavailable; honor Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2RatingProgramSummary:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 300
        description:
          type: string
          nullable: true
          maxLength: 4000
        productId:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
          pattern: ^[A-Z]{2}$
        carrierId:
          type: string
          nullable: true
        id:
          type: string
          pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
        productName:
          type: string
          nullable: true
        carrierName:
          type: string
          nullable: true
        latestVersion:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        access:
          type: object
          properties:
            canRun:
              type: boolean
            canDownload:
              type: boolean
            expiresAt:
              type: string
              nullable: true
              format: date-time
          required:
            - canRun
            - canDownload
            - expiresAt
          additionalProperties: false
      required:
        - name
        - description
        - productId
        - state
        - carrierId
        - id
        - productName
        - carrierName
        - latestVersion
        - access
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
              description: Dataset needed for dataset_not_enabled.
            upgradeUrl:
              type: string
              nullable: true
              format: uri
              description: Where to upgrade for plan_required, when available.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.