Global Financial Data JSON API Documentation

Version 2.3.0

Global Financial Data offers several API options to access and download our data, both as files and as JSON data. The JSON data API methods are identified and listed below. API access and use is controlled via a subscription to Global Financial Data. If you do not have a subscription to GFD, please contact us to inquire about terms of access.

If you're new to GFD and have questions , please contact support.

Version 2.0.0 introduces token-based authentication.
Version 2.1.0 introduces the Fundamentals API.
Version 2.2.0 introduces searching by cik code.
Version 2.3.0 introduces search and retrieval for ICE data.

Returns a token to be submitted with all calls to the API. The token expires after 30 minutes.

Example ajax POST to https://api.globalfinancialdata.com/login/
Parameters
username *required version added: 2.0.0

Type: String

(request body)

password *required version added: 2.0.0

Type: String

(request body)

Responses Returns: json
Code
Description
200
successful operation
Name Description Type
token encrypted string to be submitted with each call to the API except Login. string
400
Bad Request
Examples:
  • Post is malformed. Look for missing paramters in body of call, or formatting issues.
  • Empty username or password.
401
Unauthorized
Examples:
  • Wrong username or password.
  • Correct username and password, but missing user permissions.
500
Internal Server Error
Examples:
  • Something went wrong server-side.
Models
Request Body version added: 2.0.0

Parameters {
username string
password string
}

Response version added: 2.0.0

token {
token string
}

Searches the entire scope of GFD's data regardless of whether or not the user has access to the price data. Included in the return data is information as to whether or not the user can access the returned data fields.

Example ajax POST to https://api.globalfinancialdata.com/search/
Parameters
token *required version added: 2.0.0

Type: String

(request body)

searchstring *required version added: 1.0.0

Type: String

(request body)

searchtype version added: 1.0.0

Options: name, symbol.
(Defaults to "name" if not provided.)

Type: String

(request body)

basefilter version added: 1.0.0

Options: contains, startswith, exactmatch.
(Defaults to "contains" if not provided.)

Type: String

(request body)

sort version added: 1.0.0

Options: pop, alpha.
(Defaults to "pop" if not provided.)

Type: String

(request body)

page version added: 1.0.0

Type: String

(request body)

pagesize version added: 1.0.0

Options: Any integer between 10 - 100.

Type: String

(request body)

Responses Returns: json
Code
Description
200
successful operation
Example Value: See below for response Model
"JSON tables"
Name Description Type
paging_info current_page, page_size, total_records, total_pages datarow
search_results 23-columns, see model for list table
400
Bad Request
Examples:
  • Post is malformed. Look for missing paramters in body of call, or formatting issues.
  • Empty UserName, Password or SearchString.
401
Unauthorized
Examples:
  • Missing user permissions.
500
Internal Server Error
Examples:
  • Something went wrong server-side.
Models
Request Body version added: 1.0.0

Parameters {
token string
searchstring string
searchtype string
default: name
Enum: [name, symbol]
basefilter string
default: contains
Enum: [contains, startswith, exactmatch]
sort string
default: pop
Enum: [pop, alpha]
page string
default: ""
Range: ""= return all; > 0 to set page
pagesize string
default: ""
Range: ""= return all; 10 - 100 to set pagesize
}

Response version added: 1.0.0

paging_info {
current_page string
page_size string
total_records string
total_pages string
}
search_results {
series_id string
country_name string
iso string
currency string
series string
gfd_sector string
dl_freq string
start_date string
end_date string
symbol string
description string
periodicity string
metadata string
corporate_history string
equity_type string
sector string
industry string
exchange string
units string
scale string
scale_num string
cik string
has_access string
}
token {
token string
}

Data returned includes series metadata and price data.

Example ajax POST to https://api.globalfinancialdata.com/series/
Parameters
token *required version added: 2.0.0

Type: String

(request body)

seriesname *required version added: 1.0.0

Description: Selected characters to search for the Series Symbol. Use Comma Separated Values to search Multi Series by Symbol.

Type: String

(request body)

seriesid version added: 1.0.0

Options: GFD SeriesID.
(Defaults to N/A if not provided.)

Type: String

(request body)

splitadjusted version added: 1.0.1

Options: true, false.
(Defaults to "true" if not provided.)

Type: String

(request body)

startdate version added: 1.0.0

Options: Start Data for Price Data, in MM/DD/YYYY format.
(Defaults to "01/01/1000" if not provided.)

Type: String

(request body)

enddate version added: 1.0.0

Options: MM/DD/YYYY format input.
(Defaults to latest available if not provided.)

Type: String

(request body)

periodicity version added: 1.0.0

Options: Daily, Weekly, Monthly, Quarterly, Annual.
(Defaults to "Daily" if not provided.)

Type: String

(request body)

closeonly version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

currency version added: 1.0.0

Options: USD,GBP,JPY,EUR,CAD,AUD,CHF,INR,BRL,CNY.
(Defaults to series Native Currency if not provided.)

Type: String

(request body)

inflationadjusted version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

annualflow version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

totalreturn version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

corporateactions version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

metadata version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

incfields version added: 1.0.0

Options: unknown.
(Defaults to "" if not provided.)

Type: String

(request body)

includeaverage version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

periodpercentchange version added: 1.0.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

Responses Returns: json
Code
Description
200
successful operation
Example Value: See below for response Model
"JSON tables"
Name Description Type
data_information 11-columns, see model for list table
price_data 8-columns, see model for list table
400
Bad Request
Examples:
  • Post is malformed. Look for missing paramters in body of call, or formatting issues.
  • Empty Token or SearchString.
401
Unauthorized
Examples:
  • Wrong username or password.
  • Correct username and password, but missing user permissions.
500
Internal Server Error
Examples:
  • Something went wrong server-side.
Models
Request Body version added: 1.0.0

Parameters {
token string
seriesname string
seriesid string
splitadjusted string
startdate string
enddate string
periodicity string
default: Daily
Enum: [Daily,Weekly,Monthly,Quarterly,Annual]
closeonly string
default: false
Enum: [true,false]
currency string
default: NATIVE
Enum: [NATIVE,USD,GBP,JPY,EUR,CAD,AUD,CHF,INR,BRL,CNY]
inflationadjusted string
default: false
Enum: [true,false]
annualflow string
default: false
Enum: [true,false]
totalreturn string
default: false
Enum: [true,false]
corporateactions string
default: false
Enum: [true,false]
metadata string
default: false
Enum: [true,false]
incfields string
includeaverage string
default: false
Enum: [true,false]
periodpercentchange string
default: False
Enum: [true,false]
}

Response version added: 1.0.0

data_information {
series_id string
symbol string
name string
series_type string
units string
scale string
flow string
adjustment string
periodicity string
metadata string
corporate_history string
}
download_status {
id string
status string
}
price_data {
date string
series_id string
open string
high string
low string
close string
volume string
openint string
}
token {
token string
}

Returns fundamental series data by symbol.

Example ajax POST to https://api.globalfinancialdata.com/fundamentals/
Parameters
token *required version added: 2.1.0

Type: String

(request body)

seriesname *required version added: 2.1.0

Description: Series Symbol, AKA Ticker. Single Symbol searches only.

Type: String

(request body)

period *required version added: 2.1.0

Options: Quarterly, Annual.
(Defaults to "Quarterly" if not provided.) (Estimates group N/A)

Type: String

(request body)

group version added: 2.1.0

Options: Balance Sheet, Cash Flow, Estimates, Fundamentals, Income Statement, Ratios, Basic Ratios, Share Information.
(Defaults to "Share Information" if not provided.)

Type: String

(request body)

startdate version added: 2.1.0

Options: MM/DD/YYYY format.
(Defaults to "01/01/1000" if not provided.)

Type: String

(request body)

enddate version added: 2.1.0

Options: MM/DD/YYYY format.
(Defaults to latest available if not provided.)

Type: String

(request body)

Responses Returns: json
Code
Description
200
successful operation
Example Value: See below for response Models
JSON tables - one of the following + "token"
Name Description Type
balance_sheet 40 columns, see model for list table
cash_flow 23-columns, see model for list table
estimates 33-columns, see model for list table
fundamentals 90-columns, see model for list table
income_statement 30-columns, see model for list table
ratios 68-columns, see model for list table
basic_ratios 24-columns, see model for list table
share_information 21-columns, see model for list table
400
Bad Request
Examples:
  • Post is malformed. Look for missing paramters in body of call, or formatting issues.
  • Empty or malformed token, empty seriesname, empty period.
401
Unauthorized
Examples:
  • Missing user permissions, expired token.
500
Internal Server Error
Examples:
  • Something went wrong server-side.
Models
Request Body version added: 2.1.0

Parameters {
token string
seriesname string
Period string
default: Yearly
Enum: [Quarterly, Yearly]
Group string
default: Share Information
Enum: [Balance Sheet, Cashflow, Estimates, Fundamentals, Income Statement, Ratios, Basic Ratios, Share Information]
startdate string
enddate string
}

Responses version added: 2.1.0

balance_sheet {
Date string
Ticker string
Accounts Payable string
Accrued Expenses string
Accumulated Depreciation string
Capital Surplus string
Cash string
Common Stock Net string
Convertible Debt string
Current Portion Of Capital Leases string
Current Portion Of Long Term Debt string
Deferred Charges string
Deferred Charges (Taxes Income) string
Deposits & Other Assets string
Finished Goods string
Income Taxes Payable string
Intangibles string
Inventories string
Investment & Advances string
Long-Term Debt string
Marketable Securities string
Minority Interest (Liabilities) string
Mortgages string
Net Property Plant Equipment string
Non-Current Capital Leases string
Notes Payable string
Notes Receivable string
Other Current Assets string
Other Current Liabilities string
Other Liabilities string
Other Long-Term Liabilities string
Other Non-Current Assets string
Preferred Stocks string
Property Plant And Equipment string
Receivables string
Retained Earnings string
Shareholders Equity string
Total Assets string
Total Current Assets string
Total Current Liabilities string
Total Liabilities string
Total Liabilities & Shareholder Equity string
Treasury Stock string
Work In Progress string
Raw Materials string
}
cash_flow {
Date string
Ticker string
Acquisition/Disposition Of Subsidiaries And Other Businesses string
Cash & Equivalents At Beginning Of Year string
Cash & Equivalents At Year End string
Cash From (Used In) Discontinued Operations string
Decrease In Property, Plant & Equipment string
Depreciation Depletion & Amortization string
Effect Of Exchange Rate Changes On Cash string
Increase (Decrease) In Bank & Other Borrowings string
Increase (Decrease) In Investments string
Issuance (Purchase) Of Equity Shares string
Issuance (Repayment) Of Debt Securities string
Net Cash From (Used By) Financing Activities string
Net Cash From (Used By) Investment Activities string
Net Cash From (Used By) Operating Activities string
Net Change In Cash & Cash Equivalents string
Net Income string
Net Increase (Decrease) In Assets/Liabilities string
Other Adjustments - Net string
Other Cash From (Used By) Financing Activities string
Other Cash Inflow From Investment Activities string
Payment Of Dividends & Other Cash Distributions string
}
estimates {
Date string
Ticker string
Growth In FY+2 Mean EPS Over FY+1 EPS (%) string
Number Of Fiscal Year + 2 Estimates string
Growth In FY+1 Mean EPS Over Current FY EPS (%) string
Growth In Q+1 EPS Mean Over Q-3 EPS (%) string
Growth In Q+2 EPS Mean Over Q-2 EPS (%) string
Quarter +2 High Estimate string
Long-Term Growth Rate Current Mean string
Number Of Long-Term Growth Estimates string
FY + 1 EPS Current Mean string
FY + 2 EPS Current Mean string
FY +1 Estimated EPS (Year Prior To FY 2) string
Number Of Fiscal Year +1 Estimates string
Number Of Quarter +1 Estimates string
Number Of Quarter + 2 Estimates string
FY +2 EPS Low Estimate string
Quarter +1 EPS Current Mean string
Quarter +1 Low Estimate string
Quarter +2 Current Mean string
Quarter +2 Low Estimate string
Current Fiscal Year Actual EPS (Year Prior To FY +1) string
FY +1 EPS High Estimate string
FY +2 EPS High Estimate string
Long-Term Growth Rate Low Estimate string
Quarter +1 High Estimate string
Quarter -2 Actual EPS (Year Prior To Q+2) string
Quarter -3 Actual EPS (Year Prior To Q+1) string
Long-Term Growth Rate High Estimate string
Quarter +1 End Date (YYYYMM) string
Quarter +2 End Date (YYYYMM) string
FY +1 End Date (YYYYMM) string
FY +2 End Date (YYYYMM) string
}
fundamentals {
Date string
Ticker string
Accounts Payable string
Accrued Expenses string
Accumulated Depreciation string
Acquisition/Disposition Of Subsidiaries And Other Businesses string
Average Shares Used To Compute Basic EPS string
Average Shares Used To Compute Diluted EPS string
Capital Surplus string
Cash string
Cash & Equivalents At Beginning Of Year string
Cash & Equivalents At Year End string
Cash From (Used In) Discontinued Operations string
Common Stock Net string
Convertible Debt string
Cost Of Goods Sold string
Current Portion Of Capital Leases string
Current Portion Of Long Term Debt string
Decrease In Property, Plant & Equipment string
Deferred Charges string
Deferred Charges (Taxes Income) string
Deposits & Other Assets string
Depreciation Depletion & Amortization string
Dividends (Common) string
Dividends Per Share Basic string
Effect Of Exchange Rate Changes On Cash string
EPS - Basic, Net string
EPS - Diluted, Before Non-Recurring Items string
EPS - Diluted, Net string
EPS Report Date string
Extraordinary Items & Discontinued Operations string
Finished Goods string
Gross Profit string
Income Before Depreciation, Depletion & Amortization string
Income Before Extraordinaries & Discontinued Operations string
Income Before Non-Recurring Items string
Income From Non-Recurring Items string
Income Taxes Payable string
Increase (Decrease) In Bank & Other Borrowings string
Increase (Decrease) In Investments string
Intangibles string
Interest Expense string
Inventories string
Investment & Advances string
Investment Gains (Losses) string
Issuance (Purchase) Of Equity Shares string
Issuance (Repayment) Of Debt Securities string
Long-Term Debt string
Marketable Securities string
Minority Interest string
Minority Interest (Liabilities) string
Mortgages string
Net Cash From (Used By) Financing Activities string
Net Cash From (Used By) Investment Activities string
Net Cash From (Used By) Operating Activities string
Net Change In Cash & Cash Equivalents string
Net Income string
Net Increase (Decrease) In Assets/Liabilities string
Net Property Plant Equipment string
Net Sales Or Revenues string
Non-Current Capital Leases string
Non-Operating Income string
Notes Payable string
Notes Receivable string
Other Adjustments - Net string
Other Cash From (Used By) Financing Activities string
Other Cash Inflow From Investment Activities string
Other Current Assets string
Other Current Liabilities string
Other Income string
Other Liabilities string
Other Long-Term Liabilities string
Other Non-Current Assets string
Payment Of Dividends & Other Cash Distributions string
Pre-Tax Income string
Preferred Stocks string
Property Plant And Equipment string
Provision For Income Taxes string
Raw Materials string
Receivables string
Research & Development Expense string
Retained Earnings string
Selling, General & Administrative Expense string
Shareholders Equity string
Total Assets string
Total Current Assets string
Total Current Liabilities string
Total Liabilities string
Total Liabilities & Shareholder Equity string
Treasury Stock string
Work In Progress string
Preferred Dividends - Accumulated & Paid string
}
income_statement {
Date string
Ticker string
Average Shares Used To Compute Basic EPS string
Average Shares Used To Compute Diluted EPS string
Cost Of Goods Sold string
Depreciation Depletion & Amortization string
Dividends (Common) string
Dividends Per Share Basic string
EPS - Basic, Net string
EPS - Diluted, Before Non-Recurring Items string
EPS - Diluted, Net string
EPS Report Date string
Extraordinary Items & Discontinued Operations string
Gross Profit string
Income Before Depreciation, Depletion & Amortization string
Income Before Extraordinaries & Discontinued Operations string
Income Before Non-Recurring Items string
Income From Non-Recurring Items string
Interest Expense string
Investment Gains (Losses) string
Minority Interest string
Net Income string
Net Sales Or Revenues string
Non-Operating Income string
Other Income string
Pre-Tax Income string
Provision For Income Taxes string
Research & Development Expense string
Selling, General & Administrative Expense string
Preferred Dividends - Accumulated & Paid string
}
ratios {
Date string
Ticker string
Close string
Shares Outstanding string
Market Capitalization string
Depreciation Depletion & Amortization string
Dividends Per Share Basic string
Extraordinary Items & Discontinued Operations string
Gross Profit string
Income Before Depreciation, Depletion & Amortization string
Income Before Extraordinaries & Discontinued Operations string
Intangibles string
Interest Expense string
Inventories string
Investment Gains (Losses) string
Long-Term Debt string
Net Sales Or Revenues string
Non-Operating Income string
Other Income string
Pre-Tax Income string
Preferred Stocks string
Property Plant And Equipment string
Provision For Income Taxes string
Shareholders Equity string
Total Assets string
Total Current Assets string
Total Current Liabilities string
Preferred Dividends - Accumulated & Paid string
Dividends Paid string
Revenue (1-Year Rate Of Change) string
EPS (1-Year Rate Of Change) string
Operating Income string
Net Income string
52 Week High string
52 Week Low string
52 Week Average Volume string
Revenue (3-Year Rate Of Change) string
Revenue (5-Year Rate Of Change) string
Revenue (7-Year Rate Of Change) string
EPS (3-Year Rate Of Change) string
EPS (5-Year Rate Of Change) string
EPS (7-Year Rate Of Change) string
Total Shares Outstanding string
Price To Earnings Ratio string
Market Cap string
Price To Sales Ratio string
Price To Book Ratio string
Price To Tangible Book Ratio string
Price To Cash Flow Ratio string
Dividends Per Share string
Dividend Yield string
Earnings Per Share string
Payout Ratio string
Revenues Per Share string
Book Value Per Share string
Cash Flow Per Share string
Quick Ratio string
Current Ratio string
Long-Term Debt To Equity string
Interest Coverage Ratio string
Gross Profit Margin string
EBIT Profit Margin string
Operating Profit Margin string
Net Profit Margin string
Effective Tax Rate string
Return On Equity string
Asset Turnover string
NWC Turnover string
}
basic_ratios {
Date string
Ticker string
Close string
Shares Outstanding string
Market Capitalization string
Depreciation Depletion & Amortization string
EPS - Basic, Net string
EPS - Diluted, Net string
Extraordinary Items & Discontinued Operations string
Income Before Extraordinaries & Discontinued Operations string
Intangibles string
Net Sales Or Revenues string
Preferred Stocks string
Property Plant And Equipment string
Total Assets string
Preferred Dividends - Accumulated & Paid string
EPS - Basic Net Ttm string
EPS - Diluted Net Ttm string
Price To Sales Ratio string
Price To Book Ratio string
Price To Tangible Book Ratio string
Price To Cash Flow Ratio string
PE Ratio Basic string
PE Ratio Diluted string
}
share_information {
Date string
Ticker string
Close string
Shares Outstanding string
Market Capitalization string
Common Stock Net string
Depreciation Depletion & Amortization string
Dividends Per Share Basic string
EPS - Basic, Net string
EPS - Diluted, Before Non-Recurring Items string
EPS - Diluted, Net string
EPS Report Date string
Extraordinary Items & Discontinued Operations string
Income Before Extraordinaries & Discontinued Operations string
Preferred Stocks string
Shareholders Equity string
Share Equity string
Preferred Dividends - Accumulated & Paid string
Stored Market Cap Value string
Stored Dividend Yield string
Cash Flow Per Share string
}
token {
token string
}

Searches the entire scope of GFD's data regardless of whether or not the user has access to the price data. Included in the return data is information as to whether or not the user can access the returned data fields.

Example ajax POST to https://api.globalfinancialdata.com/searchbycikcodes/
Parameters
token *required version added: 2.0.0

Type: String

(request body)

cikcodes *required version added: 1.0.0

Type: String

(request body)

Responses Returns: json
Code
Description
200
successful operation
Example Value: See below for response Model
"JSON tables"
400
Bad Request
Examples:
  • Post is malformed. Look for missing paramters in body of call, or formatting issues.
  • Empty UserName, Password or SearchString.
401
Unauthorized
Examples:
  • Missing user permissions.
500
Internal Server Error
Examples:
  • Something went wrong server-side.
Models
Request Body version added: 1.0.0

Parameters {
token string
cikcodes string
}

Response version added: 1.0.0

search_results {
series_id string
seriesname string
cik string
}

Searches for securities in the ICE database, using ticker, exchange, cusip code, sedol and isin.

Example ajax POST to https://api.globalfinancialdata.com/searchice/
Parameters
token *required version added: 2.3.0

Type: String

(request body)

Ticker version added: 2.3.0

Type: String

(request body)

seriesid version added: 2.3.0

Type: String

(request body)

Exchange version added: 2.3.0

Type: String

(request body)

Cusip version added: 2.3.0

Type: String

(request body)

Sedol version added: 2.3.0

Type: String

(request body)

ISIN version added: 2.3.0

Type: String

(request body)

Name version added: 2.3.0

Type: String

(request body)

Responses Returns: json
Code
Description
200
successful operation
Example Value: See below for response Model
"JSON tables"
Name Description Type
search_results 8-columns, see model for list table
400
Bad Request
Examples:
  • Post is malformed. Look for missing paramters in body of call, or formatting issues.
  • Empty UserName, Password or SearchString.
404
Not Found
Examples:
  • Ticker being searched for was not found.
401
Unauthorized
Examples:
  • Missing user permissions.
500
Internal Server Error
Examples:
  • Something went wrong on the server-side.
Models
Request Body version added: 2.3.0

Parameters {
token string
seriesid string
ticker string
exchange string
cusip string
sedol string
isin string
name string
}

Response version added: 2.3.0

search_results {
SeriesID string
Filename string
Description string
exchange string
ISIN string
Sedol string
currency string
iso string
SeriesType string
}
token {
token string
}

Data returned includes series metadata and price data. Optionally available are corporate actions and shares outstanding.

Example ajax POST to https://api.globalfinancialdata.com/ice/
Parameters
token *required version added: 2.3.0

Type: String

(request body)

seriesid *required version added: 2.3.0

Options: Ice SeriesID.
(Defaults to N/A if not provided.)

Type: String

(request body)

splitadjusted version added: 2.3.0

Options: true, false.
(Defaults to "true" if not provided.)

Type: String

(request body)

startdate version added: 2.3.0

Options: Start Data for Price Data, in MM/DD/YYYY format.
(Defaults to "01/01/1000" if not provided.)

Type: String

(request body)

enddate version added: 2.3.0

Options: MM/DD/YYYY format input.
(Defaults to latest available if not provided.)

Type: String

(request body)

periodicity version added: 2.3.0

Options: Daily, Weekly, Monthly, Quarterly, Annual.
(Defaults to "Daily" if not provided.)

Type: String

(request body)

currency version added: 2.3.0

Options: USD,GBP,JPY,EUR,CAD,AUD,CHF,INR,BRL,CNY.
(Defaults to series Native Currency if not provided.)

Type: String

(request body)

inflationadjusted version added: 2.3.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

totalreturnadjusted version added: 2.3.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

includeactions version added: 2.3.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

includeshares version added: 2.3.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

closeonly version added: 2.3.0

Options: true, false.
(Defaults to "false" if not provided.)

Type: String

(request body)

Responses Returns: json
Code
Description
200
successful operation
Example Value: See below for response Model
"JSON tables"
Name Description Type
MetaData 11-columns, see model for list table
PriceData 8-columns, see model for list table
ActionData 8-columns, see model for list table
ShareData 4-columns, see model for list table
400
Bad Request
Examples:
  • Post is malformed. Look for missing paramters in body of call, or formatting issues.
  • Empty Token or SearchString.
401
Unauthorized
Examples:
  • Wrong username or password.
  • Correct username and password, but missing user permissions.
500
Internal Server Error
Examples:
  • Something went wrong server-side.
Models
Request Body version added: 2.3.0

Parameters {
token string
seriesid string
splitadjusted bool
default: true
Enum: [true,false]
startdate string
enddate string
periodicity string
default: Daily
Enum: [Daily,Weekly,Monthly,Quarterly,Annual]
currency string
default: NATIVE
Enum: [NATIVE,USD,GBP,JPY,EUR,CAD,AUD,CHF,INR,BRL,CNY]
closeonly bool
default: false
Enum: [true,false]
inflationadjusted bool
default: false
Enum: [true,false]
totalreturnadjusted bool
default: false
Enum: [true,false]
includeactions bool
default: false
Enum: [true,false]
includeshares bool
default: false
Enum: [true,false]
}

Response version added: 2.3.0

metadata {
SeriesID string
Filename string
Description string
exchange string
ISIN string
Sedol string
currency string
iso string
}
price_data {
SeriesID string
date string
open string
high string
low string
close string
volume string
openint string
Additional columns returned when InflationAdjusted is requested.
real_open string
real_high string
real_low string
real_close string
Additional columns returned when TotalReturn is requested.
total_return string
total_return_percent_change string
total_return_change string
}
ActionData {
ticker string
date string
series_id string
AnnouncementDate string
PaymentDate string
RecordDate string
Action string
amount string
notes string
currency string
}
ShareData {
date string
series_id string
value string
}
token {
token string
}