TMN - API Gateway

برچسب‌ها

TomanApi

OpenAPI 3.0.0

نسخه 1.0

منبع: آدرس ریموت

آدرس پایه APIhttps://api.tmn.site

GET/TomanApi/health

TomanApi

Health check for TomanApi module

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/Payment/token

TomanApi

Account information endpoint

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/Token/info

TomanApi

Get 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

GET/TomanApi/FullRatesArchive

TomanApi

Get 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

GET/TomanApi/FullRatesArchive/from-to-dates

TomanApi

Get 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

GET/TomanApi/FullRatesArchive/closest-date

TomanApi

Get 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

GET/TomanApi/FullRatesArchive{id}

TomanApi

Get one FullRatesArchive

پارامترها

Name	In	Type	Required	Description
`id`	`path`	`string`	بله

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/FullRates

TomanApi

Get 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

GET/TomanApi/FullRates{id}

TomanApi

Get one FullRates

پارامترها

Name	In	Type	Required	Description
`id`	`path`	`string`	بله

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/FullRates/symbol/{symbol}

TomanApi

Get FullRates by symbol

پارامترها

Name	In	Type	Required	Description
`symbol`	`path`	`string`	بله

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRateArchive

TomanApi

Get 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

GET/TomanApi/GlobalRateArchive/from-to-dates

TomanApi

Get 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

GET/TomanApi/GlobalRateArchive/closest-date

TomanApi

Get 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

GET/TomanApi/GlobalRateArchive{id}

TomanApi

Get one GlobalRateArchive

پارامترها

Name	In	Type	Required	Description
`id`	`path`	`string`	بله

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRates/public-rates

TomanApi

Get all GlobalRates

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRates

TomanApi

Get 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

GET/TomanApi/GlobalRates/rates-usd

TomanApi

Get all rates as object {symbol: [rate, inverseRate]}

پاسخ‌ها

200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRates/rates-aed

TomanApi

Get all rates as object {symbol: [rate, inverseRate]}

پاسخ‌ها

200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRates/rates-eur

TomanApi

Get all rates as object {symbol: [rate, inverseRate]}

پاسخ‌ها

200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRates/rates-try

TomanApi

Get all rates as object {symbol: [rate, inverseRate]}

پاسخ‌ها

200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRates/rates-tmn

TomanApi

Get all rates as object {symbol: [rate, inverseRate]}

پاسخ‌ها

200 — Rates as object401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/GlobalRates{id}

TomanApi

Get one GlobalRates

پارامترها

Name	In	Type	Required	Description
`id`	`path`	`string`	بله

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/XeApi/currencies

TomanApi

Get 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

GET/TomanApi/XeApi/convert-from

TomanApi

Convert 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

GET/TomanApi/XeApi/convert-to

TomanApi

Convert 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

GET/TomanApi/XeApi/historic-rates

TomanApi

Historic 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

GET/TomanApi/XeApi/historic-rates/period

TomanApi

Historic rates over a time period

پارامترها

Name	In	Type	Required
`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

GET/TomanApi/XeApi/monthly-average

TomanApi

Monthly average rate

پارامترها

Name	In	Type	Required
`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

GET/TomanApi/XeApi/stats

TomanApi

Rate statistics over a period

پارامترها

Name	In	Type	Required
`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

GET/TomanApi/FinanceApi/Home/currencies/fv3

TomanApi

Get 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

GET/TomanApi/FinanceApi/Home/currencies/app

TomanApi

Get 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

GET/TomanApi/FinanceApi/Home/currencies

TomanApi

Get 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

GET/TomanApi/FinanceApi/bin

TomanApi

Lookup 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

GET/TomanApi/FinanceApi/iban

TomanApi

Lookup 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

GET/TomanApi/FinanceApi/mortgage-rates

TomanApi

Get 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

GET/TomanApi/FinanceApi/inflation

TomanApi

Get 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

GET/TomanApi/FinanceApi/inflation/countries

TomanApi

List countries with available inflation data

پاسخ‌ها

200 — Array of country names400 — Invalid parameters. type must be 'CPI' or 'HICP'.401 — Unauthorized429 — Rate limit exceeded

GET/TomanApi/FinanceApi/vat

TomanApi

Get EU VAT rates for a country (API Ninjas)

پارامترها

Name	In	Type	Required
`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

GET/TomanApi/FinanceApi/swift

TomanApi

Find 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

GET/TomanApi/FinanceApi/routingnumber

TomanApi

Lookup 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

GET/TomanApi/FinanceApi/routingnumber/search

TomanApi

Search 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

GET/TomanApi/FinanceApi/mortgage-calculator

TomanApi

پارامترها

Name	In	Type	Required
`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

GET/TomanApi/FinanceApi/income-tax

TomanApi

پارامترها

Name	In	Type	Required
`country`	`query`	`string`	بله
`year`	`query`	`string`	بله
`federal_only`	`query`	`string`	بله

پاسخ‌ها

200401 — API key is required or invalid429 — Rate limit exceeded

GET/TomanApi/FinanceApi/time-series

TomanApi

Get 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

مستندات API های اپ تومن

برچسب‌ها

پاسخ‌ها

پاسخ‌ها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پاسخ‌ها

پارامترها

پاسخ‌ها

پاسخ‌ها

پاسخ‌ها

پاسخ‌ها

پاسخ‌ها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها

پارامترها

پاسخ‌ها