> ## 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.

# Get extracted filing rate impact

> Read the stored SERFF filing-level aggregate. Percentages are premium-weighted across companies with known positive premium when possible, otherwise averaged. Premiums and policyholder counts are summed; minimum/maximum changes are extrema. Partial source coverage remains possible. This is extracted filed information, not evidence of approval. No acquisition or recalculation is started; null data means unavailable, not zero.



## OpenAPI

````yaml /openapi.json get /filings/{filingId}/rate-impact
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://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /filings/{filingId}/rate-impact:
    get:
      tags:
        - Filings
      summary: Get extracted filing rate impact
      description: >-
        Read the stored SERFF filing-level aggregate. Percentages are
        premium-weighted across companies with known positive premium when
        possible, otherwise averaged. Premiums and policyholder counts are
        summed; minimum/maximum changes are extrema. Partial source coverage
        remains possible. This is extracted filed information, not evidence of
        approval. No acquisition or recalculation is started; null data means
        unavailable, not zero.
      operationId: getFilingRateImpact
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
      responses:
        '200':
          description: Available extracted rate impact, or null.
          content:
            application/json:
              schema:
                type: object
                properties:
                  filingId:
                    type: string
                    format: uuid
                  rateImpact:
                    $ref: '#/components/schemas/V2FilingRateImpact'
                  availability:
                    type: object
                    properties:
                      sourceSupported:
                        type: boolean
                        description: >-
                          True for SERFF; these extractions are not available
                          for Florida IRFS.
                      sourceCompleteness:
                        type: string
                        enum:
                          - unknown
                        description: >-
                          Stored extracted data is not proof of a complete
                          source schedule or rate analysis.
                    required:
                      - sourceSupported
                      - sourceCompleteness
                required:
                  - filingId
                  - rateImpact
                  - availability
        '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: Operation forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Filing not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable. Retry-After is in seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2FilingRateImpact:
      type: object
      nullable: true
      properties:
        overallIndicatedChangePercent:
          type: number
          nullable: true
          description: 'Percent, not a fraction: 7.5 means 7.5%. Null means unknown.'
        overallRateImpactPercent:
          type: number
          nullable: true
          description: 'Percent, not a fraction: 7.5 means 7.5%. Null means unknown.'
        writtenPremiumChangeUsd:
          type: string
          nullable: true
          pattern: ^-?\d+(?:\.\d+)?$
          description: >-
            US dollars as a decimal string, preserving stored precision. Null
            means unknown.
        policyholdersAffected:
          type: integer
          nullable: true
          minimum: 0
        writtenPremiumUsd:
          type: string
          nullable: true
          pattern: ^-?\d+(?:\.\d+)?$
          description: >-
            US dollars as a decimal string, preserving stored precision. Null
            means unknown.
        maxChangePercent:
          type: number
          nullable: true
          description: 'Percent, not a fraction: 7.5 means 7.5%. Null means unknown.'
        minChangePercent:
          type: number
          nullable: true
          description: 'Percent, not a fraction: 7.5 means 7.5%. Null means unknown.'
      required:
        - overallIndicatedChangePercent
        - overallRateImpactPercent
        - writtenPremiumChangeUsd
        - policyholdersAffected
        - writtenPremiumUsd
        - maxChangePercent
        - minChangePercent
    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.
          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.