الوسوم
- TomanApi
OpenAPI 3.0.0
الإصدار 1.0
المصدر: رابط بعيد
https://api.tmn.site/TomanApi/healthHealth check for TomanApi module
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/Payment/tokenAccount information endpoint
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/Token/infoGet subscription info, usage stats, and remaining limits by API key
الاستجابات
200 — Subscription information with usage statistics401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FullRatesArchiveGet all FullRatesArchive
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | number | لا | |
limit | query | number | لا | |
search | query | string | لا | Search in name, title, description, url |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FullRatesArchive/from-to-datesGet FullRatesArchive between two dates
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
fromDate | query | string | نعم | Start date (inclusive) |
toDate | query | string | نعم | End date (inclusive) |
الاستجابات
200 — List of FullRatesArchive entities between fromDate and toDate401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FullRatesArchive/closest-dateGet closest FullRatesArchive record to a given date and time
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date | query | string | نعم | Target date and time (ISO string) |
الاستجابات
200 — Closest FullRatesArchive entity to the given date and time401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FullRatesArchive{id}Get one FullRatesArchive
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FullRatesGet all FullRates
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | number | لا | |
limit | query | number | لا | |
search | query | string | لا | Search in name, title, description, url |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FullRates{id}Get one FullRates
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FullRates/symbol/{symbol}Get FullRates by symbol
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
symbol | path | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRateArchiveGet all GlobalRateArchives
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | number | لا | |
limit | query | number | لا | |
search | query | string | لا | Search in name, title, description, url |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRateArchive/from-to-datesGet RateArchives between two dates
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
fromDate | query | string | نعم | Start date (inclusive) |
toDate | query | string | نعم | End date (inclusive) |
الاستجابات
200 — List of RateArchive entities between fromDate and toDate401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRateArchive/closest-dateGet closest GlobalRateArchive record to a given date and time
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date | query | string | نعم | Target date and time (ISO string) |
الاستجابات
200 — Closest GlobalRateArchive entity to the given date and time401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRateArchive{id}Get one GlobalRateArchive
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRates/public-ratesGet all GlobalRates
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRatesGet all GlobalRatess
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | number | لا | |
limit | query | number | لا | |
search | query | string | لا | Search in name, title, description, url |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRates/rates-usdGet all rates as object {symbol: [rate, inverseRate]}
الاستجابات
200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRates/rates-aedGet all rates as object {symbol: [rate, inverseRate]}
الاستجابات
200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRates/rates-eurGet all rates as object {symbol: [rate, inverseRate]}
الاستجابات
200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRates/rates-tryGet all rates as object {symbol: [rate, inverseRate]}
الاستجابات
200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRates/rates-tmnGet all rates as object {symbol: [rate, inverseRate]}
الاستجابات
200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/GlobalRates{id}Get one GlobalRates
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/XeApi/currenciesGet currency list from XE
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
iso | query | string | لا | ISO currency code (optional) |
obsolete | query | boolean | لا | Include obsolete currencies? |
language | query | string | لا | Output language (optional) |
additionalInfo | query | string | لا | Additional info (optional) |
crypto | query | boolean | لا | Include cryptocurrencies? |
الاستجابات
200 — Currency list400 — Bad request401 — API key is required or invalid429 — Rate limit exceeded500 — Server error/TomanApi/XeApi/convert-fromConvert from multiple currencies to a target currency
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
to | query | string | نعم | Target ISO currency code |
from | query | string | لا | Comma-separated source currency list or empty |
amount | query | number | لا | Input amount |
obsolete | query | boolean | لا | |
interval | query | string | لا | Rate interval (e.g., 1m, 1h, 1d) |
inverse | query | boolean | لا | |
decimal_places | query | number | لا | |
margin | query | number | لا | |
crypto | query | boolean | لا | |
skip_weekends | query | boolean | لا |
الاستجابات
200 — Conversion result400 — Bad request401 — API key is required or invalid429 — Rate limit exceeded500 — Server error/TomanApi/XeApi/convert-toConvert from one currency to multiple currencies
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
from | query | string | نعم | Source ISO currency code or * |
to | query | string | لا | Target ISO currency code (optional) |
amount | query | number | لا | |
obsolete | query | boolean | لا | |
interval | query | string | لا | |
inverse | query | boolean | لا | |
decimal_places | query | number | لا | |
margin | query | number | لا | |
crypto | query | boolean | لا | |
skip_weekends | query | boolean | لا |
الاستجابات
200 — Conversion result401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/XeApi/historic-ratesHistoric conversion rate
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
to | query | string | نعم | |
from | query | string | لا | |
amount | query | number | لا | |
date | query | string | لا | YYYY-MM-DD |
time | query | string | لا | HH:mm:ss |
obsolete | query | boolean | لا | |
inverse | query | boolean | لا | |
decimal_places | query | number | لا | |
margin | query | number | لا | |
crypto | query | boolean | لا | |
use_lock_in_time | query | boolean | لا |
الاستجابات
200 — Historic rate401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/XeApi/historic-rates/periodHistoric rates over a time period
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
to | query | string | نعم | |
from | query | string | لا | |
amount | query | number | لا | |
start_timestamp | query | string | لا | |
end_timestamp | query | string | لا | |
interval | query | string | لا | |
page | query | number | لا | |
per_page | query | number | لا | |
obsolete | query | boolean | لا | |
inverse | query | boolean | لا | |
decimal_places | query | number | لا | |
margin | query | number | لا | |
crypto | query | boolean | لا |
الاستجابات
200 — List of rates401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/XeApi/monthly-averageMonthly average rate
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
to | query | string | نعم | |
from | query | string | لا | |
year | query | number | لا | |
month | query | number | لا | |
obsolete | query | boolean | لا | |
inverse | query | boolean | لا | |
decimal_places | query | number | لا | |
crypto | query | boolean | لا | |
amount | query | number | لا |
الاستجابات
200 — Average result401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/XeApi/statsRate statistics over a period
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
to | query | string | نعم | |
from | query | string | لا | |
start_date | query | string | لا | |
end_date | query | string | لا | |
obsolete | query | boolean | لا | |
decimal_places | query | number | لا | |
daysInPeriod | query | number | لا | |
crypto | query | boolean | لا |
الاستجابات
200 — Statistics result401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FinanceApi/Home/currencies/fv3Get exchange rates (fv3) by Rate Group ID 0, 1, 2, 3, 4, 5, 6
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
rateGroupId | query | string | لا | Rate Group ID (default: 3) 0, 1, 2, 3, 4, 5, 6 |
الاستجابات
200 — fv3 rates object400 — Backend URL not configured or invalid parameters401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/Home/currencies/appGet exchange rates for App (fv3app) by Rate Group ID 0, 1, 2, 3, 4, 5, 6
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
rateGroupId | query | string | لا | Rate Group ID (default: 3) 0, 1, 2, 3, 4, 5, 6 |
الاستجابات
200 — fv3app rates object400 — Backend URL not configured or invalid parameters401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/Home/currenciesGet currencies by Rate Group ID 0, 1, 2, 3, 4, 5, 6
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
rateGroupId | query | string | لا | Rate Group ID (default: 3) 0, 1, 2, 3, 4, 5, 6 |
الاستجابات
200 — Array of currency items (may be empty)400 — Backend URL not configured or invalid parameters401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/binLookup card BIN information (API Ninjas)
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
bin | query | string | نعم | First 6-8 digits of the card number |
الاستجابات
200 — BIN lookup results (array)400 — Invalid BIN401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/ibanLookup and validate an IBAN (API Ninjas)
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
iban | query | string | نعم | International Bank Account Number (e.g., DE16200700000532013000) |
الاستجابات
200 — IBAN details400 — Invalid IBAN401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/mortgage-ratesGet mortgage rates from API Ninjas (optional date range)
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date | query | string | لا | YYYY-MM-DD. Premium only. |
min_date | query | string | لا | YYYY-MM-DD. Must be used with max_date. Premium only. |
max_date | query | string | لا | YYYY-MM-DD. Must be used with min_date. Premium only. |
الاستجابات
200 — Mortgage rate data returned from API Ninjas400 — Invalid parameters. min_date and max_date must be provided together.401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/inflationGet current inflation (CPI or HICP) from API Ninjas
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | query | string | لا | CPI or HICP. Defaults to CPI. |
country | query | string | لا | Country name (case-insensitive). |
الاستجابات
200 — Inflation data400 — Invalid parameters. type must be 'CPI' or 'HICP'.401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/inflation/countriesList countries with available inflation data
الاستجابات
200 — Array of country names400 — Invalid parameters. type must be 'CPI' or 'HICP'.401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/vatGet EU VAT rates for a country (API Ninjas)
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
country | query | string | نعم | |
type | query | string | نعم | |
min_date | query | string | نعم | |
max_date | query | string | نعم | |
limit | query | string | نعم | |
offset | query | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FinanceApi/swiftFind SWIFT codes for banks
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
swift | query | string | لا | 8 or 11 character SWIFT/BIC code |
bank | query | string | لا | Bank name (partial match, premium only) |
city | query | string | لا | City name |
country | query | string | لا | ISO 3166 two-letter country code (e.g., US) |
offset | query | number | لا | >= 0 (annual premium) for pagination |
الاستجابات
200 — SWIFT search results400 — Invalid parameters401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/routingnumberLookup US bank info by routing number
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
routing_number | query | string | نعم | 9-digit routing number |
الاستجابات
200 — Bank info for routing number (array, up to 1 item)400 — Invalid routing number401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/routingnumber/searchSearch US banks and routing numbers (Premium)
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
bank_name | query | string | لا | |
city | query | string | لا | |
state | query | string | لا | Two-letter (e.g., CA, NY) |
zip_code | query | string | لا | 5-digit ZIP code |
offset | query | number | لا | >= 0 pagination (Premium) |
الاستجابات
200 — Search results (array)400 — Invalid parameters401 — Unauthorized429 — Rate limit exceeded/TomanApi/FinanceApi/mortgage-calculatorالمعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
loan_amount | query | string | نعم | |
home_value | query | string | نعم | |
downpayment | query | string | نعم | |
interest_rate | query | string | نعم | |
duration_years | query | string | نعم | |
monthly_hoa | query | string | نعم | |
annual_property_tax | query | string | نعم | |
annual_home_insurance | query | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FinanceApi/income-taxالمعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
country | query | string | نعم | |
year | query | string | نعم | |
federal_only | query | string | نعم |
الاستجابات
200401 — API key is required or invalid429 — Rate limit exceeded/TomanApi/FinanceApi/time-seriesGet simple time series candles from TwelveData
المعلمات
| Name | In | Type | Required | Description |
|---|---|---|---|---|
symbol | query | string | نعم | Symbol pair, e.g., BTC/USD |
interval | query | string | نعم | Interval, e.g., 1h |
range | query | string | نعم | Number of candles (outputsize), e.g., 25 |
الاستجابات
200 — TwelveData time_series JSON400 — Invalid parameters or configuration401 — Unauthorized429 — Rate limit exceeded