📡 مستندات API نرخ‌چی

با API نرخ‌چی می‌توانید قیمت لحظه‌ای طلا، ارز، سکه و ارز دیجیتال را در پروژه خود نمایش دهید. تمام پاسخ‌ها به فرمت JSON هستند.

🔗 Base URL: https://nerkhchii.com/api/v1
فرمت پاسخ
JSON با UTF-8 encoding
به‌روزرسانی داده
هر ۶۰ ثانیه یکبار
نماد ارز
usd, eur, gbp, aed, try, cny, rub, jpy
نماد طلا
gold_18k, gold_24k, mesghal, gold_ounce
نماد سکه
coin_emami, coin_bahar, coin_nim, coin_rob
نماد کریپتو
btc, eth, usdt

🔑 احراز هویت

تمام درخواست‌ها نیاز به API Key دارند. کلید را از داشبورد کاربری دریافت کنید.

روش اول: هدر HTTP

X-API-Key: YOUR_API_KEY

روش دوم: Query Parameter

GET /api/v1/prices?api_key=YOUR_API_KEY
💡 کلید تست رایگان: TEST-API-KEY-FREE (۱۰۰ درخواست روزانه)

⚡ محدودیت‌ها

پلن روزانه ماهانه
رایگان ۱۰۰ ۳,۰۰۰
پایه ⭐ ۱,۰۰۰ ۳۰,۰۰۰
حرفه‌ای 🚀 ۱۰,۰۰۰ ۳۰۰,۰۰۰

📊 قیمت‌ها

GET /api/v1/prices دریافت همه قیمت‌ها

پارامترها

category
string
فیلتر دسته: currency, gold, coin, crypto

پاسخ نمونه

{
  "success": true,
  "count": 19,
  "data": [
    {
      "symbol": "usd",
      "name_fa": "دلار آمریکا",
      "name_en": "US Dollar",
      "category": "currency",
      "price": 920000,
      "unit": "تومان",
      "icon": "🇺🇸",
      "change": {
        "amount": 5000,
        "percent": 0.54,
        "direction": "up"
      },
      "high_24h": 925000,
      "low_24h": 915000,
      "updated_at": "2025-01-15 10:30:00"
    }
  ]
}
GET /api/v1/prices/:symbol قیمت یک نماد خاص

مثال

GET /api/v1/prices/usd
GET /api/v1/prices/gold_18k
GET /api/v1/prices/btc

📈 تاریخچه قیمت

GET /api/v1/history/:symbol تاریخچه قیمت برای نمودار
period
string
1d | 7d | 30d | 90d (پیش‌فرض: 7d)
GET /api/v1/history/usd?period=7d

{
  "success": true,
  "symbol": "usd",
  "period": "7d",
  "count": 168,
  "data": [
    { "price": 915000, "recorded_at": "2025-01-08 10:00:00" },
    ...
  ]
}

🔍 وضعیت API Key

GET /api/v1/status بررسی وضعیت API Key
{
  "success": true,
  "plan": "free",
  "daily_limit": 100,
  "daily_used": 23,
  "daily_remaining": 77,
  "total_used": 450
}

❌ کدهای خطا

401
API Key ارسال نشده
403
API Key نامعتبر یا غیرفعال
404
نماد یافت نشد
429
سقف درخواست روزانه تمام شده
500
خطای داخلی سرور

💻 نمونه کد

JavaScript / Fetch

const API_KEY = 'YOUR_API_KEY';

fetch('https://nerkhchii.com/api/v1/prices', {
  headers: { 'X-API-Key': API_KEY }
})
.then(res => res.json())
.then(data => {
  data.data.forEach(item => {
    console.log(`${item.name_fa}: ${item.price.toLocaleString()} ${item.unit}`);
  });
});

PHP

Python

import requests

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

headers = {'X-API-Key': API_KEY}
response = requests.get(f'{BASE_URL}/prices', headers=headers)
data = response.json()

for item in data['data']:
    print(f"{item['name_fa']}: {item['price']:,} {item['unit']}")

🧪 Playground - تست زنده

API را مستقیماً از اینجا تست کنید.

نتیجه اینجا نمایش داده می‌شود...