API Documentation

Integrate LightningEX into your application with our powerful REST API. Build custom trading solutions, automate exchanges, and more.

🔑 Need an API Key?

To use the LightningEX API, you'll need an API key. Contact our team to request access and get your unique API credentials.

Contact support@lightningex.io

Introduction

The LightningEX API provides programmatic access to our cryptocurrency exchange services. You can use our API to build custom trading applications, automate exchanges, retrieve market data, and manage orders.

Base URL

https://api.lightningex.io

General Information

  • All API requests must be made over HTTPS
  • All timestamps are returned in milliseconds (UTC)
  • All endpoints return JSON responses
  • Data is returned in descending order (newest first)
  • Rate limits apply to all endpoints (100 requests per minute)
  • All requests must include your API key in the header

Authentication

All API endpoints require authentication using an API key. Include your API key in the X-API-Key header with every request.

Important: Keep your API key secure. Do not share it or expose it in client-side code. If your key is compromised, contact us immediately to revoke it and generate a new one.

Request Header

X-API-Key: your_api_key_here

Example Request

curl -X GET 'https://api.lightningex.io/exchange/currency/list' \
  -H 'X-API-Key: your_api_key_here'

Getting an API Key

To obtain an API key, please contact our support team at support@lightningex.io with the following information:

  • Your name and company name
  • Intended use case for the API
  • Estimated request volume
  • Any specific requirements or questions

Currencies

Retrieve the list of supported cryptocurrencies and their available networks.

GET /exchange/currency/list

Response Fields

Field Type Description
currency string Currency ticker (e.g., BTC, ETH)
name string Full currency name
sendStatusAll boolean Whether any network supports sending
receiveStatusAll boolean Whether any network supports receiving
networkList array Available networks for this currency

Pair Information

Get exchange information for a specific currency pair, including minimum/maximum amounts and fees.

GET /exchange/pair/info

Query Parameters

Parameter Type Required Description
send string Yes Currency to send (ticker)
receive string Yes Currency to receive (ticker)
sendNetwork string Yes Network for sending
receiveNetwork string Yes Network for receiving

Exchange Rates

Get the current exchange rate for a currency pair, including the estimated receive amount.

GET /exchange/rate

Query Parameters

Parameter Type Required Description
send string Yes Currency to send
receive string Yes Currency to receive
amount number Yes Amount to exchange
sendNetwork string Yes Send network
receiveNetwork string Yes Receive network

Orders

Create and manage exchange orders through our API.

Create Order

POST /exchange/order/place

Request Body

Field Type Required Description
send string Yes Currency to send
receive string Yes Currency to receive
amount number Yes Amount to send
receiveAddress string Yes Destination wallet address
sendNetwork string Yes Send network
receiveNetwork string Yes Receive network

Get Order Status

GET /exchange/order/get

Query Parameters

Parameter Type Required Description
id string Yes Order ID

Order Status Values

  • Awaiting Deposit - Waiting for user deposit
  • Confirming Deposit - Deposit detected, awaiting confirmation
  • Exchanging - Exchange in progress
  • Sending - Sending funds to user
  • Complete - Exchange completed successfully
  • Failed - Exchange failed
  • Action Request - Manual review required
  • Request Overdue - Order expired

Error Handling

All API errors follow a consistent format. Errors return an appropriate HTTP status code and a JSON response with error details.

Error Response Format

{
  "code": 400,
  "msg": "Invalid parameters"
}

HTTP Status Codes

Code Description
200 Success
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing API key
404 Not Found - Resource doesn't exist
429 Rate Limit Exceeded
500 Internal Server Error

Need Help? If you have questions about the API or need assistance with integration, please contact us at support@lightningex.io.