getCompetitors API

The getCompetitors API provides a list of related stock symbols (competitors) for an underlying stock input.

Pricing is based on the number of monthly queries and fields requested. We offer four packages: Small, Medium, Large, Enterprise. Contact us for additional details.


API Documentation

INPUTS:

symbol (required)
A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. For futures, notation such as <root_symbol*0> for the active contract or <root_symbol*1> for the first nearby is supported, as is <root_symbol^F> for all futures contracts for a given root symbol, as is <root_symbol^O> for all options contracts for a given underlying futures symbol. (string)
Example: AAPL

fields (optional)
The fields requested. (list)
Example: fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate

maxRecords (optional)
The maximum number of records to show in the return. (int)
Default: 10
Example: 10


OUTPUTS:

symbol (always returned)
A symbol or code that identifies a financial instrument. (string)
name (always returned)
The full name of the instrument. (string)
exchange (as requested)
Exchange code for the marketplace where the financial instruments are listed. (string)
marketCap (always returned)
The quantity of shares or contracts traded. (int)
fiftyTwoWkHigh (as requested)
The highest price over the past 52 weeks. (double)
fiftyTwoWkHighDate (as requested)
The date in which the high price was reached over the past 52 weeks. (date)
fiftyTwoWkLow (as requested)
The low price over the past 52 weeks. (double)
fiftyTwoWkLowDate (as requested)
The date in which the low price was reached over the past 52 weeks. (date)

STATUS CODE RESPONSES:

200 OK Success
400 Bad Request The request was invalid, please see the message for more information.
500 Internal Server Error Something is not working correctly, please contact support.