openapi: 3.0.3
info:
  title: Finbase Service API
  version: 1.0.0
  description: |
    Service API for income limit data, geography references, derived income-limit calculations, and derived rent-limit calculations.
    Auth uses a Bearer token with format `keyId:secret`.

    Income-limit endpoints use `datasource` and `datasettype` to select the underlying data set. Use
    `/data/fixed/il/sets` to discover supported canonical source/type values, aliases, geography coverage,
    fiscal years, effective dates, release dates, and source agency/program metadata.

    Some data sets expose aliases for customer-friendly compatibility. Aliases resolve to canonical data
    sets before entitlement checks and data lookup. When an alias is used, response metadata may include
    `metadata.source.requestedAlias` alongside the canonical source/type.
servers:
  - url: https://api.finbaseco.com/api/service/v1
    description: Prod
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: keyId:secret
  parameters:
    Page:
      name: page
      in: query
      description: Page number (1-based).
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
    Limit:
      name: limit
      in: query
      description: Max records per page; endpoint-specific defaults and max limits apply.
      required: false
      schema:
        type: integer
        minimum: 1
        default: 10
    Datasource:
      name: datasource
      in: query
      description: Canonical data source or supported alias. Use `/data/fixed/il/sets` to discover available values.
      required: false
      schema:
        type: string
    DatasourceRequired:
      name: datasource
      in: query
      description: Canonical data source or supported alias. Use `/data/fixed/il/sets` to discover available values.
      required: true
      schema:
        type: string
    DatasetType:
      name: datasettype
      in: query
      description: Canonical data set type or supported alias. Required unless the source can be defaulted unambiguously.
      required: false
      schema:
        type: string
    FiscalYear:
      name: fiscalyear
      in: query
      required: false
      schema:
        type: integer
    EffectiveDate:
      name: effectivedate
      in: query
      required: false
      description: YYYY-MM-DD
      schema:
        type: string
        pattern: '^\d{4}-\d{2}-\d{2}$'
    StateCode:
      name: statecode
      in: query
      required: false
      description: 2-digit FIPS. May be derived from 5-digit countycode. For `/data/fixed/il/sets`, state filters return national data sets plus state-covered data sets and may participate in supported source defaulting.
      schema:
        type: string
    StateAbbr:
      name: stateabbr
      in: query
      required: false
      description: Two-letter state abbreviation. For `/data/fixed/il/sets`, state filters return national data sets plus state-covered data sets and may participate in supported source defaulting.
      schema:
        type: string
    CountyCode:
      name: countycode
      in: query
      required: false
      description: County FIPS. 5-digit values will be normalized to 3-digit county code and statecode.
      schema:
        type: string
    CountyName:
      name: countyname
      in: query
      required: false
      schema:
        type: string
    SubcountyName:
      name: subcountyname
      in: query
      required: false
      schema:
        type: string
    HouseholdSize:
      name: householdsize
      in: query
      required: false
      description: Range 1-8 (values outside are clamped).
      schema:
        type: integer
        minimum: 1
        maximum: 8
    LimitType:
      name: limittype
      in: query
      required: false
      description: Percent value (e.g. 60 or 60%). If missing '%', it is appended.
      schema:
        type: string
    LimitTypeRequired:
      name: limittype
      in: query
      required: true
      description: Percent value (e.g. 60 or 60%). If missing '%', it is appended.
      schema:
        type: string
    TargetAmis:
      name: targetamis
      in: query
      required: false
      description: CSV of up to 3 AMI values (e.g. 60,80,120). Values may include %.
      schema:
        type: string
    TargetAmisRequired:
      name: targetamis
      in: query
      required: true
      description: CSV of up to 3 AMI values (e.g. 60,80,120). Values may include %.
      schema:
        type: string
    RoundingMode:
      name: roundingmode
      in: query
      required: false
      description: Final two-decimal handling for calculated derived values. `round` is the default. `truncate` conservatively truncates. `trunc` is accepted as shorthand for `truncate`.
      schema:
        type: string
        enum: [round, truncate, trunc]
        default: round
    ExpenseLimit:
      name: expenselimit
      in: query
      required: false
      description: Percent value (e.g. 30 or 30%). If missing '%', it is appended.
      schema:
        type: string
    AreaId:
      name: areaid
      in: query
      required: false
      schema:
        type: string
    AreaName:
      name: areaname
      in: query
      required: false
      schema:
        type: string
    BedroomSize:
      name: bedroomsize
      in: query
      required: false
      description: Range 0-4 (values outside are clamped).
      schema:
        type: integer
        minimum: 0
        maximum: 4
    BedroomSizeFactor:
      name: bedroomsizefactor
      in: query
      required: false
      description: Numeric multiplier (defaults to 1.5 if invalid or missing).
      schema:
        type: number
    BedroomSizeRoundFlag:
      name: bedroomsizeroundflag
      in: query
      required: false
      schema:
        type: string
    SplitCountiesOnlyFlag:
      name: splitcountiesonlyflag
      in: query
      required: false
      schema:
        type: string
  schemas:
    ApiResponse:
      type: object
      properties:
        status:
          type: string
          enum: [success, failure]
        input:
          type: object
        metadata:
          type: object
        data:
          oneOf:
            - type: object
            - type: array
              items:
                type: object
        pagination:
          type: object
          properties:
            totalRecords:
              type: integer
            totalPages:
              type: integer
            currentPage:
              type: integer
            recordsPerPage:
              type: integer
            nextPage:
              type: integer
              nullable: true
            prevPage:
              type: integer
              nullable: true
        xRateLimit:
          type: object
          properties:
            key:
              type: string
            period:
              type: string
            limit:
              type: integer
            remaining:
              type: integer
            reset:
              type: string
              format: date-time
    IncomeLimitSourceMetadata:
      type: object
      description: Selected income-limit data-set metadata returned by fixed, derived, and rent-limit endpoints.
      properties:
        dataSource:
          type: string
          description: Canonical data source used for the response.
        dataSetType:
          type: string
          description: Canonical data set type used for the response.
        fiscalYear:
          type: integer
        effectiveDate:
          type: string
          format: date-time
        releasedDate:
          type: string
          format: date-time
        sourceAgencyName:
          type: string
          nullable: true
        sourceProgramName:
          type: string
          nullable: true
        entitlementCategory:
          type: string
          description: Entitlement category used for source-access checks.
        requestedAlias:
          type: object
          nullable: true
          description: Present only when the request used an alias that resolved to a canonical data set.
          properties:
            dataSource:
              type: string
            dataSetType:
              type: string
    IncomeLimitSet:
      type: object
      description: Data-set discovery row returned by `/data/fixed/il/sets`.
      properties:
        dataSource:
          type: string
          description: Canonical data source.
        dataSetType:
          type: string
          description: Canonical data set type.
        fiscalYear:
          type: integer
        effectiveDate:
          type: string
          format: date-time
        releasedDate:
          type: string
          format: date-time
        sourceAgencyName:
          type: string
          nullable: true
        sourceProgramName:
          type: string
          nullable: true
        entitlementCategory:
          type: string
        geographicScope:
          type: string
          description: "`NATIONAL` or state-scoped coverage."
        states:
          type: array
          items:
            type: string
        aliases:
          type: array
          items:
            type: object
            properties:
              dataSource:
                type: string
              dataSetType:
                type: string
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
paths:
  /data/geo-map/states:
    get:
      summary: Geo-map states
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"limit":1,"page":1},"metadata":{"resource":"geo-map-states","filterWarnings":[],"inputsOverridden":[],"inputsIgnored":[],"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","stateName":"Alaska"}],"pagination":{"totalRecords":56,"totalPages":56,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99734,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"limit":1,"page":1},"metadata":{"resource":"geo-map-states","filterWarnings":[],"inputsOverridden":[],"inputsIgnored":[],"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","stateName":"Alaska"}],"pagination":{"totalRecords":56,"totalPages":56,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99754,"reset":"2026-03-01T00:00:00.000Z"}}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /data/geo-map/counties:
    get:
      summary: Geo-map counties
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"limit":1,"page":1},"metadata":{"resource":"geo-map-counties","filterWarnings":[],"inputsOverridden":[],"inputsIgnored":[],"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","stateName":"Alaska","countyCode":"013","countyName":"Aleutians East Borough","countyNameAbbr":"Aleutians East Borough"}],"pagination":{"totalRecords":3228,"totalPages":3228,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99733,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"statecode":"02","limit":1,"page":1},"metadata":{"resource":"geo-map-counties","filterWarnings":[],"inputsOverridden":[],"inputsIgnored":[],"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","stateName":"Alaska","countyCode":"013","countyName":"Aleutians East Borough","countyNameAbbr":"Aleutians East Borough"}],"pagination":{"totalRecords":30,"totalPages":30,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99753,"reset":"2026-03-01T00:00:00.000Z"}}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /data/fixed/il/sets:
    get:
      summary: Fixed IL dataset listing
      description: |
        Discovers released income-limit data sets. Use this endpoint to find supported canonical
        `datasource` / `datasettype` values, aliases, entitlement categories, source metadata,
        fiscal years, effective dates, release dates, and geography coverage.

        When `statecode` or `stateabbr` is supplied, the response includes national data sets plus
        data sets whose catalog geography covers the requested state. Source/type filters can match
        canonical values or active aliases.
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Datasource'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"limit":5,"page":1},"metadata":{"resource":"fixed-il-sets","filterWarnings":[],"inputsOverridden":[],"inputsIgnored":[],"dataSize":5},"data":[{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2026,"effectiveDate":"2026-05-01T00:00:00.000Z","releasedDate":"2026-05-15T17:31:37.890Z","sourceAgencyName":"U.S. Department of Housing and Urban Development","sourceProgramName":"Section 8 Income Limits","entitlementCategory":"HUD","geographicScope":"NATIONAL","states":[],"aliases":[]},{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","releasedDate":"2025-04-04T20:44:20.395Z","sourceAgencyName":"U.S. Department of Housing and Urban Development","sourceProgramName":"Section 8 Income Limits","entitlementCategory":"HUD","geographicScope":"NATIONAL","states":[],"aliases":[]},{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2024,"effectiveDate":"2024-04-01T00:00:00.000Z","releasedDate":"2025-03-10T00:29:44.717Z","sourceAgencyName":"U.S. Department of Housing and Urban Development","sourceProgramName":"Section 8 Income Limits","entitlementCategory":"HUD","geographicScope":"NATIONAL","states":[],"aliases":[]},{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2023,"effectiveDate":"2023-06-15T00:00:00.000Z","releasedDate":"2025-03-10T00:29:14.170Z","sourceAgencyName":"U.S. Department of Housing and Urban Development","sourceProgramName":"Section 8 Income Limits","entitlementCategory":"HUD","geographicScope":"NATIONAL","states":[],"aliases":[]},{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2022,"effectiveDate":"2022-04-18T00:00:00.000Z","releasedDate":"2025-03-10T00:28:42.204Z","sourceAgencyName":"U.S. Department of Housing and Urban Development","sourceProgramName":"Section 8 Income Limits","entitlementCategory":"HUD","geographicScope":"NATIONAL","states":[],"aliases":[]}],"pagination":{"totalRecords":13,"totalPages":3,"currentPage":1,"recordsPerPage":5,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202606","limit":null,"remaining":null,"reset":"2026-07-01T00:00:00.000Z","unlimited":true}}
                example2:
                  value: {"status":"success","input":{"datasource":"MRB","stateabbr":"NJ","limit":5,"page":1},"metadata":{"resource":"fixed-il-sets","filterWarnings":[],"inputsOverridden":[],"inputsIgnored":[],"dataSize":1},"data":[{"dataSource":"NJHMFA","dataSetType":"FTHB","fiscalYear":2025,"effectiveDate":"2025-07-28T00:00:00.000Z","releasedDate":"2026-05-16T01:39:02.821Z","sourceAgencyName":"New Jersey Housing and Mortgage Finance Agency","sourceProgramName":"First-Time Homebuyer Program","entitlementCategory":"STATE_AGENCY","geographicScope":"STATE","states":["NJ"],"aliases":[{"dataSource":"MRB","dataSetType":"MRB-NJ"}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":5,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202606","limit":null,"remaining":null,"reset":"2026-07-01T00:00:00.000Z","unlimited":true}}
  /data/fixed/il/map/counties:
    get:
      summary: Fixed IL county mapping
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SplitCountiesOnlyFlag'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-map-counties","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areaMapCount":1}],"pagination":{"totalRecords":3237,"totalPages":3237,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99731,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-map-counties","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areaMapCount":1}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99751,"reset":"2026-03-01T00:00:00.000Z"}}
        '400':
          description: Invalid request or not allowed by account limits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /data/fixed/il/map/subcounties:
    get:
      summary: Fixed IL subcounty mapping (expanded)
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SplitCountiesOnlyFlag'
        - $ref: '#/components/parameters/SubcountyName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-map-subcounties","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","subCountyName":"Aleutians East Borough","areaId":"NCNTY02013N02013","areaName":"Aleutians East Borough, AK"}],"pagination":{"totalRecords":4933,"totalPages":4933,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99730,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-map-subcounties","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","subCountyName":"Aleutians East Borough","areaId":"NCNTY02013N02013","areaName":"Aleutians East Borough, AK"}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99750,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/fixed/il/map/subcounties/collapse:
    get:
      summary: Fixed IL subcounty mapping (collapsed)
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SplitCountiesOnlyFlag'
        - $ref: '#/components/parameters/SubcountyName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-map-subcounties-collapse","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","subCountyList":["All"],"areaId":"NCNTY02013N02013","areaName":"Aleutians East Borough, AK"}],"pagination":{"totalRecords":3332,"totalPages":3332,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99729,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-map-subcounties-collapse","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","subCountyList":["All"],"areaId":"NCNTY02013N02013","areaName":"Aleutians East Borough, AK"}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99749,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/fixed/il/bycounty:
    get:
      summary: Fixed IL income limits grouped by county
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitType'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-county","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"30%","limitValues":[{"incomeLimit":20250,"householdSize":1},{"incomeLimit":26430,"householdSize":2},{"incomeLimit":33310,"householdSize":3},{"incomeLimit":40190,"householdSize":4},{"incomeLimit":47070,"householdSize":5},{"incomeLimit":53950,"householdSize":6},{"incomeLimit":59750,"householdSize":7},{"incomeLimit":63600,"householdSize":8}]},{"limitType":"50%","limitValues":[{"incomeLimit":33750,"householdSize":1},{"incomeLimit":38550,"householdSize":2},{"incomeLimit":43350,"householdSize":3},{"incomeLimit":48150,"householdSize":4},{"incomeLimit":52050,"householdSize":5},{"incomeLimit":55900,"householdSize":6},{"incomeLimit":59750,"householdSize":7},{"incomeLimit":63600,"householdSize":8}]},{"limitType":"80%","limitValues":[{"incomeLimit":53950,"householdSize":1},{"incomeLimit":61650,"householdSize":2},{"incomeLimit":69350,"householdSize":3},{"incomeLimit":77050,"householdSize":4},{"incomeLimit":83250,"householdSize":5},{"incomeLimit":89400,"householdSize":6},{"incomeLimit":95550,"householdSize":7},{"incomeLimit":101750,"householdSize":8}]}]}]}],"pagination":{"totalRecords":3237,"totalPages":3237,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99728,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","householdsize":"4","limittype":"50%","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-county","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":48150,"householdSize":4}]}]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99748,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/fixed/il/bycounty/map:
    get:
      summary: Fixed IL county mapping only
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-county-maponly","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","name":"Aleutians East Borough, AK","subCounty":["All"]}]}],"pagination":{"totalRecords":3237,"totalPages":3237,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99727,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-county-maponly","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","name":"Aleutians East Borough, AK","subCounty":["All"]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99747,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/fixed/il/byarea:
    get:
      summary: Fixed IL income limits grouped by area
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitType'
        - $ref: '#/components/parameters/AreaId'
        - $ref: '#/components/parameters/AreaName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-area","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"id":"METRO33860M33860","mfi":83600,"name":"Montgomery, AL MSA","counties":[{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"001","countyName":"Autauga County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"051","countyName":"Elmore County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"085","countyName":"Lowndes County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"101","countyName":"Montgomery County"}],"incomeLimits":[{"limitType":"30%","limitValues":[{"incomeLimit":17600,"householdSize":1},{"incomeLimit":21150,"householdSize":2},{"incomeLimit":26650,"householdSize":3},{"incomeLimit":32150,"householdSize":4},{"incomeLimit":37650,"householdSize":5},{"incomeLimit":43150,"householdSize":6},{"incomeLimit":48650,"householdSize":7},{"incomeLimit":54150,"householdSize":8}]},{"limitType":"50%","limitValues":[{"incomeLimit":29300,"householdSize":1},{"incomeLimit":33450,"householdSize":2},{"incomeLimit":37650,"householdSize":3},{"incomeLimit":41800,"householdSize":4},{"incomeLimit":45150,"householdSize":5},{"incomeLimit":48500,"householdSize":6},{"incomeLimit":51850,"householdSize":7},{"incomeLimit":55200,"householdSize":8}]},{"limitType":"80%","limitValues":[{"incomeLimit":46850,"householdSize":1},{"incomeLimit":53550,"householdSize":2},{"incomeLimit":60250,"householdSize":3},{"incomeLimit":66900,"householdSize":4},{"incomeLimit":72300,"householdSize":5},{"incomeLimit":77650,"householdSize":6},{"incomeLimit":83000,"householdSize":7},{"incomeLimit":88350,"householdSize":8}]}]}],"pagination":{"totalRecords":2644,"totalPages":2644,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99725,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","areaid":"None","areaname":"None","householdsize":"4","limittype":"50%","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-area","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":0},"data":[],"pagination":{"totalRecords":0,"totalPages":0,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99745,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/fixed/il/byarea/map:
    get:
      summary: Fixed IL area mapping only
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/AreaId'
        - $ref: '#/components/parameters/AreaName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-area-maponly","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"id":"METRO33860M33860","name":"Montgomery, AL MSA","counties":[{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"001","countyName":"Autauga County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"051","countyName":"Elmore County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"085","countyName":"Lowndes County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"101","countyName":"Montgomery County"}]}],"pagination":{"totalRecords":2644,"totalPages":2644,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99726,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-groupby-area-maponly","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"id":"NCNTY02013N02013","name":"Aleutians East Borough, AK","counties":[{"stateAbbr":"AK","stateCode":"02","subCounty":["All"],"countyCode":"013","countyName":"Aleutians East Borough"}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99746,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/fixed/il/state-limits:
    get:
      summary: Fixed IL state-level limits
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitType'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-state-limits","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"30%","limitValues":[{"incomeLimit":24050,"householdSize":1},{"incomeLimit":27450,"householdSize":2},{"incomeLimit":30900,"householdSize":3},{"incomeLimit":34300,"householdSize":4},{"incomeLimit":37050,"householdSize":5},{"incomeLimit":39800,"householdSize":6},{"incomeLimit":42550,"householdSize":7},{"incomeLimit":45300,"householdSize":8}]},{"limitType":"50%","limitValues":[{"incomeLimit":40050,"householdSize":1},{"incomeLimit":45750,"householdSize":2},{"incomeLimit":51450,"householdSize":3},{"incomeLimit":57150,"householdSize":4},{"incomeLimit":61750,"householdSize":5},{"incomeLimit":66300,"householdSize":6},{"incomeLimit":70900,"householdSize":7},{"incomeLimit":75450,"householdSize":8}]},{"limitType":"80%","limitValues":[{"incomeLimit":64050,"householdSize":1},{"incomeLimit":73200,"householdSize":2},{"incomeLimit":82350,"householdSize":3},{"incomeLimit":91450,"householdSize":4},{"incomeLimit":98800,"householdSize":5},{"incomeLimit":106100,"householdSize":6},{"incomeLimit":113400,"householdSize":7},{"incomeLimit":120750,"householdSize":8}]}]}]],"pagination":{"totalRecords":56,"totalPages":56,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99724,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","householdsize":"4","limittype":"50%","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"fixed-il-state-limits","filterWarnings":["statecode value used to filter data; stateabbr has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["countycode","countyname","stateabbr"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":57150,"householdSize":4}]}]}]],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99744,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-income/bycounty:
    get:
      summary: Derived IL max income by county
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-income-groupby-county","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["expenselimit"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":33750,"householdSize":1},{"incomeLimit":38550,"householdSize":2},{"incomeLimit":43350,"householdSize":3},{"incomeLimit":48150,"householdSize":4},{"incomeLimit":52050,"householdSize":5},{"incomeLimit":55900,"householdSize":6},{"incomeLimit":59750,"householdSize":7},{"incomeLimit":63600,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":1,"incomeLimit":54000},{"householdSize":2,"incomeLimit":61680},{"householdSize":3,"incomeLimit":69360},{"householdSize":4,"incomeLimit":77040},{"householdSize":5,"incomeLimit":83280},{"householdSize":6,"incomeLimit":89440},{"householdSize":7,"incomeLimit":95600},{"householdSize":8,"incomeLimit":101760}]},{"limitType":"100%","limitValues":[{"householdSize":1,"incomeLimit":67500},{"householdSize":2,"incomeLimit":77100},{"householdSize":3,"incomeLimit":86700},{"householdSize":4,"incomeLimit":96300},{"householdSize":5,"incomeLimit":104100},{"householdSize":6,"incomeLimit":111800},{"householdSize":7,"incomeLimit":119500},{"householdSize":8,"incomeLimit":127200}]}]}]}],"pagination":{"totalRecords":3237,"totalPages":3237,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99723,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limittype":"50%","targetamis":"80,100","householdsize":"4","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-income-groupby-county","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["areaid","areaname","expenselimit","stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":48150,"householdSize":4}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":4,"incomeLimit":77040}]},{"limitType":"100%","limitValues":[{"householdSize":4,"incomeLimit":96300}]}]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99743,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-income/byarea:
    get:
      summary: Derived IL max income by area
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/AreaId'
        - $ref: '#/components/parameters/AreaName'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-income-groupby-area","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["expenselimit"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"id":"METRO33860M33860","mfi":83600,"name":"Montgomery, AL MSA","counties":[{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"001","countyName":"Autauga County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"051","countyName":"Elmore County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"085","countyName":"Lowndes County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"101","countyName":"Montgomery County"}],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":29300,"householdSize":1},{"incomeLimit":33450,"householdSize":2},{"incomeLimit":37650,"householdSize":3},{"incomeLimit":41800,"householdSize":4},{"incomeLimit":45150,"householdSize":5},{"incomeLimit":48500,"householdSize":6},{"incomeLimit":51850,"householdSize":7},{"incomeLimit":55200,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":1,"incomeLimit":46880},{"householdSize":2,"incomeLimit":53520},{"householdSize":3,"incomeLimit":60240},{"householdSize":4,"incomeLimit":66880},{"householdSize":5,"incomeLimit":72240},{"householdSize":6,"incomeLimit":77600},{"householdSize":7,"incomeLimit":82960},{"householdSize":8,"incomeLimit":88320}]},{"limitType":"100%","limitValues":[{"householdSize":1,"incomeLimit":58600},{"householdSize":2,"incomeLimit":66900},{"householdSize":3,"incomeLimit":75300},{"householdSize":4,"incomeLimit":83600},{"householdSize":5,"incomeLimit":90300},{"householdSize":6,"incomeLimit":97000},{"householdSize":7,"incomeLimit":103700},{"householdSize":8,"incomeLimit":110400}]}]}],"pagination":{"totalRecords":2644,"totalPages":2644,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99722,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","areaid":"None","areaname":"None","limittype":"50%","targetamis":"80,100","householdsize":"4","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-income-groupby-area","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["expenselimit","stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":0},"data":[],"pagination":{"totalRecords":0,"totalPages":0,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99742,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-income/state-limits:
    get:
      summary: Derived IL max income state limits
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-income-state-limits","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["expenselimit"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":40050,"householdSize":1},{"incomeLimit":45750,"householdSize":2},{"incomeLimit":51450,"householdSize":3},{"incomeLimit":57150,"householdSize":4},{"incomeLimit":61750,"householdSize":5},{"incomeLimit":66300,"householdSize":6},{"incomeLimit":70900,"householdSize":7},{"incomeLimit":75450,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":1,"incomeLimit":64080},{"householdSize":2,"incomeLimit":73200},{"householdSize":3,"incomeLimit":82320},{"householdSize":4,"incomeLimit":91440},{"householdSize":5,"incomeLimit":98800},{"householdSize":6,"incomeLimit":106080},{"householdSize":7,"incomeLimit":113440},{"householdSize":8,"incomeLimit":120720}]},{"limitType":"100%","limitValues":[{"householdSize":1,"incomeLimit":80100},{"householdSize":2,"incomeLimit":91500},{"householdSize":3,"incomeLimit":102900},{"householdSize":4,"incomeLimit":114300},{"householdSize":5,"incomeLimit":123500},{"householdSize":6,"incomeLimit":132600},{"householdSize":7,"incomeLimit":141800},{"householdSize":8,"incomeLimit":150900}]}]}],"pagination":{"totalRecords":56,"totalPages":56,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99721,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","limittype":"50%","targetamis":"80,100","householdsize":"4","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-income-state-limits","filterWarnings":["statecode value used to filter data; stateabbr has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["countycode","countyname","areaid","areaname","expenselimit","stateabbr"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":57150,"householdSize":4}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":4,"incomeLimit":91440}]},{"limitType":"100%","limitValues":[{"householdSize":4,"incomeLimit":114300}]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99741,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-rent/bycounty:
    get:
      summary: Derived IL max rent by county
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
        - $ref: '#/components/parameters/ExpenseLimit'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","expenselimit":"30%","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-county","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":33750,"householdSize":1},{"incomeLimit":38550,"householdSize":2},{"incomeLimit":43350,"householdSize":3},{"incomeLimit":48150,"householdSize":4},{"incomeLimit":52050,"householdSize":5},{"incomeLimit":55900,"householdSize":6},{"incomeLimit":59750,"householdSize":7},{"incomeLimit":63600,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":1,"incomeLimit":54000,"rentLimit":1350},{"householdSize":2,"incomeLimit":61680,"rentLimit":1542},{"householdSize":3,"incomeLimit":69360,"rentLimit":1734},{"householdSize":4,"incomeLimit":77040,"rentLimit":1926},{"householdSize":5,"incomeLimit":83280,"rentLimit":2082},{"householdSize":6,"incomeLimit":89440,"rentLimit":2236},{"householdSize":7,"incomeLimit":95600,"rentLimit":2390},{"householdSize":8,"incomeLimit":101760,"rentLimit":2544}]},{"limitType":"100%","limitValues":[{"householdSize":1,"incomeLimit":67500,"rentLimit":1687.5},{"householdSize":2,"incomeLimit":77100,"rentLimit":1927.5},{"householdSize":3,"incomeLimit":86700,"rentLimit":2167.5},{"householdSize":4,"incomeLimit":96300,"rentLimit":2407.5},{"householdSize":5,"incomeLimit":104100,"rentLimit":2602.5},{"householdSize":6,"incomeLimit":111800,"rentLimit":2795},{"householdSize":7,"incomeLimit":119500,"rentLimit":2987.5},{"householdSize":8,"incomeLimit":127200,"rentLimit":3180}]}]}]}],"pagination":{"totalRecords":3237,"totalPages":3237,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99720,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limittype":"50%","targetamis":"80,100","expenselimit":"30%","householdsize":"4","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-county","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["areaid","areaname","stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":48150,"householdSize":4}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":4,"incomeLimit":77040,"rentLimit":1926}]},{"limitType":"100%","limitValues":[{"householdSize":4,"incomeLimit":96300,"rentLimit":2407.5}]}]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99740,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-rent/bycounty/bybedroomsize:
    get:
      summary: Derived IL max rent by county (bedroom size)
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/BedroomSize'
        - $ref: '#/components/parameters/BedroomSizeFactor'
        - $ref: '#/components/parameters/BedroomSizeRoundFlag'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
        - $ref: '#/components/parameters/ExpenseLimit'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","expenselimit":"30%","limit":1,"datasettype":"Section8","bedroomsizefactor":1.5,"page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-county-outputby-bedroomsize","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"},{"fieldName":"bedroomSizeFactor","originalValue":null,"updatedValue":1.5,"overrideReason":"Default Value Applied"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":33750,"householdSize":1},{"incomeLimit":38550,"householdSize":2},{"incomeLimit":43350,"householdSize":3},{"incomeLimit":48150,"householdSize":4},{"incomeLimit":52050,"householdSize":5},{"incomeLimit":55900,"householdSize":6},{"incomeLimit":59750,"householdSize":7},{"incomeLimit":63600,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"bedroomSize":0,"householdSize":1,"incomeLimit":54000,"rentLimit":1350},{"bedroomSize":1,"householdSize":1.5,"incomeLimit":57840,"rentLimit":1446},{"bedroomSize":2,"householdSize":3,"incomeLimit":69360,"rentLimit":1734},{"bedroomSize":3,"householdSize":4.5,"incomeLimit":80160,"rentLimit":2004},{"bedroomSize":4,"householdSize":6,"incomeLimit":89440,"rentLimit":2236}]},{"limitType":"100%","limitValues":[{"bedroomSize":0,"householdSize":1,"incomeLimit":67500,"rentLimit":1687.5},{"bedroomSize":1,"householdSize":1.5,"incomeLimit":72300,"rentLimit":1807.5},{"bedroomSize":2,"householdSize":3,"incomeLimit":86700,"rentLimit":2167.5},{"bedroomSize":3,"householdSize":4.5,"incomeLimit":100200,"rentLimit":2505},{"bedroomSize":4,"householdSize":6,"incomeLimit":111800,"rentLimit":2795}]}]}]}],"pagination":{"totalRecords":3237,"totalPages":3237,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99719,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","limittype":"50%","targetamis":"80,100","expenselimit":"30%","bedroomsize":2,"limit":1,"bedroomsizefactor":1.5,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-county-outputby-bedroomsize","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"bedroomSizeFactor","originalValue":null,"updatedValue":1.5,"overrideReason":"Default Value Applied"},{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["areaid","areaname","stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"stateCode":"02","stateAbbr":"AK","countyCode":"013","countyName":"Aleutians East Borough","areas":[{"id":"NCNTY02013N02013","mfi":85200,"name":"Aleutians East Borough, AK","subCounty":["All"],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":33750,"householdSize":1},{"incomeLimit":38550,"householdSize":2},{"incomeLimit":43350,"householdSize":3},{"incomeLimit":48150,"householdSize":4},{"incomeLimit":52050,"householdSize":5},{"incomeLimit":55900,"householdSize":6},{"incomeLimit":59750,"householdSize":7},{"incomeLimit":63600,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"bedroomSize":2,"householdSize":3,"incomeLimit":69360,"rentLimit":1734}]},{"limitType":"100%","limitValues":[{"bedroomSize":2,"householdSize":3,"incomeLimit":86700,"rentLimit":2167.5}]}]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99739,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-rent/byarea:
    get:
      summary: Derived IL max rent by area
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/AreaId'
        - $ref: '#/components/parameters/AreaName'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
        - $ref: '#/components/parameters/ExpenseLimit'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","expenselimit":"30%","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-area","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"id":"METRO33860M33860","mfi":83600,"name":"Montgomery, AL MSA","counties":[{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"001","countyName":"Autauga County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"051","countyName":"Elmore County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"085","countyName":"Lowndes County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"101","countyName":"Montgomery County"}],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":29300,"householdSize":1},{"incomeLimit":33450,"householdSize":2},{"incomeLimit":37650,"householdSize":3},{"incomeLimit":41800,"householdSize":4},{"incomeLimit":45150,"householdSize":5},{"incomeLimit":48500,"householdSize":6},{"incomeLimit":51850,"householdSize":7},{"incomeLimit":55200,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":1,"incomeLimit":46880,"rentLimit":1172},{"householdSize":2,"incomeLimit":53520,"rentLimit":1338},{"householdSize":3,"incomeLimit":60240,"rentLimit":1506},{"householdSize":4,"incomeLimit":66880,"rentLimit":1672},{"householdSize":5,"incomeLimit":72240,"rentLimit":1806},{"householdSize":6,"incomeLimit":77600,"rentLimit":1940},{"householdSize":7,"incomeLimit":82960,"rentLimit":2074},{"householdSize":8,"incomeLimit":88320,"rentLimit":2208}]},{"limitType":"100%","limitValues":[{"householdSize":1,"incomeLimit":58600,"rentLimit":1465},{"householdSize":2,"incomeLimit":66900,"rentLimit":1672.5},{"householdSize":3,"incomeLimit":75300,"rentLimit":1882.5},{"householdSize":4,"incomeLimit":83600,"rentLimit":2090},{"householdSize":5,"incomeLimit":90300,"rentLimit":2257.5},{"householdSize":6,"incomeLimit":97000,"rentLimit":2425},{"householdSize":7,"incomeLimit":103700,"rentLimit":2592.5},{"householdSize":8,"incomeLimit":110400,"rentLimit":2760}]}]}],"pagination":{"totalRecords":2644,"totalPages":2644,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99718,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","areaid":"None","areaname":"None","limittype":"50%","targetamis":"80,100","expenselimit":"30%","householdsize":"4","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-area","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":0},"data":[],"pagination":{"totalRecords":0,"totalPages":0,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99738,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-rent/byarea/bybedroomsize:
    get:
      summary: Derived IL max rent by area (bedroom size)
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/CountyCode'
        - $ref: '#/components/parameters/CountyName'
        - $ref: '#/components/parameters/SubcountyName'
        - $ref: '#/components/parameters/BedroomSize'
        - $ref: '#/components/parameters/BedroomSizeFactor'
        - $ref: '#/components/parameters/BedroomSizeRoundFlag'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/AreaId'
        - $ref: '#/components/parameters/AreaName'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
        - $ref: '#/components/parameters/ExpenseLimit'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","expenselimit":"30%","limit":1,"datasettype":"Section8","bedroomsizefactor":1.5,"page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-area","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"},{"fieldName":"bedroomSizeFactor","originalValue":null,"updatedValue":1.5,"overrideReason":"Default Value Applied"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"id":"METRO33860M33860","mfi":83600,"name":"Montgomery, AL MSA","counties":[{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"001","countyName":"Autauga County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"051","countyName":"Elmore County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"085","countyName":"Lowndes County"},{"stateAbbr":"AL","stateCode":"01","subCounty":["All"],"countyCode":"101","countyName":"Montgomery County"}],"incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":29300,"householdSize":1},{"incomeLimit":33450,"householdSize":2},{"incomeLimit":37650,"householdSize":3},{"incomeLimit":41800,"householdSize":4},{"incomeLimit":45150,"householdSize":5},{"incomeLimit":48500,"householdSize":6},{"incomeLimit":51850,"householdSize":7},{"incomeLimit":55200,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"bedroomSize":0,"householdSize":1,"incomeLimit":46880,"rentLimit":1172},{"bedroomSize":1,"householdSize":1.5,"incomeLimit":50200,"rentLimit":1255},{"bedroomSize":2,"householdSize":3,"incomeLimit":60240,"rentLimit":1506},{"bedroomSize":3,"householdSize":4.5,"incomeLimit":69560,"rentLimit":1739},{"bedroomSize":4,"householdSize":6,"incomeLimit":77600,"rentLimit":1940}]},{"limitType":"100%","limitValues":[{"bedroomSize":0,"householdSize":1,"incomeLimit":58600,"rentLimit":1465},{"bedroomSize":1,"householdSize":1.5,"incomeLimit":62750,"rentLimit":1568.75},{"bedroomSize":2,"householdSize":3,"incomeLimit":75300,"rentLimit":1882.5},{"bedroomSize":3,"householdSize":4.5,"incomeLimit":86950,"rentLimit":2173.75},{"bedroomSize":4,"householdSize":6,"incomeLimit":97000,"rentLimit":2425}]}]}],"pagination":{"totalRecords":2644,"totalPages":2644,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99717,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","countycode":"013","areaid":"None","areaname":"None","limittype":"50%","targetamis":"80,100","expenselimit":"30%","bedroomsize":2,"limit":1,"bedroomsizefactor":1.5,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-groupby-area","filterWarnings":["statecode value used to filter data; stateabbr has been ignored","countycode value used to filter data; countyname has been ignored"],"inputsOverridden":[{"fieldName":"bedroomSizeFactor","originalValue":null,"updatedValue":1.5,"overrideReason":"Default Value Applied"},{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["stateabbr","countyname"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":0},"data":[],"pagination":{"totalRecords":0,"totalPages":0,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99737,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-rent/state-limits:
    get:
      summary: Derived IL max rent state limits
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/HouseholdSize'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
        - $ref: '#/components/parameters/ExpenseLimit'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","expenselimit":"30%","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-state-limits","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":40050,"householdSize":1},{"incomeLimit":45750,"householdSize":2},{"incomeLimit":51450,"householdSize":3},{"incomeLimit":57150,"householdSize":4},{"incomeLimit":61750,"householdSize":5},{"incomeLimit":66300,"householdSize":6},{"incomeLimit":70900,"householdSize":7},{"incomeLimit":75450,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":1,"incomeLimit":64080,"rentLimit":1602},{"householdSize":2,"incomeLimit":73200,"rentLimit":1830},{"householdSize":3,"incomeLimit":82320,"rentLimit":2058},{"householdSize":4,"incomeLimit":91440,"rentLimit":2286},{"householdSize":5,"incomeLimit":98800,"rentLimit":2470},{"householdSize":6,"incomeLimit":106080,"rentLimit":2652},{"householdSize":7,"incomeLimit":113440,"rentLimit":2836},{"householdSize":8,"incomeLimit":120720,"rentLimit":3018}]},{"limitType":"100%","limitValues":[{"householdSize":1,"incomeLimit":80100,"rentLimit":2002.5},{"householdSize":2,"incomeLimit":91500,"rentLimit":2287.5},{"householdSize":3,"incomeLimit":102900,"rentLimit":2572.5},{"householdSize":4,"incomeLimit":114300,"rentLimit":2857.5},{"householdSize":5,"incomeLimit":123500,"rentLimit":3087.5},{"householdSize":6,"incomeLimit":132600,"rentLimit":3315},{"householdSize":7,"incomeLimit":141800,"rentLimit":3545},{"householdSize":8,"incomeLimit":150900,"rentLimit":3772.5}]}]}],"pagination":{"totalRecords":56,"totalPages":56,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99716,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","limittype":"50%","targetamis":"80,100","expenselimit":"30%","householdsize":"4","limit":1,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-state-limits","filterWarnings":["statecode value used to filter data; stateabbr has been ignored"],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["countycode","countyname","areaid","areaname","stateabbr"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":57150,"householdSize":4}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"householdSize":4,"incomeLimit":91440,"rentLimit":2286}]},{"limitType":"100%","limitValues":[{"householdSize":4,"incomeLimit":114300,"rentLimit":2857.5}]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99736,"reset":"2026-03-01T00:00:00.000Z"}}
  /data/derived/il/target-ami-max-rent/state-limits/bybedroomsize:
    get:
      summary: Derived IL max rent state limits (bedroom size)
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/DatasourceRequired'
        - $ref: '#/components/parameters/DatasetType'
        - $ref: '#/components/parameters/FiscalYear'
        - $ref: '#/components/parameters/EffectiveDate'
        - $ref: '#/components/parameters/StateCode'
        - $ref: '#/components/parameters/StateAbbr'
        - $ref: '#/components/parameters/LimitTypeRequired'
        - $ref: '#/components/parameters/BedroomSize'
        - $ref: '#/components/parameters/BedroomSizeFactor'
        - $ref: '#/components/parameters/BedroomSizeRoundFlag'
        - $ref: '#/components/parameters/TargetAmisRequired'
        - $ref: '#/components/parameters/RoundingMode'
        - $ref: '#/components/parameters/ExpenseLimit'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
              examples:
                example1:
                  value: {"status":"success","input":{"datasource":"HUD","limittype":"50%","targetamis":"80,100","expenselimit":"30%","limit":1,"datasettype":"Section8","bedroomsizefactor":1.5,"page":1},"metadata":{"resource":"derived-il-ami-max-rent-state-limits-outputby-bedroomsize","filterWarnings":[],"inputsOverridden":[{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"},{"fieldName":"bedroomSizeFactor","originalValue":null,"updatedValue":1.5,"overrideReason":"Default Value Applied"}],"inputsIgnored":[],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":40050,"householdSize":1},{"incomeLimit":45750,"householdSize":2},{"incomeLimit":51450,"householdSize":3},{"incomeLimit":57150,"householdSize":4},{"incomeLimit":61750,"householdSize":5},{"incomeLimit":66300,"householdSize":6},{"incomeLimit":70900,"householdSize":7},{"incomeLimit":75450,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"bedroomSize":0,"householdSize":1,"incomeLimit":64080,"rentLimit":1602},{"bedroomSize":1,"householdSize":1.5,"incomeLimit":68640,"rentLimit":1716},{"bedroomSize":2,"householdSize":3,"incomeLimit":82320,"rentLimit":2058},{"bedroomSize":3,"householdSize":4.5,"incomeLimit":95120,"rentLimit":2378},{"bedroomSize":4,"householdSize":6,"incomeLimit":106080,"rentLimit":2652}]},{"limitType":"100%","limitValues":[{"bedroomSize":0,"householdSize":1,"incomeLimit":80100,"rentLimit":2002.5},{"bedroomSize":1,"householdSize":1.5,"incomeLimit":85800,"rentLimit":2145},{"bedroomSize":2,"householdSize":3,"incomeLimit":102900,"rentLimit":2572.5},{"bedroomSize":3,"householdSize":4.5,"incomeLimit":118900,"rentLimit":2972.5},{"bedroomSize":4,"householdSize":6,"incomeLimit":132600,"rentLimit":3315}]}]}],"pagination":{"totalRecords":56,"totalPages":56,"currentPage":1,"recordsPerPage":1,"nextPage":2,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99715,"reset":"2026-03-01T00:00:00.000Z"}}
                example2:
                  value: {"status":"success","input":{"datasource":"HUD","statecode":"02","limittype":"50%","targetamis":"80,100","expenselimit":"30%","bedroomsize":2,"limit":1,"bedroomsizefactor":1.5,"datasettype":"Section8","page":1},"metadata":{"resource":"derived-il-ami-max-rent-state-limits-outputby-bedroomsize","filterWarnings":["statecode value used to filter data; stateabbr has been ignored"],"inputsOverridden":[{"fieldName":"bedroomSizeFactor","originalValue":null,"updatedValue":1.5,"overrideReason":"Default Value Applied"},{"fieldName":"datasettype","originalValue":null,"updatedValue":"Section8","overrideReason":"Default Data Set Type Applied for Specified Source"}],"inputsIgnored":["countycode","countyname","areaid","areaname","stateabbr"],"source":{"dataSource":"HUD","dataSetType":"Section8","fiscalYear":2025,"effectiveDate":"2025-04-01T00:00:00.000Z","entitlementCategory":"HUD"},"dataSize":1},"data":[{"mfi":114300,"stateAbbr":"AK","stateCode":"02","stateName":"Alaska","incomeLimits":[{"limitType":"50%","limitValues":[{"incomeLimit":40050,"householdSize":1},{"incomeLimit":45750,"householdSize":2},{"incomeLimit":51450,"householdSize":3},{"incomeLimit":57150,"householdSize":4},{"incomeLimit":61750,"householdSize":5},{"incomeLimit":66300,"householdSize":6},{"incomeLimit":70900,"householdSize":7},{"incomeLimit":75450,"householdSize":8}]}],"derivedLimits":[{"limitType":"80%","limitValues":[{"bedroomSize":2,"householdSize":3,"incomeLimit":82320,"rentLimit":2058}]},{"limitType":"100%","limitValues":[{"bedroomSize":2,"householdSize":3,"incomeLimit":102900,"rentLimit":2572.5}]}]}],"pagination":{"totalRecords":1,"totalPages":1,"currentPage":1,"recordsPerPage":1,"nextPage":null,"prevPage":null},"xRateLimit":{"key":"Example API Key","period":"202602","limit":100000,"remaining":99735,"reset":"2026-03-01T00:00:00.000Z"}}
