Skip to content

GhostMixIO/GhostMix-API-Docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 

Repository files navigation

GhostMix-API-Docs

Official API documentation and Telegram Bot integration for GhostMix Protocol. Work-in-progress endpoints for automated Bitcoin privacy and zero-log mixing

🔌 GhostMix Protocol API & Telegram Bot (v1.0 - Work In Progress)

⚠️ Status: The GhostMix Universal API is currently under active development. Endpoints, parameters, and payload structures are subject to change before the official Mainnet release.

📖 Overview

The GhostMix REST API is the core engine powering our ecosystem. It is designed to seamlessly run our Official Telegram Bot while also allowing external developers, exchanges, and wallets to programmatically interact with our privacy protocol.

🌐 Base URL

https://api.ghostmix.io/v1/ (Coming soon)

🔐 Authentication

Public endpoints (like fees and network status) will be open. Advanced integration endpoints and Bot Webhooks will utilize standard Bearer Token authentication and cryptographic signature verification.


🛠️ Planned Endpoints (Draft)

1. Check Protocol Liquidity & Fees

GET /api/v1/network-status Returns the current available BTC liquidity in the pools and dynamic fee estimations. (Used by the Telegram bot to display current rates).

2. Initiate Mixing Session

POST /api/v1/mix Creates a new secure mixing session.

  • Planned Parameters: Target destination addresses, time delay preferences, fund distribution strategy, and optional telegram_chat_id for status alerts.

3. Track Session Status & Webhooks

GET /api/v1/status/{session_id} Checks the current state of your mixing process. We will also support active Webhooks to instantly notify your services or Telegram bot when a transaction is fully confirmed and processed.


Full technical documentation, payload examples, WebSocket integration guides, and code snippets will be published in this repository once the API is officially finalized by our core development team.

About

Official API documentation and Telegram Bot integration for GhostMix Protocol. Work-in-progress endpoints for automated Bitcoin privacy and zero-log mixing

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors