API Summary Table

Here's a comprehensive summary of the APIs mentioned:

General APIs

Response
API Name Method Endpoint Arguments Description
Attributes

Returns
symbol, candlestick
Forex Candles GET /forex/candle resolution, c, h, l, o, s, t, v data for
from, to forex
symbols.
Gets rates
Forex Rates GET /forex/rates base, date base, quote for all forex
pairs.
Lists
supported
Crypto Exchanges GET /crypto/exchange None List of exchanges
crypto
exchanges.

Lists
description, supported
Crypto Symbol GET /crypto/symbol exchange displaySymbol, crypto
symbol symbols by
exchange.

circulatingSupply,
description,
launchDate, logo,
longName, Gets crypto
Crypto Profile GET /crypto/profile symbol marketCap, profile
maxSupply, information.
name, proofType,
totalSupply,
website

Returns
symbol, candlestick
Crypto Candles GET /crypto/candle resolution, c, h, l, o, s, t, v data for
from, to crypto
symbols.

Runs
pattern
Pattern symbol, recognition
GET /scan/pattern points
Recognition resolution algorithm
on a
symbol.

Support/Resistance GET /scan/support- symbol, levels Gets

resistance resolution support and
resistance

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 1/24
 Response
API Name Method Endpoint Arguments Description
Attributes
levels for a
symbol.
Gets
technicalAnalysis, aggregate
Aggregate /scan/technical- symbol, count, signal, signal of
GET
Indicators indicator resolution trend, adx, multiple
trending technical
indicators.
symbol, Returns
resolution, technical
Technical Depends on the
GET /indicator from, to, indicator
Indicators indicator
indicator, with price
indicator_fields data.

Lists
symbol, earnings
Earnings Call
GET /stock/transcripts/list symbol transcripts call
Transcripts List
(metadata) transcripts'
metadata.
audio, id,
participant, Gets full
description, earnings
name, role, call
Earnings Call
GET /stock/transcripts id quarter, symbol, transcript,
Transcripts
time, title, audio, and
transcript, participants'
session, speech, list.
year

Splits, Dividends, Indices, ETFs, and Mutual Funds

Premium
API Method Endpoint Example Arguments Response Attributes
Required

`/stock/split? `symbol`,
Splits `date`, `fromFactor`,
GET Yes symbol=AAPL&from=2015- `from`,
Premium `symbol`, `toFactor`
02-01&to=2021-03-09` `to`

Dividends 2
`/stock/dividend2? `data`, `amount`, `exDa
(Basic) GET Yes `symbol`
symbol=AAPL` `symbol`
Premium

`constituents`,
Indices `constituentsBreakdow
`/index/constituents?
Constituents GET Yes `symbol` `cusip`, `isin`, `name`
symbol=^GSPC`
Premium `shareClassFIGI`,
`symbol`, `weight`

Indices
`/index/historical-
Historical `historicalConstituen
GET Yes constituents? `symbol`
Constituents `action`, `date`, `symb
symbol=^GSPC`
Premium

ETFs Profile `/etf/profile? `symbol`, `profile` (includes multi

GET Yes
Premium symbol=ARKK` `isin` attributes)

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 2/24
 Premium
API Method Endpoint Example Arguments Response Attributes
Required
`symbol`,
ETFs `atDate`, `holdings`
`/etf/holdings? `isin`,
Holdings GET Yes (includes multiple attribute
symbol=ARKK` `skip`,
Premium `numberOfHoldings`
`date`

ETFs Sector
`/etf/sector? `symbol`, `sectorExposure` (includ
Exposure GET Yes
symbol=SPY` `isin` `exposure`, `industry`
Premium
ETFs
Country `/etf/country? `symbol`, `countryExposure` (inclu
GET Yes
Exposure symbol=SPY` `isin` `country`, `exposure`)
Premium
Mutual
Funds `/mutual-fund/profile? `symbol`, `profile` (includes multi
GET Yes
Profile symbol=VTSAX` `isin` attributes)
Premium

Mutual
`/mutual- `symbol`, `atDate`, `holdings`
Funds
GET Yes fund/holdings? `isin`, (includes multiple attribute
Holdings
symbol=VTSAX` `skip` `numberOfHoldings`
Premium
Mutual
Funds Sector `/mutual-fund/sector? `symbol`, `sectorExposure` (includ
GET Yes
Exposure symbol=VTSAX` `isin` `exposure`, `sector`)
Premium
Mutual
Funds
`/mutual-fund/country? `symbol`, `countryExposure` (inclu
Country GET Yes
symbol=FNILX` `isin` `country`, `exposure`)
Exposure
Premium
Mutual
`/mutual-fund/eet?
Funds EET GET Yes `isin` `data`
isin=LU2036931686`
Premium

Financial Estimates and Metrics

API Name Method Premium Arguments Response Attributes Examples

`estimate`,
`symbol`,
`estimateDate`,
`fiscalYear`,
Earnings Premium `fiscalYear`, Sample
GET `fiscalQuarter`,
Estimates Required `fiscalQuarter`, Code
`consensus`,
`actual`,
`estimates`
`estimateCount`

`symbol`, `debtToEquity`,
Financial Premium `fiscalYear`, `profitMargin`, Sample
GET
Ratios Required `fiscalQuarter`, `currentRatio`, Code
`metrics`, `fields` `returnOnEquity`, etc.
`symbol`,
`fiscalYear`, `earningsGrowth`,
Growth Premium Sample
GET `fiscalQuarter`, `revenueGrowth`,
Estimates Required Code
`fields`, `freeCashFlowGrowth`
`estimates`

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 3/24
 API Name Method Premium Arguments Response Attributes Examples

`symbol`,
`close`, `high`, `low`,
Historical Premium `dateRange`, Sample
GET `open`, `volume`,
Data Required `fields`, Code
`dividends`, `splits`
`adjusted`
`marketCap`,
`metric`, `symbol`,
Market Premium `trailingPE`, Sample
GET `dateRange`,
Metrics Required `forwardPE`, `pegRatio`, Code
`fields`
`beta`
`symbol`, `revenue`, `netIncome`,
Key
Premium `fiscalYear`, `totalAssets`, Sample
Financial GET
Required `fiscalQuarter`, `totalLiabilities`, Code
Metrics
`fields` `shareholdersEquity`

This table summarizes the APIs and provides sample code for each one, with the key attributes and
examples where applicable. Let me know if you need more details or have any specific questions!

Here’s a breakdown of the various API endpoints, methods, arguments, and sample responses:

1. Crypto Exchanges

Method: GET
Endpoint: `/crypto/exchanges`
Response Attributes:

List of supported crypto exchanges.

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.crypto_exchanges())

Sample Response:

json

[
"KRAKEN",
"HITBTC",
"COINBASE",
"GEMINI",
"POLONIEX",
"Binance",
"ZB",
"BITTREX",
"KUCOIN",
"OKEX",
"BITFINEX",
"HUOBI"
]

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 4/24
 2. Crypto Symbols

Method: GET
Endpoint: `/crypto/symbol?exchange=binance`
Arguments:

`exchange` (REQUIRED): Exchange you want to get the list of symbols from.

Response Attributes:

`description`:Symbol description
`displaySymbol`: Display symbol name
`symbol`: Unique symbol used to identify this symbol used in `/crypto/candle` endpoint

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.crypto_symbols('BINANCE'))

Sample Response:

json

[
{
"description": "Binance ETHBTC",
"displaySymbol": "ETH/BTC",
"symbol": "ETHBTC"
},
{
"description": "Binance LTCBTC",
"displaySymbol": "LTC/BTC",
"symbol": "BINANCE:LTCBTC"
},
{
"description": "Binance BNBBTC",
"displaySymbol": "BNB/BTC",
"symbol": "BINANCE:BNBBTC"
}
]

3. Crypto Profile

Method: GET
Endpoint: `/crypto/profile?symbol=BTC`
Arguments:

`symbol` (REQUIRED): Crypto symbol such as BTC or ETH.

Response Attributes:

`circulatingSupply`: Circulating supply

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 5/24
 `description`: Description
`launchDate`: Launch date
`logo`: Logo image
`longName`: Long name
`marketCap`: Market capitalization
`maxSupply`: Max supply
`name`: Name
`proofType`: Proof type
`totalSupply`: Total supply
`website`: Project's website

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.crypto_profile('BTC'))

Sample Response:

json

{
"name": "Bitcoin",
"longName": "Bitcoin (BTC)",
"description": "Bitcoin uses peer-to-peer technology to operate with no central
authority or banks...",
"marketCap": 1119891535870.4905,
"totalSupply": 18876550,
"maxSupply": 21000000,
"circulatingSupply": 18876550,
"logo": "",
"launchDate": "2009-01-03",
"website": "[Link]
"proofType": "PoW"
}

4. Crypto Candles

Method: GET
Endpoint: `/crypto/candle?symbol=BINANCE:BTCUSDT&resolution=D&from=1572651390&to=1575243390`
Arguments:

`symbol` (REQUIRED): Use symbol returned in `/crypto/symbol` endpoint for this field.
`resolution` (REQUIRED): Supported resolutions include 1, 5, 15, 30, 60, D, W, M.
`from` (REQUIRED): UNIX timestamp. Interval initial value.
`to` (REQUIRED): UNIX timestamp. Interval end value.

Response Attributes:

`c`: List of close prices

`h`: List of high prices
`l`: List of low prices

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 6/24
 `o`: List of open prices
`s`: Status of the response (ok or no_data)
`t`: List of timestamps
`v`: List of volume data

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))

Sample Response:

json

{
"c": [1.10713, 1.10288, 1.10397, 1.10182],
"h": [1.1074, 1.10751, 1.10729, 1.10595],
"l": [1.09897, 1.1013, 1.10223, 1.10101],
"o": [1.0996, 1.107, 1.10269, 1.10398],
"s": "ok",
"t": [1568667600, 1568754000, 1568840400, 1568926800],
"v": [75789, 75883, 73485, 5138]
}

5. Pattern Recognition

Method: GET
Endpoint: `/scan/pattern?symbol=AAPL&resolution=D`
Arguments:

`symbol` (REQUIRED): Symbol

`resolution` (REQUIRED): Supported resolutions include 1, 5, 15, 30, 60, D, W, M.

Response Attributes:

`points`: Array of patterns with details such as pattern name, type, entry, exit points, etc.

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.pattern_recognition('AAPL', 'D'))

Sample Response:

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 7/24
 json

{
"points": [
{
"aprice": 1.09236,
"atime": 1567458000,
"bprice": 1.1109,
"btime": 1568322000,
"cprice": 1.09897,
"ctime": 1568667600,
"patternname": "Double Bottom",
"patterntype": "bullish",
"profit1": 1.1294,
"stoploss": 1.0905,
"symbol": "EUR_USD"
},
{
"aprice": 1.09236,
"atime": 1567458000,
"bprice": 1.1109,
"btime": 1568322000,
"cprice": 1.09897,
"ctime": 1568667600,
"patternname": "Bat",
"patterntype": "bearish",
"profit1": 1.1181,
"stoploss": 1.1416,
"symbol": "EUR_USD"
}
]
}

6. Support/Resistance Levels

Method: GET
Endpoint: `/scan/support-resistance?symbol=IBM&resolution=D`
Arguments:

`symbol` (REQUIRED): Symbol

`resolution` (REQUIRED): Supported resolutions include 1, 5, 15, 30, 60, D, W, M.

Response Attributes:

`levels`: Array of support and resistance levels.

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.support_resistance('AAPL', 'D'))

Sample Response:

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 8/24
 json

{
"levels": [
1.092360019683838,
1.1026300191879272,
1.113450050354004,
1.1233500242233276,
1.134719967842102,
1.1513700485229492
]
}

7. Aggregate Indicators

Method: GET
Endpoint: `/scan/technical-indicator?symbol=AAPL&resolution=D`
Arguments:

`symbol` (REQUIRED): Symbol

`resolution` (REQUIRED): Supported resolutions include 1, 5, 15, 30, 60, D, W, M.

Response Attributes:

`technicalAnalysis`: Number of signals (buy, neutral, sell)

`signal`: Aggregate Signal
`trend`: Trend details (e.g., ADX reading, whether the market is trending)

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.aggregate_indicator('AAPL', 'D'))

Sample Response:

json

{
"technicalAnalysis": {
"count": {
"buy": 6,
"neutral": 7,
"sell": 4
},
"signal": "neutral"
},
"trend": {
"adx": 24.46020733373421,
"trending": false
}
}

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 9/24
 8. Technical Indicators

Method: GET
Endpoint: `/indicator?symbol=AAPL&resolution=D`
Arguments:

`symbol` (REQUIRED): Symbol

`resolution` (REQUIRED): Supported resolutions include 1, 5, 15, 30, 60, D, W, M.

Response Attributes:

`indicators`: Array of technical indicators and their values.

Sample Code (Python):

python

import finnhub
finnhub_client = [Link](api_key="")
print(finnhub_client.technical_indicator('AAPL', 'D'))

Sample Response:

json

{
"indicators": [
{
"indicator": "RSI",
"value": 55.63453674316406
},
{
"indicator": "MACD",
"value": 0.18447369384765625
},
{
"indicator": "SMA",
"value": 120.2244873046875
}
]
}

Let me know if you need more details or additional API endpoints!

Here's the tabular format for the API data you've described:

Company ESG Scores Premium

Attribute Description

Method GET

Premium Premium Access Required

Arguments `symbol` (REQUIRED) - Symbol

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 10/24
 Attribute Description

Response Attributes
`data` Map key-value pair of key ESG data points

`environmentScore` Environment Score

`governanceScore` Governance Score

`socialScore` Social Score

`symbol` Symbol
`totalESGScore` Total ESG Score

Sample Response

`data` Various ESG data points including percentages and policies

`environmentScore` 73.21

`governanceScore` 56.06
`socialScore` 45.81

`symbol` AAPL

`totalESGScore` 56.04

Historical ESG Scores Premium

Attribute Description

Method GET

Premium Premium Access Required

Arguments `symbol` (REQUIRED) - Symbol

Response Attributes
`data` Array of historical ESG scores and indicators

`environmentScore` Environment Score

`governanceScore` Governance Score

`socialScore` Social Score

`symbol` Symbol
`totalESGScore` Total ESG Score

Sample Response

`data` Array of historical data with period-specific scores

`environmentScore` 61.74593 (2021-09-25), 59.460255 (2020-09-26)

`governanceScore` 92.81813 (2021-09-25), 85.85033 (2020-09-26)

`socialScore` 76.52558 (2021-09-25), 74.40586 (2020-09-26)

`totalESGScore` 77.02988 (2021-09-25), 73.238815 (2020-09-26)

`symbol` AAPL

Company Earnings Quality Score Premium

Attribute Description
Method GET

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 11/24
 Attribute Description
Premium Premium Access Required
`symbol` (REQUIRED) - Symbol, `freq` (REQUIRED) - Frequency
Arguments
(annual or quarterly)

Response Attributes
`data` Array of earnings quality scores
`cashGenerationCapitalAllocation` Cash Generation and Capital Allocation

`growth` Growth Score

`letterScore` Letter Score
`leverage` Leverage Score

`period` Period
`profitability` Profitability Score
`score` Total Score
`freq` Frequency

`symbol` Symbol
Sample Response
`data` Array of data with scores for different periods

`capitalAllocation` 67.6878 (2021-06-01), 75.1464 (2021-03-01)

`growth` 55.8022 (2021-06-01), 70.2461 (2021-03-01)
`letterScore` B+ (2021-06-01), A- (2021-03-01)

`leverage` 24.5122 (2021-06-01), 39.5682 (2021-03-01)

`period` 2021-06-01, 2021-03-01
`profitability` 82.3843 (2021-06-01), 88.4613 (2021-03-01)
`score` 57.5966 (2021-06-01), 68.3555 (2021-03-01)

`freq` quarterly
`symbol` AAPL

USPTO Patents

Attribute Description
Method GET

`symbol` (REQUIRED) - Symbol, `from` (REQUIRED) - From date, `to` (REQUIRED) -

Arguments
To date
Response Attributes
`data` Array of patents

`applicationNumber` Application Number

`companyFilingName` Array of companies' name on the patent
`description` Description

`filingDate` Filing date

`filingStatus` Filing status
`patentNumber` Patent number

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 12/24
 Attribute Description
`patentType` Patent's type
`publicationDate` Publication date

`url` URL of the original article

`symbol` Symbol
Sample Response
`data` Array of patents with detailed attributes

`applicationNumber` 17163855, 17162550

`companyFilingName` NVIDIA CORPORATION, NVIDIA CORPORATION
DYNAMIC DIRECTIONAL ROUNDING, REAL-TIME HARDWARE-ASSISTED GPU TUNING
`description`
USING MACHINE LEARNING
`filingDate` 2021-02-01, 2021-01-29
`filingStatus` Application
`patentNumber` US20210232366A1, US20210174569A1

`publicationDate` 2021-07-29, 2021-06-10

`url` URL1, URL2
`symbol` NVDA

H1-B Visa Application

Attribute Description

Method GET
`symbol` (REQUIRED) - Symbol, `from` (REQUIRED) - From date, `to`
Arguments
(REQUIRED) - To date
Response Attributes

`data` Array of H1-B and Permanent visa applications

`beginDate` Job's start date
`caseNumber` Case number

`caseStatus` Case status

`employerName` Company's name
`endDate` Job's end date

`fullTimePosition` Full-time position flag

`h1bDependent` H1B dependent flag
`jobTitle` Job Title
`quarter` Quarter

`receivedDate` Received date

`socCode` SOC Code
`symbol` Symbol

`visaClass` Visa class

`wageLevel` Wage level
`wageRangeFrom` Wage range from

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 13/24
 Attribute Description
`wageRangeTo` Wage range to
`wageUnitOfPay` Wage unit of pay

`worksiteAddress` Worksite address

`worksiteCity` Worksite city
`worksiteCounty` Worksite county
`worksitePostalCode` Worksite postal code

`worksiteState` Worksite state

`year` Year
Sample Response

`data` Array of visa applications with detailed attributes

`year` 2020
`caseNumber` I-200-19268-472068

`caseStatus` Certified
`receivedDate` 2019-09-25
`visaClass` H-1B
`jobTitle` ASIC DESIGN VERIFICATION ENGINEER

`socCode` 17-2072
`fullTimePosition` Y
`beginDate` 2019-10-14

`endDate` 2022-10-13
`employerName` NVIDIA CORPORATION
`wageLevel` Level III

`wageRangeFrom` 110000
`wageRangeTo` 130000
`wageUnitOfPay` Year
`worksiteAddress` 2788 San Tomas Expressway

`worksiteCity` Santa Clara

`worksiteState` CA
`worksitePostalCode` 95051

`symbol` NVDA

Proxy

Attribute Description
Method GET
Arguments `symbol` (REQUIRED) - Symbol, `id` (REQUIRED) - Proxy ID

Response Attributes
`data` Array of proxy data
`id` Proxy ID

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 14/24
 Attribute Description
`name` Proxy Name
`description` Proxy Description

`ip` IP Address
`port` Port
`protocol` Protocol

`status` Status
`symbol` Symbol
Sample Response
`data` Array of proxies with detailed attributes

`id` 1
`name` Proxy 1
`description` Main proxy for data requests

`ip` [Link]
`port` 8080
`protocol` HTTP

`status` Active
`symbol` NVDA

Company Events

Attribute Description
Method GET
`symbol` (REQUIRED) - Symbol, `startDate` (REQUIRED) - Start date, `endDate`
Arguments
(REQUIRED) - End date
Response
Attributes
`data` Array of company events

`date` Event date

`eventType` Type of event (e.g., earnings report, product launch)
`headline` Event headline

`symbol` Symbol
Sample Response
`data` Array of events with detailed attributes
`date` 2024-01-15

`eventType` Earnings Report

`headline` Q4 2023 Earnings Report
`symbol` NVDA

Feel free to adjust any attributes or examples according to your specific requirements!

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 15/24
 Certainly! Here are the API method calls with their names and URLs based on your requirements:

1. Company ESG Scores Premium

Name: Get Company ESG Scores Premium

Method: `GET`
URL: `/api/esg_scores/premium?symbol={symbol}`

2. Historical ESG Scores Premium

Name: Get Historical ESG Scores Premium

Method: `GET`
URL: `/api/esg_scores/historical/premium?symbol={symbol}`

3. Company Earnings Quality Score Premium

Name: Get Company Earnings Quality Score Premium

Method: `GET`
URL: `/api/earnings_quality/premium?symbol={symbol}&freq={freq}`

4. USPTO Patents

Name: Get USPTO Patents

Method: `GET`
URL: `/api/patents/uspto?symbol={symbol}&from={fromDate}&to={toDate}`

5. H1-B Visa Application

Name: Get H1-B Visa Applications

Method: `GET`
URL: `/api/visa/h1b?symbol={symbol}&from={fromDate}&to={toDate}`

6. Proxy

Name: Get Proxy Details

Method: `GET`
URL: `/api/proxies/{id}?symbol={symbol}`

7. Company Events

Name: Get Company Events

Method: `GET`
URL: `/api/events/company?symbol={symbol}&startDate={startDate}&endDate={endDate}`

You can replace the placeholders (`{symbol}`, `{fromDate}`, `{toDate}`, `{freq}`, `{id}`, `{startDate}`,
`{endDate}`) with actual values when making the API calls.

Sure! Here’s the information in a tabular format:

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 16/24
 Name Method URL
Get Company ESG Scores
GET `/api/esg_scores/premium?symbol={symbol}`
Premium

Get Historical ESG Scores

GET `/api/esg_scores/historical/premium?symbol={symbol}`
Premium
Get Company Earnings `/api/earnings_quality/premium?symbol={symbol}&freq=
GET
Quality Score Premium {freq}`

`/api/patents/uspto?symbol={symbol}&from=
Get USPTO Patents GET
{fromDate}&to={toDate}`
`/api/visa/h1b?symbol={symbol}&from={fromDate}&to=
Get H1-B Visa Applications GET
{toDate}`

Get Proxy Details GET `/api/proxies/{id}?symbol={symbol}`

`/api/events/company?symbol={symbol}&startDate=
Get Company Events GET
{startDate}&endDate={endDate}`

You can replace the placeholders with the appropriate values when making the API calls.

Here’s the API data in a tabular format:

API Name Method URL Arguments Response Attributes
`code2`, `code3`,
`codeNo`, `country`,
`countryRiskPremium`,
`currency`,
Country
GET `/country` None `currencyCode`,
Metadata
`defaultSpread`,
`equityRiskPremium`,
`rating`, `region`,
`subRegion`
`economicCalendar`:
Economic `from` `actual`, `country`,
Calendar GET `/calendar/economic` (optional), `to` `estimate`, `event`,
Premium (optional) `impact`, `prev`, `time`,
`unit`
Economic
`code`, `country`, `name`,
Code GET `/economic/code` None
`unit`
Premium

Economic
`/economic?code= `code` `code`, `data`: `date`,
Data GET
{code}` (required) `value`
Premium
`symbol`
(optional), `category`,
International `country` `companyName`, `country`,
`/stock/international-
Filings GET (optional), `description`,
filings`
Premium `from` `filedDate`, `language`,
(optional), `to` `symbol`, `title`, `url`
(optional)
Global Filings POST `/global- `query` `count`, `filings`:
Search filings/search` (required), `acceptanceDate`,
Premium others optional `amend`, `documentCount`,
like `symbols`, `filedDate`, `filerId`,

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 17/24
 API Name Method URL Arguments Response Attributes
`fromDate`, `filingId`, `form`,
`toDate` `name`, `pageCount`,
`reportDate`, `source`,
`symbol`, `title`, `page`,
`took`
`acceptanceDate`,
`amend`, `documentCount`,
`documents`:
`documentId`, `excerpts`:
`content`, `endOffset`,
`filingId`
Search In `/global- `snippetId`,
(required),
Filing POST filings/search-in- `startOffset`, `format`,
`query`
Premium filing` `hits`, `title`, `url`,
(required)
`filedDate`, `filerId`,
`filingId`, `form`,
`name`, `pageCount`,
`reportDate`, `source`,
`symbol`, `title`
`field`
Search Filter `/global- (required),
GET `id`, `name`
Premium filings/filter` `source`
(optional)
Download
`/global- `documentId`
Filings GET Raw document content
filings/download` (required)
Premium

You can replace placeholders with actual values as needed for each API call.

Here is a detailed tabular summary of all the APIs mentioned, including their methods, endpoints,
arguments, response attributes, and descriptions:

General APIs

Response
API Name Method Endpoint Arguments Description
Attributes
Returns
symbol, candlestick
Forex Candles GET /forex/candle resolution, c, h, l, o, s, t, v data for
from, to forex
symbols.
Gets rates
Forex Rates GET /forex/rates base, date base, quote for all forex
pairs.
Lists
supported
Crypto Exchanges GET /crypto/exchange None List of exchanges
crypto
exchanges.
Crypto Symbol GET /crypto/symbol exchange description, Lists
displaySymbol, supported
symbol crypto

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 18/24
 Response
API Name Method Endpoint Arguments Description
Attributes
symbols by
exchange.
circulatingSupply,
description,
launchDate, logo,
longName, Gets crypto
Crypto Profile GET /crypto/profile symbol marketCap, profile
maxSupply, information.
name, proofType,
totalSupply,
website

Returns
symbol, candlestick
Crypto Candles GET /crypto/candle resolution, c, h, l, o, s, t, v data for
from, to crypto
symbols.
Runs
pattern
Pattern symbol, recognition
GET /scan/pattern points
Recognition resolution algorithm
on a
symbol.
Gets
support and
/scan/support- symbol,
Support/Resistance GET levels resistance
resistance resolution
levels for a
symbol.
Gets
technicalAnalysis, aggregate
Aggregate /scan/technical- symbol, count, signal, signal of
GET
Indicators indicator resolution trend, adx, multiple
trending technical
indicators.

symbol, Returns
resolution, technical
Technical Depends on the
GET /indicator from, to, indicator
Indicators indicator
indicator, with price
indicator_fields data.

Lists
symbol, earnings
Earnings Call
GET /stock/transcripts/list symbol transcripts call
Transcripts List
(metadata) transcripts'
metadata.
audio, id,
participant, Gets full
description, earnings
name, role, call
Earnings Call
GET /stock/transcripts id quarter, symbol, transcript,
Transcripts
time, title, audio, and
transcript, participants'
session, speech, list.
year

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 19/24
 Splits, Dividends, Indices, ETFs, and Mutual Funds

Premium
API Method Endpoint Example Arguments Response Attributes
Required

`/stock/split? `symbol`,
Splits `date`, `fromFactor`,
GET Yes symbol=AAPL&from=2015- `from`,
Premium `symbol`, `toFactor`
02-01&to=2021-03-09` `to`

Dividends 2
`/stock/dividend2? `data`, `amount`, `exDa
(Basic) GET Yes `symbol`
symbol=AAPL` `symbol`
Premium

`constituents`,
Indices `constituentsBreakdow
`/index/constituents?
Constituents GET Yes `symbol` `cusip`, `isin`, `name`
symbol=^GSPC`
Premium `shareClassFIGI`,
`symbol`, `weight`

Indices
`/index/historical-
Historical `historicalConstituen
GET Yes constituents? `symbol`
Constituents `action`, `date`, `symb
symbol=^GSPC`
Premium

ETFs Profile `/etf/profile? `symbol`, `profile` (includes multi

GET Yes
Premium symbol=ARKK` `isin` attributes)

`symbol`,
ETFs `atDate`, `holdings`
`/etf/holdings? `isin`,
Holdings GET Yes (includes multiple attribute
symbol=ARKK` `skip`,
Premium `numberOfHoldings`
`date`
ETFs Sector
`/etf/sector? `symbol`, `sectorExposure` (includ
Exposure GET Yes
symbol=SPY` `isin` `exposure`, `industry`
Premium
ETFs
Country `/etf/country? `symbol`, `countryExposure` (inclu
GET Yes
Exposure symbol=SPY` `isin` `country`, `exposure`)
Premium

Mutual
Funds `/mutual-fund/profile? `symbol`, `profile` (includes multi
GET Yes
Profile symbol=VTSAX` `isin` attributes)
Premium

Mutual
`/mutual- `symbol`, `atDate`, `holdings`
Funds
GET Yes fund/holdings? `isin`, (includes multiple attribute
Holdings
symbol=VTSAX` `skip` `numberOfHoldings`
Premium

Mutual
Funds Sector `/mutual-fund/sector? `symbol`, `sectorExposure` (includ
GET Yes
Exposure symbol=VTSAX` `isin` `exposure`, `sector`)
Premium
Mutual
Funds
`/mutual-fund/country? `symbol`, `countryExposure` (inclu
Country GET Yes
symbol=FNILX` `isin` `country`, `exposure`)
Exposure
Premium

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 20/24
 Premium
API Method Endpoint Example Arguments Response Attributes
Required
Mutual
`/mutual-fund/eet?
Funds EET GET Yes `isin` `data`
isin=LU2036931686`
Premium

Financial Estimates and Metrics

API Response
Method Premium Arguments Examples
Name Attributes
`estimate`,
`metric`, `python<br>import finnhub<br>finnhu
Earnings
GET Yes `symbol` `period`, [Link](api_key="")
Estimates
`value`, <br>print(finnhub_client.earnings_e
`year`
`metrics`,
`symbol`, `python<br>import finnhub<br>finnhu
Financial `ratios`,
GET Yes `date`, [Link](api_key="")
Metrics `date`,
`type` <br>print(finnhub_client.financial_
`type`
`estimate`,
`metric`, `python<br>import finnhub<br>finnhu
Financial
GET Yes `symbol` `period`, [Link](api_key="")
Estimates
`value`, <br>print(finnhub_client.financial_
`year`
`metrics`, `python<br>import finnhub<br>finnhu
Key `symbol`,
GET Yes `ratios`, [Link](api_key="")
Metrics `date`
`date` <br>print(finnhub_client.key_metric

This table organizes the key details of each API for easy reference and integration into your
application. If you need further customization or additional details, just let me know!

Here are the API URLs with clickable links:

General APIs

API
API Name Method Endpoint Arguments Description
URL

Returns
symbol, resolution, candlestick data API
Forex Candles GET /forex/candle
from, to for forex URL
symbols.

Gets rates for all API

Forex Rates GET /forex/rates base, date
forex pairs. URL
Lists supported
API
Crypto Exchanges GET /crypto/exchange None crypto
URL
exchanges.
Lists supported
API
Crypto Symbol GET /crypto/symbol exchange crypto symbols
URL
by exchange.

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 21/24
 API
API Name Method Endpoint Arguments Description
URL

Gets crypto
API
Crypto Profile GET /crypto/profile symbol profile
URL
information.
Returns
symbol, resolution, candlestick data API
Crypto Candles GET /crypto/candle
from, to for crypto URL
symbols.
Runs pattern
recognition API
Pattern Recognition GET /scan/pattern symbol, resolution
algorithm on a URL
symbol.
Gets support and
/scan/support- API
Support/Resistance GET symbol, resolution resistance levels
resistance URL
for a symbol.

Gets aggregate
Aggregate /scan/technical- signal of multiple API
GET symbol, resolution
Indicators indicator technical URL
indicators.

symbol, resolution, Returns technical

API
Technical Indicators GET /indicator from, to, indicator, indicator with
URL
indicator_fields price data.
Lists earnings call
Earnings Call API
GET /stock/transcripts/list symbol transcripts'
Transcripts List URL
metadata.
Gets full earnings
Earnings Call call transcript, API
GET /stock/transcripts id
Transcripts audio, and URL
participants' list.

Splits, Dividends, Indices, ETFs, and Mutual Funds

Premium API
API Method Endpoint Example Arguments Description
Required URL

/stock/split? Returns
Splits symbol, API
GET Yes symbol=AAPL&from=2015- stock split
Premium from, to URL
02-01&to=2021-03-09 data.
Returns
Dividends 2
/stock/dividend2? stock API
(Basic) GET Yes symbol
symbol=AAPL dividend URL
Premium
data.
Indices Lists
/index/constituents? API
Constituents GET Yes symbol constituents
symbol=^GSPC URL
Premium of an index.
Indices Lists
/index/historical-
Historical historical API
GET Yes constituents? symbol
Constituents constituents URL
symbol=^GSPC
Premium of an index.
ETFs Profile GET Yes /etf/profile?symbol=ARKK symbol, isin Returns ETF API
Premium profile URL

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 22/24
 Premium API
API Method Endpoint Example Arguments Description
Required URL
information.
ETFs symbol, Returns ETF
API
Holdings GET Yes /etf/holdings?symbol=ARKK isin, skip, holdings
URL
Premium date data.
Returns ETF
ETFs Sector
sector API
Exposure GET Yes /etf/sector?symbol=SPY symbol, isin
exposure URL
Premium
data.
Returns ETF
ETFs Country
country API
Exposure GET Yes /etf/country?symbol=SPY symbol, isin
exposure URL
Premium
data.
Returns
Mutual
/mutual-fund/profile? mutual fund API
Funds Profile GET Yes symbol, isin
symbol=VTSAX profile URL
Premium
information.

Mutual Returns
Funds /mutual-fund/holdings? symbol, mutual fund API
GET Yes
Holdings symbol=VTSAX isin, skip holdings URL
Premium data.
Returns
Mutual
mutual fund
Funds Sector /mutual-fund/sector? API
GET Yes symbol, isin sector
Exposure symbol=VTSAX URL
exposure
Premium
data.

Mutual Returns
Funds mutual fund
/mutual-fund/country? API
Country GET Yes symbol, isin country
symbol=FNILX URL
Exposure exposure
Premium data.
Mutual Returns
/mutual-fund/eet? API
Funds EET GET Yes isin mutual fund
isin=LU2036931686 URL
Premium EET data.

Financial Estimates and Metrics

API
API Name Method Premium Arguments Description
URL
Earnings Returns earnings API
GET Yes `symbol`
Estimates estimates data. URL
Financial `symbol`, `date`, Returns financial metrics API
GET Yes
Metrics `type` data. URL

Financial Returns financial estimates API

GET Yes `symbol`
Estimates data. URL
API
Key Metrics GET Yes `symbol`, `date` Returns key metrics data.
URL

Replace `YOUR_API_KEY` with your actual API key when making requests. If you need any more
information or further assistance, feel free to ask!

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 23/24
 ChatGPT can make mistakes. Check important info.

Printed using Save ChatGPT as PDF, powered by PDFCrowd HTML to PDF API. 24/24