Documentation API
Query exchange data, current news and online tools with an AlphaX API key.
https://alphax.pro
Authentification API Key
Register and sign in, then create an API key in your account. Send the key in either header below. Keep it out of URLs and public browser code.
Authorization: Bearer <API_KEY>
X-API-Key: <API_KEY>
API keys allow read-only queries. Browser-local tools and account, watchlist or alert changes are not part of this API.
Limites de requêtes 1 requête / seconde
All keys on your account share one request per second across all endpoints. Authenticated requests consume the interval even when parameters or upstream services fail. On HTTP 429, wait for the Retry-After header before retrying.
Quotes are cached observations. Check update times and market-status before using data; an empty list does not prove the source has no instruments.
| HTTP | Description |
|---|---|
400 | Invalid request or unavailable exchange capability |
401 | Missing, invalid or revoked API key |
404 | Unknown exchange or lookup |
422 | Invalid parameters |
429 | Rate limit exceeded; wait for Retry-After |
502 / 503 / 504 | The upstream or dependent service is unavailable. |
Exemples cURL · Python · JavaScript
Set API_KEY in your server environment. Each endpoint includes copyable examples; leave at least one second between requests.
All responses use data, meta and error. Lists are data arrays; pagination and source details are in meta. Errors provide code and message.
Use symbol for one exact instrument or symbols for up to 30 comma-separated instruments. Crypto symbols use BASE-QUOTE, for example BTC-USDT; native exchange identifiers are mapped internally. Use q for fuzzy search instead.
News covers the last 72 hours. language selects original article languages; locale controls response labels. Simplified and Traditional Chinese are separate filters.
Omit ip to query the caller public IP. Local or private addresses require an explicit public IP parameter.
Les exemples de réponse sont illustratifs et ne sont pas des données de marché en direct.
Marchés
Plateformes
Configured exchanges, data-source aliases and spot/futures capabilities. Unavailable counts may be null.
/api/v1/exchangesAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · ExchangeList
| Champ | Type | Description |
|---|---|---|
data | Exchange[] | Normalized result; collections always use an array. |
data[].data_source | string | — |
data[].futures_count | integer | null | Reported futures instruments; null when unavailable. |
data[].has_futures | boolean | — |
data[].has_spot | boolean | — |
data[].id | string | — |
data[].market_data_source | string | — |
data[].name | string | — |
data[].spot_count | integer | null | Reported spot instruments; null when unavailable. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.total | integer | Total number of matching records. |
Marchés
Marchés
Paginated quotes. Defaults to Binance spot. Use exchange IDs from /exchanges; stock data is also available via /stocks.
/api/v1/marketsAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
exchangeOptional |
string |
Configured exchange ID; default binance. |
marketOptional |
string |
Market type; default spot. Valeurs autorisées: |
qOptional |
string |
Search text; at most 80 characters.
|
pageOptional |
integer |
Page number. Default:
|
limitOptional |
integer |
Rows per page. Default:
|
sortOptional |
string |
Sort field; default volume. Valeurs autorisées: |
dirOptional |
string |
Sort direction. Valeurs autorisées: |
symbolOptional |
string |
Exact instrument symbol, for example BTC-USDT or AAPL. Case-insensitive; exchange-native aliases are mapped internally. Cannot be combined with symbols or q. |
symbolsOptional |
string |
Comma-separated exact instrument symbols, at most 30. Cannot be combined with symbol or q. Filtering happens before pagination; stocks return the requested set in one page. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · MarketPage
| Champ | Type | Description |
|---|---|---|
data | Ticker[] | Normalized result; collections always use an array. |
data[].base | string | Base asset code. |
data[].change_24h | number | Price change in percentage points; check change_period. |
data[].change_period | string | — |
data[].exchange | string | Exchange or independent data-source ID. |
data[].high_24h | number | — |
data[].low_24h | number | — |
data[].market_type | string | — |
data[].price | number | Observed price in the quote currency. |
data[].quote | string | Quote currency code. |
data[].range_period | string | — |
data[].symbol | string | Canonical instrument symbol. |
data[].updated_at | integer | Observation time in Unix seconds. |
data[].volume_24h | number | Volume in quote-currency units; check availability and estimation flags. |
data[].volume_estimated | boolean | — |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.counts | object | — |
meta.exchange | string | — |
meta.market_type | string | — |
meta.pagination | Pagination | Pagination metadata and links to this API. |
meta.pagination.end | integer | — |
meta.pagination.limit | integer | — |
meta.pagination.next_url | string | Next API page URL, or an empty string. |
meta.pagination.page | integer | Current page number, starting at 1. |
meta.pagination.previous_url | string | Previous API page URL, or an empty string. |
meta.pagination.start | integer | — |
meta.pagination.total | integer | Total number of matching records. |
meta.pagination.total_pages | integer | Total number of pages. |
meta.query | string | — |
meta.source | string | — |
meta.total | integer | — |
meta.updated_at | integer | Observation time in Unix seconds. |
Marchés
Spot tickers
Cached spot quotes for one configured exchange. Consult /market-status for feed health and timestamps.
/api/v1/tickers/{exchange}/spotAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de chemin
| Parameter | Type | Description |
|---|---|---|
exchangeRequired |
string |
Configured exchange ID. |
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
symbolOptional |
string |
Exact instrument symbol, for example BTC-USDT or AAPL. Case-insensitive; exchange-native aliases are mapped internally. Cannot be combined with symbols or q. |
symbolsOptional |
string |
Comma-separated exact instrument symbols, at most 30. Cannot be combined with symbol or q. Filtering happens before pagination; stocks return the requested set in one page. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · TickerArray
| Champ | Type | Description |
|---|---|---|
data | Ticker[] | Normalized result; collections always use an array. |
data[].base | string | Base asset code. |
data[].change_24h | number | Price change in percentage points; check change_period. |
data[].change_period | string | — |
data[].exchange | string | Exchange or independent data-source ID. |
data[].high_24h | number | — |
data[].low_24h | number | — |
data[].market_type | string | — |
data[].price | number | Observed price in the quote currency. |
data[].quote | string | Quote currency code. |
data[].range_period | string | — |
data[].symbol | string | Canonical instrument symbol. |
data[].updated_at | integer | Observation time in Unix seconds. |
data[].volume_24h | number | Volume in quote-currency units; check availability and estimation flags. |
data[].volume_estimated | boolean | — |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.exchange | string | — |
meta.total | integer | — |
Marchés
Futures tickers
Cached futures quotes for one configured exchange. Consult /market-status for feed health and timestamps.
/api/v1/tickers/{exchange}/futuresAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de chemin
| Parameter | Type | Description |
|---|---|---|
exchangeRequired |
string |
Configured exchange ID. |
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
symbolOptional |
string |
Exact instrument symbol, for example BTC-USDT or AAPL. Case-insensitive; exchange-native aliases are mapped internally. Cannot be combined with symbols or q. |
symbolsOptional |
string |
Comma-separated exact instrument symbols, at most 30. Cannot be combined with symbol or q. Filtering happens before pagination; stocks return the requested set in one page. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · TickerArray
| Champ | Type | Description |
|---|---|---|
data | Ticker[] | Normalized result; collections always use an array. |
data[].base | string | Base asset code. |
data[].change_24h | number | Price change in percentage points; check change_period. |
data[].change_period | string | — |
data[].exchange | string | Exchange or independent data-source ID. |
data[].high_24h | number | — |
data[].low_24h | number | — |
data[].market_type | string | — |
data[].price | number | Observed price in the quote currency. |
data[].quote | string | Quote currency code. |
data[].range_period | string | — |
data[].symbol | string | Canonical instrument symbol. |
data[].updated_at | integer | Observation time in Unix seconds. |
data[].volume_24h | number | Volume in quote-currency units; check availability and estimation flags. |
data[].volume_estimated | boolean | — |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.exchange | string | — |
meta.total | integer | — |
Marchés
Taux de financement
Paginated futures funding rates, 80 rows per page. Rates are percentage points; next_funding_time is Unix seconds.
/api/v1/funding-ratesAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
sourceOptional |
string |
Independent futures source ID, or all (default). |
qOptional |
string |
Search text; at most 80 characters.
|
pageOptional |
integer |
Page number. Default:
|
sortOptional |
string |
Sort field; default abs_rate. Valeurs autorisées: |
dirOptional |
string |
Sort direction; default desc. Valeurs autorisées: |
symbolOptional |
string |
Exact instrument symbol, for example BTC-USDT or AAPL. Case-insensitive; exchange-native aliases are mapped internally. Cannot be combined with symbols or q. |
symbolsOptional |
string |
Comma-separated exact instrument symbols, at most 30. Cannot be combined with symbol or q. Filtering happens before pagination; stocks return the requested set in one page. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · FundingPage
| Champ | Type | Description |
|---|---|---|
data | FundingRate[] | Normalized result; collections always use an array. |
data[].base | string | Base asset code. |
data[].exchange | string | Exchange or independent data-source ID. |
data[].funding_interval_hours | integer | Funding settlement interval in hours. |
data[].funding_rate | number | Funding rate in percentage points: 0.01 means 0.01%. |
data[].funding_rate_annualized | number | — |
data[].index_price | number | — |
data[].mark_price | number | — |
data[].next_funding_time | integer | Next funding settlement time in Unix seconds. |
data[].quote | string | Quote currency code. |
data[].symbol | string | Canonical instrument symbol. |
data[].updated_at | integer | Observation time in Unix seconds. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.all_total | integer | — |
meta.pagination | Pagination | Pagination metadata and links to this API. |
meta.pagination.end | integer | — |
meta.pagination.limit | integer | — |
meta.pagination.next_url | string | Next API page URL, or an empty string. |
meta.pagination.page | integer | Current page number, starting at 1. |
meta.pagination.previous_url | string | Previous API page URL, or an empty string. |
meta.pagination.start | integer | — |
meta.pagination.total | integer | Total number of matching records. |
meta.pagination.total_pages | integer | Total number of pages. |
meta.query | string | — |
meta.source | string | Publisher or lookup provider name. |
meta.source_counts | object | — |
meta.total | integer | Total number of matching records. |
meta.updated_at | integer | Observation time in Unix seconds. |
Marchés
Exchange funding rates
Full funding-rate snapshot with source status and generated_at.
/api/v1/funding-rates/{exchange}Autorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de chemin
| Parameter | Type | Description |
|---|---|---|
exchangeRequired |
string |
Configured futures exchange ID. |
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
symbolOptional |
string |
Exact instrument symbol, for example BTC-USDT or AAPL. Case-insensitive; exchange-native aliases are mapped internally. Cannot be combined with symbols or q. |
symbolsOptional |
string |
Comma-separated exact instrument symbols, at most 30. Cannot be combined with symbol or q. Filtering happens before pagination; stocks return the requested set in one page. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · FundingSnapshot
| Champ | Type | Description |
|---|---|---|
data | FundingRate[] | Normalized result; collections always use an array. |
data[].base | string | Base asset code. |
data[].exchange | string | Exchange or independent data-source ID. |
data[].funding_interval_hours | integer | Funding settlement interval in hours. |
data[].funding_rate | number | Funding rate in percentage points: 0.01 means 0.01%. |
data[].funding_rate_annualized | number | — |
data[].index_price | number | — |
data[].mark_price | number | — |
data[].next_funding_time | integer | Next funding settlement time in Unix seconds. |
data[].quote | string | Quote currency code. |
data[].symbol | string | Canonical instrument symbol. |
data[].updated_at | integer | Observation time in Unix seconds. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.exchange | string | Exchange or independent data-source ID. |
meta.status | FeedStatus | Source or service status; HTTP success alone does not imply a healthy feed. |
meta.status.error | string | Error identifier or diagnostic summary. |
meta.status.last_success_at | integer | — |
meta.status.ok | boolean | Whether this data source is healthy. |
meta.status.updated_at | integer | Observation time in Unix seconds. |
meta.total | integer | — |
meta.updated_at | integer | Snapshot generation time in Unix seconds. |
Marchés
Intérêt ouvert
Open-interest ranking for one supported source (default binance). Units and supported sources follow the website's open-interest page.
/api/v1/open-interestAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
sourceOptional |
string |
Supported OI source ID; available IDs are returned in source_ids. |
qOptional |
string |
Search text; at most 80 characters.
|
pageOptional |
integer |
Page number. Default:
|
limitOptional |
integer |
Rows per page. Default:
|
sortOptional |
string |
Sort field; default oi. Valeurs autorisées: |
dirOptional |
string |
Sort direction; default desc. Valeurs autorisées: |
symbolOptional |
string |
Exact instrument symbol, for example BTC-USDT or AAPL. Case-insensitive; exchange-native aliases are mapped internally. Cannot be combined with symbols or q. |
symbolsOptional |
string |
Comma-separated exact instrument symbols, at most 30. Cannot be combined with symbol or q. Filtering happens before pagination; stocks return the requested set in one page. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · OpenInterestPage
| Champ | Type | Description |
|---|---|---|
data | OpenInterest[] | Normalized result; collections always use an array. |
data[].base | string | Base asset code. |
data[].change_24h | number | — |
data[].change_period | string | — |
data[].exchange | string | Exchange or independent data-source ID. |
data[].open_interest | number | Open interest in base-asset units. |
data[].open_interest_change_pct | number | null | Percentage change, or null without a comparable observation. |
data[].open_interest_value | number | Open interest value in quote-currency units. |
data[].price | number | Observed price in the quote currency. |
data[].quote | string | Quote currency code. |
data[].symbol | string | Canonical instrument symbol. |
data[].timestamp | integer | Observation time in Unix seconds. |
data[].volume_24h | number | — |
data[].volume_estimated | boolean | — |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.all_total | integer | — |
meta.pagination | Pagination | Pagination metadata and links to this API. |
meta.pagination.end | integer | — |
meta.pagination.limit | integer | — |
meta.pagination.next_url | string | Next API page URL, or an empty string. |
meta.pagination.page | integer | Current page number, starting at 1. |
meta.pagination.previous_url | string | Previous API page URL, or an empty string. |
meta.pagination.start | integer | — |
meta.pagination.total | integer | Total number of matching records. |
meta.pagination.total_pages | integer | Total number of pages. |
meta.query | string | — |
meta.source | string | Publisher or lookup provider name. |
meta.source_counts | object | — |
meta.source_ids | string[] | — |
meta.total | integer | Total number of matching records. |
meta.updated_at | integer | Observation time in Unix seconds. |
Marchés
Actions
Binance Stocks quotes with availability flags. Pagination is returned in meta.pagination. Exact symbol filters return one result set.
/api/v1/stocksAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
qOptional |
string |
Search text; at most 80 characters.
|
regionOptional |
string |
Region; default all. Valeurs autorisées: |
universeOptional |
string |
Stock universe; default all. Valeurs autorisées: |
pageOptional |
integer |
Page number. Default:
|
limitOptional |
integer |
Rows per page. Default:
|
sortOptional |
string |
Sort field. Valeurs autorisées: |
dirOptional |
string |
Sort direction. Valeurs autorisées: |
symbolOptional |
string |
Exact instrument symbol, for example BTC-USDT or AAPL. Case-insensitive; exchange-native aliases are mapped internally. Cannot be combined with symbols or q. |
symbolsOptional |
string |
Comma-separated exact instrument symbols, at most 30. Cannot be combined with symbol or q. Filtering happens before pagination; stocks return the requested set in one page. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · StockArray
| Champ | Type | Description |
|---|---|---|
data | object[] | Normalized result; collections always use an array. |
data[].asset_code | string | null | — |
data[].asset_name | string | null | — |
data[].base | string | null | — |
data[].change_24h | number | null | — |
data[].change_available | boolean | — |
data[].data_stale | boolean | Whether the observation is stale. |
data[].data_timestamp | integer | null | — |
data[].exchange | string | null | — |
data[].high_24h | number | null | — |
data[].low_24h | number | null | — |
data[].market_phase | string | null | — |
data[].market_type | string | — |
data[].name | string | null | — |
data[].price | number | null | — |
data[].price_available | boolean | Whether a usable observed price is available. |
data[].quote | string | null | — |
data[].stock_market | string | — |
data[].symbol | string | Canonical instrument symbol. |
data[].tradability | string | null | — |
data[].trading_status | string | — |
data[].volume_24h | number | null | — |
data[].volume_available | boolean | — |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.pagination | Pagination | — |
meta.pagination.end | integer | — |
meta.pagination.limit | integer | — |
meta.pagination.next_url | string | Next API page URL, or an empty string. |
meta.pagination.page | integer | Current page number, starting at 1. |
meta.pagination.previous_url | string | Previous API page URL, or an empty string. |
meta.pagination.start | integer | — |
meta.pagination.total | integer | Total number of matching records. |
meta.pagination.total_pages | integer | Total number of pages. |
meta.total | integer | — |
Marchés
Market data status
Source-level feed health, counts and last-success timestamps. A successful HTTP response does not imply healthy upstream feeds.
/api/v1/market-statusAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · MarketStatus
| Champ | Type | Description |
|---|---|---|
data | object | Normalized result; collections always use an array. |
data.degraded_feeds | string[] | — |
data.exchanges | object[] | — |
data.exchanges[].counts | object | — |
data.exchanges[].exchange | string | Exchange or independent data-source ID. |
data.exchanges[].generated_at | integer | Snapshot generation time in Unix seconds. |
data.exchanges[].status | object | Source or service status; HTTP success alone does not imply a healthy feed. |
data.status | string | Source or service status; HTTP success alone does not imply a healthy feed. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
Actualités
Actualités
Current articles published within the last 72 hours, newest first, deduplicated by publisher URL. Language filters select original articles; they do not translate them. Omit language for all available languages.
/api/v1/newsAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
languageOptional |
string |
Article language: en, zh-CN, zh-TW, es, de, ja, fr, all or auto. auto follows locale; Chinese aliases are accepted. |
sourceOptional |
string |
Publisher display name from sources in the news response. |
assetOptional |
string |
Asset symbol, for example BTC. |
qOptional |
string |
Search text; at most 80 characters.
|
pageOptional |
integer |
Page number. Default:
|
limitOptional |
integer |
Articles per page. Default:
|
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · NewsPage
| Champ | Type | Description |
|---|---|---|
data | Article[] | Normalized result; collections always use an array. |
data[].archived_iso | string | — |
data[].assets | string[] | — |
data[].description | string | — |
data[].detail_url | string | — |
data[].language | string | Original article language; no translation is performed. |
data[].published_iso | string | Original publication time in ISO 8601 format. |
data[].slug | string | — |
data[].source | string | Publisher or lookup provider name. |
data[].title | string | — |
data[].url | string | Original publisher URL. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.asset | string | — |
meta.language | string | Original article language; no translation is performed. |
meta.language_filters | object[] | — |
meta.language_filters[].code | string | — |
meta.language_filters[].label_key | string | — |
meta.limit | integer | — |
meta.pagination | Pagination | Pagination metadata and links to this API. |
meta.pagination.end | integer | — |
meta.pagination.limit | integer | — |
meta.pagination.next_url | string | Next API page URL, or an empty string. |
meta.pagination.page | integer | Current page number, starting at 1. |
meta.pagination.previous_url | string | Previous API page URL, or an empty string. |
meta.pagination.start | integer | — |
meta.pagination.total | integer | Total number of matching records. |
meta.pagination.total_pages | integer | Total number of pages. |
meta.query | string | — |
meta.source | string | Publisher or lookup provider name. |
meta.sources | string[] | — |
meta.total | integer | Total number of matching records. |
Outils
IP lookup
Omit ip to query the caller's public IP. Forwarded IP is trusted only from the loopback reverse proxy. Private/reserved addresses return 422. Local calls must supply a public IP explicitly.
/api/v1/tools/ipAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
ipOptional |
string |
Optional public IPv4 or IPv6 address; omit or leave empty for the caller IP. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · IPResult
| Champ | Type | Description |
|---|---|---|
data | object | Normalized result; collections always use an array. |
data.as_domain | string | Autonomous system domain, when provided. |
data.asn | string | Autonomous system number, when provided. |
data.city | string | City reported by the provider, when available. |
data.country | string | Country name, when provided. |
data.country_code | string | Two-letter country code reported by the provider. |
data.hostname | string | Reported hostname, when available. |
data.ip | string | Normalized public IPv4 or IPv6 address. |
data.location | string | Reported latitude and longitude, when available. |
data.organization | string | Network organization, when provided. |
data.region | string | Region reported by the provider, when available. |
data.timezone | string | Reported timezone, when available. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.source | string | Publisher or lookup provider name. |
meta.updated_at | string | Lookup observation time in ISO 8601 format. |
Outils
Recherche DNS
Resolve public DNS records through the existing daemon lookup service.
/api/v1/tools/dnsAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
inputRequired |
string |
Domain name; PTR also accepts a public IP address. |
typeOptional |
string |
Record type; default A. Valeurs autorisées: |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · DNSResult
| Champ | Type | Description |
|---|---|---|
data | object | Normalized result; collections always use an array. |
data.dnssec | boolean | Whether the DNS resolver authenticated the response. |
data.name | string | Normalized queried DNS name. |
data.records | object[] | Returned DNS records; the array can be empty. |
data.records[].data | string | DNS record value. |
data.records[].name | string | DNS owner name. |
data.records[].ttl | integer | Record time to live in seconds. |
data.records[].type | string | DNS record type. |
data.status | string | DNS response status: NOERROR or NXDOMAIN. |
data.type | string | Requested DNS record type. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.source | string | Publisher or lookup provider name. |
meta.updated_at | string | Lookup observation time in ISO 8601 format. |
Outils
WHOIS lookup
Public domain registration data via RDAP.
/api/v1/tools/whoisAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
inputRequired |
string |
Public domain name. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · WhoisResult
| Champ | Type | Description |
|---|---|---|
data | object | Normalized result; collections always use an array. |
data.dnssec | boolean | Whether the domain is DNSSEC signed, when reported. |
data.domain | string | Normalized domain name. |
data.events | object[] | Registration lifecycle events. |
data.events[].action | string | — |
data.events[].date | string | — |
data.handle | string | Registry identifier. |
data.nameservers | string[] | Registered nameserver names. |
data.registrar | string | Registrar name, when reported. |
data.status | string[] | Domain registration status values. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.source | string | Publisher or lookup provider name. |
meta.updated_at | string | Lookup observation time in ISO 8601 format. |
Outils
Exchange rate lookup
Query the reference exchange rate for a currency pair. The data timestamp identifies its reference date.
/api/v1/tools/forexAutorisation
Send one of these headers with a valid API key.
AuthorizationBearer <API_KEY>X-API-Key<API_KEY>
Limite de requêtes
One request per second, shared by all keys on the account. Limites de requêtes ↗
Paramètres de requête
| Parameter | Type | Description |
|---|---|---|
fromRequired |
string |
Source currency, for example USD. |
toRequired |
string |
Target currency, for example CNY. |
localeOptional |
string |
Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages. |
Champs de réponse 200
application/json · ForexResult
| Champ | Type | Description |
|---|---|---|
data | object | Normalized result; collections always use an array. |
data.base | string | Source currency code. |
data.date | string | Reference rate date; empty for an identical currency pair. |
data.quote | string | Target currency code. |
data.rate | number | Target-currency units for one source-currency unit. |
error | null | Error object on failure; null on success. |
meta | object | Pagination, data source and observation metadata. |
meta.source | string | Publisher or lookup provider name. |
meta.updated_at | string | Lookup observation time in ISO 8601 format. |