Introduction
Welcome to the FinBrain API! You can use our API to access FinBrain API endpoints, which can get predictions for markets you have subscribed for API access.
You can view code examples in the dark area to the right, and you can see the example responses in JSON format.
Authentication
FinBrain API uses API keys to allow access to the API. You can get a new FinBrain API Key at your Profile Page on FinBrain Dashboard.
FinBrain API expects for the API Key to be included in all requests to the server in a query string that looks like the following:
token=YOUR_API_KEY
Availables
Get All Markets
curl "https://api.finbrain.tech/v1/available/markets?token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"availableMarkets": [
"S&P 500",
"NASDAQ",
...
]
}
This endpoint retrieves all markets.
HTTP Request
GET https://api.finbrain.tech/v1/available/markets?token=<YOUR_API_KEY>
Get All Tickers
curl "https://api.finbrain.tech/v1/available/tickers/<TYPE>?token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
[
{
"ticker": "AIG",
"name": "American International Group Inc.",
"market": "S&P 500"
},
{
"ticker": "AAPL",
"name": "Apple Inc.",
"market": "S&P 500"
},
...
]
This endpoint retrieves a list of all predicted tickers for given type, that your subscriptions have access.
HTTP Request
GET https://api.finbrain.tech/v1/available/tickers/<TYPE>?token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
TYPE | daily,monthly | Type of the prediction. |
Predictions
Get Market Predictions
curl "https://api.finbrain.tech/v1/market/<MARKET_NAME>/predictions/<TYPE>?token=<YOUR_API_KEY>"
The above command returns JSON structured like this (Example: "S&P 500" Market):
[
{
"ticker": "STX",
"name": "Seagate Technology",
"prediction": {
"expectedShort": "1.24632",
"expectedMid": "1.34583",
"expectedLong": "0.07213",
"technicalAnalysis": "STX price has changed -6.25% in the last 3 days and -0.83% yesterday. RSI is currently neutral but close to the oversold area and the indicator is pointing downwards. MACD is in the Bearish area and the histogram is moving downwards. STX price is trading below the 200-day SMA line and the SMA is trending down. The asset price is between the Middle and the Lower Bollinger Bands. Our Deep Learning algorithms have analyzed the Historical Pricing Data & Technical Indicators & The Market Sentiment numerically for STX and the results are as the followings. FinBrain expects an upward move with a 0.07% change in the asset price within the next 10 days. The predictability of the asset is 62%.",
"lastUpdate": "2020-10-27T23:46:54.359Z",
"type": "daily"
},
"sentimentScore": "-0.137"
},
{
"ticker": "TAP",
"name": "Molson Coors Brewing Company",
"prediction": {
"expectedShort": "0.14241",
"expectedMid": "1.19539",
"expectedLong": "1.34984",
"technicalAnalysis": "TAP price has changed -4.22% in the last 3 days and -3.07% yesterday. RSI is currently neutral but close to the oversold area and the indicator is pointing downwards. MACD is in the Bearish area and the histogram is moving downwards. TAP price is trading below the 200-day SMA line and the SMA is trending down. The asset price is between the Middle and the Lower Bollinger Bands. Our Deep Learning algorithms have analyzed the Historical Pricing Data & Technical Indicators & The Market Sentiment numerically for TAP and the results are as the followings. FinBrain expects an upward move with a 1.35% change in the asset price within the next 10 days. The predictability of the asset is 74%.",
"lastUpdate": "2020-10-27T23:46:54.415Z",
"type": "daily"
},
"sentimentScore": "0.261"
},
...
]
This endpoint retrieves all predictions for given market and prediction type.
HTTP Request
GET https://api.finbrain.tech/v1/market/<MARKET_NAME>/predictions/<TYPE>?token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TYPE | daily,monthly | Type of the prediction. |
Response Mappings
Name | Type | Description |
---|---|---|
ticker | daily,monthly | Ticker listed in the market |
name | daily,monthly | Long name of the related ticker |
expectedShort | daily,monthly | Expected change in percentage for ticker after 3 days / 3 months |
expectedMid | daily,monthly | Expected change in percentage for ticker after 5 days / 6 months |
expectedLong | daily,monthly | Expected change in percentage for ticker after 10 days / 12 months |
technicalAnalysis | daily | Technical Analysis generated by FinBrain AI |
lastUpdate | daily,monthly | Last time FinBrain AI generated prediction for given ticker |
type | daily,monthly | Prediction type returned for the request |
sentimentScore | daily | FinBrain's last sentiment analysis score for the ticker |
Get Ticker Predictions
curl "https://api.finbrain.tech/v1/ticker/<TICKER>/predictions/<TYPE>?token=<YOUR_API_TOKEN>"
The above command returns JSON structured like this (Example: "AAPL"):
{
"ticker": "AAPL",
"name": "Apple Inc.",
"prediction": {
"2024-11-04": "201.33,197.21,205.45",
"2024-11-05": "202.77,196.92,208.61",
"2024-11-06": "203.99,196.90,211.08",
"2024-11-07": "204.68,196.78,212.59",
"2024-11-08": "204.72,195.56,213.88",
"2024-11-11": "203.48,193.22,213.73",
"2024-11-12": "203.32,191.97,214.66",
"2024-11-13": "203.11,190.97,215.26",
"2024-11-14": "203.32,190.66,215.97",
"2024-11-15": "204.05,190.93,217.18",
"expectedShort": "0.22",
"expectedMid": "0.58",
"expectedLong": "0.25",
"technicalAnalysis": "AAPL price has changed 0.73% in the last 3 days and 1.35% yesterday. RSI is currently neutral but close to the overbought area and the indicator is pointing downwards. MACD is in the Bearish area and the histogram is moving upwards. AAPL price is trading above the 200-day SMA line and the SMA is trending up. The asset price is between the Middle and the Lower Bollinger Bands. Our Deep Learning algorithms have analyzed the Historical Pricing Data & Technical Indicators & The Market Sentiment numerically for AAPL and the results are as the followings. FinBrain expects an downward move with a -5.53% change in the asset price within the next 10 days. The predictability of the asset is 78%.",
"type": "daily",
"lastUpdate": "2024-11-01T23:24:18.371Z"
},
"sentimentAnalysis": {
"2024-11-04": "0.186",
"2024-11-01": "0.339",
"2024-10-31": "0.565",
"2024-10-30": "0.437",
"2024-10-29": "0.433",
"2024-10-28": "0.398",
"2024-10-25": "0.443",
"2024-10-24": "0.426",
"2024-10-23": "0.426",
"2024-10-22": "0.426"
}
}
This endpoint retrieves predictions for the next 10 days/12 months for requested tickers.
HTTP Request
GET https://api.finbrain.tech/v1/ticker/<TICKER>/predictions/<TYPE>?token=<YOUR_API_TOKEN>
URL Parameters
Parameter | Values | Description |
---|---|---|
TICKER | one of the tickers | One of the tickers included in your subscriptions |
TYPE | daily,monthly | Type of the prediction. |
Response Mappings
Name | Type | Description |
---|---|---|
ticker | daily,monthly | Ticker listed in the market |
name | daily,monthly | Long name of the related ticker |
dates* | daily,monthly | Predicted closing price of ticker for the given date, as a comma seperated string consisting of "Main Prediction, Lower Confidence Interval, Upper Confidence Interval" |
expectedShort | daily,monthly | Expected change in percentage for ticker after 3 days / 3 months |
expectedMid | daily,monthly | Expected change in percentage for ticker after 5 days / 6 months |
expectedLong | daily,monthly | Expected change in percentage for ticker after 10 days / 12 months |
technicalAnalysis | daily | Technical Analysis generated by FinBrain AI |
lastUpdate | daily,monthly | Last time FinBrain AI generated prediction for given ticker |
type | daily,monthly | Prediction type returned for the request |
sentimentAnalysis | daily | FinBrain's sentiment analysis scores for the ticker |
Sentiments
Get Ticker Sentiments
curl "https://api.finbrain.tech/v1/sentiments/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"ticker": "AMZN",
"name": "Amazon.com Inc.",
"sentimentAnalysis": {
"2021-12-15": "0.223",
"2021-12-14": "0.037",
"2021-12-13": "-0.038"
...
}
}
This endpoint retrieves sentiments for requested tickers.
HTTP Request
GET https://api.finbrain.tech/v1/sentiments/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TICKER | one of the tickers | One of the tickers included in your subscriptions |
DAYS | [1...120] | Past days included in request |
Query String Parameters
Parameter | Values | Description |
---|---|---|
dateFrom | date | Start date of the data (Optional) |
dateTo | date | End date for the data (Optional) |
Response Mappings
Name | Description |
---|---|
ticker | Ticker listed in the market |
name | Long name of the related ticker |
sentimentAnalysis | FinBrain's sentiment analysis scores |
App Ratings
Get App Ratings
curl "https://api.finbrain.tech/v1/appratings/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"ticker": "AMZN",
"name": "Amazon.com Inc",
"appRatings": [
{
"playStoreScore": 3.75,
"playStoreRatingsCount": 567996,
"appStoreScore": 4.07,
"appStoreRatingsCount": 88533,
"playStoreInstallCount": null,
"date": "2024-02-02"
},
{
"playStoreScore": 3.76,
"playStoreRatingsCount": 567421,
"appStoreScore": 4.07,
"appStoreRatingsCount": 88293,
"playStoreInstallCount": null,
"date": "2024-01-26"
},
{
"playStoreScore": 3.76,
"playStoreRatingsCount": 566931,
"appStoreScore": 4.07,
"appStoreRatingsCount": 88036,
"playStoreInstallCount": null,
"date": "2024-01-19"
},
...
]
}
This endpoint retrieves mobile app ratings for requested tickers' mobile application.
HTTP Request
GET https://api.finbrain.tech/v1/appratings/<MARKET_NAME>/<TICKER>?token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TICKER | one of the tickers | One of the tickers included in your subscriptions |
Query String Parameters
Parameter | Values | Description |
---|---|---|
dateFrom | date | Start date of the data (Optional) |
dateTo | date | End date for the data (Optional) |
Response Mappings
Name | Description |
---|---|
ticker | Ticker listed in the market |
name | Long name of the related ticker |
appRatings | FinBrain's mobile app rating analysis |
Analyst Ratings
Get Ticker Analyst Ratings
curl "https://api.finbrain.tech/v1/analystratings/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"ticker": "AMZN",
"name": "Amazon.com Inc.",
"analystRatings": [
{
"date": "2024-02-02",
"type": "Reiterated",
"institution": "Piper Sandler",
"signal": "Neutral",
"targetPrice": "$205 → $190"
},
{
"date": "2024-02-02",
"type": "Reiterated",
"institution": "Monness Crespi & Hardt",
"signal": "Buy",
"targetPrice": "$189 → $200"
},
...
]
}
}
This endpoint retrieves analyst ratings for requested ticker.
HTTP Request
GET https://api.finbrain.tech/v1/analystratings/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TICKER | one of the tickers | One of the tickers included in your subscriptions |
Query String Parameters
Parameter | Values | Description |
---|---|---|
dateFrom | date | Start date of the data (Optional) |
dateTo | date | End date for the data (Optional) |
Response Mappings
Name | Description |
---|---|
ticker | Ticker listed in the market |
name | Long name of the related ticker |
analystRatings | Analyst Ratings for the requested ticker |
House Trades
Get Ticker House Trades
curl "https://api.finbrain.tech/v1/housetrades/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"ticker": "AMZN",
"name": "Amazon.com Inc.",
"houseTrades": [
{
"date": "2024-02-29",
"amount": "$360.00",
"representative": "Pete Sessions",
"type": "Purchase"
},
{
"date": "2024-01-25",
"amount": "$15,001 - $50,000",
"representative": "Shri Thanedar",
"type": "Sale"
},
...
]
}
}
This endpoint retrieves trading activities of US House Representatives for requested ticker.
HTTP Request
GET https://api.finbrain.tech/v1/housetrades/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TICKER | one of the tickers | One of the tickers included in your subscriptions |
Query String Parameters
Parameter | Values | Description |
---|---|---|
dateFrom | date | Start date of the data (Optional) |
dateTo | date | End date for the data (Optional) |
Response Mappings
Name | Description |
---|---|
ticker | Ticker listed in the market |
name | Long name of the related ticker |
houseTrades | Trading activities of US House Representatives |
Insider Transactions
Get Ticker Insider Transactions
curl "https://api.finbrain.tech/v1/insidertransactions/<MARKET_NAME>/<TICKER>?token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"ticker": "AMZN",
"name": "Amazon.com Inc.",
"insiderTransactions": [
{
"date": "Mar 08 '24",
"insiderTradings": "Selipsky Adam",
"relationship": "CEO Amazon Web Services",
"transaction": "Sale",
"cost": 176.31,
"shares": 500,
"USDValue": 88155,
"totalShares": 133100,
"SECForm4Date": "2001-03-11T16:34:00.000Z",
"SECForm4Link": "http://www.sec.gov/Archives/edgar/data/1018724/000101872424000058/xslF345X05/wk-form4_1710189274.xml"
},
...
]
}
}
This endpoint retrieves insider transactions for requested ticker.
HTTP Request
GET https://api.finbrain.tech/v1/insidertransactions/<MARKET_NAME>/<TICKER>?token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TICKER | one of the tickers | One of the tickers included in your subscriptions |
Response Mappings
Name | Description |
---|---|
ticker | Ticker listed in the market |
name | Long name of the related ticker |
insiderTransactions | Insider Transactions for the ticker |
LinkedIn Data
Get Ticker LinkedIn Data
curl "https://api.finbrain.tech/v1/linkedindata/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"ticker": "AMZN",
"name": "Amazon.com Inc.",
"linkedinData": [
{
"date": "2024-03-20",
"employeeCount": 755461,
"followersCount": 30628460
},
...
]
}
}
This endpoint retrieves LinkedIn data for requested ticker.
HTTP Request
GET https://api.finbrain.tech/v1/linkedindata/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TICKER | one of the tickers | One of the tickers included in your subscriptions |
Query String Parameters
Parameter | Values | Description |
---|---|---|
dateFrom | date | Start date of the data (Optional) |
dateTo | date | End date for the data (Optional) |
Response Mappings
Name | Description |
---|---|
ticker | Ticker listed in the market |
name | Long name of the related ticker |
linkedinData | LinkedIn Data for the requested ticker |
Put/Call Data
Get Ticker Put/Call Data
curl "https://api.finbrain.tech/v1/putcalldata/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>"
The above command returns JSON structured like this:
{
"ticker": "AMZN",
"name": "Amazon.com Inc.",
"putCallData": [
{
"date": "2024-03-19",
"ratio": 0.4,
"callCount": 788319,
"putCount": 315327
},
...
]
}
}
This endpoint retrieves Put/Call data for requested ticker.
HTTP Request
GET https://api.finbrain.tech/v1/putcalldata/<MARKET_NAME>/<TICKER>?dateFrom=2024-01-01&dateTo=2024-02-02&token=<YOUR_API_KEY>
URL Parameters
Parameter | Values | Description |
---|---|---|
MARKET_NAME | one of the markets | One of the markets you have subscribed. |
TICKER | one of the tickers | One of the tickers included in your subscriptions |
Query String Parameters
Parameter | Values | Description |
---|---|---|
dateFrom | date | Start date of the data (Optional) |
dateTo | date | End date for the data (Optional) |
Response Mappings
Name | Description |
---|---|
ticker | Ticker listed in the market |
name | Long name of the related ticker |
putCallData | Put/Call Data for the requested ticker |
Errors
The FinBrain API uses the following error codes:
Error Code | Meaning |
---|---|
400 | Bad Request -- Your request is invalid. |
401 | Unauthorized -- Your API key is wrong. |
403 | Forbidden -- You don't have rights to make this request. |
404 | Not Found -- Requested data is not found. |
405 | Method Not Allowed -- You tried to access an endpoint we don't support. |
500 | Internal Server Error -- We had a problem with our server. Try again later. |