Skip to content

Commit 5d8b50a

Browse files
committed
README update
1 parent 38a8dbd commit 5d8b50a

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# zoomex-go
22

3+
![Zoomex Golang Client SDK](https://github.com/user-attachments/assets/12509388-9e00-4dff-9e03-bc5124b0177c)
4+
35
Go client for [Zoomex](https://www.zoomex.com) cryptocurrency exchange API v3. Covers REST and WebSocket endpoints.
46

5-
If you're building a trading bot, market data collector, or portfolio tracker in Go and need to interact with Zoomex — this package wraps the whole v3 API so you don't have to deal with raw HTTP requests, signature generation, or WebSocket connection management yourself.
7+
If you're building a trading bot, market data collector, or portfolio tracker in Go and need to interact with Zoomex —
8+
this package wraps the whole v3 API so you don't have to deal with raw HTTP requests, signature generation, or WebSocket
9+
connection management yourself.
610

711
Works with both testnet and mainnet. Supports linear and inverse perpetual contracts.
812

@@ -127,18 +131,21 @@ ws := zoomex.NewWebSocket(
127131

128132
Base URLs used under the hood:
129133

130-
| | REST | WebSocket |
131-
|---|---|---|
132-
| **Mainnet** | `https://openapi.zoomex.com` | `wss://stream.zoomex.com/v3/private` |
134+
| | REST | WebSocket |
135+
|-------------|--------------------------------------|----------------------------------------------|
136+
| **Mainnet** | `https://openapi.zoomex.com` | `wss://stream.zoomex.com/v3/private` |
133137
| **Testnet** | `https://openapi-testnet.zoomex.com` | `wss://stream-testnet.zoomex.com/v3/private` |
134138

135139
## Authentication
136140

137-
Private endpoints are signed with HMAC_SHA256. Pass your API key and secret via `WithAPIKey` / `WithSecretKey` — the client builds the signature and sets `X-BAPI-*` headers on each request automatically. You don't need to calculate timestamps or sign anything manually.
141+
Private endpoints are signed with HMAC_SHA256. Pass your API key and secret via `WithAPIKey` / `WithSecretKey` — the
142+
client builds the signature and sets `X-BAPI-*` headers on each request automatically. You don't need to calculate
143+
timestamps or sign anything manually.
138144

139145
Public endpoints (market data) don't require credentials.
140146

141-
Testnet and mainnet are toggled with `WithTestnet(true|false)`. Get your testnet keys at [testnet.zoomex.com](https://testnet.zoomex.com).
147+
Testnet and mainnet are toggled with `WithTestnet(true|false)`. Get your testnet keys
148+
at [testnet.zoomex.com](https://testnet.zoomex.com).
142149

143150
## Docs
144151

0 commit comments

Comments
 (0)