Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.quantcite.com/llms.txt

Use this file to discover all available pages before exploring further.

​
List Supported Exchanges

GET /api/v1/exchanges Get list of all supported exchanges and their capabilities.

​
Request

curl "https://data.quantcite.com/api/v1/exchanges"

​
Response

[
  {
    "exchange_name": "bybit",
    "display_name": "Bybit",
    "supported_transaction_types": [
      "holdings",
      "deposits", 
      "withdrawals",
      "spot_orders",
      "futures_linear",
      "futures_inverse",
      "ledger",
      "leverage_token_trades",
      "transfers"
    ],
    "requires_passphrase": false,
    "testnet_available": true,
    "documentation_url": "/docs#tag-bybit"
  }
]

​
Response Fields

FieldTypeDescription
exchange_namestringInternal exchange identifier
display_namestringHuman-readable exchange name
supported_transaction_typesarrayAvailable transaction types
requires_passphrasebooleanWhether exchange requires passphrase
testnet_availablebooleanWhether testnet is supported
documentation_urlstringLink to exchange-specific documentation

​
Check Credential Availability

GET /api/v1/exchanges/credentials Check which exchanges have internal credentials configured.

​
Request

curl "https://data.quantcite.com/api/v1/exchanges/credentials"

​
Response

{
  "exchanges_with_internal_credentials": ["bybit"],
  "exchanges_requiring_user_credentials": [],
  "details": {
    "bybit": {
      "has_internal_credentials": true,
      "requires_user_credentials": false,
      "can_use_without_api_keys": true,
      "testnet_available": false
    }
  }
}

​
Response Fields

FieldTypeDescription
exchanges_with_internal_credentialsarrayExchanges with built-in credentials
exchanges_requiring_user_credentialsarrayExchanges requiring user API keys
detailsobjectDetailed credential information per exchange

​
Validate Exchange Credentials

POST /api/v1/transactions/validate-credentials Validate exchange credentials without fetching transactions. Requires session authentication.

​
Request

curl -X POST "https://data.quantcite.com/api/v1/transactions/validate-credentials" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer your_session_token" \
     -d '{
       "exchange": "bybit",
       "testnet": false
     }'

​
Request Parameters

ParameterTypeRequiredDescription
exchangestringYesExchange name to validate
testnetbooleanNoUse testnet environment (default: false)

​
Success Response

{
  "success": true,
  "message": "Credentials are valid (using internal credentials)",
  "exchange": "bybit",
  "credentials_source": "internal",
  "account_info": {
    "account_type": "UNIFIED",
    "status": "active"
  }
}

​
Error Response

{
  "success": false,
  "message": "Invalid credentials provided",
  "exchange": "bybit",
  "error": "authentication_failed"
}

​
List Transaction Types

GET /api/v1/transactions/types Get all supported transaction types across exchanges.

​
Request

curl "https://data.quantcite.com/api/v1/transactions/types"

​
Response

{
  "unified_types": {
    "deposits": "Deposit transactions (incoming funds)",
    "withdrawals": "Withdrawal transactions (outgoing funds)",
    "trades": "Spot trading transactions", 
    "spot_trades": "Spot market trades",
    "futures": "Futures/derivatives trading",
    "derivatives": "Derivative trading transactions",
    "transfers": "Internal transfers between accounts",
    "holdings": "Current account balances",
    "balances": "Account balance snapshots"
  },
  "exchange_specific": {
    "bybit": [
      "holdings", "deposits", "withdrawals", "spot_orders",
      "futures_linear", "futures_inverse", "ledger",
      "leverage_token_trades", "transfers"
    ]
  }
}

​
Response Fields

FieldTypeDescription
unified_typesobjectStandard transaction types with descriptions
exchange_specificobjectExchange-specific transaction type mappings

​
Currently Supported Exchanges

​
Bybit

Bybit

Status: Fully supported
Testnet: Available
Credentials: Internal (no user API keys required)

​
Supported Transaction Types

TypeDescriptionAvailable
holdingsCurrent account balances✅
depositsDeposit transactions✅
withdrawalsWithdrawal transactions✅
spot_ordersSpot trading orders✅
futures_linearLinear futures trading✅
futures_inverseInverse futures trading✅
ledgerGeneral ledger entries✅
leverage_token_tradesLeveraged token transactions✅
transfersInternal account transfers✅

​
Features

  • Real-time streaming via WebSocket
  • Historical data with flexible date ranges
  • Unified data format across all transaction types
  • Automatic credential management (no user setup required)
  • Testnet support for development and testing

​
Upcoming Exchanges

We’re actively working on adding support for more exchanges. Contact our support team if you need a specific exchange prioritized.

​
Planned Exchanges

  • Binance - Spot and futures trading
  • Coinbase - Spot trading and custody
  • Kraken - Spot and futures trading
  • OKX - Comprehensive trading support
  • KuCoin - Spot and futures trading

​
Request Exchange Support

To request support for a new exchange:
  1. Contact Support: Email us at support@quantcite.com
  2. Provide Details: Include exchange name and required transaction types
  3. Business Case: Explain your use case and timeline
  4. Priority Queue: We’ll add it to our development roadmap

​
Health Check

GET /api/v1/health Get health status of unified transaction services.

​
Request

curl "https://data.quantcite.com/api/v1/health"

​
Response

{
  "status": "healthy",
  "unified_api": "operational",
  "available_exchanges": ["bybit"],
  "supported_exchanges": 1,
  "timestamp": "2025-09-18T10:30:00.000Z"
}

​
Response Fields

FieldTypeDescription
statusstringOverall system health status
unified_apistringUnified API service status
available_exchangesarrayCurrently operational exchanges
supported_exchangesnumberTotal number of supported exchanges
timestampstringHealth check timestamp
Use the health check endpoint to verify system status before making API calls.