Files
proxmox/docs/11-references/DBIS_CORE_API_REFERENCE.md
defiQUG fbda1b4beb
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
docs: Ledger Live integration, contract deploy learnings, NEXT_STEPS updates
- ADD_CHAIN138_TO_LEDGER_LIVE: Ledger form done; public code review repo bis-innovations/LedgerLive; init/push commands
- CONTRACT_DEPLOYMENT_RUNBOOK: Chain 138 gas price 1 gwei, 36-addr check, TransactionMirror workaround
- CONTRACT_*: AddressMapper, MirrorManager deployed 2026-02-12; 36-address on-chain check
- NEXT_STEPS_FOR_YOU: Ledger done; steps completable now (no LAN); run-completable-tasks-from-anywhere
- MASTER_INDEX, OPERATOR_OPTIONAL, SMART_CONTRACTS_INVENTORY_SIMPLE: updates
- LEDGER_BLOCKCHAIN_INTEGRATION_COMPLETE: bis-innovations/LedgerLive reference

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-12 15:46:57 -08:00

4.3 KiB

DBIS Core API Reference

Last Updated: 2026-01-31
Status: Active
Purpose: Master reference for DBIS Core Banking System APIs including exchange integrations


Overview

The DBIS Core API Gateway exposes multiple API groups. Base URLs:

  • DBIS API Primary: https://dbis-api.d-bis.org (VMID 10150)
  • DBIS API Secondary: https://dbis-api-2.d-bis.org (VMID 10151)

All APIs require authentication via zeroTrustAuthMiddleware unless otherwise noted.


Exchange Integrations

Crypto.com OTC 2.0 API

Base Path: /api/v1/crypto-com-otc
Documentation: exchange-docs.crypto.com/exchange/v1/rest-ws/index_OTC2.html

Institutional OTC trading integration with Crypto.com Exchange OTC 2.0 REST/WebSocket APIs.

Environment Variables (Optional)

Variable Required Description
CRYPTO_COM_API_KEY Yes (when using OTC) API key from Crypto.com Exchange
CRYPTO_COM_API_SECRET Yes (when using OTC) API secret
CRYPTO_COM_ENVIRONMENT No production (default) or uat

When credentials are not configured, OTC endpoints return 503 Service Unavailable.

Reference Data

Method Path Description
GET /instruments Available OTC instruments (BTC_USD, ETH_USD, etc.)
GET /status Service connectivity and instrument count

Quote Management

Method Path Description
GET /quote-requests Open quote requests (NEW/ACTIVE)
GET /quote-requests/history Quote request history (COMPLETED/REJECTED)
GET /quotes Open quotes (ACTIVE)
GET /quotes/history Quote history

Deal Management

Method Path Description
GET /deals Open deals (not yet SETTLED)
GET /deals/history Closed deal history

Settle Later

Method Path Description
GET /settle-later/limit Configured and used settle-later limit
GET /settle-later/unsettled Unsettled amounts by date/instrument
GET /settle-later/status Full monitoring status with alerts

RFQ (Request for Quote)

Method Path Description
POST /rfq/request-quote Submit Request for Quote
POST /rfq/request-deal Execute deal from received quote

FX Integration

When OTC is configured, FxService.getMarketPrice() automatically uses cached OTC prices when available. OTC prices are populated when quotes are received via WebSocket.

Database

  • Model: otc_trades (Prisma)
  • Migration: npx prisma migrate dev --name add_otc_trades

Exchange Registry API

Base Path: /api/v1/exchange
Purpose: Unified price lookup with fallback across multiple exchange providers (Binance, Kraken, Oanda, FXCM). Optional OTC provider integration.

Endpoints

Method Path Description
GET /price Get market price for pair. Query: pair (e.g. BTC/USD), amount (optional)
GET /providers List enabled exchange providers

Environment Variables (Optional)

Variable Required Description
OANDA_API_KEY Yes (for Oanda) Oanda v20 API key
OANDA_ACCOUNT_ID Yes (for Oanda) Oanda account ID
OANDA_ENVIRONMENT No practice (default) or live
FXCM_API_TOKEN Yes (for FXCM) FXCM API token

Binance and Kraken use public ticker APIs (no credentials required).


Other DBIS Core APIs

FX API

Base Path: /api/fx

  • POST /orders - Submit FX order
  • GET /trades/:id - Get FX trade by ID

Ledger API

Base Path: /api/ledger

Accounts API

Base Path: /api/accounts

Payments API

Base Path: /api/payments