curl
curl https://api.arcus.xyz/v1/api-meta/markets
curl "https://api.arcus.xyz/v1/api-meta/markets?market=BTC-USD"import requests
r = requests.get(
"https://api.arcus.xyz/v1/api-meta/markets",
params={"market": "BTC-USD"},
)
print(r.json())
const url = new URL("https://api.arcus.xyz/v1/api-meta/markets");
url.searchParams.set("market", "BTC-USD");
const res = await fetch(url);
console.log(await res.json());
const options = {method: 'GET'};
fetch('https://api.arcus.xyz/v1/api-meta/markets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcus.xyz/v1/api-meta/markets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.arcus.xyz/v1/api-meta/markets"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcus.xyz/v1/api-meta/markets")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcus.xyz/v1/api-meta/markets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"results": [
{
"ticker": "<string>",
"tradingViewId": "<string>",
"name": "<string>",
"description": "<string>",
"website": "<string>",
"logo": "<string>",
"sector": "<string>",
"ceo": {
"name": "<string>",
"title": "<string>",
"since": "<string>"
},
"employees": 123,
"headquarters": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"address": "<string>"
},
"founded": {
"ipoDate": "<string>",
"year": 123
},
"financials": {
"marketCap": 123,
"peRatio": 123,
"dividendYield": 123,
"currency": "<string>",
"revenue": 123,
"evToSales": 123,
"evToEBITDA": 123,
"priceToBook": 123
},
"quarterlyEarnings": [
{
"period": "<string>",
"fiscalQuarter": "<string>",
"epsActual": 123,
"epsEstimate": 123,
"epsSurprise": 123,
"epsSurprisePercent": 123
}
],
"news": [
{
"publishedDate": "<string>",
"title": "<string>",
"publisher": "<string>",
"site": "<string>",
"text": "<string>",
"url": "<string>",
"image": "<string>"
}
],
"incomeStatements": [
{
"date": "<string>",
"symbol": "<string>",
"reportedCurrency": "<string>",
"cik": "<string>",
"filingDate": "<string>",
"acceptedDate": "<string>",
"fiscalYear": "<string>",
"period": "<string>",
"fiscalQuarter": "<string>",
"revenue": 123,
"costOfRevenue": 123,
"grossProfit": 123,
"researchAndDevelopmentExpenses": 123,
"generalAndAdministrativeExpenses": 123,
"sellingAndMarketingExpenses": 123,
"sellingGeneralAndAdministrativeExpenses": 123,
"otherExpenses": 123,
"operatingExpenses": 123,
"costAndExpenses": 123,
"netInterestIncome": 123,
"interestIncome": 123,
"interestExpense": 123,
"depreciationAndAmortization": 123,
"ebitda": 123,
"ebit": 123,
"nonOperatingIncomeExcludingInterest": 123,
"operatingIncome": 123,
"totalOtherIncomeExpensesNet": 123,
"incomeBeforeTax": 123,
"incomeTaxExpense": 123,
"netIncomeFromContinuingOperations": 123,
"netIncomeFromDiscontinuedOperations": 123,
"otherAdjustmentsToNetIncome": 123,
"netIncome": 123,
"netIncomeDeductions": 123,
"bottomLineNetIncome": 123,
"eps": 123,
"epsDiluted": 123,
"weightedAverageShsOut": 123,
"weightedAverageShsOutDil": 123
}
],
"balanceSheets": [
{
"date": "<string>",
"symbol": "<string>",
"reportedCurrency": "<string>",
"cik": "<string>",
"filingDate": "<string>",
"acceptedDate": "<string>",
"fiscalYear": "<string>",
"period": "<string>",
"fiscalQuarter": "<string>",
"cashAndCashEquivalents": 123,
"shortTermInvestments": 123,
"cashAndShortTermInvestments": 123,
"netReceivables": 123,
"accountsReceivables": 123,
"otherReceivables": 123,
"inventory": 123,
"prepaids": 123,
"otherCurrentAssets": 123,
"totalCurrentAssets": 123,
"propertyPlantEquipmentNet": 123,
"goodwill": 123,
"intangibleAssets": 123,
"goodwillAndIntangibleAssets": 123,
"longTermInvestments": 123,
"taxAssets": 123,
"otherNonCurrentAssets": 123,
"totalNonCurrentAssets": 123,
"otherAssets": 123,
"totalAssets": 123,
"totalPayables": 123,
"accountPayables": 123,
"otherPayables": 123,
"accruedExpenses": 123,
"shortTermDebt": 123,
"capitalLeaseObligationsCurrent": 123,
"taxPayables": 123,
"deferredRevenue": 123,
"otherCurrentLiabilities": 123,
"totalCurrentLiabilities": 123,
"longTermDebt": 123,
"capitalLeaseObligationsNonCurrent": 123,
"deferredRevenueNonCurrent": 123,
"deferredTaxLiabilitiesNonCurrent": 123,
"otherNonCurrentLiabilities": 123,
"totalNonCurrentLiabilities": 123,
"otherLiabilities": 123,
"capitalLeaseObligations": 123,
"totalLiabilities": 123,
"treasuryStock": 123,
"preferredStock": 123,
"commonStock": 123,
"retainedEarnings": 123,
"additionalPaidInCapital": 123,
"accumulatedOtherComprehensiveIncomeLoss": 123,
"otherTotalStockholdersEquity": 123,
"totalStockholdersEquity": 123,
"totalEquity": 123,
"minorityInterest": 123,
"totalLiabilitiesAndTotalEquity": 123,
"totalInvestments": 123,
"totalDebt": 123,
"netDebt": 123
}
],
"cashFlowStatements": [
{
"date": "<string>",
"symbol": "<string>",
"reportedCurrency": "<string>",
"cik": "<string>",
"filingDate": "<string>",
"acceptedDate": "<string>",
"fiscalYear": "<string>",
"period": "<string>",
"fiscalQuarter": "<string>",
"netIncome": 123,
"depreciationAndAmortization": 123,
"deferredIncomeTax": 123,
"stockBasedCompensation": 123,
"changeInWorkingCapital": 123,
"accountsReceivables": 123,
"inventory": 123,
"accountsPayables": 123,
"otherWorkingCapital": 123,
"otherNonCashItems": 123,
"netCashProvidedByOperatingActivities": 123,
"investmentsInPropertyPlantAndEquipment": 123,
"acquisitionsNet": 123,
"purchasesOfInvestments": 123,
"salesMaturitiesOfInvestments": 123,
"otherInvestingActivities": 123,
"netCashProvidedByInvestingActivities": 123,
"netDebtIssuance": 123,
"longTermNetDebtIssuance": 123,
"shortTermNetDebtIssuance": 123,
"netStockIssuance": 123,
"netCommonStockIssuance": 123,
"commonStockIssuance": 123,
"commonStockRepurchased": 123,
"netPreferredStockIssuance": 123,
"netDividendsPaid": 123,
"commonDividendsPaid": 123,
"preferredDividendsPaid": 123,
"otherFinancingActivities": 123,
"netCashProvidedByFinancingActivities": 123,
"effectOfForexChangesOnCash": 123,
"netChangeInCash": 123,
"cashAtEndOfPeriod": 123,
"cashAtBeginningOfPeriod": 123,
"operatingCashFlow": 123,
"capitalExpenditure": 123,
"freeCashFlow": 123,
"incomeTaxesPaid": 123,
"interestPaid": 123
}
]
}
],
"count": 1,
"ingestedAt": 1
}{
"error": "<string>",
"code": "GEO_RESTRICTED"
}{
"error": "<string>",
"code": "GEO_RESTRICTED"
}MarketMetadata
Get market metadata
Returns curated reference data (company profile, branding, headline financials, TradingView chart identifiers, …) for one or all markets served by the api-meta service.
GET
/
v1
/
api-meta
/
markets
curl
curl https://api.arcus.xyz/v1/api-meta/markets
curl "https://api.arcus.xyz/v1/api-meta/markets?market=BTC-USD"import requests
r = requests.get(
"https://api.arcus.xyz/v1/api-meta/markets",
params={"market": "BTC-USD"},
)
print(r.json())
const url = new URL("https://api.arcus.xyz/v1/api-meta/markets");
url.searchParams.set("market", "BTC-USD");
const res = await fetch(url);
console.log(await res.json());
const options = {method: 'GET'};
fetch('https://api.arcus.xyz/v1/api-meta/markets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcus.xyz/v1/api-meta/markets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.arcus.xyz/v1/api-meta/markets"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcus.xyz/v1/api-meta/markets")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcus.xyz/v1/api-meta/markets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"results": [
{
"ticker": "<string>",
"tradingViewId": "<string>",
"name": "<string>",
"description": "<string>",
"website": "<string>",
"logo": "<string>",
"sector": "<string>",
"ceo": {
"name": "<string>",
"title": "<string>",
"since": "<string>"
},
"employees": 123,
"headquarters": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"address": "<string>"
},
"founded": {
"ipoDate": "<string>",
"year": 123
},
"financials": {
"marketCap": 123,
"peRatio": 123,
"dividendYield": 123,
"currency": "<string>",
"revenue": 123,
"evToSales": 123,
"evToEBITDA": 123,
"priceToBook": 123
},
"quarterlyEarnings": [
{
"period": "<string>",
"fiscalQuarter": "<string>",
"epsActual": 123,
"epsEstimate": 123,
"epsSurprise": 123,
"epsSurprisePercent": 123
}
],
"news": [
{
"publishedDate": "<string>",
"title": "<string>",
"publisher": "<string>",
"site": "<string>",
"text": "<string>",
"url": "<string>",
"image": "<string>"
}
],
"incomeStatements": [
{
"date": "<string>",
"symbol": "<string>",
"reportedCurrency": "<string>",
"cik": "<string>",
"filingDate": "<string>",
"acceptedDate": "<string>",
"fiscalYear": "<string>",
"period": "<string>",
"fiscalQuarter": "<string>",
"revenue": 123,
"costOfRevenue": 123,
"grossProfit": 123,
"researchAndDevelopmentExpenses": 123,
"generalAndAdministrativeExpenses": 123,
"sellingAndMarketingExpenses": 123,
"sellingGeneralAndAdministrativeExpenses": 123,
"otherExpenses": 123,
"operatingExpenses": 123,
"costAndExpenses": 123,
"netInterestIncome": 123,
"interestIncome": 123,
"interestExpense": 123,
"depreciationAndAmortization": 123,
"ebitda": 123,
"ebit": 123,
"nonOperatingIncomeExcludingInterest": 123,
"operatingIncome": 123,
"totalOtherIncomeExpensesNet": 123,
"incomeBeforeTax": 123,
"incomeTaxExpense": 123,
"netIncomeFromContinuingOperations": 123,
"netIncomeFromDiscontinuedOperations": 123,
"otherAdjustmentsToNetIncome": 123,
"netIncome": 123,
"netIncomeDeductions": 123,
"bottomLineNetIncome": 123,
"eps": 123,
"epsDiluted": 123,
"weightedAverageShsOut": 123,
"weightedAverageShsOutDil": 123
}
],
"balanceSheets": [
{
"date": "<string>",
"symbol": "<string>",
"reportedCurrency": "<string>",
"cik": "<string>",
"filingDate": "<string>",
"acceptedDate": "<string>",
"fiscalYear": "<string>",
"period": "<string>",
"fiscalQuarter": "<string>",
"cashAndCashEquivalents": 123,
"shortTermInvestments": 123,
"cashAndShortTermInvestments": 123,
"netReceivables": 123,
"accountsReceivables": 123,
"otherReceivables": 123,
"inventory": 123,
"prepaids": 123,
"otherCurrentAssets": 123,
"totalCurrentAssets": 123,
"propertyPlantEquipmentNet": 123,
"goodwill": 123,
"intangibleAssets": 123,
"goodwillAndIntangibleAssets": 123,
"longTermInvestments": 123,
"taxAssets": 123,
"otherNonCurrentAssets": 123,
"totalNonCurrentAssets": 123,
"otherAssets": 123,
"totalAssets": 123,
"totalPayables": 123,
"accountPayables": 123,
"otherPayables": 123,
"accruedExpenses": 123,
"shortTermDebt": 123,
"capitalLeaseObligationsCurrent": 123,
"taxPayables": 123,
"deferredRevenue": 123,
"otherCurrentLiabilities": 123,
"totalCurrentLiabilities": 123,
"longTermDebt": 123,
"capitalLeaseObligationsNonCurrent": 123,
"deferredRevenueNonCurrent": 123,
"deferredTaxLiabilitiesNonCurrent": 123,
"otherNonCurrentLiabilities": 123,
"totalNonCurrentLiabilities": 123,
"otherLiabilities": 123,
"capitalLeaseObligations": 123,
"totalLiabilities": 123,
"treasuryStock": 123,
"preferredStock": 123,
"commonStock": 123,
"retainedEarnings": 123,
"additionalPaidInCapital": 123,
"accumulatedOtherComprehensiveIncomeLoss": 123,
"otherTotalStockholdersEquity": 123,
"totalStockholdersEquity": 123,
"totalEquity": 123,
"minorityInterest": 123,
"totalLiabilitiesAndTotalEquity": 123,
"totalInvestments": 123,
"totalDebt": 123,
"netDebt": 123
}
],
"cashFlowStatements": [
{
"date": "<string>",
"symbol": "<string>",
"reportedCurrency": "<string>",
"cik": "<string>",
"filingDate": "<string>",
"acceptedDate": "<string>",
"fiscalYear": "<string>",
"period": "<string>",
"fiscalQuarter": "<string>",
"netIncome": 123,
"depreciationAndAmortization": 123,
"deferredIncomeTax": 123,
"stockBasedCompensation": 123,
"changeInWorkingCapital": 123,
"accountsReceivables": 123,
"inventory": 123,
"accountsPayables": 123,
"otherWorkingCapital": 123,
"otherNonCashItems": 123,
"netCashProvidedByOperatingActivities": 123,
"investmentsInPropertyPlantAndEquipment": 123,
"acquisitionsNet": 123,
"purchasesOfInvestments": 123,
"salesMaturitiesOfInvestments": 123,
"otherInvestingActivities": 123,
"netCashProvidedByInvestingActivities": 123,
"netDebtIssuance": 123,
"longTermNetDebtIssuance": 123,
"shortTermNetDebtIssuance": 123,
"netStockIssuance": 123,
"netCommonStockIssuance": 123,
"commonStockIssuance": 123,
"commonStockRepurchased": 123,
"netPreferredStockIssuance": 123,
"netDividendsPaid": 123,
"commonDividendsPaid": 123,
"preferredDividendsPaid": 123,
"otherFinancingActivities": 123,
"netCashProvidedByFinancingActivities": 123,
"effectOfForexChangesOnCash": 123,
"netChangeInCash": 123,
"cashAtEndOfPeriod": 123,
"cashAtBeginningOfPeriod": 123,
"operatingCashFlow": 123,
"capitalExpenditure": 123,
"freeCashFlow": 123,
"incomeTaxesPaid": 123,
"interestPaid": 123
}
]
}
],
"count": 1,
"ingestedAt": 1
}{
"error": "<string>",
"code": "GEO_RESTRICTED"
}{
"error": "<string>",
"code": "GEO_RESTRICTED"
}The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
X-API-Key and no signature required.
Without ?market= the full set is returned; with ?market=<arcus market> (e.g. BTC-USD) the response is a single-row envelope. Data is refreshed in the background from the upstream reference feed roughly every 30 minutes; clients should cache downstream accordingly and use ingestedAt to bound staleness.
Fields with no upstream source today (CEO, P/E ratio, dividend yield, quarterly earnings, country) serialize as null / []. See MarketMetadata for the full per-row contract.Query Parameters
Optional arcus market filter (e.g. BTC-USD). When set, the response contains exactly the matching row or 404.
Response
Market metadata envelope (possibly empty results).
Envelope returned by GET /v1/api-meta/markets. Both the unfiltered list call and the single-market lookup (?market=) share this shape; a single-market hit has count == 1.
Show child attributes
Show child attributes
Number of entries in results.
Required range:
x >= 0Newest ingested_at_ms (Unix milliseconds) across the returned rows. 0 when results is empty. Use this to bound client-side cache freshness.
Required range:
x >= 0Was this page helpful?
⌘I