> ## 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 rater versions

> List a market rater’s published versions, newest first. Each version fixes the engine that rates, its dates and its scope.

The newest version is not always the one for your policy date or transaction. [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) returns the exact version.

For the next page, send `nextBefore` as `before`.



## OpenAPI

````yaml /openapi.json get /insurance/rating-programs/{id}/versions
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/{id}/versions:
    get:
      tags:
        - Market raters
      summary: List market rater versions
      description: >-
        List a market rater’s published versions, newest first. Each version
        fixes the engine that rates, its dates and its scope.


        The newest version is not always the one for your policy date or
        transaction. [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)
        returns the exact version.


        For the next page, send `nextBefore` as `before`.
      operationId: listRatingProgramVersions
      parameters:
        - schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: The market rater’s ID, such as `effective.example-ca-ppa`.
          required: true
          description: The market rater’s ID, such as `effective.example-ca-ppa`.
          name: id
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
            description: Maximum number of versions to return (1-100).
          required: false
          description: Maximum number of versions to return (1-100).
          name: limit
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            description: 'Return versions below this number: the previous page’s nextBefore.'
          required: false
          description: 'Return versions below this number: the previous page’s nextBefore.'
          name: before
          in: query
      responses:
        '200':
          description: Newest versions first. Pass nextBefore as before for the next page.
          content:
            application/json:
              schema:
                type: object
                properties:
                  versions:
                    type: array
                    items:
                      $ref: '#/components/schemas/V2RatingProgramVersion'
                  nextBefore:
                    type: number
                    nullable: true
                required:
                  - versions
                  - nextBefore
                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:
    V2RatingProgramVersion:
      type: object
      properties:
        engineBundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
        programBundleId:
          type: string
          nullable: true
          pattern: ^[a-f0-9]{64}$
        effectiveDate:
          type: string
          nullable: true
          format: date
        supportedFrom:
          type: string
          nullable: true
          format: date
        supportedTo:
          type: string
          nullable: true
          format: date
        scopeNote:
          type: string
          nullable: true
          maxLength: 100000
        releaseNotes:
          type: string
          nullable: true
          maxLength: 100000
        modelDescriptor:
          type: object
          nullable: true
          properties:
            layer:
              type: string
              enum:
                - score
                - tier
                - factor
              description: >-
                What the model computes: a score from attributes, a tier or code
                from a score, or a factor from a tier or code
            title:
              type: string
              minLength: 1
              maxLength: 200
            carrier:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                naicGroup:
                  type: string
                  maxLength: 16
                naicCompanies:
                  type: array
                  items:
                    type: string
                    maxLength: 16
                  maxItems: 100
              required:
                - name
            states:
              type: array
              items:
                type: string
                pattern: ^[A-Z]{2}$
              minItems: 1
              maxItems: 60
              description: States whose filings the model reproduces
            vintage:
              type: object
              properties:
                filed:
                  type: string
                  format: date
                effective:
                  type: string
                  format: date
            fidelity:
              type: string
              enum:
                - exact_filed
                - alt_state_proxy
                - non_filed_assumption
              description: >-
                exact_filed: reproduces the filed rules for the stated states
                and vintage. alt_state_proxy: filed rules from another state or
                vintage stand in for these. non_filed_assumption: part of the
                logic is an assumption, not a filing.
            sources:
              type: array
              items:
                type: object
                properties:
                  serffTrackingNumber:
                    type: string
                    minLength: 1
                    maxLength: 64
                  document:
                    type: string
                    maxLength: 500
                  pages:
                    type: string
                    maxLength: 100
                  note:
                    type: string
                    maxLength: 1000
                required:
                  - serffTrackingNumber
              minItems: 1
              maxItems: 50
            knownGaps:
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 500
              maxItems: 50
              default: []
            chainsTo:
              type: array
              items:
                type: string
                pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
                description: >-
                  Stable model identifier, for example `geico.cbra-5.0` or
                  `geico.fr-bands.va-2021`
              maxItems: 20
              default: []
              description: Models that can consume this model output as their input
          required:
            - layer
            - title
            - carrier
            - states
            - vintage
            - fidelity
            - sources
          additionalProperties: false
          description: A model version’s descriptor; null for a rater.
        programId:
          type: string
          pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
          description: The market rater’s ID, such as `effective.example-ca-ppa`.
        version:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        publishedAt:
          type: string
          format: date-time
        publishedBy:
          type: string
      required:
        - engineBundleId
        - programBundleId
        - effectiveDate
        - supportedFrom
        - supportedTo
        - scopeNote
        - releaseNotes
        - modelDescriptor
        - programId
        - version
        - publishedAt
        - publishedBy
      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.