Before integrating with XFX, ensure the following prerequisites are complete:
- Completed onboarding with XFX
- Access to the XFX customer portal
- XFX-issued API credentials (Client ID and Client Secret)
- Access to a development environment
Onboarding
Onboarding is required before you can access XFX APIs. During onboarding, XFX will collect information about you and your business to complete required KYB (Know Your Business) checks.
Once onboarding is complete, XFX will provision your account and enable API access.
XFX Customer Account and API Credentials
After onboarding, you will receive access to the XFX customer portal, and will be granted your API credentials:
- Client ID
- Client Secret
Keep your credentials secure
These credentials are used to authenticate all API requests. Treat them as sensitive secrets and store them securely (similar to passwords or private keys).
Environments
XFX provides multiple environments to support development, testing, and live trading.
| Environment | Base URL | Purpose |
|---|---|---|
| Development | https://dev-api.xfx.io | Initial testing and integration |
| Staging | https://staging-api.xfx.io | Pre-production validation |
| Production | https://api.xfx.io | Live trading once your integration is approved |
Recommended Environment Variables
We recommend configuring the following environment variables to simplify development and avoid hardcoding sensitive values.
| Variable | Description |
|---|---|
XFX_CLIENT_ID | Your XFX Client ID |
XFX_CLIENT_SECRET | Your XFX Client Secret |
XFX_BASE_URL | API base URL for the selected environment |
XFX_ACCESS_TOKEN | OAuth access token (generated during authentication) |