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

# List market raters

> List the market raters in Effective’s catalog, including raters your organization has not subscribed to. In this API a market rater is a rating program: its `id` is the `programId` the other operations take. Raters whose IDs start with `effective.example` are synthetic examples for learning.

Filter by name, product, carrier, state or subscription. A result matches every filter you send.

- `productId` and `state` match the rater’s recorded product and state routes. A rater without a state is not nationwide. For the exact version that rates a policy date and transaction, use [List which rating program versions rate a product in a state](/api-reference/products/list-which-rating-program-versions-rate-a-product-in-a-state).
- `subscribed=true` lists your organization’s subscriptions, and `subscribed=false` lists the others.
- `kind=model` lists rating models in place of raters.

Results sort by name, then ID. For the next page, send `nextCursor` as `cursor` with the same filters and `limit`. A cursor from another query returns `invalid_cursor`.



## 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.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/rating-programs:
    get:
      tags:
        - Market raters
      summary: List market raters
      description: >-
        List the market raters in Effective’s catalog, including raters your
        organization has not subscribed to. In this API a market rater is a
        rating program: its `id` is the `programId` the other operations take.
        Raters whose IDs start with `effective.example` are synthetic examples
        for learning.


        Filter by name, product, carrier, state or subscription. A result
        matches every filter you send.


        - `productId` and `state` match the rater’s recorded product and state
        routes. A rater without a state is not nationwide. For the exact version
        that rates a policy date and transaction, use [List which rating program
        versions rate a product in a
        state](/api-reference/products/list-which-rating-program-versions-rate-a-product-in-a-state).

        - `subscribed=true` lists your organization’s subscriptions, and
        `subscribed=false` lists the others.

        - `kind=model` lists rating models in place of raters.


        Results sort by name, then ID. For the next page, send `nextCursor` as
        `cursor` with the same filters and `limit`. A cursor from another query
        returns `invalid_cursor`.
      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
            minLength: 1
            maxLength: 8192
            description: >-
              Opaque nextCursor from this operation. Repeat every other query
              parameter unchanged; a cursor from a different query returns
              invalid_cursor.
          required: false
          description: >-
            Opaque nextCursor from this operation. Repeat every other query
            parameter unchanged; a cursor from a different query returns
            invalid_cursor.
          name: cursor
          in: query
        - schema:
            type: string
            maxLength: 300
            description: Match raters whose name contains this text, in any case.
          required: false
          description: Match raters whose name contains this text, in any case.
          name: name
          in: query
        - schema:
            type: string
            description: >-
              Managed product_ ID or bare checked code; case-insensitive with
              Crockford aliases.
          required: false
          description: >-
            Managed product_ ID or bare checked code; case-insensitive with
            Crockford aliases.
          name: productId
          in: query
        - schema:
            type: string
            pattern: ^[A-Z]{2}$
            description: Two-letter state code, such as `CA`.
          required: false
          description: Two-letter state code, such as `CA`.
          name: state
          in: query
        - schema:
            type: string
            description: The carrier’s Market Directory ID.
          required: false
          description: The carrier’s Market Directory ID.
          name: carrierId
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: true for your organization’s subscriptions, false for the others.
          required: false
          description: true for your organization’s subscriptions, false for the others.
          name: subscribed
          in: query
        - schema:
            type: string
            enum:
              - rater
              - model
            description: >-
              rater, the default, or model. A model is one part of a carrier’s
              rating plan, such as a credit score, a tier or a tier factor. For
              models, state, layer and fidelity match the latest version, and
              productId matches nothing.
          required: false
          description: >-
            rater, the default, or model. A model is one part of a carrier’s
            rating plan, such as a credit score, a tier or a tier factor. For
            models, state, layer and fidelity match the latest version, and
            productId matches nothing.
          name: kind
          in: query
        - schema:
            type: string
            enum:
              - score
              - tier
              - factor
            description: 'Models only: what the latest version computes.'
          required: false
          description: 'Models only: what the latest version computes.'
          name: layer
          in: query
        - schema:
            type: string
            enum:
              - exact_filed
              - alt_state_proxy
              - non_filed_assumption
            description: 'Models only: how closely the latest version follows its filings.'
          required: false
          description: 'Models only: how closely the latest version follows its filings.'
          name: fidelity
          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: >-
            Your organization’s access to the rater, or your permission, is
            missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: The rater, version or package is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            The engine that serves this version differs from the engine it
            records. Retry later; if it persists, contact Effective.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: The inputs exceed 1 MiB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: The request body is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '422':
          description: >-
            invalid_inputs or business_rejection: violations lists each failed
            constraint. evaluation_failed: the engine could not rate the inputs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Too many requests, or no rating capacity. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: A dependency is unavailable. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2RatingProgramSummary:
      type: object
      properties:
        kind:
          type: string
          enum:
            - rater
            - model
          description: >-
            rater: a program that rates a policy. model: one part of a carrier
            rating plan, such as a credit score, a tier or a tier factor. Fixed
            when the program is created.
        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}$
          description: The market rater’s ID, such as `effective.example-ca-ppa`.
        productName:
          type: string
          nullable: true
        carrierName:
          type: string
          nullable: true
        latestVersion:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        coverage:
          type: object
          properties:
            products:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    description: Managed product_ ID.
                  name:
                    type: string
                  states:
                    type: array
                    items:
                      type: string
                    description: States with at least one route, as stored.
                required:
                  - id
                  - name
                  - states
                additionalProperties: false
          required:
            - products
          additionalProperties: false
          description: >-
            Products and states this program has routes for, by product name.
            Empty means no routes are recorded, not nationwide or unsupported.
        access:
          type: object
          properties:
            canRun:
              type: boolean
            canDownload:
              type: boolean
            expiresAt:
              type: string
              nullable: true
              format: date-time
          required:
            - canRun
            - canDownload
            - expiresAt
          additionalProperties: false
        subscription:
          type: object
          properties:
            subscribed:
              type: boolean
            subscribedAt:
              type: string
              nullable: true
              format: date-time
            subscribedBy:
              type: string
              nullable: true
            canSubscribe:
              type: boolean
            canUnsubscribe:
              type: boolean
          required:
            - subscribed
            - subscribedAt
            - subscribedBy
            - canSubscribe
            - canUnsubscribe
          additionalProperties: false
      required:
        - kind
        - name
        - description
        - productId
        - state
        - carrierId
        - id
        - productName
        - carrierName
        - latestVersion
        - coverage
        - access
        - subscription
      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
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          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.