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

# Readiness Score

> Score this deployment against every loaded instrument, and say what to fix.

**Who may call it:** any role. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/readiness
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/readiness:
    get:
      tags:
        - Regulatory
      summary: Readiness Score
      description: >-
        Score this deployment against every loaded instrument, and say what to
        fix.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: readiness_score_v1_readiness_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessOut'
      security:
        - bearerToken: []
components:
  schemas:
    ReadinessOut:
      properties:
        generated_at:
          type: string
          format: date-time
          title: Generated At
        workspace_id:
          type: string
          title: Workspace Id
        disclaimer:
          additionalProperties: true
          type: object
          title: Disclaimer
        market_profile:
          type: string
          title: Market Profile
        market_profile_source:
          type: string
          title: Market Profile Source
        instruments:
          items:
            $ref: '#/components/schemas/InstrumentReadiness'
          type: array
          title: Instruments
        selects_no_instrument:
          type: boolean
          title: Selects No Instrument
        scope_note:
          type: string
          title: Scope Note
        evidence:
          additionalProperties:
            $ref: '#/components/schemas/EvidenceAvailability'
          type: object
          title: Evidence
        next_actions:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Next Actions
        improvements:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Improvements
      type: object
      required:
        - generated_at
        - workspace_id
        - disclaimer
        - market_profile
        - market_profile_source
        - instruments
        - selects_no_instrument
        - scope_note
        - evidence
        - next_actions
        - improvements
      title: ReadinessOut
      description: How far the evidence goes — never whether anybody is compliant.
    InstrumentReadiness:
      properties:
        key:
          type: string
          title: Key
        selected:
          type: boolean
          title: Selected
        jurisdiction:
          type: string
          title: Jurisdiction
        instrument:
          type: string
          title: Instrument
        status:
          type: string
          title: Status
        satisfied:
          type: integer
          title: Satisfied
        scored_clauses:
          type: integer
          title: Scored Clauses
        percent:
          type: integer
          title: Percent
        blocking_evidence:
          items:
            type: string
          type: array
          title: Blocking Evidence
        improvable_evidence:
          items:
            type: string
          type: array
          title: Improvable Evidence
      type: object
      required:
        - key
        - selected
        - jurisdiction
        - instrument
        - status
        - satisfied
        - scored_clauses
        - percent
        - blocking_evidence
        - improvable_evidence
      title: InstrumentReadiness
    EvidenceAvailability:
      properties:
        title:
          type: string
          title: Title
        available:
          type: boolean
          title: Available
        detail:
          type: string
          title: Detail
        count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Count
        fix:
          anyOf:
            - type: string
            - type: 'null'
          title: Fix
      type: object
      required:
        - title
        - available
        - detail
      title: EvidenceAvailability
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

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