Guides

Quickstart

Go from zero to your first paper order in about five minutes.

1. Install an SDK

Use an official SDK or call the REST API directly. SDKs wrap auth, retries, and pagination.

Shell

# Python
pip install egxapi

# Node
npm install @egxapi/node

Create a free account and copy your paper secret key from Dashboard → API keys. Keep it server-side.

Fetch your paper account to confirm the key works.

Shell

curl https://api.egxapi.com/v2/account \
  -H "Authorization: Bearer $EGX_KEY" \
  -H "X-EGX-Env: paper"

Shell

curl https://api.egxapi.com/v2/orders \
  -H "Authorization: Bearer $EGX_KEY" \
  -d '{"symbol":"COMI","qty":100,"side":"buy","type":"market"}'

When you're ready for real money, swap the key for a live key and set X-EGX-Env: live. No other code changes.