Calls to this API will return either a price or price and volume chart for the requested company
https://secure.newsedge.com/opensapi/20/company/chart?session=<<SESSION>>&acorn=<<ACORN>>[¶meter=value][&. . .]
https://secure.newsedge.com/opensapi/20/company/chart?session=<<SESSION>>&ticker=<<EXCHANGE:TICKER>>[¶meter=value][&. . .]
https://secure.newsedge.com/opensapi/20/company/chart?session=<<SESSION>>&cusip=<<CUSIP>>[¶meter=value][&. . .]
https://secure.newsedge.com/opensapi/20/company/chart?session=<<SESSION>>&isin=<<ISIN>>[¶meter=value][&. . .]
| Parameter | Values | Description |
|---|---|---|
| session | The ID of the OPENS API session. Use the user-token value returned from the session/login request. | |
| company identifier | One type of company identifier must be supplied in the request. The available company identifier types are acorn , ticker , cusip , or isin . Only a single company identifier can be included in a call to company/chart. |
| Parameter | Values | Description |
|---|---|---|
| acorn | The ACquire media ORganizational Number for the company that the filings are desired. It is always a 10 digit number. ACORNs can be found using the company/search API. | |
| ticker | The ticker company identifier is in the form EXCHANGE:TICKER. Both the exchange and ticker for a company can be found using the company/search API. | |
| cusip | The cusip identifier is the 9 character Committee on Uniform Securities Identification Procedures number. The cusip number for a company can be found using the company/search API. | |
| isin | The ISIN identifier is the 12 character International Securities Identification Number. The isin for a company can be found using the company/search API. | |
| type | Default:price price,pricevolume | The type parameter controls whether only price information is shown or price and volume information are shown in the returned image. |
| format | Default:line line,bar,candlestick | The format parameter controls the representation of the price values -- either a line graph, a bar chart, or a candlestick chart. |
| frequency | Default:1min 1min,5min,10min,hourly,daily,weekly,monthly | The frequency parameter controls the time span between data points in the chart. |
| daterange | Default:intraday intraday,week,month,year,5years | The time span covered by the chart is controlled by either the daterange parameter or the startdate and enddate parameter. If the daterange parameter is specified, then the chart will go back the indicated amount of time from the time of the call. For example, intraday means today's prices and volumes and week would go back 7 days from today. |
| startdate | The startdate parameter sets the beginning of the time range for the chart. It can be speficied as YYYYMMDD to indicate starting at market opening on a certain day or as YYYYMMDDHHMMSS to indicate starting at a particular time on a certain day. If the startdate is specified, the daterange is not allowed. | |
| enddate | The enddate parameter sets the end of the time range for the chart. It can be speficied as YYYYMMDD to indicate ending at market closing on a certain day or as YYYYMMDDHHMMSS to indicate ending at a particular time on a certain day. If startdate is specified and enddate is not specified, then enddate is assumed to be the time of the call to the API. | |
| height | Default:300 | The height parameter sets the height in pixels of the returned image. |
| width | Default:400 | The width parameter sets the width in pixels of the returned image. |
| axisColor | R,G,B or X-11 color names | The color of the axes of the charts. |
| backgroundColor | R,G,B or X-11 color names | This is the color of the border of the chart and the background color of the volume chart. |
| chartBackgroundColor | R,G,B or X-11 color names | This is the color of the even horizontal grids of the price chart. |
| altChartBackgroundColor | R,G,B or X-11 color names | This is the color of the odd horizontal grids of the price chart. |
| chartColor | R,G,B or X-11 color names | This is the color of the line of the price chart. |
| scaleColor | R,G,B or X-11 color names | This is the color of the horizontal dashed grid lines of both charts. |
| textColor | R,G,B or X-11 color names | This is the color of all the text on the chart. |
| studyColor | R,G,B or X-11 color names | This is the color the indicators on the volume chart. |
| candleUpColor | R,G,B or X-11 color names | This is the color of the candlesticks for up ticks. |
| candleDownColor | R,G,B or X-11 color names | This is the color of the candlesticks for down ticks. |
If successful, the company/chart request will return an image showing the requested price and volume information. If unsuccessful, the company/chart request will return a status of ERROR, and a message element with a description of the error.
Calls to this API return available official corporate registration statements, period reports and other forms from the requested company as filed to official governmental commissions.
Currently, only filings made to the United States Securities and Exchange Commission (SEC)
The returned forms can be filtered by type.
https://secure.newsedge.com/opensapi/20/company/filings?session=<<SESSION>>&acorn=<<ACORN>>[¶meter=value][&. . .]
https://secure.newsedge.com/opensapi/20/company/filings?session=<<SESSION>>&ticker=<<EXCHANGE:TICKER>>[¶meter=value][&. . .]
https://secure.newsedge.com/opensapi/20/company/filings?session=<<SESSION>>&cusip=<<CUSIP>>[¶meter=value][&. . .]
https://secure.newsedge.com/opensapi/20/company/filings?session=<<SESSION>>&isin=<<ISIN>>[¶meter=value][&. . .]
| Parameter | Values | Description |
|---|---|---|
| session | The ID of the OPENS API session. Use the user-token value returned from the session/login request. | |
| company identifier | One type of company identifier must be supplied in the request. The available company identifier types are acorn, ticker, cusip, or isin. Only a single value may be provided per call. |
| Parameter | Values | Description |
|---|---|---|
| json | Default:0 0,1,2 | The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
|
| acorn | The ACquire media ORganizational Number for the company that the filings are desired. It is always a 10 digit number. ACORNs can be found using the company/search API. | |
| ticker | The ticker company identifier is in the form EXCHANGE:TICKER. Both the exchange and ticker for a company can be found using the company/search API. | |
| cusip | The cusip identifier is the 9 character Committee on Uniform Securities Identification Procedures number. The cusip number for a company can be found using the company/search API. | |
| isin | The ISIN identifier is the 12 character International Securities Identification Number. The isin for a company can be found using the company/search API. | |
| forms | The forms parameter is a pipe delimited list of forms to be returned in the results. The available forms can be found using the company/getforms API. | |
| resultsPerPage | Default:20 1-210 | The number of results returned in a company/filings call. |
| page | Default:1 1 - totalPages | A number representing a page of returned results. Use the page parameter with the original company identifier and forms parameters to return subsequent pages of results. The totalPages element from returned results indicates how many pages of results are available. |
If successful, the company/filings request returns a list of links to official corporate registration statements, period reports and other forms as filed to official governmental commissions.
| Name | Values | Description |
|---|---|---|
| status | OK, ERROR | If status is OK, the results element will contain links to filings. If status is ERROR, a message element will contain a description of the error. |
| company-name | The official name of the company requested. | |
| pageInfo | This element contains child elements for number of results and pages. | |
| results | This element contains a list of result elements. |
| Name | Values | Description |
|---|---|---|
| totalResults | integer | The total number of forms available. If the element contains the attribute partialTotal with the value of TRUE, then the totalResults value is the minimum number available and a subsequent call for additional pages will eventually return the final totalResults. |
| totalPages | integer | The total number of pages available based on the resultsPerPage parameter. Subsequent calls can have a page parameter between 1 and this number. If the element contains the attribute partialTotal with the value of TRUE, then the totalPages value is the minimum number of pages available and a subsequent call for additional pages will eventually return the final totalPages number. |
| resultsPage | 1 ... totalPages | If the page parameter on the request was between 1 and totalPages, resultsPage will be the requested page. However, if the page parameter on the request is greater than the totalPages value, then the last valid page will be returned. |
| topResult | 1 ... totalResults | The topResult is the ordinal for the first result element in the returned results. |
| bottomResult | 1 ... totalResults | The bottomResult is the ordinal for the last result element in the returned results. For all pages except the last page, bottomResult will equal topResult + resultsPerPage -1. On the last page, bottomResult can be less than topResult + resultsPerPage - 1. |
The results element contains bottomResult - topResult + 1 number of result elements. Each result element contains the following child elements.
| Name | Values | Description |
|---|---|---|
| headline | The headline of the filing. | |
| formtype | The type of form this result links to. | |
| received-date | YYYYMMDDTHHMMSS-ZZZZ | This is the first time the NewsEdge system received this story. |
| publication-date | YYYYMMDDTHHMMSS-ZZZZ | This is the date and time that the company filed this form with the superviory body. |
| storyURL | This is the URL to follow to read the filing. |
Calls to this API return a list of forms that are available in the company/filings interface
https://secure.newsedge.com/opensapi/20/company/forms?session=<<SESSION>>
| Parameter | Values | Description |
|---|---|---|
| session | The ID of the OPENS API session. Use the user-token value returned from the session/login request. |
| Parameter | Values | Description |
|---|---|---|
| json | Default:0 0,1,2 | The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
|
If successful, the company/forms request will return a list of forms available for use in the company/filings interface.
| Name | Values | Description |
|---|---|---|
| status | OK, ERROR | If status is OK, then the forms element contains a list of form elements. If status is ERROR, then there was an issue retrieving the list of forms and the message element will describe the error. |
| forms | The forms element contains a list of form elements that can be used to filter the results returned by a call to company/filings. |
| Name | Values | Description |
|---|---|---|
| form | An individual form type that can be used in the forms parameter in a call to company/filings. |
https://secure.newsedge.com/opensapi/20/company/info?session=<<SESSION>>&acorn=<<ACORN>>[,<<ACORN>>]
https://secure.newsedge.com/opensapi/20/company/info?session=<<SESSION>>&ticker=<<EXCHANGE:TICKER>>[,<<EXCHANGE:TICKER>>]
https://secure.newsedge.com/opensapi/20/company/info?session=<<SESSION>>&cusip=<<CUSIP>>[,<<CUSIP>>]
https://secure.newsedge.com/opensapi/20/company/info?session=<<SESSION>>&isin=<<ISIN>>[,<<ISIN>>]
| Parameter | Values | Description |
|---|---|---|
| session | The ID of the OPENS API session. Use the user-token value returned from the session/login request. | |
| company identifier | One type of company identifier must be supplied in the request. The available company identifier types are acorn , ticker , cusip , or isin . Multiple company identifier values may be provided in a comma-separated list. |
| Parameter | Values | Description |
|---|---|---|
| json | Default:0 0,1,2 | The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
|
| acorn | The ACquire media ORganizational Number for the company that the infomation is desired. It is always a 10 digit number. ACORNs can be found using the company/search API. | |
| ticker | The ticker company identifier is in the form EXCHANGE:TICKER. Both the exchange and ticker for a company can be found using the company/search API. | |
| cusip | The cusip identifier is the 9 character Committee on Uniform Securities Identification Procedures number. The cusip number for a company can be found using the company/search API. | |
| isin | The ISIN identifier is the 12 character International Securities Identification Number. The isin for a company can be found using the company/search API. |
If successful, the company/info request returns profile information about the requested companies including a company description, locations, number of employees, etc.
| Name | Values | Description |
|---|---|---|
| status | OK, PARTIAL-OK, ERROR | If status is OK, the company profile information for all of the companies requested. The profile information is contained in the company child elements If status is PARTIAL-OK, at least one, but not all, of the companies requested did not return profile information. The caller must refer to the status child element of the company element to determine which company identifiers were not valid. If status is ERROR, then all of the company identifiers requested were invalid. The count and company elements will not be returned and a message element will contain a description of the error. |
| count | This number represents the number of company elements returned. | |
| company | The company element contains the main payload for each of the requested companies. The value attribute maps the contained profile information back to the requested company identifier. |
| Name | Values | Description |
|---|---|---|
| status | OK, ERROR | If status is OK, a company-profile element is present that contains all of the requested information. If status is ERROR, a message element is present that contains a description of the error. |
| company-profile | The company-profile element contains individual child elements for the company indicated by the value attribute of the parent company element. |
| Name | Values | Description |
|---|---|---|
| acorn | The 10 digit ACquire media ORganizational Number for the company information contained in this element. | |
| name | The official name of the company requested. | |
| synopsys | This element contains a short description of the company and its operations. | |
| url | The optional main website of the company. | |
| dba-names | This optional element contains zero or more dba-name elements which contain other names that this company is known by. | |
| description | The element contains a long description of the company and its operations. | |
| year-founded | The year that the company started operations. | |
| total employees | The number of employees in the company, if available. | |
| sales-revenue | The reported sales figure, in millions, for the period indicated by the period attribute, if avaiable. | |
| net-income | The reported net-income, in millions, for the period indicated by the period attribute, if available. | |
| accounting-firm | The name of the company's accounting firm, if available. | |
| bank-name | The name of the company's primary financial institution, if available. | |
| ethnicity | The reported ethnicity of the company's ownership, if available. | |
| legal-status | The status of the company as registered with the applicable government regulatory body. | |
| mfg-indicator | Indicator of whether the company manufactures goods for sale, if available. | |
| number-of-pcs | The number of personal computers in use at the company, if available. | |
| owned-or-leased | Owns, Leases | The ownership status of the primary company location. |
| ownership-year | The year in which the business was incorporated | |
| parent-name | If this company is a subsidiary This is the name of the company that is is immediate owner. | |
| ultimate-parent-name | This is the name of the company at the top of the ownership structure. The name can be the same as the name element if the company is not a subsidiary . | |
| subsidiary-status | true, false | If the company is partially- or wholly-owned by another organization, this element will be true. |
| minority-owned | true, false | For the purposes of consideration in government contracting, is this company considered to be minority-owned. |
| women-owned | true, false | For the purposes of consideration in government contracting, is this company considered to be women-owned. |
| stocks | This element contains zero or more stock elements that contain country, exchange and symbol attributes on which the company's shares are traded. | |
| naics-list | The North American Industry Classification System (NAICS) code for this company. This element contains zero or more naics elements whose value is the name of the assigned naics and the code attribute is the numerical identifier for the naics. | |
| rankings | This element contains zero or more ranking elements whose value is the name of the ranking list and whose rank attribute is the optional placement of the company on the list. | |
| top-execs | This element contains zero or more exec elements that describe the top executives of the company. The value of the exec element is the name of the executive; the position attribute is the role the person plays in the organization; the optional age attribute is the age, in years, of the executive, and the optional salary attribute is the number in dollars of the executive's yearly salary. | |
| competitors | This element contains zero or more competitor elements whose value are the names of this company's top competition. | |
| location | This element contains the primary address of the company with the following child elements: addr1, addr2, city, sate, country, zip, zip4, latitude, and longitude. | |
| phones | This element contains zero or more phone elements containing the main contact phone numbers for the company. The value of the phone element is the number; the countrycode attribute contains the country code for the number and the areacode element contains the optional area code. The full number would be countrycode-areacode-value. | |
| faxes | This element contains zero of more phone elements containing the main fax numbers for the company. The value of the phone element is the number; the countrycode attribute contains the country code for the number and the areacode element contains the optional area code. The full number would be countrycode-areacode-value. | |
| children | This element contains zero or more child elements indicating subsidary companies. The value of the child element is the name of the subsidary and the acorn attribute is the Acquire Media identifier for that child company. |
Calls to this API return equities pricing information for the requested company.
https://secure.newsedge.com/opensapi/20/company/quote?session=<<SESSION>>&acorn=<<ACORN>>[,<<ACORN>>]
https://secure.newsedge.com/opensapi/20/company/quote?session=<<SESSION>>&ticker=<<EXCHANGE:TICKER>>[,<<EXCHANGE:TICKER>>]
https://secure.newsedge.com/opensapi/20/company/quote?session=<<SESSION>>&cusip=<<CUSIP>>[,<<CUSIP>>]
https://secure.newsedge.com/opensapi/20/company/quote?session=<<SESSION>>&isin=<<ISIN>>[,<<ISIN>>]
| Parameter | Values | Description |
|---|---|---|
| session | The ID of the OPENS API session. Use the user-token value returned from the session/login request. | |
| company identifier | One type of company identifier must be supplied in the request. The available company identifier types are acorn , ticker , cusip , or isin . Multiple company identifiers can be provided in a comma-separated list. |
| Parameter | Values | Description |
|---|---|---|
| json | Default:0 0,1,2 | The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
|
| acorn | The ACquire media ORganizational Number for the company that the filings are desired. It is always a 10 digit number. ACORNs can be found using the company/search API. | |
| ticker | The ticker company identifier is in the form EXCHANGE:TICKER. Both the exchange and ticker for a company can be found using the company/search API. | |
| cusip | The cusip identifier is the 9 character Committee on Uniform Securities Identification Procedures number. The cusip number for a company can be found using the company/search API. | |
| isin | The ISIN identifier is the 12 character International Securities Identification Number. The isin for a company can be found using the company/search API. |
If successful, the company/quote request will return pricing, trading volume and other relevant equities data.
| Name | Values | Description |
|---|---|---|
| count | The number of company quotes requested. | |
| status | OK, PARTIAL-OK, ERROR | If status is OK, then all company elements contain quotation information. If status is PARTIAL-OK, from 1 to count-1 company elements had an error. If status is ERROR, then none of the company identifiers provided were valid. |
| company | The company element contains the quotation information for the company identified by the value attribute. |
| Name | Values | Description |
|---|---|---|
| status | OK, ERROR | If status is OK, the results element will contain links to filings. If status is ERROR, a message element will contain a description of the error. |
| quote | The quote element contains the header, dtstamp, quotation, wk52, and stats child elements. |
The header element contains identifing information about the company requested
| Name | Values | Description |
|---|---|---|
| cusip | The cusip identifier is the 9 character Committee on Uniform Securities Identification Procedures number, if available. | |
| symbol | The ticker symbol of the company. | |
| name | The official name of the company. | |
| desc | An optional, short description of the company. | |
| exch | The exchange on which this equity is traded. | |
| isin | The ISIN identifier is the 12 character International Securities Identification Number,if available. |
The dtstamp element contains information when the quote was last updated.
| Name | Values | Description |
|---|---|---|
| date | This is the date of the last update in the form YYYYMMDD | |
| time_t | This is the time of the last update in 12-hour format HH:MM am/pm | |
| time | This is the time of the last update in 24-hour format HH:MM | |
| date_t | This is the date of the last update in the form MMM. DD, YYYY |
The quotation element contains the values for requested company.
| Name | Values | Description |
|---|---|---|
| pvol | This is the traded volume for the previous trading day. | |
| last | This is the value of the equity at the time specified in the dtstamp element. | |
| curr_str | This is the three-letter code for the currency in which the equity is traded. | |
| hi | This is the highest value the equity has reached during today's trading. | |
| lo | This is the lowest value the equity has reached during today's trading. | |
| vl | This is the volume of trades of this equity during today's session. | |
| chg | This is the magnitude of the change of the price of the equity between yesterday's close and the last reported value. | |
| chg_sign | u,d | This element is 'u' if last is greater than or equal to pcls and 'd' if pcls is greater than last . |
| bid | This is the currently reported bid price. | |
| ask | This is the currently reported ask price | |
| pcls | This is the value of the equity at the close of the previous trading day. | |
| opn | This is the value of the equity at the beginning of the current trading day. | |
| phi | This is the highest value of the equity during the previous trading day. | |
| plo | This is the lowest value of the equity during the previous trading day. | |
| popn | This is the value of the equity at the beginning of the previous trading day. | |
| asksz | The number of shares being offered at the ask price . | |
| bidsz | The number of shares being offered at the ask price . |
This element contains information regarding the 52 week high and low values of the equity.
| Name | Values | Description |
|---|---|---|
| wk52hidate | The date in the past year where the equity reached its highest value in the form YYYYMMDD. | |
| wk52lodate | The date in the past year where the equity reached its lowest value in the form YYYYMMDD. | |
| wk52lo | The lowest value of the equity in the past year. It occured on wk52lodate . | |
| wk52hi | The highest value of the equity in the past year. It occured on wk52hidate . | |
| wk52lodate_t | The date in the past year where the equity reached its lowest value in the form MMM. DD, YYYY. | |
| wk52hidate_t | The date in the past year where the equity reached its highest value in the form MMM. DD, YYYY. |
The stats element contains related information regarding the equity.
| Name | Values | Description |
|---|---|---|
| sho | The sho element is the number of shares outstanding of the equity | |
| sp_rate | ||
| beta | The beta measure of volatility of the equity. | |
| eps | The last reported earnings per share. | |
| pe | The ratio of equity price to earnings. | |
| iad | The indicated annual dividend for the equity. | |
| sic | The standard industry classification code for the company. | |
| yield | The divident yield of the equity. |
Calls to this API return a history of equities pricing information for the requested company.
https://secure.newsedge.com/opensapi/20/company/quotehistory?session=<<user-token>>&acorn=<<ACORN>>
https://secure.newsedge.com/opensapi/20/company/quotehistory?session=<<user-token>>&ticker=<<EXCHANGE:TICKER>>
https://secure.newsedge.com/opensapi/20/company/quotehistory?session=<<user-token>>&cusip=<<CUSIP>>
https://secure.newsedge.com/opensapi/20/company/quotehistory?session=<<user-token>>&isin=<<ISIN>>
| Parameter | Values | Description |
|---|---|---|
| session | The ID of the OPENS API session. Use the user-token value returned from the session/login request. | |
| company identifier | One type of company identifier must be supplied in the request. The available company identifier types are acorn , ticker , cusip , or isin . Multiple company identifiers can be provided in a comma-separated list. |
| Parameter | Values | Description |
|---|---|---|
| json | Default:0 0,1,2 | The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
|
| acorn | The ACquire media ORganizational Number for the company that the filings are desired. It is always a 10 digit number. ACORNs can be found using the company/search API. | |
| ticker | The ticker company identifier is in the form EXCHANGE:TICKER. Both the exchange and ticker for a company can be found using the company/search API. | |
| cusip | The cusip identifier is the 9 character Committee on Uniform Securities Identification Procedures number. The cusip number for a company can be found using the company/search API. | |
| isin | The ISIN identifier is the 12 character International Securities Identification Number. The isin for a company can be found using the company/search API. | |
| period | Default:1D 1D, 1W, 1M, 3M, 6M, 1Y, 2Y, 3Y, 5Y, ALL | The period parameter controls what the time range is covered by the request. The default is 1D meaning the past one day of quote data will be returned. The period time range is always measured backwards from the current time. The time ranged returned may be less than requested if the data is not available. For example, requesting a period of five years for a company that went public 1-1/2 years ago will only return 1-1/2 years of data. The values for period are:
|
| frequency | Default:H H, D, W, M | The frequency parameter controls the amount of time between quote data points in the returned data. The default is H which means hourly data will be returned. The values for frequency are:
|
If successful, the company/quotehistory request will return a data series representing the stock prices for the times indicated and the company requested.
| Name | Values | Description |
|---|---|---|
| count | The number of company quotes requested. | |
| status | OK, PARTIAL-OK, ERROR | If status is OK, then all company elements contain quotation information. If status is PARTIAL-OK, from 1 to count-1 company elements had an error. If status is ERROR, then none of the company identifiers provided were valid. |
| company | The company element contains the quotation information for the company identified by the value attribute. |
| Name | Values | Description |
|---|---|---|
| status | OK, ERROR | If status is OK, the results element will contain a quote data series for the indicated company. If status is ERROR, a message element will contain a description of the error. |
| prhist | The prhist element contains the header and pts child elements. |
The header element contains identifing information about the company requested.
| Name | Values | Description |
|---|---|---|
| symbol | The ticker symbol of the company. | |
| name | The official name of the company. | |
| desc | An optional, short description of the company. | |
| exch | The exchange on which this equity is traded. | |
| act | y, n | The active attribute of the act element indicates if the requested company is still actively being traded. |
The pts element contains obs child elements. The obs child elements each contain a quote history data point.
| Name | Values | Description |
|---|---|---|
| frequency | The frequency attribute reflects the requested data frequency - h, d, w, m. | |
| begdate | The begdate attribute provides the starting date of the data series in YYYYMMDD format. | |
| enddate | The enddate attribute provides the ending date of the data series in YYYYMMDD format. | |
| curr_str | This is the three-letter ISO 4217 code for the currency in which the equity is traded. |
The obs element contains the data points for the requested quote history.
| Name | Values | Description |
|---|---|---|
| curr_str | This is the three-letter ISO 4217 code code for the currency in which the equity is traded. | |
| date | The date for the data point in YYYYMMDD format. | |
| time | If the requested frequency is H, this element contains the hour for the data point in HH:MM:SS format. | |
| hi | This is the high value for the equity requested during the time range covered by this data point. It can be used at the top value in a candlestick display. | |
| lo | This is the low value for the equity requested during the time range covered by this data point. It can be used at the bottom value in a candlestick display. | |
| cl | This is the value of the equity at the date and time for this data point. | |
| vl | This is the volume of traded equities during the time range covered by this data point. |
Calls to the API return a list of supported exchanges and the availability of quotes and filings for those exchanges.
https://secure.newsedge.com/opensapi/20/company/exchanges?session=<<SESSION>>
| Parameter | Values | Description |
|---|---|---|
| session | The ID of the OPENS API session. Use the user-token value returned from the session/login request. |
| Parameter | Values | Description |
|---|---|---|
| json | Default:0 0,1,2 | The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
|
If successful, the company/exchanges request will return a list of stock exchanges supported by the OPENS API and related information.
| Name | Values | Description |
|---|---|---|
| status | OK, ERROR | If status is OK, then the exchanges element contains a list of exchange elements. If status is ERROR, then there was an issue retrieving the exchange information and the message element will describe the error. |
| exchanges | The exchanges element contains a list of exchange elements which contain information that can be in various company-related API calls. |
The exchanges element contains one or more exchange element. Each exchange element has the following attributes.
| Name | Values | Description |
|---|---|---|
| code | The value to use for the EXCHANGE in calls to company-related functions. For example, ticker in company/quote. | |
| name | The formal name of the stock exchange. | |
| mic | If available, this is the ISO 10383 Market Identifier Code for the exchange. | |
| mic_name | If available, this is the exchange name provided by ISO 10383. | |
| country_code | The two-letter country code for the location of the exchange as defined by ISO 3166. | |
| quotes | 0,1 | If the value is 1, then calls to company/quotes for this exchange are supported. |
| filings | 0,1 | If the value is 1, then calls to company/filings for this exchange are supported. |