REST API Reference

Complete reference for all PulseMarkets REST endpoints.

Base URL

https://api.pulse-markets.com/v1

GET /quotes/{symbol}

Get real-time quote for a single currency pair.

Path Parameters

Parameter	Type	Description
`symbol`	string	Currency pair (e.g., EUR/USD, GBP/JPY)

Example Request

bash

curl -X GET "https://api.pulse-markets.com/v1/quotes/EUR/USD" \
  -H "X-API-Key: fx_your_key" \
  -H "X-API-Secret: fxs_your_secret"

Response

json

{
  "success": true,
  "data": {
    "symbol": "EUR/USD",
    "bid": 1.08542,
    "ask": 1.08545,
    "mid": 1.085435,
    "spread": 0.00003,
    "change": 0.00125,
    "change_percent": 0.1152,
    "high": 1.08890,
    "low": 1.08210,
    "timestamp": "2025-01-15T14:30:00.125Z"
  }
}

GET /quotes

Get real-time quotes for multiple currency pairs.

Query Parameters

Parameter	Type	Description
`symbols`	string	Comma-separated list of symbols

Example Request

bash

curl -X GET "https://api.pulse-markets.com/v1/quotes?symbols=EUR/USD,GBP/USD,USD/JPY" \
  -H "X-API-Key: fx_your_key" \
  -H "X-API-Secret: fxs_your_secret"

Response

json

{
  "success": true,
  "data": [
    {
      "symbol": "EUR/USD",
      "bid": 1.08542,
      "ask": 1.08545,
      "timestamp": "2025-01-15T14:30:00.125Z"
    },
    {
      "symbol": "GBP/USD",
      "bid": 1.26890,
      "ask": 1.26895,
      "timestamp": "2025-01-15T14:30:00.125Z"
    },
    {
      "symbol": "USD/JPY",
      "bid": 148.542,
      "ask": 148.548,
      "timestamp": "2025-01-15T14:30:00.125Z"
    }
  ],
  "count": 3
}

GET /symbols

Get list of all available trading symbols.

Query Parameters

Parameter	Type	Description
`type`	string	Filter by type: forex, metal, index, crypto

Example Request

bash

curl -X GET "https://api.pulse-markets.com/v1/symbols?type=forex" \
  -H "X-API-Key: fx_your_key" \
  -H "X-API-Secret: fxs_your_secret"

Response

json

{
  "success": true,
  "data": [
    {
      "symbol": "EUR/USD",
      "type": "forex",
      "base_currency": "EUR",
      "quote_currency": "USD",
      "pip_size": 0.0001,
      "digits": 5,
      "description": "Euro vs US Dollar"
    },
    {
      "symbol": "GBP/USD",
      "type": "forex",
      "base_currency": "GBP",
      "quote_currency": "USD",
      "pip_size": 0.0001,
      "digits": 5,
      "description": "British Pound vs US Dollar"
    }
  ],
  "count": 28
}

GET /convert

Convert amount between two currencies at current rates.

Query Parameters

Parameter	Type	Description
`from`	string	Source currency (e.g., EUR)
`to`	string	Target currency (e.g., USD)
`amount`	number	Amount to convert

Example Request

bash

curl -X GET "https://api.pulse-markets.com/v1/convert?from=EUR&to=USD&amount=1000" \
  -H "X-API-Key: fx_your_key" \
  -H "X-API-Secret: fxs_your_secret"

Response

json

{
  "success": true,
  "data": {
    "from": "EUR",
    "to": "USD",
    "amount": 1000,
    "result": 1085.42,
    "rate": 1.08542,
    "timestamp": "2025-01-15T14:30:00.125Z"
  }
}

GET /market/status

Get current market status and trading sessions.

Example Response

json

{
  "success": true,
  "data": {
    "forex_market_open": true,
    "current_session": "london",
    "sessions": {
      "sydney": { "open": false, "next_open": "2025-01-15T21:00:00Z" },
      "tokyo": { "open": false, "next_open": "2025-01-15T23:00:00Z" },
      "london": { "open": true, "closes_at": "2025-01-15T16:00:00Z" },
      "new_york": { "open": true, "closes_at": "2025-01-15T21:00:00Z" }
    },
    "server_time": "2025-01-15T14:30:00Z"
  }
}

Available Symbols

Major Pairs

EUR/USD

GBP/USD

USD/JPY

USD/CHF

AUD/USD

USD/CAD

NZD/USD

Cross Pairs

EUR/GBP

EUR/JPY

GBP/JPY

EUR/CHF

GBP/CHF

AUD/JPY

+ more...

Metals

XAU/USD (Gold)

XAG/USD (Silver)

XPT/USD (Platinum)

XPD/USD (Palladium)

Crypto

BTC/USD

ETH/USD

XRP/USD

LTC/USD