> ## 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 a rating program > Get a rating program’s details, documentation, and your current access. Authentication is required. The response includes the program’s carrier, product, state, and your organization’s subscription status. - **Coverage:** `coverage` lists the products and states the program has routes for, and `routes` lists each route: product, state, version, policy dates and transactions. - **Access:** `canRun` and `canDownload` show whether your organization’s access and your permissions allow you to run or download the program. - **Subscription:** `subscribed` shows whether your organization has an active subscription. `canSubscribe` and `canUnsubscribe` show which subscription actions you can take. ## OpenAPI ````yaml /openapi.json get /insurance/rating-programs/{id} 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}: get: tags: - Rating programs summary: Get a rating program description: >- Get a rating program’s details, documentation, and your current access. Authentication is required. The response includes the program’s carrier, product, state, and your organization’s subscription status. - **Coverage:** `coverage` lists the products and states the program has routes for, and `routes` lists each route: product, state, version, policy dates and transactions. - **Access:** `canRun` and `canDownload` show whether your organization’s access and your permissions allow you to run or download the program. - **Subscription:** `subscribed` shows whether your organization has an active subscription. `canSubscribe` and `canUnsubscribe` show which subscription actions you can take. operationId: getRatingProgram parameters: - schema: type: string pattern: ^[a-z0-9][a-z0-9._-]{0,127}$ required: true name: id in: path responses: '200': description: Profile, documentation and current access. content: application/json: schema: $ref: '#/components/schemas/V2RatingProgram' '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: V2RatingProgram: 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 documentation: type: string nullable: true maxLength: 100000 id: type: string pattern: ^[a-z0-9][a-z0-9._-]{0,127}$ productName: type: string nullable: true carrierName: type: string nullable: 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. routes: type: array items: $ref: '#/components/schemas/V2RatingProgramProfileRoute' description: >- Every route to this program, by product name, state and newest window. 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 createdAt: type: string format: date-time createdBy: type: string updatedAt: type: string format: date-time updatedBy: type: string required: - name - description - productId - state - carrierId - documentation - id - productName - carrierName - coverage - routes - access - subscription - createdAt - createdBy - updatedAt - updatedBy 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. accessUrl: type: string nullable: true format: uri description: >- Where to add the product to your account, for product_access_required. required: - code V2RatingProgramProfileRoute: type: object properties: productId: type: string productName: type: string state: type: string version: type: integer minimum: 0 exclusiveMinimum: true effectiveFrom: type: string format: date description: >- First policy effective date the route covers (YYYY-MM-DD), inclusive. effectiveTo: type: string nullable: true format: date description: >- First policy effective date the route no longer covers (YYYY-MM-DD), exclusive; null is open-ended. newBusiness: type: boolean description: The route rates new business. renewals: type: boolean description: The route rates renewals. note: type: string nullable: true maxLength: 2000 description: Why the route exists or what it excludes. required: - productId - productName - state - version - effectiveFrom - effectiveTo - newBusiness - renewals - note additionalProperties: false 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.