Referencia de APIREST APIv1

Documentación de la API

Query exchange data, current news and online tools with an AlphaX API key.

URL basehttps://alphax.pro
Autenticación 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.

HTTP
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.

Límites de solicitudes 1 solicitud / segundo

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.

HTTPDescription
400Invalid request or unavailable exchange capability
401Missing, invalid or revoked API key
404Unknown exchange or lookup
422Invalid parameters
429Rate limit exceeded; wait for Retry-After
502 / 503 / 504The upstream or dependent service is unavailable.
Ejemplos 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.

Los ejemplos de respuesta son datos ilustrativos, no datos de mercado en tiempo real.

Mercados

Exchanges

Configured exchanges, data-source aliases and spot/futures capabilities. Unavailable counts may be null.

GET/api/v1/exchanges

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
localeOptional string

Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages.

Campos de respuesta 200

application/json · ExchangeList

CampoTypeDescription
dataExchange[]Normalized result; collections always use an array.
data[].data_sourcestring—
data[].futures_countinteger | nullReported futures instruments; null when unavailable.
data[].has_futuresboolean—
data[].has_spotboolean—
data[].idstring—
data[].market_data_sourcestring—
data[].namestring—
data[].spot_countinteger | nullReported spot instruments; null when unavailable.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.totalintegerTotal number of matching records.

Mercados

Mercados

Paginated quotes. Defaults to Binance spot. Use exchange IDs from /exchanges; stock data is also available via /stocks.

GET/api/v1/markets

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
exchangeOptional string

Configured exchange ID; default binance.

marketOptional string

Market type; default spot.

Valores permitidos: spot, futures

qOptional string

Search text; at most 80 characters.

maxLength: 80

pageOptional integer

Page number.

Default: 1

minimum: 1 · maximum: 10000

limitOptional integer

Rows per page.

Default: 80

minimum: 1 · maximum: 200

sortOptional string

Sort field; default volume.

Valores permitidos: symbol, price, change, high, low, volume

dirOptional string

Sort direction.

Valores permitidos: asc, desc

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.

Campos de respuesta 200

application/json · MarketPage

CampoTypeDescription
dataTicker[]Normalized result; collections always use an array.
data[].basestringBase asset code.
data[].change_24hnumberPrice change in percentage points; check change_period.
data[].change_periodstring—
data[].exchangestringExchange or independent data-source ID.
data[].high_24hnumber—
data[].low_24hnumber—
data[].market_typestring—
data[].pricenumberObserved price in the quote currency.
data[].quotestringQuote currency code.
data[].range_periodstring—
data[].symbolstringCanonical instrument symbol.
data[].updated_atintegerObservation time in Unix seconds.
data[].volume_24hnumberVolume in quote-currency units; check availability and estimation flags.
data[].volume_estimatedboolean—
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.countsobject—
meta.exchangestring—
meta.market_typestring—
meta.paginationPaginationPagination metadata and links to this API.
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstringNext API page URL, or an empty string.
meta.pagination.pageintegerCurrent page number, starting at 1.
meta.pagination.previous_urlstringPrevious API page URL, or an empty string.
meta.pagination.startinteger—
meta.pagination.totalintegerTotal number of matching records.
meta.pagination.total_pagesintegerTotal number of pages.
meta.querystring—
meta.sourcestring—
meta.totalinteger—
meta.updated_atintegerObservation time in Unix seconds.

Mercados

Spot tickers

Cached spot quotes for one configured exchange. Consult /market-status for feed health and timestamps.

GET/api/v1/tickers/{exchange}/spot

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de ruta

ParameterTypeDescription
exchangeRequired string

Configured exchange ID.

Parámetros de consulta

ParameterTypeDescription
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.

Campos de respuesta 200

application/json · TickerArray

CampoTypeDescription
dataTicker[]Normalized result; collections always use an array.
data[].basestringBase asset code.
data[].change_24hnumberPrice change in percentage points; check change_period.
data[].change_periodstring—
data[].exchangestringExchange or independent data-source ID.
data[].high_24hnumber—
data[].low_24hnumber—
data[].market_typestring—
data[].pricenumberObserved price in the quote currency.
data[].quotestringQuote currency code.
data[].range_periodstring—
data[].symbolstringCanonical instrument symbol.
data[].updated_atintegerObservation time in Unix seconds.
data[].volume_24hnumberVolume in quote-currency units; check availability and estimation flags.
data[].volume_estimatedboolean—
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.exchangestring—
meta.totalinteger—

Mercados

Futures tickers

Cached futures quotes for one configured exchange. Consult /market-status for feed health and timestamps.

GET/api/v1/tickers/{exchange}/futures

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de ruta

ParameterTypeDescription
exchangeRequired string

Configured exchange ID.

Parámetros de consulta

ParameterTypeDescription
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.

Campos de respuesta 200

application/json · TickerArray

CampoTypeDescription
dataTicker[]Normalized result; collections always use an array.
data[].basestringBase asset code.
data[].change_24hnumberPrice change in percentage points; check change_period.
data[].change_periodstring—
data[].exchangestringExchange or independent data-source ID.
data[].high_24hnumber—
data[].low_24hnumber—
data[].market_typestring—
data[].pricenumberObserved price in the quote currency.
data[].quotestringQuote currency code.
data[].range_periodstring—
data[].symbolstringCanonical instrument symbol.
data[].updated_atintegerObservation time in Unix seconds.
data[].volume_24hnumberVolume in quote-currency units; check availability and estimation flags.
data[].volume_estimatedboolean—
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.exchangestring—
meta.totalinteger—

Mercados

Tasas de financiación

Paginated futures funding rates, 80 rows per page. Rates are percentage points; next_funding_time is Unix seconds.

GET/api/v1/funding-rates

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
sourceOptional string

Independent futures source ID, or all (default).

qOptional string

Search text; at most 80 characters.

maxLength: 80

pageOptional integer

Page number.

Default: 1

minimum: 1 · maximum: 10000

sortOptional string

Sort field; default abs_rate.

Valores permitidos: abs_rate, rate, annualized, symbol, exchange, mark, index, interval, next

dirOptional string

Sort direction; default desc.

Valores permitidos: asc, desc

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.

Campos de respuesta 200

application/json · FundingPage

CampoTypeDescription
dataFundingRate[]Normalized result; collections always use an array.
data[].basestringBase asset code.
data[].exchangestringExchange or independent data-source ID.
data[].funding_interval_hoursintegerFunding settlement interval in hours.
data[].funding_ratenumberFunding rate in percentage points: 0.01 means 0.01%.
data[].funding_rate_annualizednumber—
data[].index_pricenumber—
data[].mark_pricenumber—
data[].next_funding_timeintegerNext funding settlement time in Unix seconds.
data[].quotestringQuote currency code.
data[].symbolstringCanonical instrument symbol.
data[].updated_atintegerObservation time in Unix seconds.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.all_totalinteger—
meta.paginationPaginationPagination metadata and links to this API.
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstringNext API page URL, or an empty string.
meta.pagination.pageintegerCurrent page number, starting at 1.
meta.pagination.previous_urlstringPrevious API page URL, or an empty string.
meta.pagination.startinteger—
meta.pagination.totalintegerTotal number of matching records.
meta.pagination.total_pagesintegerTotal number of pages.
meta.querystring—
meta.sourcestringPublisher or lookup provider name.
meta.source_countsobject—
meta.totalintegerTotal number of matching records.
meta.updated_atintegerObservation time in Unix seconds.

Mercados

Exchange funding rates

Full funding-rate snapshot with source status and generated_at.

GET/api/v1/funding-rates/{exchange}

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de ruta

ParameterTypeDescription
exchangeRequired string

Configured futures exchange ID.

Parámetros de consulta

ParameterTypeDescription
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.

Campos de respuesta 200

application/json · FundingSnapshot

CampoTypeDescription
dataFundingRate[]Normalized result; collections always use an array.
data[].basestringBase asset code.
data[].exchangestringExchange or independent data-source ID.
data[].funding_interval_hoursintegerFunding settlement interval in hours.
data[].funding_ratenumberFunding rate in percentage points: 0.01 means 0.01%.
data[].funding_rate_annualizednumber—
data[].index_pricenumber—
data[].mark_pricenumber—
data[].next_funding_timeintegerNext funding settlement time in Unix seconds.
data[].quotestringQuote currency code.
data[].symbolstringCanonical instrument symbol.
data[].updated_atintegerObservation time in Unix seconds.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.exchangestringExchange or independent data-source ID.
meta.statusFeedStatusSource or service status; HTTP success alone does not imply a healthy feed.
meta.status.errorstringError identifier or diagnostic summary.
meta.status.last_success_atinteger—
meta.status.okbooleanWhether this data source is healthy.
meta.status.updated_atintegerObservation time in Unix seconds.
meta.totalinteger—
meta.updated_atintegerSnapshot generation time in Unix seconds.

Mercados

Interés abierto

Open-interest ranking for one supported source (default binance). Units and supported sources follow the website's open-interest page.

GET/api/v1/open-interest

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
sourceOptional string

Supported OI source ID; available IDs are returned in source_ids.

qOptional string

Search text; at most 80 characters.

maxLength: 80

pageOptional integer

Page number.

Default: 1

minimum: 1 · maximum: 10000

limitOptional integer

Rows per page.

Default: 80

minimum: 1 · maximum: 80

sortOptional string

Sort field; default oi.

Valores permitidos: symbol, oi, change, exchange, volume, price

dirOptional string

Sort direction; default desc.

Valores permitidos: asc, desc

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.

Campos de respuesta 200

application/json · OpenInterestPage

CampoTypeDescription
dataOpenInterest[]Normalized result; collections always use an array.
data[].basestringBase asset code.
data[].change_24hnumber—
data[].change_periodstring—
data[].exchangestringExchange or independent data-source ID.
data[].open_interestnumberOpen interest in base-asset units.
data[].open_interest_change_pctnumber | nullPercentage change, or null without a comparable observation.
data[].open_interest_valuenumberOpen interest value in quote-currency units.
data[].pricenumberObserved price in the quote currency.
data[].quotestringQuote currency code.
data[].symbolstringCanonical instrument symbol.
data[].timestampintegerObservation time in Unix seconds.
data[].volume_24hnumber—
data[].volume_estimatedboolean—
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.all_totalinteger—
meta.paginationPaginationPagination metadata and links to this API.
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstringNext API page URL, or an empty string.
meta.pagination.pageintegerCurrent page number, starting at 1.
meta.pagination.previous_urlstringPrevious API page URL, or an empty string.
meta.pagination.startinteger—
meta.pagination.totalintegerTotal number of matching records.
meta.pagination.total_pagesintegerTotal number of pages.
meta.querystring—
meta.sourcestringPublisher or lookup provider name.
meta.source_countsobject—
meta.source_idsstring[]—
meta.totalintegerTotal number of matching records.
meta.updated_atintegerObservation time in Unix seconds.

Mercados

Acciones

Binance Stocks quotes with availability flags. Pagination is returned in meta.pagination. Exact symbol filters return one result set.

GET/api/v1/stocks

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
qOptional string

Search text; at most 80 characters.

maxLength: 80

regionOptional string

Region; default all.

Valores permitidos: all, us

universeOptional string

Stock universe; default all.

Valores permitidos: all, tokenized

pageOptional integer

Page number.

Default: 1

minimum: 1 · maximum: 10000

limitOptional integer

Rows per page.

Default: 80

minimum: 1 · maximum: 200

sortOptional string

Sort field.

Valores permitidos: symbol, price, change, high, low, volume

dirOptional string

Sort direction.

Valores permitidos: asc, desc

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.

Campos de respuesta 200

application/json · StockArray

CampoTypeDescription
dataobject[]Normalized result; collections always use an array.
data[].asset_codestring | null—
data[].asset_namestring | null—
data[].basestring | null—
data[].change_24hnumber | null—
data[].change_availableboolean—
data[].data_stalebooleanWhether the observation is stale.
data[].data_timestampinteger | null—
data[].exchangestring | null—
data[].high_24hnumber | null—
data[].low_24hnumber | null—
data[].market_phasestring | null—
data[].market_typestring—
data[].namestring | null—
data[].pricenumber | null—
data[].price_availablebooleanWhether a usable observed price is available.
data[].quotestring | null—
data[].stock_marketstring—
data[].symbolstringCanonical instrument symbol.
data[].tradabilitystring | null—
data[].trading_statusstring—
data[].volume_24hnumber | null—
data[].volume_availableboolean—
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.paginationPagination—
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstringNext API page URL, or an empty string.
meta.pagination.pageintegerCurrent page number, starting at 1.
meta.pagination.previous_urlstringPrevious API page URL, or an empty string.
meta.pagination.startinteger—
meta.pagination.totalintegerTotal number of matching records.
meta.pagination.total_pagesintegerTotal number of pages.
meta.totalinteger—

Mercados

Market data status

Source-level feed health, counts and last-success timestamps. A successful HTTP response does not imply healthy upstream feeds.

GET/api/v1/market-status

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
localeOptional string

Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages.

Campos de respuesta 200

application/json · MarketStatus

CampoTypeDescription
dataobjectNormalized result; collections always use an array.
data.degraded_feedsstring[]—
data.exchangesobject[]—
data.exchanges[].countsobject—
data.exchanges[].exchangestringExchange or independent data-source ID.
data.exchanges[].generated_atintegerSnapshot generation time in Unix seconds.
data.exchanges[].statusobjectSource or service status; HTTP success alone does not imply a healthy feed.
data.statusstringSource or service status; HTTP success alone does not imply a healthy feed.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.

Noticias

Noticias

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.

GET/api/v1/news

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
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.

maxLength: 80

pageOptional integer

Page number.

Default: 1

minimum: 1 · maximum: 10000

limitOptional integer

Articles per page.

Default: 24

minimum: 1 · maximum: 50

localeOptional string

Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages.

Campos de respuesta 200

application/json · NewsPage

CampoTypeDescription
dataArticle[]Normalized result; collections always use an array.
data[].archived_isostring—
data[].assetsstring[]—
data[].descriptionstring—
data[].detail_urlstring—
data[].languagestringOriginal article language; no translation is performed.
data[].published_isostringOriginal publication time in ISO 8601 format.
data[].slugstring—
data[].sourcestringPublisher or lookup provider name.
data[].titlestring—
data[].urlstringOriginal publisher URL.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.assetstring—
meta.languagestringOriginal article language; no translation is performed.
meta.language_filtersobject[]—
meta.language_filters[].codestring—
meta.language_filters[].label_keystring—
meta.limitinteger—
meta.paginationPaginationPagination metadata and links to this API.
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstringNext API page URL, or an empty string.
meta.pagination.pageintegerCurrent page number, starting at 1.
meta.pagination.previous_urlstringPrevious API page URL, or an empty string.
meta.pagination.startinteger—
meta.pagination.totalintegerTotal number of matching records.
meta.pagination.total_pagesintegerTotal number of pages.
meta.querystring—
meta.sourcestringPublisher or lookup provider name.
meta.sourcesstring[]—
meta.totalintegerTotal number of matching records.

Herramientas

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.

GET/api/v1/tools/ip

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
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.

Campos de respuesta 200

application/json · IPResult

CampoTypeDescription
dataobjectNormalized result; collections always use an array.
data.as_domainstringAutonomous system domain, when provided.
data.asnstringAutonomous system number, when provided.
data.citystringCity reported by the provider, when available.
data.countrystringCountry name, when provided.
data.country_codestringTwo-letter country code reported by the provider.
data.hostnamestringReported hostname, when available.
data.ipstringNormalized public IPv4 or IPv6 address.
data.locationstringReported latitude and longitude, when available.
data.organizationstringNetwork organization, when provided.
data.regionstringRegion reported by the provider, when available.
data.timezonestringReported timezone, when available.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.sourcestringPublisher or lookup provider name.
meta.updated_atstringLookup observation time in ISO 8601 format.

Herramientas

Consulta DNS

Resolve public DNS records through the existing daemon lookup service.

GET/api/v1/tools/dns

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
inputRequired string

Domain name; PTR also accepts a public IP address.

typeOptional string

Record type; default A.

Valores permitidos: A, AAAA, MX, TXT, NS, CNAME, SOA, CAA, SRV, PTR

localeOptional string

Response labels and article links: en, zh-cn, zh-tw, es, de, ja or fr; default en. Does not filter article languages.

Campos de respuesta 200

application/json · DNSResult

CampoTypeDescription
dataobjectNormalized result; collections always use an array.
data.dnssecbooleanWhether the DNS resolver authenticated the response.
data.namestringNormalized queried DNS name.
data.recordsobject[]Returned DNS records; the array can be empty.
data.records[].datastringDNS record value.
data.records[].namestringDNS owner name.
data.records[].ttlintegerRecord time to live in seconds.
data.records[].typestringDNS record type.
data.statusstringDNS response status: NOERROR or NXDOMAIN.
data.typestringRequested DNS record type.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.sourcestringPublisher or lookup provider name.
meta.updated_atstringLookup observation time in ISO 8601 format.

Herramientas

WHOIS lookup

Public domain registration data via RDAP.

GET/api/v1/tools/whois

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
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.

Campos de respuesta 200

application/json · WhoisResult

CampoTypeDescription
dataobjectNormalized result; collections always use an array.
data.dnssecbooleanWhether the domain is DNSSEC signed, when reported.
data.domainstringNormalized domain name.
data.eventsobject[]Registration lifecycle events.
data.events[].actionstring—
data.events[].datestring—
data.handlestringRegistry identifier.
data.nameserversstring[]Registered nameserver names.
data.registrarstringRegistrar name, when reported.
data.statusstring[]Domain registration status values.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.sourcestringPublisher or lookup provider name.
meta.updated_atstringLookup observation time in ISO 8601 format.

Herramientas

Exchange rate lookup

Query the reference exchange rate for a currency pair. The data timestamp identifies its reference date.

GET/api/v1/tools/forex

Autorización

Send one of these headers with a valid API key.

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

Límite de solicitudes

One request per second, shared by all keys on the account. Límites de solicitudes ↗

Parámetros de consulta

ParameterTypeDescription
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.

Campos de respuesta 200

application/json · ForexResult

CampoTypeDescription
dataobjectNormalized result; collections always use an array.
data.basestringSource currency code.
data.datestringReference rate date; empty for an identical currency pair.
data.quotestringTarget currency code.
data.ratenumberTarget-currency units for one source-currency unit.
errornullError object on failure; null on success.
metaobjectPagination, data source and observation metadata.
meta.sourcestringPublisher or lookup provider name.
meta.updated_atstringLookup observation time in ISO 8601 format.