Symbols

Get the list of all supported symbols (currencies and metals).

Example Request

curl "https://metalapi.com/api/v1/symbols?api_key=YOUR_API_KEY"

Example Response

{
  "success": true,
  "symbols": {
    "XAU": "Gold",
    "XAG": "Silver",
    "XPT": "Platinum",
    "XPD": "Palladium",
    "USD": "US Dollar",
    "EUR": "Euro",
    "GBP": "British Pound"
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

Latest Rates

Get the latest rates for all supported symbols.

Parameters

Example Request

curl "https://metalapi.com/api/v1/latest?api_key=YOUR_API_KEY&base=USD&currencies=XAU,XAG,EUR"

Example Response

{
  "success": true,
  "timestamp": 1748189445,
  "base": "USD",
  "date": "2025-05-27",
  "rates": {
    "XAU": 0.00053853,
    "USDXAU": 1856.906765,
    "XAG": 0.032,
    "USDXAG": 31.25,
    "EUR": 0.8255334,
    "USDEUR": 1.211338027
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

Historical Rates

Get historical rates for a specific date.

Parameters

Example Request

curl "https://metalapi.com/api/v1/2024-01-15?api_key=YOUR_API_KEY&base=USD&currencies=XAU,XAG"

Example Response

{
  "success": true,
  "timestamp": 1705363200,
  "historical": true,
  "date": "2024-01-15",
  "base": "USD",
  "rates": {
    "XAU": 0.00053853,
    "USDXAU": 1856.906765,
    "XAG": 0.032,
    "USDXAG": 31.25
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

Convert

Convert one currency to another.

Parameters

Example Request

curl "https://metalapi.com/api/v1/convert?api_key=YOUR_API_KEY&from=USD&to=XAU&amount=1000"

Example Response

{
  "success": true,
  "query": {
    "from": "USD",
    "to": "XAU",
    "amount": 1000
  },
  "info": {
    "timestamp": 1748189445,
    "rate": 0.00053853
  },
  "result": 0.53853,
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

Timeframe

Get historical rates for a date range (max 365 days).

Parameters

Example Request

curl "https://metalapi.com/api/v1/timeframe?api_key=YOUR_API_KEY&start_date=2024-01-01&end_date=2024-01-07&currencies=XAU"

Example Response

{
  "success": true,
  "timeframe": true,
  "start_date": "2024-01-01",
  "end_date": "2024-01-07",
  "base": "USD",
  "rates": {
    "2024-01-01": {
      "XAU": 0.00053853,
      "USDXAU": 1856.906765,
      "XAG": 0.032,
      "USDXAG": 31.25
    },
    "2024-01-02": {
      "XAU": 0.00053853,
      "USDXAU": 1856.906765,
      "XAG": 0.032,
      "USDXAG": 31.25
    }
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

Change

Calculate rate changes between two dates.

Parameters

Example Request

curl "https://metalapi.com/api/v1/change?api_key=YOUR_API_KEY&start_date=2024-01-01&end_date=2024-01-02&currencies=XAU"

Example Response

{
  "success": true,
  "change": true,
  "start_date": "2024-01-01",
  "end_date": "2024-01-02",
  "base": "USD",
  "rates": {
    "XAU": {
      "start_rate": 0.00053853,
      "end_rate": 0.00053853,
      "change": 0,
      "change_pct": 0
    }
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

OHLC

Get Open, High, Low, Close prices for a specific date.

Parameters

Example Request

curl "https://metalapi.com/api/v1/ohlc?api_key=YOUR_API_KEY&date=2024-01-01&currencies=XAU"

Example Response

{
  "success": true,
  "ohlc": true,
  "date": "2024-01-01",
  "base": "USD",
  "rates": {
    "XAU": {
      "open": 0.0005277594,
      "high": 0.0005654565,
      "low": 0.0005116035,
      "close": 0.00053853
    }
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

Carat

Get gold prices by carat (available for paid plans).

Parameters

Example Request

curl "https://metalapi.com/api/v1/carat?api_key=YOUR_API_KEY&carat=24"

Example Response

{
  "success": true,
  "carat": "24",
  "date": "2025-05-27",
  "base": "USD",
  "timestamp": 1748336188,
  "rates": {
    "XAU24K": {
      "price": 1856.9,
      "unit": "troy_oz",
      "carat": "24"
    }
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

Usage

Get API usage statistics for your account.

Example Request

curl "https://metalapi.com/api/v1/usage?api_key=YOUR_API_KEY"

Example Response

{
  "success": true,
  "usage": {
    "requests_made": 15,
    "requests_quota": 1000,
    "requests_remaining": 985,
    "plan": "lite"
  },
  "rate_limit": {
    "limit": 10000,
    "remaining": 9995,
    "reset": 1748736000,
    "used": 5,
    "plan": "Standard",
    "reset_date": "2025-06-01T00:00:00.000000Z"
  }
}

JavaScript (Node.js)

const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://metalapi.com/api/v1';

// Get latest rates
async function getLatestRates() {
  try {
    const response = await axios.get(`${baseUrl}/latest`, {
      params: {
        api_key: apiKey,
        base: 'USD',
        currencies: 'XAU,XAG,EUR'
      }
    });
    
    console.log('Response:', response.data);
    console.log('Rate Limit Info:', response.data.rate_limit);
    
    // You can also access rate limit info from headers
    console.log('Remaining requests:', response.headers['x-ratelimit-remaining']);
  } catch (error) {
    console.error('Error:', error.response.data);
    if (error.response.data.rate_limit) {
      console.log('Rate Limit Info:', error.response.data.rate_limit);
    }
  }
}

// Convert currency
async function convertCurrency() {
  try {
    const response = await axios.get(`${baseUrl}/convert`, {
      params: {
        api_key: apiKey,
        from: 'USD',
        to: 'XAU',
        amount: 1000
      }
    });
    
    console.log(`1000 USD = ${response.data.result} XAU`);
    console.log('Rate Limit Info:', response.data.rate_limit);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}

// Get symbols
async function getSymbols() {
  try {
    const response = await axios.get(`${baseUrl}/symbols`, {
      params: {
        api_key: apiKey
      }
    });
    
    console.log('Available symbols:', response.data.symbols);
    console.log('Rate Limit Info:', response.data.rate_limit);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}

getLatestRates();
convertCurrency();
getSymbols();

Python

import requests
import json

API_KEY = 'YOUR_API_KEY'
BASE_URL = 'https://metalapi.com/api/v1'

def get_latest_rates():
    """Get latest exchange rates"""
    params = {
        'api_key': API_KEY,
        'base': 'USD',
        'currencies': 'XAU,XAG,EUR'
    }
    
    response = requests.get(f'{BASE_URL}/latest', params=params)
    
    if response.status_code == 200:
        data = response.json()
        print('Response:', json.dumps(data, indent=2))
        print(f'Remaining requests: {data["rate_limit"]["remaining"]}')
        
        # You can also access rate limit info from headers
        print(f'Rate limit from headers: {response.headers.get("X-RateLimit-Remaining")}')
    else:
        print(f'Error: {response.status_code}')
        error_data = response.json()
        print(json.dumps(error_data, indent=2))
        if 'rate_limit' in error_data:
            print('Rate Limit Info:', error_data['rate_limit'])

def convert_currency(from_currency, to_currency, amount):
    """Convert one currency to another"""
    params = {
        'api_key': API_KEY,
        'from': from_currency,
        'to': to_currency,
        'amount': amount
    }
    
    response = requests.get(f'{BASE_URL}/convert', params=params)
    
    if response.status_code == 200:
        data = response.json()
        print(f'{amount} {from_currency} = {data["result"]} {to_currency}')
        print('Rate Limit Info:', data['rate_limit'])
    else:
        print(f'Error: {response.status_code}')
        print(response.json())

def get_symbols():
    """Get available symbols"""
    params = {
        'api_key': API_KEY
    }
    
    response = requests.get(f'{BASE_URL}/symbols', params=params)
    
    if response.status_code == 200:
        data = response.json()
        print('Available symbols:')
        if 'metals' in data['symbols']:
            print('Metals:', data['symbols']['metals'])
        if 'currencies' in data['symbols']:
            print('Currencies:', data['symbols']['currencies'])
        print('Rate Limit Info:', data['rate_limit'])
    else:
        print(f'Error: {response.status_code}')
        print(response.json())

# Example usage
get_latest_rates()
convert_currency('USD', 'XAU', 1000)
get_symbols()

PHP

Quick Start

<?php
// Simple PHP example - Get latest gold price
$api_key = 'YOUR_API_KEY';
$url = 'https://metalapi.com/api/v1/latest?api_key=' . urlencode($api_key) . '&base=USD¤cies=XAU';

$response = file_get_contents($url);
$data = json_decode($response, true);

if ($data['success']) {
    echo "Gold Price: $" . $data['rates']['XAU'] . " per troy ounce\n";
    echo "Rate Limit: " . $data['rate_limit']['remaining'] . " requests remaining\n";
} else {
    echo "Error: " . $data['message'] . "\n";
}
?>

cURL

# Get latest rates
curl "https://metalapi.com/api/v1/latest?api_key=YOUR_API_KEY&base=USD¤cies=XAU,XAG,EUR"

# Get symbols
curl "https://metalapi.com/api/v1/symbols?api_key=YOUR_API_KEY"

# Convert currency
curl "https://metalapi.com/api/v1/convert?api_key=YOUR_API_KEY&from=USD&to=XAU&amount=1000"

Widget Generator

Use our interactive widget generator to create custom widgets without any coding. Choose from multiple themes, sizes, and data types.

Integration Guide

Learn how to integrate MetalAPI widgets into your website with these simple steps.

<!-- HTML Embed -->
<iframe src="https://metalapi.com/widget/YOUR_WIDGET_ID" 
        width="400" height="300" frameborder="0"></iframe>

<!-- JavaScript Integration -->
<div id="metalapi-widget"></div>
<script src="https://metalapi.com/js/widget.js"></script>
<script>
    MetalAPIWidget.init({
        container: '#metalapi-widget',
        widgetId: 'YOUR_WIDGET_ID',
        apiUrl: 'https://metalapi.com/api/widgets/data'
    });
</script>

Configuration Options

Customize your widgets with these configuration options to match your website's design and requirements.

Live Examples

See our widgets in action with these live examples. Click on any widget to view it in full screen.