mirror of https://github.com/NoFxAiOS/nofx.git synced 2025-12-06 13:54:41 +08:00

Files

tinkle-community 67d69b132d docs: add supported exchanges table and API/wallet setup guides

- Add supported exchanges table to EN, ZH-CN, JA, KO READMEs
- CEX: Binance (supported), OKX (coming soon), Bybit (coming soon)
- Perp-DEX: Hyperliquid (supported), Aster DEX (supported)
- Include referral links with fee discounts for all exchanges
- Remove What's New sections from all READMEs
- Create Binance API setup guide
- Create Hyperliquid agent wallet setup guide
- Create Aster DEX API wallet setup guide

2025-11-27 02:56:19 +08:00

1.8 KiB

Raw Permalink Blame History

Binance API Setup Guide

This guide explains how to create and configure Binance API keys for use with NOFX.

Create API Key

Log in to your Binance account
Go to Account → API Management
Click Create API
Select System Generated API key type
Complete 2FA verification
Name your API key (e.g., "NOFX Trading")

Configure API Permissions

Enable the following permissions:

✅ Enable Reading - Required
✅ Enable Futures - Required for trading
❌ Enable Withdrawals - Keep disabled for security

IP Whitelist (Recommended)

For enhanced security:

Click Edit restrictions
Select Restrict access to trusted IPs only
Add your server's IP address
Save changes

Save Your Keys

After creation, you'll see:

API Key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Secret Key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

⚠️ Important: Save the Secret Key immediately - it's only shown once!

Configure in NOFX

Add your API credentials through the NOFX web interface:

Open NOFX dashboard (http://localhost:3000)
Go to Exchange Configuration
Enable Binance
Enter your API Key and Secret Key
Save configuration

Troubleshooting

Error	Solution
`Invalid API-key`	Check if API key is correct
`Signature verification failed`	Check if Secret key is correct
`IP not whitelisted`	Add your IP to whitelist or disable IP restriction
`Futures not enabled`	Enable Futures permission in API settings

Security Best Practices

Never share your API keys
Use IP whitelisting
Don't enable withdrawal permissions
Create separate API keys for different applications
Regularly rotate your API keys

1.8 KiB Raw Permalink Blame History