XFT API Interface

Live Server

Account Management

POST /api/x-token/accounts/create: Registers a new user account with KYC verification.
GET /api/x-token/accounts/{account_id}: Retrieves account details, including X Token holdings and transaction history.
POST /api/x-token/accounts/{account_id}/update: Updates user account information.
DELETE /api/x-token/accounts/{account_id}: Deactivates a user account.

Token Management

POST /api/x-token/tokens/issue: Issues X Tokens against verified CEF shares.
POST /api/x-token/tokens/redeem: Redeems X Tokens for the underlying CEF shares.
GET /api/x-token/tokens/{token_id}: Retrieves details and current status of a specific X Token.
POST /api/x-token/tokens/{token_id}/update: Updates information related to a specific X Token.

Trading and Transactions

POST /api/x-token/trading/place-order: Places an order for buying or selling X Tokens.
GET /api/x-token/trading/{order_id}: Retrieves specific order details.
DELETE /api/x-token/trading/{order_id}/cancel: Cancels an existing order.
POST /api/x-token/trading/execute-transaction: Executes a transaction following order matching.

Wallet Management

POST /api/x-token/wallets/create: Creates a new wallet for storing X Tokens.
GET /api/x-token/wallets/{wallet_id}: Retrieves wallet details, including X Token balances.
POST /api/x-token/wallets/{wallet_id}/transfer-tokens: Allows for the transfer of X Tokens between wallets.

NAV Calculation and Arbitrage

GET /api/x-token/nav/calculate: Calculates the current NAV of the CEF.
POST /api/x-token/arbitrage/evaluate: Evaluates current market conditions for arbitrage opportunities.
POST /api/x-token/arbitrage/execute: Automatically executes arbitrage strategies based on predefined rules.

Compliance and Reporting

POST /api/x-token/compliance/kyc/submit: Submits KYC documents for user verification.
GET /api/x-token/compliance/kyc/{user_id}/status: Checks the KYC status of a user.
POST /api/x-token/compliance/aml/check: Performs AML checks on specific transactions.
GET /api/x-token/compliance/reporting: Generates compliance reports for regulatory bodies.

Escrow Operations

POST /api/escrow/hold: Holds an asset in escrow.
POST /api/escrow/release: Releases a held asset from escrow.
POST /api/escrow/rollback: Rolls back a held asset in escrow.

Liquidity Management

POST /api/liquidity/pools/create: Establishes a new liquidity pool for a specific asset.
GET /api/liquidity/pools/{pool_id}: Fetches details about a specific liquidity pool.
POST /api/liquidity/pools/{pool_id}/contribute: Adds liquidity to a pool.
POST /api/liquidity/pools/{pool_id}/withdraw: Removes liquidity from a pool.

Compliance and KYC

POST /api/compliance/kyc/submit: Submits KYC documents for verification.
GET /api/compliance/kyc/{user_id}/status: Checks the KYC status of a user.
POST /api/compliance/aml/check: Performs AML checks on specific transactions.
POST /api/compliance/verify: Submits user data for KYC and KYB compliance checks.

Subscription

POST /api/v1/compliance/kyc/submit: Submits KYC documents for verification.
GET /api/v1/compliance/kyc/status: Checks the KYC status of a user.
POST /api/v1/subscription/documents/sign: Signs documents related to subscriptions.
POST /api/v1/payments/send: Sends payments as part of subscription processes.
GET /api/v1/subscription/certificate/temporary: Retrieves a temporary subscription certificate.
GET /api/v1/tokens/usdx/issue: Issues USDX tokens under a subscription model.
POST /api/v1/transfer/secondary/allowlist/add: Adds entities to the allowlist for secondary transfers.

NAV Calculation

GET /api/nav/calculate: Calculates the net asset value (NAV) of the fund.

GET /api/nav/history: Retrieves the historical NAV data of the fund.

Redemption

POST /api/v1/tokens/usdx/transfer: Transfers USDX tokens as part of redemption processes.
POST /api/v1/redemption/request: Requests redemption of tokenized assets.
POST /api/v1/redemption/complete: Completes the redemption process for tokenized assets.

Data and Analytics

GET /api/reports/transactions: Generates detailed reports on transaction history.
GET /api/reports/liquidity: Provides reports on liquidity metrics across various pools.
GET /api/analytics/user-activity: Analyzes user activity and trading patterns.

Orchestration and Issuance

POST /api/orchestration/convert: Converts between two specified dollar formats or between fiat and stablecoins.
GET /api/orchestration/rates: Retrieves current conversion rates between specified currencies.
POST /api/issuance/create: Issues a new custom stablecoin from a specified dollar amount.
GET /api/issuance/{coin_id}/details: Provides details about a specific issued stablecoin.

Proof of Reserves

GET /api/reserves/overview: Provides an overview of all reserves held by the platform.

Proof of Compliance

GET /api/compliance/proof: Retrieves proof of compliance documents and certifications.

Regulatory Compliance Management

POST /api/regulatory/rules/create: Creates a new set of compliance rules for a specific jurisdiction.
GET /api/regulatory/rules/{rule_id}: Retrieves details of specific compliance rules.
PUT /api/regulatory/rules/{rule_id}/update: Updates existing compliance rules.
DELETE /api/regulatory/rules/{rule_id}: Deletes a set of compliance rules.
GET /api/regulatory/rules/all: Lists all compliance rules across different jurisdictions.

Asset Compliance Wrapping

POST /api/assets/{asset_id}/compliance-wrap: Applies compliance wrapping to a tokenized asset based on the jurisdiction it is being traded to.
GET /api/assets/{asset_id}/compliance-status: Checks the compliance status of a tokenized asset against current jurisdictional regulations.

Consolidated Tape

GET /api/transactions/consolidated_tape: Retrieves all transactions executed on the XFT platform.

Monitoring and Reporting

GET /api/compliance/transactions/monitored: Retrieves a list of transactions flagged for compliance review.
POST /api/compliance/transactions/report: Submits a compliance report for a specific transaction or set of transactions.
GET /api/regulatory/audit-logs: Accesses logs of all regulatory actions and rule changes for audit purposes.

API Management

GET /api/v1/api_keys: Lists all API keys.
POST /api/v1/api_keys/create: Creates a new API key.
PUT /api/v1/api_keys/{api_key_id}/update: Updates an existing API key.
DELETE /api/v1/api_keys/{api_key_id}/delete: Deletes an API key.
GET /api/v1/usage_limits: Views API usage limits.

Support and Miscellaneous

GET /api/v1/support/faq: Accesses frequently asked questions.
POST /api/v1/support/tickets/create: Creates a new support ticket.
GET /api/v1/support/tickets/{ticket_id}: Retrieves a specific support ticket.
POST /api/v1/feedback/submit: Submits feedback or reports an issue.
GET /api/v1/announcements: Views current announcements.
GET /api/v1/terms_of_service: Reads the terms of service.
GET /api/v1/privacy_policy: Accesses the privacy policy.

Equities

GET /api/v1/_health/
GET /api/v1/orders/
GET /api/v1/orders/search
GET /api/v1/stocks/
GET /api/v1/stocks/quote
GET /api/v1/stocks/market_hours
GET /api/v1/stocks/{stock_id}/price_chart_data/
GET /api/v1/stocks/{stock_id}/news_articles
GET /api/v1/stocks/{stock_id}/market_details/
GET /api/v1/stocks/{stock_id}/dividends
GET /api/v1/stocks/splits
GET /api/v1/tokens/{chain_id}
GET /api/v1/entity/balance
GET /api/v1/managed/orders/
GET /api/v1/managed/orders/{order_id}
POST /api/v1/managed/orders/buy/market
POST /api/v1/managed/orders/buy/market/preview
POST /api/v1/managed/orders/buy/limit
POST /api/v1/managed/orders/buy/limit/preview
POST /api/v1/managed/orders/sell/market
POST /api/v1/managed/orders/sell/market/preview
POST /api/v1/managed/orders/sell/limit
POST /api/v1/managed/orders/sell/limit/preview
DELETE /api/v1/managed/orders/{order_id}/cancel
GET /api/v1/managed/order_requests/
GET /api/v1/managed/order_requests/{order_request_confirmation_code}
GET /api/v1/managed/accounts/
GET /api/v1/managed/portfolio/
GET /api/v1/web3/wallet/{wallet_address}/kyc/managed/status
POST /api/v1/web3/wallet/{wallet_address}/kyc/managed
GET /api/v1/web3/wallet/{wallet_address}/kyc/managed/nonce
GET /api/v1/web3/orders/fee

User Management

POST /register: Register a new user account.
POST /login: Authenticate a user and return a token.
POST /logout: Logout a user and invalidate their token.
GET /user/profile: Retrieve user profile information.
PUT /user/profile: Update user profile information.
DELETE /user/account: Delete a user account.

Account and Funds Management

GET /account/balance: Retrieve the user's account balance.
POST /account/deposit: Deposit funds into the user's account.
POST /account/withdraw: Withdraw funds from the user's account.
GET /account/transactions: List all transactions for the user's account.

Tokenized CFD Management

GET /cfds: List all available tokenized CFDs.
GET /cfds/{id}: Retrieve detailed information about a specific tokenized CFD.
POST /cfds/issue: Issue new tokenized CFDs (admin only).
PUT /cfds/{id}/update: Update details of a specific tokenized CFD (admin only).
DELETE /cfds/{id}: Delete a specific tokenized CFD (admin only).

Trading

POST /orders: Place a new buy or sell order.
GET /orders/{id}: Retrieve details of a specific order.
GET /orders/user: List all orders placed by the user.
PUT /orders/{id}/cancel: Cancel a specific order.

Market Data

GET /market/tickers: Retrieve current market tickers.
GET /market/orderbook/{cfd_id}: Retrieve the order book for a specific tokenized CFD.
GET /market/trades/{cfd_id}: List recent trades for a specific tokenized CFD.
GET /market/nav/{cfd_id}: Retrieve the current NAV for a specific closed-end fund.

Notifications and Alerts

POST /notifications/subscribe: Subscribe to notifications for specific events (e.g., margin calls, order execution).
POST /notifications/unsubscribe: Unsubscribe from notifications.

Risk Management

GET /risk/margin: Retrieve the current margin requirements.
POST /risk/margin/call: Handle margin calls (admin only).
POST /risk/liquidate: Liquidate positions when margin requirements are not met (admin only).

XFT's API interface plays an important role in creating a frictionless experience for our users. We have developed a set of endpoints that abstract direct blockchain interaction and have integrated all necessary services for our customers. Our goal is to remove the learning curve for developers AND traders unfamiliar with blockchain technology.

Please refer our API Reference and Documentation for more information. Contact alex@alexandros-securities.com with any questions/feedback.