Swipe Developer Docs

Welcome to the Swipe API documentation. This guide will help you get started with integrating Swipe's AI-powered trading capabilities into your applications.

Swipe provides a RESTful API that allows you to access GPT-powered trading signals, execute trades, and monitor performance in real-time. Our API is designed to be simple, intuitive, and powerful.

Before you begin, you'll need to create an account and obtain an API key. You can sign up for a free account at dashboard.swipe.trade.

Base URL

All API requests should be made to the following base URL:

https://api.swipe.trade/v1

Making Your First Request

Here's a simple example of how to fetch a trading signal for ETH/USDT:

curl https://api.swipe.trade/v1/signal \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{ "pair": "ETH/USDT" }'

Swipe uses Bearer tokens for scoped, role-based access. Include your API key in the Authorization header.

All API requests must include your API key in the Authorization header. Your API key is a sensitive piece of information that grants access to your Swipe account and trading capabilities.

curl https://api.swipe.trade/v1/signal \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{ "pair": "BTC/USDT" }'

API Key Management

You can manage your API keys in the Swipe dashboard. We recommend creating separate API keys for different environments (development, staging, production) and with different scopes.

The Signal API allows you to fetch AI-generated trading signals based on market conditions and your chosen strategy.

Signals are generated using our proprietary GPT models trained on vast amounts of market data. Each signal includes a recommended action (buy, sell, hold), confidence level, and supporting data.

Request Parameters

Response Format

{
  "signal": "buy",
  "confidence": 0.87,
  "pair": "BTC/USDT",
  "price": 42568.75,
  "timestamp": "2023-06-15T14:32:10Z",
  "strategy": "momentum",
  "reasoning": "Strong bullish momentum with increasing volume and positive MACD crossover",
  "suggested_entry": 42500,
  "suggested_stop_loss": 41800,
  "suggested_take_profit": 44000
}

The Trade Execution API allows you to submit trade orders to connected exchanges or trading terminals.

You can execute trades based on signals or your own custom logic. Our API supports market orders, limit orders, and stop orders.

Execute a Trade

To execute a trade, send a POST request to the /execute endpoint:

curl https://api.swipe.trade/v1/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "pair": "ETH/USDT",
    "side": "buy",
    "type": "market",
    "amount": 0.5,
    "exchange": "binance"
  }'

Request Parameters

The Swipe API uses conventional HTTP response codes to indicate the success or failure of an API request.

In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter was missing), and codes in the 5xx range indicate an error with our servers.

Error Responses

Error Response Format

All error responses include a JSON object with an error message and additional details:

{
  "error": {
    "code": 401,
    "message": "Unauthorized",
    "details": "Invalid API key provided"
  }
}

The Swipe API implements rate limiting to protect our infrastructure and ensure fair usage across all users.

Rate limits vary based on your subscription plan. If you exceed your rate limit, you'll receive a 429 Too Many Requests response.

Rate Limit Headers

All API responses include headers that provide information about your current rate limit status:

Rate Limit By Plan

Stay up to date with the latest changes and improvements to the Swipe API.