K-φ (K-Phi) Data API

openapi: 3.2.0
info:
  title: K-φ Data API
  version: 1.0.0
  description: 'Read your K-φ data (statements, cash, forecasts, scenarios) and save scenarios. The tenant always comes from the credential. Every response is { data, meta }; every error { error: { code, message } }.'
tags:
- name: Data
paths:
  /api/v1/data:
    get:
      x-audience: data
      x-group: data
      operationId: data_catalog
      summary: 'The Data library: market, macro and public series, each with its source…'
      x-scope: read:data
      security:
      - bearer: []
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
      tags:
      - Data
  /api/v1/data/var:
    post:
      x-audience: data
      x-group: data
      operationId: var_define
      summary: Define one of the account's own variables (any reference series), or change its…
      x-scope: write:vars
      security:
      - bearer: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                name:
                  type: string
                unit:
                  type: string
                currency:
                  type: string
                frequency:
                  type: string
                description:
                  type: string
              required:
              - code
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
      tags:
      - Data
  /api/v1/data/{series}:
    put:
      x-audience: data
      x-group: data
      operationId: var_put
      summary: Load points into a variable (var.), all or none; the same date and key again…
      x-scope: write:vars
      security:
      - bearer: []
      parameters:
      - name: series
        in: path
        required: true
        schema:
          type: string
        description: ecb.fx.usd, ecb.estr, ecb.yc.aaa, fred.sofr, fred.ust, wb.inflation…
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                points:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      key:
                        type: string
                      value:
                        type: number
                    required:
                    - date
                    - value
              required:
              - points
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '422':
          description: 'A point refused: nothing stored'
      tags:
      - Data
    delete:
      x-audience: data
      x-group: data
      operationId: var_remove
      summary: Remove a variable and its points
      x-scope: write:vars
      security:
      - bearer: []
      parameters:
      - name: series
        in: path
        required: true
        schema:
          type: string
        description: ecb.fx.usd, ecb.estr, ecb.yc.aaa, fred.sofr, fred.ust, wb.inflation…
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '404':
          description: No such variable
      tags:
      - Data
    get:
      x-audience: data
      x-group: data
      operationId: data_series
      summary: 'The points of a series: a scalar (date, value), a curve (date, tenor, value) or…'
      x-scope: read:data
      security:
      - bearer: []
      parameters:
      - name: series
        in: path
        required: true
        schema:
          type: string
        description: ecb.fx.usd, ecb.estr, ecb.yc.aaa, fred.sofr, fred.ust, wb.inflation…
      - name: from
        in: query
        schema:
          type: string
      - name: to
        in: query
        schema:
          type: string
      - name: key
        in: query
        schema:
          type: string
        description: One tenor (10Y) or one country (FRA)
      - name: limit
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '404':
          description: No such series
      tags:
      - Data
  /api/v1/data/{series}/latest:
    get:
      x-audience: data
      x-group: data
      operationId: data_latest
      summary: 'The latest date of a series: a scalar''s value, a curve''s tenors, a panel''s…'
      x-scope: read:data
      security:
      - bearer: []
      parameters:
      - name: series
        in: path
        required: true
        schema:
          type: string
        description: ecb.fx.usd, ecb.estr, ecb.yc.aaa, fred.sofr, fred.ust, wb.inflation…
      responses:
        '200':
          description: OK
        '401':
          description: No or invalid credential
        '403':
          description: Scope refused
        '404':
          description: No such series
      tags:
      - Data
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: API key, OAuth access token, extension key (kphix_…) or extension session token (kxs1.…)
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with the gl:ingest scope (ERP connectors)
x-scopes:
  gl:ingest: Push GL data from an ERP (/api/gl/mappings, /api/gl/schema, /api/gl/ingest)
  mcp:tools: All read scopes (read:gl read:cash read:forecast read:sheets read:data)
  mcp:write: All MCP write scopes (write:scenarios write:config write:data write:sheets)
  read:gl: Read statements, KPIs, ratios, GL lines, versions, dimensions, variance, data lake, FX rates and FP&A settings
  read:cash: Read bank positions, transactions, balance history, cash forecast, AR/AP
  read:forecast: Read forecasts, budgets, scenarios (levers, list, run) and valuations
  read:sheets: Read the Google Sheets registered as inputs of the account, each tab as JSON (/api/v1/sheets/…), and their webhooks' deliveries (2026-11-02)
  write:sheets: 'Register and remove the Google Sheets the account serves as JSON (read only: K-φ never writes to a sheet), and the webhooks told when one changes'
  read:data: 'Read the Data library (/api/v1/data/…): market, macro and public series with their source and licence (2026-11-03)'
  write:vars: 'Define, load and remove the account''s own variables (var.<CODE>) of the Data library, and nothing else: never the books (2026-11-05)'
  write:scenarios: Save scenarios (Simulation page)
  write:config: 'Change tenant configuration: flow rules, classification overrides, budget versions and templates, valuation refresh'
  write:data: 'Import rows from a spreadsheet Claude read (Excel in, 2026-10-29): cash forecasts, a GL version, a bank statement; preview first, then commit'
  run:build: 'Call the BUILD''s functions that only read (POST /api/v1/fn/<name>): the logic the account built, served as an API (2026-10-29)'
  run:build:write: 'Also call the BUILD''s functions that change data (declared "writes": true in its kphi.json)'
x-limits:
  per_ip_per_min: 200
  extension_per_min: 120
  extension_per_day: 20000