سه endpoint پرو برای تحلیل: کندلهای OHLC برای نمودار شمعی، آمار خلاصهٔ یک بازه، و نرخ دقیق در یک لحظهٔ مشخص (برای صورتحساب، حسابداری یا تسویه با نرخ روز).
کندلهای OHLC
GET
/api/fx/v1/ohlc/{code}
فقط طرح پرو
| پارامتر | توضیح |
|---|---|
range / from / to | مثل تاریخچه. |
period | طول هر کندل: 15m، 30m، 1h، 4h، 1d، 1w، 1mo یا دقیقه. حداقل ۱۵. از یک روز به بالا، کندلها از آرشیو روزانه ساخته میشوند و تا ابتدای آرشیو عقب میروند. |
curl "https://netarz.ir/api/fx/v1/ohlc/USD?range=30d&period=1d" \
-H "Authorization: Bearer $NETARZ_FX_KEY"
{
"data": [
{ "t": "2026-08-06T10:20:00+03:30", "open": 99800, "high": 100300, "low": 99600, "close": 100100, "moves": 7 },
{ "t": "2026-08-07T10:20:00+03:30", "open": 100100, "high": 100100, "low": 100100, "close": 100100, "moves": 0 },
"…"
],
"meta": { "code": "USD", "quote_currency": "IRT", "from": "…", "to": "…", "period_minutes": 1440, "candles": 30 }
}
moves تعداد تغییرات ثبتشده در آن دوره است؛ کندلی با moves: 0 چهار مقدارش برابر بستهٔ قبلی است (بازار تکان نخورده). t شروع دوره است.
آمار بازه
GET
/api/fx/v1/stats/{code}
فقط طرح پرو
curl "https://netarz.ir/api/fx/v1/stats/EUR?range=7d" \
-H "Authorization: Bearer $NETARZ_FX_KEY"
{
"data": {
"code": "EUR", "quote_currency": "IRT",
"from": "2026-08-29T10:20:00+03:30", "to": "2026-09-05T10:20:00+03:30",
"open": 117900, "close": 119100, "high": 119400, "low": 117600, "average": 118500,
"change": 1200, "change_percent": 1.02, "range_percent": 1.53, "volatility_percent": 0.11, "moves": 41
}
}
| فیلد | معنا |
|---|---|
open / close | نرخ در شروع و پایان بازه. |
high / low / average | بیشینه، کمینه و میانگین سادهٔ نقاط ثبتشده. |
change / change_percent | close − open و درصد آن. |
range_percent | (high − low) ÷ low — دامنهٔ نوسان. |
volatility_percent | انحراف معیار حرکتهای درصدی متوالی؛ null با کمتر از دو حرکت. |
moves | تعداد تغییرات در بازه. |
نرخ در یک لحظه
GET
/api/fx/v1/snapshot/{code}
فقط طرح پرو
«نرخ دلار ساعت ۱۲ روز اول شهریور چند بود؟» — at را بدهید؛ effective_from میگوید آن نرخ از چه زمانی برقرار شده بود.
curl "https://netarz.ir/api/fx/v1/snapshot/USD?at=2026-09-01T12:00:00%2B03:30" \
-H "Authorization: Bearer $NETARZ_FX_KEY"
{ "data": { "code": "USD", "quote_currency": "IRT", "at": "2026-09-01T12:00:00+03:30", "effective_from": "2026-09-01T11:45:03+03:30", "mid": 101700 } }
در URL، علامت + منطقهٔ زمانی را بهصورت %2B بنویسید یا از Unix timestamp استفاده کنید. لحظهای خارج از پنجرهٔ تاریخچهٔ طرح → 403 outside_history_window.