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

# Check eligibility

> Read-only eligibility breakdown for a site and its assets. Returns the list of propositions the site can enrol in, along with per-asset eligibility detail.



## OpenAPI

````yaml GET /entities/site/{site_id}/eligibility
openapi: 3.1.0
info:
  title: Axle API Docs
  description: >-
    For full documentation please see our official docs at <a
    href='http://docs.axle.energy'>docs.axle.energy</a>
  version: 1.4.6
servers:
  - url: https://api-sandbox.axle.energy
security: []
tags:
  - name: 1. Authentication
    description: Authenticate yourself with the Axle API
  - name: 2. Meters
    description: Find key info about your sites
  - name: 3. Sites
    description: Register your sites with Axle; configure market participation
  - name: 4. Assets
    description: Register your assets with Axle
  - name: 5. Data
    description: Send asset metrics to Axle, for analysis and optimisation purposes
  - name: 6. Rewards
    description: >-
      Determine how much your users have earned by participating with Axle;
      allow balance withdrawal
  - name: 7. Validation
    description: Validate structured data against Axle's rules
  - name: 8. Examples
    description: Get example data for testing
paths:
  /entities/site/{site_id}/eligibility:
    get:
      tags:
        - 3. Sites
      summary: Get Site Eligibility
      description: >-
        Read-only eligibility breakdown for a site and its assets. Returns the
        list of propositions the site can enrol in, along with per-asset
        eligibility detail.
      operationId: get_site_eligibility_entities_site__site_id__eligibility_get
      parameters:
        - required: true
          schema:
            type: string
            format: uuid
            title: Site Id
          name: site_id
          in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteEligibilityDetail'
        '404':
          description: Site not found or not authorized
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal server error
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    SiteEligibilityDetail:
      properties:
        eligible_propositions:
          items:
            type: string
            enum:
              - limited_pause
              - full_asset_schedule_control
          type: array
          title: Eligible Propositions
          default: []
        site_id:
          type: string
          format: uuid
          title: Site Id
          examples:
            - a1b2c3d4-e5f6-7890-abcd-ef1234567890
        site_properties:
          allOf:
            - $ref: '#/components/schemas/SiteProperties'
          title: Site Properties
          examples:
            - is_half_hourly_settled: false
              has_meter_consent: true
        assets:
          items:
            $ref: '#/components/schemas/AssetEligibilityDetail'
          type: array
          title: Assets
          default: []
      type: object
      required:
        - site_id
        - site_properties
      title: SiteEligibilityDetail
      description: Eligibility detail for a site's proposition eligibility check.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SiteProperties:
      properties:
        is_half_hourly_settled:
          type: boolean
          title: Is Half Hourly Settled
        has_meter_consent:
          type: boolean
          title: Has Meter Consent
      type: object
      required:
        - is_half_hourly_settled
        - has_meter_consent
      title: SiteProperties
      description: Site-level properties relevant to eligibility evaluation.
    AssetEligibilityDetail:
      properties:
        asset_id:
          type: string
          format: uuid
          title: Asset Id
          examples:
            - b2c3d4e5-f6a7-8901-bcde-f23456789012
        external_id:
          type: string
          title: External Id
          examples:
            - charger-001
        propositions:
          items:
            $ref: '#/components/schemas/PropositionEligibility'
          type: array
          title: Propositions
          default: []
      type: object
      required:
        - asset_id
        - external_id
      title: AssetEligibilityDetail
      description: Eligibility detail for a single asset across all propositions.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PropositionEligibility:
      properties:
        proposition:
          type: string
          enum:
            - limited_pause
            - full_asset_schedule_control
          title: Proposition
          examples:
            - limited_pause
        is_eligible:
          type: boolean
          title: Is Eligible
        issues:
          items:
            $ref: '#/components/schemas/EligibilityCode'
          type: array
          default: []
      type: object
      required:
        - proposition
        - is_eligible
      title: PropositionEligibility
      description: Eligibility detail for a single proposition.
    EligibilityCode:
      type: string
      enum:
        - asset_model_not_set
        - asset_model_not_found
        - asset_model_not_cop11_qualified
        - asset_installation_date_not_set
        - asset_model_enrol_eligibility_override
        - non_domestic_site
      title: EligibilityCode
      description: Codes identifying specific eligibility issues for an asset.
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: auth/token-form

````