dark theme
hamburger menu
Styvio API copy link
The Styvio API is a collection of endpoints that return stock market data in JSON format. You can use these responses in your own code to access the data. Learn what each of the endpoints provides and then view examples of how to use them.
Company Information
JSON Object Key: companyInformation
The key "companyInfo" provides data surrounding the business information of a listed equity. This key returns a list of objects that provide details such as a company's description, logo image, and more.
Keys List: shortName, companyDescription, logoURL, marketCap, newsData, companyLocation, companyAddress, hqLatitude, hqLongitude
JSON Object Key: fundamentals
The key "fundamentals" returns data related to the internal value of a stock's company. The "fundamentals" section provides info for balance sheet, income statement, holder insight, and more.
Keys List: balanceSheet, incomeStatement, shareholderBreakdown, institutionalOwners, totalInstitutionalOwners
Price Data
JSON Object Key: priceData
This key provides the pricing data, which is one of the most important pieces of this endpoint. The "priceData" object provides arrays for current and historical stock prices.
Keys List: currentPrice, dailyPrices, weeklyPrices, monthlyPrices, 3MonthPrices, 6MonthPrices, yearlyPrices, 5YearPrices, allTimePrices
Sentiment API copy link
The Styvio sentiment API tracks the positive and negative discussion about tickers across the internet. The sites that are currently supported are Reddit and Stock Twits. Twitter will be added soon. This endpoint returns the bullish, bearish, and netral sentiment as well as the occurences in the top 100 posts for each stock across each social media.
JSON Object Keys: rWallSstreetBetsSentiment, rStocksSentiement, stockTwitsSentiment..
Each key in the sentiment API returns an object for a social media platform. Inside each object, the keys "percentBullish" and "percentBearish" represent the sentiment of the stock on that social media platform. At the end of the API response, there are values representing the overall sentiment across the entire data set.
Keys List: percentBullish, percentBearish, percentNeutral, occurences, totalBullishSentiment, totalBearishSentiment, overallSocialRating
AI Prediction API copy link
The AI Prediction API returns the predicted direction (bullish or bearish), recommended action (buy or sell), price target, current price of the entered stock, and time frame of the prediction.
JSON Object Keys: predictionData
The "predictionData" object conaints the results for the prediction values. There is only one object that will change values depending on if a stock is showing positive or negative conditions.
Keys List: direction, action, priceTarget, currentPrice, timeFrame
ZipLine API
Interacting with your ZipLine storage account is simple with the Styvio API. Each endpoint provides a key feature that you can use inside your applications, such as uploading, downloading, and deleting files. All requests in this section are a POST request with data passed through the body.
Uploading Files copy link
POST Body: {"storageKey": "paste_key_here"} FILES Body: {"uploadFile": "your_file"}
Keys List: connectedUser, uploadedFileID, uploadedFileLink
Use this endpoint to send files from your computer or application to your zipLine storage. This endpoint accepts a file, as well as your storage key (found here) to transfer a file. Place these values inside the body of a POST request to successfuly upload a file to your storage dashboard. The JSON response back will include the CDN link to the file, or you can copy and paste this from the dashboard as well. Note: you must include a file, not a filepath in your call.
Get Download Link copy link
POST Body: {"storageKey": "paste_key_here", "fileID": "file_ID"}
Keys List: connectedUser, downloadLink
This endpoint returns a download link to a zipLine object. All files return a downlad link, so the response to this call can be used in conjunction with Python's requests and os modules to save the file to a path on your machine.
Deleting Files copy link
POST Body: {"storageKey": "paste_key_here", "fileID": "file_ID"}
Keys List: connectedUser, status
To delete a file, POST your storage key as well as the ID of the object you are trying to delete. The response to this call will be a status key with the value "File deleted." If the request was successful.
Get All Objects copy link
POST Body: {"storageKey": "paste_key_here"}
Keys List: connectedUser, allFiles
The allFiles key in this endpoint response contains a list of objects, each with keys of objectName, objectId, and objectLink. This feature is useful if you need bulk information about the objects in your storage bucket.