Ceffu OpenAPI Documentation Platform
  1. Development Tools and Resource
Ceffu OpenAPI Documentation Platform
  • Changes
    • Upcoming Changes
    • Change log
  • Development Tools and Resource
    • Overview
      • Welcome to Ceffu OpenAPI
    • Quickstart
      • Initial Setup
      • Using the Ceffu SDK
    • Authentication
    • Rate limit
    • Error Codes
    • Webhook Introduction
  • Concepts
    • Ceffu Custody
  • System Endpoints
    • Get System status
  • Wallet Management
    • Ceffu Supported Asset Endpoint
      • Get Prime Wallet supported coins list
      • Get Qualified Wallet supported coins list
      • Get Cosign Wallet supported coins list
    • Qualified Wallets and Prime Wallets Endpoint
      • Create Wallet
      • Update Wallet Details
      • Get Wallet List
      • Get Asset Details
      • Get Wallet Asset Summary
    • Deposits
      • Get Deposit Address
      • Get Deposit History
      • Get Deposit Detail
    • Withdrawals
      • Withdrawal
      • Get Withdrawal Fee (estimated)
      • Get Withdrawal History
      • Get Withdrawal Details
    • Whitelisted Addresses
      • Get Whitelisted Address List
      • Get Correspondent’s Options
      • Add/Edit Whitelisted Address
    • Transactions
      • Transaction History List
  • PW Sub Wallets
    • Sub-Wallet Management
      • Create Sub-Wallet
      • Update Sub-Wallet Details
      • Get Sub-Wallet List
      • Get Sub-Wallet Asset Details
      • Get Sub-Wallet Asset Summary
    • Sub-Wallet Deposits
      • Get Sub-Wallet Deposit Address
      • Get Deposit Address List under Prime Wallet
      • Get Deposit History under Sub-Wallet
      • Get Sub-Wallet Deposit History By Prime Wallet
    • Internal Transfers
      • Transfer between Sub Wallet and Prime Wallet
      • Get Transfer History between Sub-Wallet and Prime Wallet
    • Transactions
      • Get Transaction Details of Prime Wallet Internal Transfer
  • MirrorX
    • Link & Account
      • Get MirrorX LinkId List
    • Balances & Positions
      • Check MirrorX Available amount
      • Get MirrorX Asset Positions
    • Orders
      • Get MirrorX Orders
      • Place MirrorX Orders
  • Webhooks & Notifications
    • Resend webhook notifications
  • Archive
    • Mirror Endpoints
      • Get Mirror Linked Binance UID List
      • MIrror Assets Application
      • MIrror Assets Settlement
      • Get Mirror Operation Records
      • Get Mirrored Asset Positions
      • Get Mirrored Asset Summary
    • Wallet Endpoints
      • Get Transfer Detail with Exchange
      • Get Transfer History with Exchange
      • Transfer with Exchange
      • Get Withdrawal History
      • Get Withdrawal Details
      • Withdrawal
      • Get Sub-Wallet List (V1)
  1. Development Tools and Resource

Quickstart

Initial Setup
Initial Setup: Create a Ceffu Account: Sign up and log in to your Ceffu dashboard. Generate an API Key: From the web UI, go to Entity Management → A...
Using the Ceffu SDK
Install the SDK: Install via npm or yarn: npm install @ceffu_custody/ceffu-openapi-sdk # or yarn add @ceffu_custody/ceffu-openapi-sdk Instantiate the...
Previous
Welcome to Ceffu OpenAPI
Next
Initial Setup