kokofinance-net Reference API

openapi: 3.2.0
info:
  title: Koko Finance Reference API
  description: Credit card portfolio intelligence — analyze portfolios, compare cards, get recommendations, and check renewal value.
  version: 1.0.0
tags:
- name: Reference
  description: Static reference data — points programs, benefit categories, program valuations.
paths:
  /api/v1/reference/programs:
    get:
      tags:
      - Reference
      summary: List all verified programs
      description: List all verified, active points programs for dropdown/autocomplete.
      operationId: list_programs_api_v1_reference_programs_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: List of all verified points programs
          content:
            application/json:
              schema: {}
        '401':
          description: Invalid or missing API key
        '429':
          description: Rate limit exceeded
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/reference/programs/{program_key}:
    get:
      tags:
      - Reference
      summary: Get program details
      description: Get a single program's details including transfer partners.
      operationId: get_program_api_v1_reference_programs__program_key__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: program_key
        in: path
        required: true
        schema:
          type: string
          title: Program Key
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Program details with transfer partners
          content:
            application/json:
              schema: {}
        '401':
          description: Invalid or missing API key
        '404':
          description: Program not found
        '429':
          description: Rate limit exceeded
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/reference/programs/{program_key}/history:
    get:
      tags:
      - Reference
      summary: Program valuation history
      description: Get CPP and transfer partner ratio change history for a points program.
      operationId: get_program_history_api_v1_reference_programs__program_key__history_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: program_key
        in: path
        required: true
        schema:
          type: string
          title: Program Key
      - name: since
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: ISO date string (e.g. 2025-01-01)
          title: Since
        description: ISO date string (e.g. 2025-01-01)
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Program valuation change history
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid date format
        '401':
          description: Invalid or missing API key
        '429':
          description: Rate limit exceeded
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/reference/benefit-categories:
    get:
      tags:
      - Reference
      summary: List benefit categories and keys
      description: Returns the benefit key registry — all valid keys for benefit_selections, grouped by category. No authentication required.
      operationId: v1_benefit_categories_api_v1_reference_benefit_categories_get
      responses:
        '200':
          description: Benefit categories with individual keys
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: 'Your Koko API key (format: koko_xxxxx)'
      in: header
      name: X-API-Key