Possible Values of Some Parameters

This lesson contains information about all the possible options for lang, region, modules, and scrIds parameters and symbols of some securities.

Possible options for the lang parameter

The table below contains the list of symbols that can be assigned to the lang parameter, along with a description of which language each symbol represents.

Symbol

Language

en 

English

es

Spanish

de

Dutch

fr

French

it

Italian

zh

Chinese

Possible options for the region parameter

The table below contains the list of symbols that can be assigned to the region parameter, along with a description of which country each symbol represents.

Symbol

Country

AU

Australia

CA

Canada

DE

Netherlands

ES

Spain

FR

France

GB

United Kingdom

HK

Hong Kong

IN

India

IT

Italy

US

United States

Possible options for the modules parameter

The table below contains all possible options for the modules parameter along with their description.

module

Description

assetProfile

This can be used to obtain the profile of the company executives.

balanceSheetHistory

This provides us with the balance sheet of the company which is the issuer of the selected security.

balanceSheetHistoryQuarterly

This provides us a quarterly balance sheet of the company which is the issuer of the selected security.

calendarEvents

This provides us with important dates and statistics about the symbol that we selected.

cashflowStatementHistory

This provides us a cash flow statement of the company which is the issuer of the selected security.

cashflowStatementHistoryQuarterly

This provides us a quarterly cash flow statement of the company which is the issuer of the selected security.

defaultKeyStatistics

This provides us with key statistics about the security, like price-to-book ratio and book value.

earnings

This can be used to retrieve data about the company's earnings, which is the issuer of the selected security.

earningsHistory

This provides us earnings per share of the selected security for the previous year.

earningsTrend

This provides us the trends of the company’s earnings whose stock we selected.

esgScores

This provides us with the ESG scores of the company. ESG metrics are used to measure a company's environmental, social, and governance performance.

financialData

This parameter provides financial data of the company which is the issuer of the selected security.

fundOwnership

This provides the percentage of common shares owned by mutual funds.

fundProfile

This can be used to obtain key metrics like costs, risks, and performance of a mutual fund.

incomeStatementHistory

This provides the income statement of the company which is the issuer of the selected security.

incomeStatementHistoryQuarterly

This provides the quarterly income statement of the company which is the issuer of the selected security.

indexTrend

This provides the trend of the index of the selected symbol.

insiderHolders

This provides information about the insiders of the company.

insiderTransactions

This provides us with information about the transactions made by the insiders of the company which can help us predict the future performance of the company.

institutionOwnership

This can be used to learn the amount of a company's available stock owned by institutions that manage funds for other people.

majorDirectHolders

This provides information about the major shareholders of the company.

majorHoldersBreakdown

This can be used to see what percentage of the shares are owned by insiders and institutions.

netSharePurchaseActivity

This can be used to look at the trade activities for the security.

price

This provides us with different types of prices for the security.

quoteType

This option provides us the type of the searched security along with some information like its short name, and the exchange's name.

recommendationTrend

This provides us with the trend of the security trade for different periods.

secFilings

This provides the information about regulatory documents that companies and issuers of securities submit to the Securities and Exchange Commission on a regular basis.

sectorTrend

This provides us with information about the trend in the sector of the selected symbol.

summaryDetail

This provides us a concise form of quote which has important metrics like previous close index, and day high index.

upgradeDowngradeHistory

This provides us the information about the upgrade downgrade history of the symbol. When a rating agency raises a bond's rating, this action is called an "upgrade." Similarly, lowering the rating is called a "downgrade."

List of possible options for scrIds

The options for scrIds can be categorized based on what kind of security these IDs are associated with. These are the two categories:

  • scrIds associated with stocks

  • scrIds associated with funds

The table below lists those options along with their descriptions.

scrIds (associated with stocks)

Description

most_shorted_stocks

This provides us with a list of the top shorted stocks. Short selling is when an investor borrows a stock, sells it, and then repurchases it to return to the lender when its price falls.

undervalued_growth_stocks

This provides us with a list of undervalued stocks which are expected to grow.

growth_technology_stocks

This provides us with a list of the technology stocks that are expected to grow significantly compared to the other stocks.

day_gainers

This provides us with a list of the stocks which tend to close at a higher index than their open index.

day_losers

This provides us with a list of the stocks that close at a higher index than their open index.

most_active

This provides us with a list of the stocks that close at a lower index than their open index.

undervalued_large_caps

This provides us with a list of undervalued stocks which are large in terms of market capitalization.

aggressive_small_caps

This provides us with a list of small-capitalization high-risk stocks that can produce much higher returns than the other stocks.

small_cap_gainers

This provides us with a list of small-capitalization high-risk stocks that are expected to close at an index higher than their open index.

scrIds (associated to funds)

Description

high_yield_bonds

This provides us with a list of bonds that pay higher interest rates because they have lower credit ratings than investment-grade bonds.

top_mutual_funds

This provides us with a list of top mutual funds.

portfolio_anchors

This provides us a list of mutual funds with top-half returns that could serve as a rock-solid core of an investor portfolio

solid_large_growth_funds

This provides us with a list of funds that invest in large-cap stocks that are projected to grow faster than other large-cap stocks.

solid_midcap_growth_funds

This provides us with a list of funds that invest in mid-cap stocks that are projected to grow faster than other mid-cap stocks.

conservative_forgein_funds

This provides us with a list of low-risk, low-yield funds.

Symbols of some securities

We have used symbols as query parameters and path parameters in the previous lessons. Here is a list of symbols of some important securities:

Security

Symbol

Microsoft Corporation

MSFT

Twitter, Inc.

TWTR

Bitcoin

BTC

Ethereum

ETH

Crude Oil

CL=F

Gold

GC=F

EUR/USD

EURUSD=X

EUR/CAD

EUR/CAD=X

Transamerica Capital Growth Fund Class C

ILLX

T. Rowe Price Global Technology Fund

PRGTX