DEBYKO API

openapi: 3.1.0
info:
  title: DEBYKO API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 28 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; DEBYKO has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 25
    pages-with-code: 3
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://debyko.com/api
  - https://docs.debyko.com/api/x402
  - https://docs.debyko.com/api/arena
  - https://docs.debyko.com/api/errors
  - https://docs.debyko.com/api/limits
servers:
- url: https://api.debyko.com
paths:
  /account/api/keys:
    post:
      operationId: post_account_api_keys
      tags:
      - Account
      summary: Issue a restricted key with arena:write scope
      x-source: https://docs.debyko.com/api/arena
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAccountApiKeysRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/ingest:
    post:
      operationId: post_v1_ingest
      tags:
      - Ingest
      summary: POST /v1/ingest remains the existing raw JSON log and is not a substitute for the typed trading endpoints
      x-source: https://docs.debyko.com/api/arena
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1IngestRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/me:
    delete:
      operationId: delete_v1_me
      tags:
      - Me
      summary: DELETE /v1/me immediately deletes this account’s profiles, capital history, trades/fills, positions/snapshots and raw Arena events
      x-source: https://docs.debyko.com/api/arena
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteV1MeResponse'
      x-evidence:
        kind: documentation
  /v1/positions:
    post:
      operationId: post_v1_positions
      tags:
      - Positions
      summary: Keep open positions current
      x-source: https://docs.debyko.com/api/arena
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1PositionsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1PositionsResponse'
      x-evidence:
        kind: documentation
  /v1/profile:
    get:
      operationId: get_v1_profile
      tags:
      - Profile
      summary: GET /v1/profile returns the authenticated account’s handle, bio, declared_capital and capital_ccy
      x-source: https://docs.debyko.com/api/arena
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ProfileResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_v1_profile
      tags:
      - Profile
      summary: PUT /v1/profile
      x-source: https://docs.debyko.com/api/arena
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV1ProfileResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl/Python examples are below; no private repository access is required. \n Profile and declared capital Section titled “Profile\
          \ and declared capital” \n GET /v1/profile returns the authenticated account’s handle , bio , declared_capital and capital_ccy . It\
          \ has no side effects and is private, no-store . Capital is the latest declaration effective now, not a future scheduled value. Both\
          \ capital fie"
  /v1/trades:
    post:
      operationId: post_v1_trades
      tags:
      - Trades
      summary: Report each position when it goes flat
      x-source: https://docs.debyko.com/api/arena
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1TradesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1TradesResponse'
      x-evidence:
        kind: documentation
  /v2/account:
    get:
      operationId: get_v2_account
      tags:
      - Account
      summary: Limits and batches
      x-source: https://docs.debyko.com/api/limits
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/agent/state:
    get:
      operationId: get_v2_agent_state
      tags:
      - Agent
      summary: GET /v2/agent/state
      x-source: https://docs.debyko.com/api/x402
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/anchors:
    get:
      operationId: get_v2_anchors
      tags:
      - Anchors
      summary: ANCHOR_NOT_FOUND 404 for GET /v2/anchors/... when a day has no anchor.
      x-source: https://docs.debyko.com/api/errors
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2AnchorsResponse'
      x-evidence:
        kind: documentation
  /v2/anchors/proof:
    get:
      operationId: get_v2_anchors_proof
      tags:
      - Anchors
      summary: ANCHOR_NOT_YET 404 for GET /v2/anchors/proof when the day's root is not on the chain yet.
      x-source: https://docs.debyko.com/api/errors
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2AnchorsProofResponse'
      x-evidence:
        kind: documentation
  /v2/archive:
    get:
      operationId: get_v2_archive
      tags:
      - Archive
      summary: GET /v2/archive
      x-source: https://docs.debyko.com/api/x402
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/archive/{listing}/{layer}/{day}:
    get:
      operationId: get_v2_archive_listing_layer_day
      tags:
      - Archive
      summary: GET /v2/archive/{listing}/{layer}/{day}
      x-source: https://docs.debyko.com/api/x402
      parameters:
      - name: listing
        in: path
        required: true
        schema:
          type: string
      - name: layer
        in: path
        required: true
        schema:
          type: string
      - name: day
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/books:
    post:
      operationId: post_v2_books
      tags:
      - Books
      summary: POST /v2/books
      x-source: https://debyko.com/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/candles:
    get:
      operationId: get_v2_candles
      tags:
      - Candles
      summary: GET /v2/candles
      x-source: https://debyko.com/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_v2_candles
      tags:
      - Candles
      summary: POST /v2/candles
      x-source: https://docs.debyko.com/api/x402
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/dql/catalogue:
    get:
      operationId: get_v2_dql_catalogue
      tags:
      - Dql
      summary: Read GET /v2/dql/catalogue for the fields that exist rather than carrying a list in your client.
      x-source: https://docs.debyko.com/api/errors
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2DqlCatalogueResponse'
      x-evidence:
        kind: documentation
  /v2/dql/parse:
    post:
      operationId: post_v2_dql_parse
      tags:
      - Dql
      summary: POST /v2/dql/parse answers this without running anything, which is what an editor should call on every keystroke.
      x-source: https://docs.debyko.com/api/errors
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2DqlParseResponse'
      x-evidence:
        kind: documentation
  /v2/funding/settlements:
    get:
      operationId: get_v2_funding_settlements
      tags:
      - Funding
      summary: Limits and batches
      x-source: https://docs.debyko.com/api/limits
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/liquidations:
    post:
      operationId: post_v2_liquidations
      tags:
      - Liquidations
      summary: POST /v2/liquidations
      x-source: https://docs.debyko.com/api/x402
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/plans:
    get:
      operationId: get_v2_plans
      tags:
      - Plans
      summary: Limits and batches
      x-source: https://docs.debyko.com/api/limits
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/screen:
    post:
      operationId: post_v2_screen
      tags:
      - Screen
      summary: 'POST /v2/screen : a DQL query across venues, such as funding below zero on two venues or more.'
      x-source: https://debyko.com/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV2ScreenRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/snapshots:
    get:
      operationId: get_v2_snapshots
      tags:
      - Snapshots
      summary: GET /v2/snapshots
      x-source: https://docs.debyko.com/api/x402
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -si https://api.debyko.com/v2/snapshots \\ -H \" Content-Type: application/json \" \\ -d ' {\"where\":\"base in (BTC)\"\
          ,\"layers\":[\"mark\"]} ' \n { \"x402Version\" : 2 , \"error\" : \" PAYMENT-SIGNATURE header is required \" , \"resource\" : { \"url\"\
          \ : \" https://api.debyko.com/v2/snapshots \" , \"description\" : \" DEBYKO /v2/snapshots (price class snapshots) \" , \"mimeType\"\
          \ : \" application/json \" }, \"accepts\" : [ { "
    post:
      operationId: post_v2_snapshots
      tags:
      - Snapshots
      summary: POST /v2/snapshots
      x-source: https://debyko.com/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV2SnapshotsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s https://api.debyko.com/v2/snapshots  -H \"authorization: Bearer $DEBYKO_KEY\" -H 'content-type: application/json'  -d\
          \ '{\"where\":\"instrument = BTC-PERP and venue = BINANCE-USDM\",\"layers\":[\"funding\"]}'\n{\n \"instrument\": \"BTC-PERP\",\n \"\
          venue\": \"BINANCE-USDM\",\n \"kind\": \"perpetual\",\n \"venue_symbol\": \"BTCUSD1\",\n \"quote\": \"USD1\",\n \"identity_basis\":\
          \ \"reconstructed\",\n \"layers\": {\n \"funding\": {\n \"status"
  /v2/snapshots/history:
    post:
      operationId: post_v2_snapshots_history
      tags:
      - Snapshots
      summary: 'POST /v2/snapshots/history : history in buckets, at given instants, or every row as received.'
      x-source: https://debyko.com/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/status:
    get:
      operationId: get_v2_status
      tags:
      - Status
      summary: GET /v2/status
      x-source: https://debyko.com/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/stream:
    get:
      operationId: get_v2_stream
      tags:
      - Stream
      summary: GET /v2/stream
      x-source: https://docs.debyko.com/api/x402
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/venues:
    get:
      operationId: get_v2_venues
      tags:
      - Venues
      summary: GET /v2/venues
      x-source: https://docs.debyko.com/api/x402
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAccountApiKeysRequest:
      type: object
      properties:
        label:
          type: string
        scope:
          type: string
      required:
      - label
    PostV1IngestRequest:
      type: object
      properties:
        raw_json:
          type: object
      required:
      - raw_json
    DeleteV1MeResponse:
      type: object
      properties:
        accepted:
          type: integer
        updated:
          type: integer
    PostV1PositionsRequest:
      type: object
      properties:
        account:
          type: string
        positions:
          type: array
      required:
      - account
      - positions
    PostV1PositionsResponse:
      type: object
      properties:
        accepted:
          type: integer
        updated:
          type: integer
    GetV1ProfileResponse:
      type: object
      properties:
        handle:
          type: string
        bio:
          type: string
        declared_capital:
          type: string
        capital_ccy:
          type: string
    PutV1ProfileResponse:
      type: object
      properties:
        handle:
          type: string
        bio:
          type: string
        declared_capital:
          type:
          - string
          - 'null'
    PostV1TradesRequest:
      type: object
      properties:
        trade_id:
          type: string
        venue:
          type: string
        instrument:
          type: string
        side:
          type: string
        opened_at:
          type: string
        closed_at:
          type: string
        entry_price:
          type: string
        exit_price:
          type: string
        size:
          type: string
        size_unit:
          type: string
        leverage:
          type: string
        fees:
          type: string
        funding:
          type: string
        account:
          type: string
        exit_reason:
          type: string
        label:
          type: string
        fills:
          type: array
        debyko_firing_id:
          type: string
      required:
      - trade_id
      - venue
      - instrument
      - side
      - opened_at
      - closed_at
      - entry_price
      - exit_price
      - size
      - account
    PostV1TradesResponse:
      type: object
      properties:
        accepted:
          type: integer
        updated:
          type: integer
    GetV2AnchorsResponse:
      type: object
      properties:
        errors:
          type: array
          description: List of error objects as described on the Errors page.
    GetV2AnchorsProofResponse:
      type: object
      properties:
        errors:
          type: array
          description: List of error objects as described on the Errors page.
    GetV2DqlCatalogueResponse:
      type: object
      properties:
        errors:
          type: array
          description: List of error objects as described on the Errors page.
    PostV2DqlParseResponse:
      type: object
      properties:
        errors:
          type: array
          description: List of error objects as described on the Errors page.
    PostV2ScreenRequest:
      type: object
      properties:
        query:
          type: string
          description: DQL query string
      required:
      - query
    PostV2SnapshotsRequest:
      type: object
      properties:
        where:
          type: string
        layers:
          type: array
          items:
            type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Account
- name: Agent
- name: Anchors
- name: Archive
- name: Books
- name: Candles
- name: Dql
- name: Funding
- name: Ingest
- name: Liquidations
- name: Me
- name: Plans
- name: Positions
- name: Profile
- name: Screen
- name: Snapshots
- name: Status
- name: Stream
- name: Trades
- name: Venues