Get an instrument by symbol

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

{
  "instrumentId": 123,
  "displayname": "<string>",
  "popularityUniques7Day": 123,
  "instrumentTypeID": 123,
  "instrumentType": "<string>",
  "exchangeID": 123,
  "symbol": "<string>",
  "isOpen": true,
  "internalAssetClassId": 123,
  "internalInstrumentDisplayName": "<string>",
  "isInternalInstrument": true,
  "internalSymbolFull": "<string>",
  "isHiddenFromClient": true,
  "internalInstrumentId": 123,
  "internalCryptoTypeId": 123,
  "internalExchangeId": 123,
  "internalExchangeName": "<string>",
  "internalAssetClassName": "<string>",
  "logo35x35": "<string>",
  "logo50x50": "<string>",
  "logo150x150": "<string>",
  "dailyPriceChange": 123,
  "absDailyPriceChange": 123,
  "weeklyPriceChange": 123,
  "monthlyPriceChange": 123,
  "isDelisted": true,
  "isCurrentlyTradable": true,
  "isExchangeOpen": true,
  "internalClosingPrice": 123,
  "isActiveInPlatform": true,
  "isBuyEnabled": true,
  "currentRate": 123,
  "threeMonthPriceChange": 123,
  "sixMonthPriceChange": 123,
  "oneYearPriceChange": 123,
  "currMonthPriceChange": 123,
  "currQuarterPriceChange": 123,
  "currYearPriceChange": 123,
  "lastYearPriceChange": 123,
  "lastTwoYearsPriceChange": 123,
  "oneMonthAgoPriceChange": 123,
  "twoMonthsAgoPriceChange": 123,
  "threeMonthsAgoPriceChange": 123,
  "sixMonthsAgoPriceChange": 123,
  "oneYearAgoPriceChange": 123,
  "cvtBid": 123,
  "cvtAsk": 123,
  "cvtBiNoSpread": 123,
  "cvtAskNoSpread": 123,
  "traders7DayChange": 123,
  "traders14DayChange": 123,
  "traders30DayChange": 123,
  "popularityUniques14Day": 123,
  "popularityUniques30Day": 123,
  "internalIndustryId": 123,
  "internalStockIndustryName": "<string>",
  "popularityUniques": 123,
  "holdingPct": 123,
  "buyHoldingPct": 123,
  "sellHoldingPct": 123,
  "buyPctChange24Hours": 123,
  "absBuyPctChange24Hours": 123,
  "industryNameId": 123,
  "sectorNameId": 123
}

GET

api

instruments

{symbol}

Get an instrument by symbol

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

{
  "instrumentId": 123,
  "displayname": "<string>",
  "popularityUniques7Day": 123,
  "instrumentTypeID": 123,
  "instrumentType": "<string>",
  "exchangeID": 123,
  "symbol": "<string>",
  "isOpen": true,
  "internalAssetClassId": 123,
  "internalInstrumentDisplayName": "<string>",
  "isInternalInstrument": true,
  "internalSymbolFull": "<string>",
  "isHiddenFromClient": true,
  "internalInstrumentId": 123,
  "internalCryptoTypeId": 123,
  "internalExchangeId": 123,
  "internalExchangeName": "<string>",
  "internalAssetClassName": "<string>",
  "logo35x35": "<string>",
  "logo50x50": "<string>",
  "logo150x150": "<string>",
  "dailyPriceChange": 123,
  "absDailyPriceChange": 123,
  "weeklyPriceChange": 123,
  "monthlyPriceChange": 123,
  "isDelisted": true,
  "isCurrentlyTradable": true,
  "isExchangeOpen": true,
  "internalClosingPrice": 123,
  "isActiveInPlatform": true,
  "isBuyEnabled": true,
  "currentRate": 123,
  "threeMonthPriceChange": 123,
  "sixMonthPriceChange": 123,
  "oneYearPriceChange": 123,
  "currMonthPriceChange": 123,
  "currQuarterPriceChange": 123,
  "currYearPriceChange": 123,
  "lastYearPriceChange": 123,
  "lastTwoYearsPriceChange": 123,
  "oneMonthAgoPriceChange": 123,
  "twoMonthsAgoPriceChange": 123,
  "threeMonthsAgoPriceChange": 123,
  "sixMonthsAgoPriceChange": 123,
  "oneYearAgoPriceChange": 123,
  "cvtBid": 123,
  "cvtAsk": 123,
  "cvtBiNoSpread": 123,
  "cvtAskNoSpread": 123,
  "traders7DayChange": 123,
  "traders14DayChange": 123,
  "traders30DayChange": 123,
  "popularityUniques14Day": 123,
  "popularityUniques30Day": 123,
  "internalIndustryId": 123,
  "internalStockIndustryName": "<string>",
  "popularityUniques": 123,
  "holdingPct": 123,
  "buyHoldingPct": 123,
  "sellHoldingPct": 123,
  "buyPctChange24Hours": 123,
  "absBuyPctChange24Hours": 123,
  "industryNameId": 123,
  "sectorNameId": 123
}

Headers

x-request-id

string<uuid>

required

A unique request identifier.

Example:

"6f69fe03-03d6-4a96-a002-609254e0306d"

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

Query Parameters

fields

string

Comma-separated list of Instrument fields to include in the response. If omitted, all supported fields are returned. Example: symbol,displayName,currentRate.

Response

Successful response containing the instrument.

instrumentId

integer

A unique identifier for the instrument.

displayname

string

The display name of the instrument.

popularityUniques7Day

integer

The number of unique users who viewed this instrument in the last 7 days.

instrumentTypeID

integer

The type ID of the instrument.

instrumentType

string

The type of the instrument.

exchangeID

integer

The ID of the exchange where the instrument is traded.

symbol

string

The trading symbol of the instrument.

isOpen

boolean

Indicates whether the instrument is currently open for trading.

internalAssetClassId

integer

The internal asset class ID.

internalInstrumentDisplayName

string

The internal display name of the instrument.

isInternalInstrument

boolean

Indicates whether the instrument is internal.

internalSymbolFull

string

The full internal symbol of the instrument.

isHiddenFromClient

boolean

Indicates whether the instrument is hidden from clients.

internalInstrumentId

integer

The internal instrument ID.

internalCryptoTypeId

integer

The internal crypto type ID.

internalExchangeId

integer

The internal exchange ID.

internalExchangeName

string

The internal exchange name.

internalAssetClassName

string

The internal asset class name.

logo35x35

string

The URL of the 35x35 logo.

logo50x50

string

The URL of the 50x50 logo.

logo150x150

string

The URL of the 150x150 logo.

dailyPriceChange

number

The daily price change.

absDailyPriceChange

number

The absolute daily price change.

weeklyPriceChange

number

The weekly price change.

monthlyPriceChange

number

The monthly price change.

isDelisted

boolean

Indicates whether the instrument is delisted.

isCurrentlyTradable

boolean

Indicates whether the instrument is currently tradable.

isExchangeOpen

boolean

Indicates whether the exchange is open.

internalClosingPrice

number

The internal closing price.

isActiveInPlatform

boolean

Indicates whether the instrument is active in the platform.

isBuyEnabled

boolean

Indicates whether buying is enabled for the instrument.

currentRate

number

The current rate of the instrument.

threeMonthPriceChange

number

The three-month price change.

sixMonthPriceChange

number

The six-month price change.

oneYearPriceChange

number

The one-year price change.

currMonthPriceChange

number

The current month price change.

currQuarterPriceChange

number

The current quarter price change.

currYearPriceChange

number

The current year price change.

lastYearPriceChange

number

The last year price change.

lastTwoYearsPriceChange

number

The last two years price change.

oneMonthAgoPriceChange

number

The price change from one month ago.

twoMonthsAgoPriceChange

number

The price change from two months ago.

threeMonthsAgoPriceChange

number

The price change from three months ago.

sixMonthsAgoPriceChange

number

The price change from six months ago.

oneYearAgoPriceChange

number

The price change from one year ago.

cvtBid

number

The converted bid price.

cvtAsk

number

The converted ask price.

cvtBiNoSpread

number

The converted bid price without spread.

cvtAskNoSpread

number

The converted ask price without spread.

traders7DayChange

number

The change in the number of traders over the last 7 days.

traders14DayChange

number

The change in the number of traders over the last 14 days.

traders30DayChange

number

The change in the number of traders over the last 30 days.

popularityUniques14Day

integer

The number of unique users who viewed this instrument in the last 14 days.

popularityUniques30Day

integer

The number of unique users who viewed this instrument in the last 30 days.

internalIndustryId

integer

The internal industry ID.

internalStockIndustryName

string

The internal stock industry name.

popularityUniques

integer

Total number of unique users interested in this instrument.

holdingPct

number

The holding percentage of this instrument.

buyHoldingPct

number

The buy holding percentage.

sellHoldingPct

number

The sell holding percentage.

buyPctChange24Hours

number

The buy percentage change in the last 24 hours.

absBuyPctChange24Hours

number

The absolute buy percentage change in the last 24 hours.

industryNameId

integer

The industry name ID.

sectorNameId

integer

The sector name ID.

Discover instruments Get an instrument by symbol using a field shortener

⌘I