getProfile API

The getProfile API is used to request information about a company, such as sector, industry, company description, CEO, recent earnings, P/E ratio, and address, based on a symbol.

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:

symbols (required)
A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. (list)
Example: AAPL,GOOG

fields (optional)
The fields requested. (list)
Example: qtrOneEarnings,qtrTwoEarnings,qtrThreeEarnings,qtrFourEarnings


OUTPUTS:

symbol (always returned)
A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. (string)
exchange (always returned)
Exchange code for the marketplace where the financial instruments are listed. (string)
exchangeName (always returned)
The name of the marketplace. (string)
sicSector (always returned)
A four-digit code for classifying industries. (string)
industry (always returned)
A code that identifies a group of businesses that produce similar products or services. (string)
subIndustry (always returned)
A more specific group of businesses within an industry that produce similar products or services. (string)
indexMembership (as requested)
Indices which a stock may be part of, like the DJIA or S&P 500. (list)
businessSummary (always returned)
A description of the company. (string)
ceo (always returned)
The Chief Executive Officer. (string)
qtrOneEarnings (as requested)
The most recent 1st quarter earnings. (double)
qtrOneEarningsDate (as requested)
The reported date of the most recent 1st quarter earnings. (date)
qtrTwoEarnings (as requested)
The most recent 2nd quarter earnings. (double)
qtrTwoEarningsDate (as requested)
The reported date of the most recent 2nd quarter earnings. (date)
qtrThreeEarnings (as requested)
The most recent 3rd quarter earnings. (double)
qtrThreeEarningsDate (as requested)
The reported date of the most recent 3rd quarter earnings. (date)
qtrFourEarnings (as requested)
The most recent 4th quarter earnings. (double)
qtrFourEarningsDate (as requested)
The reported date of the most recent 4th quarter earnings. (date)
peRatio (as requested)
The ratio of a company's current share price relative to its earnings (price divided by earnings). (string)
epsGrowth (as requested)
The annual rate of earnings per share growth over the trailing one-year period. (string)
recentEarnings (as requested)
The last reported quarterly earnings value. (string)
annualEPS (as requested)
The most recent annual net income divided by the number of shares outstanding. (string)
address (always returned)
The address of the company's headquarters. (string)
city (always returned)
The city of the company's headquarters. (string)
state (always returned)
The state of the company's headquarters. (string)
zipCode (always returned)
The zip code of the company's headquarters. (string)
phoneNumber (always returned)
The company's main phone number. (string)

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.