Get instrument by symbol (shortener)

curl --request GET \
  --url https://public-api.etoro.com/api/v1/instruments/{symbol}/{shortener} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-user-key: <x-user-key>'

{
  "instrumentId": 123,
  "symbol": "<string>",
  "displayName": "<string>",
  "assetClass": "<string>",
  "exchangeName": "<string>",
  "countryCode": "<string>",
  "industryName": "<string>",
  "sectorName": "<string>",
  "umbrellaSector": "<string>",
  "currentRate": 123,
  "marketCap": 123,
  "peRatio": 123,
  "beta": 123,
  "dividendYieldFiscal": 123,
  "ceo": "<string>",
  "numberOfEmployees": 123,
  "companyFoundedDate": "2023-12-25",
  "isETFLeveraged": true,
  "etfLeverage": 123,
  "netExpenseRatio": 123,
  "prospectusLink": "<string>",
  "inceptionDate": "2023-12-25",
  "cryptoMarketCap": 123,
  "cryptoMarketCapRank": 123,
  "percentOfCryptoMarketCap": 123,
  "cryptoCirculatingSupply": 123,
  "cryptoMaxSupply": 123,
  "cryptoTotalSupply": 123,
  "cryptoWebsite": "<string>",
  "cryptoWhitePaper": "<string>",
  "salesOrRevenue": 123,
  "consolidatedNetIncome": 123,
  "epsTTM": 123,
  "epsAnnual": 123,
  "quarterlyEpsValue": 123,
  "quarterlySalesValue": 123,
  "ebitda": 123,
  "dividendRate": 123,
  "dividendsPerShare": 123,
  "grossIncomeMargin": 123,
  "operatingMargin": 123,
  "netProfitMargin": 123,
  "fiveYearAverageNetProfitMargin": 123,
  "sharesOutstanding": 123,
  "totalEnterpriseValue": 123,
  "longTermDebtToEquityRatio": 123,
  "totalDebtToEquityRatio": 123,
  "quickRatio": 123,
  "currentRatio": 123,
  "netOperatingCashFlow": 123,
  "cashFlowPerShare": 123,
  "cashFlowFromOperPerShareNet": 123,
  "revenuePerShare": 123,
  "oneYearAnnualRevenueGrowthRate": 123,
  "fiveYearAverageReturnOnInvestedCapital": 123,
  "enterpriseValueToEbitda": 123,
  "enterpriseValueToSales": 123,
  "enterpriseValueToOperCashFlow": 123,
  "nextEarningDate": "2023-12-25",
  "nextEarningsDateQuarter": "<string>"
}

GET

api

instruments

{symbol}

{shortener}

Get instrument by symbol (shortener)

curl --request GET \
  --url https://public-api.etoro.com/api/v1/instruments/{symbol}/{shortener} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-user-key: <x-user-key>'

{
  "instrumentId": 123,
  "symbol": "<string>",
  "displayName": "<string>",
  "assetClass": "<string>",
  "exchangeName": "<string>",
  "countryCode": "<string>",
  "industryName": "<string>",
  "sectorName": "<string>",
  "umbrellaSector": "<string>",
  "currentRate": 123,
  "marketCap": 123,
  "peRatio": 123,
  "beta": 123,
  "dividendYieldFiscal": 123,
  "ceo": "<string>",
  "numberOfEmployees": 123,
  "companyFoundedDate": "2023-12-25",
  "isETFLeveraged": true,
  "etfLeverage": 123,
  "netExpenseRatio": 123,
  "prospectusLink": "<string>",
  "inceptionDate": "2023-12-25",
  "cryptoMarketCap": 123,
  "cryptoMarketCapRank": 123,
  "percentOfCryptoMarketCap": 123,
  "cryptoCirculatingSupply": 123,
  "cryptoMaxSupply": 123,
  "cryptoTotalSupply": 123,
  "cryptoWebsite": "<string>",
  "cryptoWhitePaper": "<string>",
  "salesOrRevenue": 123,
  "consolidatedNetIncome": 123,
  "epsTTM": 123,
  "epsAnnual": 123,
  "quarterlyEpsValue": 123,
  "quarterlySalesValue": 123,
  "ebitda": 123,
  "dividendRate": 123,
  "dividendsPerShare": 123,
  "grossIncomeMargin": 123,
  "operatingMargin": 123,
  "netProfitMargin": 123,
  "fiveYearAverageNetProfitMargin": 123,
  "sharesOutstanding": 123,
  "totalEnterpriseValue": 123,
  "longTermDebtToEquityRatio": 123,
  "totalDebtToEquityRatio": 123,
  "quickRatio": 123,
  "currentRatio": 123,
  "netOperatingCashFlow": 123,
  "cashFlowPerShare": 123,
  "cashFlowFromOperPerShareNet": 123,
  "revenuePerShare": 123,
  "oneYearAnnualRevenueGrowthRate": 123,
  "fiveYearAverageReturnOnInvestedCapital": 123,
  "enterpriseValueToEbitda": 123,
  "enterpriseValueToSales": 123,
  "enterpriseValueToOperCashFlow": 123,
  "nextEarningDate": "2023-12-25",
  "nextEarningsDateQuarter": "<string>"
}

Authorizations

Authorization

string

header

required

eToro OAuth2. Each operation lists the scopes that grant access as separate security requirements (OpenAPI OR semantics): the caller's token only needs ONE of them — you do NOT need all of them. The same scopes back the x-api-key/x-user-key credential pair.

Headers

x-request-id

string<uuid>

required

A unique request identifier.

Example:

"f75d357b-4dbe-4328-b4a1-1233d86fa2c0"

x-api-key

string<password>

required

API key for authentication.

Example:

"lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663"

x-user-key

string<password>

required

User-specific authentication key.

Example:

"eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_"

Path Parameters

symbol

string

required

The trading symbol of the instrument (e.g. AAPL, BTC).

shortener

string

required

The name of an allowed shortener preset that restricts the returned field set.

Query Parameters

fields

string

Comma-separated list of Instrument fields to include in the response. Must be a subset of the shortener's fields. Example: symbol,displayName,currentRate.

Response

Successful response containing the instrument restricted to the shortener's fields.

An instrument record. The properties listed below are the only supported field names; they may all be used in the fields, sort, and filter (<field>, <field>Min, <field>Max) query parameters. Use the fields query parameter to project a subset; if fields is omitted, all properties are returned.

instrumentId

integer<int32>

The unique identifier of the instrument.

symbol

string

The full trading symbol of the instrument.

displayName

string

The display name of the instrument.

assetClass

string

The asset class of the instrument (e.g. Stocks, ETF, Crypto).

exchangeName

string

The name of the exchange where the instrument is traded.

countryCode

string

The country code of the issuer's corporate location.

industryName

string

The industry of the issuer.

sectorName

string

The sector of the issuer.

umbrellaSector

string

The umbrella sector of the issuer.

currentRate

number

The current rate of the instrument.

marketCap

number

The market capitalization.

peRatio

number

The price-to-earnings ratio.

beta

number

The beta of the instrument.

dividendYieldFiscal

number

The fiscal dividend yield.

ceo

string

The name of the CEO.

numberOfEmployees

integer<int64>

The number of employees.

companyFoundedDate

string<date>

The date the company was founded.

isETFLeveraged

boolean

Indicates whether the ETF is leveraged.

etfLeverage

number

The leverage factor of the ETF.

netExpenseRatio

number

The net expense ratio of the ETF.

prospectusLink

string

URL to the ETF prospectus document.

inceptionDate

string<date>

The inception date of the instrument.

cryptoMarketCap

number

The market capitalization of the crypto asset.

cryptoMarketCapRank

integer<int32>

The market capitalization rank of the crypto asset.

percentOfCryptoMarketCap

number

The crypto asset's share of total crypto market capitalization.

cryptoCirculatingSupply

number

The circulating supply of the crypto asset.

cryptoMaxSupply

number

The maximum supply of the crypto asset.

cryptoTotalSupply

number

The total supply of the crypto asset.

cryptoWebsite

string

The official website URL of the crypto project.

cryptoWhitePaper

string

URL to the crypto white paper.

salesOrRevenue

number

Sales or revenue (TTM).

consolidatedNetIncome

number

Consolidated net income (TTM).

epsTTM

number

Earnings per share over the trailing twelve months.

epsAnnual

number

Annual earnings per share.

quarterlyEpsValue

number

Earnings per share for the most recently reported quarter.

quarterlySalesValue

number

Sales for the most recently reported quarter.

ebitda

number

Earnings before interest, taxes, depreciation, and amortization (TTM).

dividendRate

number

The dividend rate.

Dividends per share over the last twelve months.

grossIncomeMargin

number

The gross income margin (TTM).

operatingMargin

number

The operating margin.

netProfitMargin

number

The net profit margin.

fiveYearAverageNetProfitMargin

number

The 5-year average net profit margin.

sharesOutstanding

number

The number of shares outstanding.

totalEnterpriseValue

number

The total enterprise value (TTM).

longTermDebtToEquityRatio

number

The long-term debt to equity ratio.

totalDebtToEquityRatio

number

The total debt to equity ratio (TTM).

quickRatio

number

The quick ratio (TTM).

currentRatio

number

The current ratio (TTM).

netOperatingCashFlow

number

Net operating cash flow (TTM).

Cash flow per share.

Net cash flow from operations per share (TTM).

Revenue per share (TTM).

oneYearAnnualRevenueGrowthRate

number

The 1-year annual revenue growth rate.

fiveYearAverageReturnOnInvestedCapital

number

The 5-year average return on invested capital.

enterpriseValueToEbitda

number

The enterprise value to EBITDA ratio.

enterpriseValueToSales

number

The enterprise value to sales ratio.

enterpriseValueToOperCashFlow

number

The enterprise value to operating cash flow ratio.

nextEarningDate

string<date>

The next earnings release date.

nextEarningsDateQuarter

string

The fiscal quarter of the next earnings release.

Get an instrument by symbol List supported exchanges

⌘I