API Reference
The Grufity API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
To authenticate the request, utilize the Grufity API along with the API key available on your profile page.
The capability to perform bulk requests is not supported by the Grufity API. Each request allows you to work on a single object at a time.
The Grufity API differs for every account as we release new versions and tailor functionality. These docs are customized to your version of the API and display data, which only you can see.
BASE URL
CLIENT LIBRARIES
Select your preferred language.
Grufity API collection
Grufity Developer API's collection contain various API's to fetch various metrics for a stock ticker or macro-economic data. This can be used to get both historical and latest metrics.
Step 1: Send requests
RESTful APIs allow you to perform GET operations using the GET HTTP method.
This collection contains request for various sample data. Open each request, put your API key in header and click "Send" to fetch the result.
You can find you API key in your profile page.
You can find you API key in your profile page.
Step 2: View responses
Observe the response tab for status code (
200 OK
), response time, and size.| AUTHORIZATION API Key | |
|---|---|
| Key | X-API-KEY |
| Value | <Please Replace this with your API Key> |
Stock API's
Collection of APIs to fetch Stock Metrics and Historical Stocks and Macro-Economic data.
| AUTHORIZATION API Key |
|---|
| This folder is using API Key from collection Grufity API collection |
Get Latest Stock Metrics
https://api.grufity.com/stock/getallmetrics?ticker=AAPLThis GET request is used to "get" latest metrics data for a ticker. Use query parameters to specify the ticker you want data on (e.g., in this request, we have
ticker=AAPL
).A successful GET response will have a
200 OK
status, and will include JSON data with latest stock metrics for the specified stock.| HEADERS | |
|---|---|
| X-API-KEY | <Please Replace this with your API Key> |
Get Historical Metrics Data
https://api.grufity.com/stock/gethistoricaldata?code=AAPL.REV.TTMThis GET request is used to "get" historical data for a single metrics of a ticker. Use query parameters to specify the metrics code you want data on (e.g.,
code=AAPL.REV.TTM
).| Name | Abbreviation |
|---|---|
| Revenue | REV |
| Net Income | NETINC |
| Cost of Revenue | COSTREV |
| Earnings Before Taxes | EBT |
| Assets | ASSETS |
| Liabilities | LIABS |
| Shareholder's Equity | SEQ |
| Cash and Cash Equivalents | CASHEQ |
| Depreciation Amortization | DEPAMOR |
| Long Term Debt | DEBT.LT |
| Cashflow From Operations | CFOPER |
| Cashflow From Financing Activities | CFFIN |
| Cashflow From Investing Activities | CFINV |
| Price to Sales | PS |
| Price to Earnings | PE |
| Return on Equity | ROE |
| Return on Assets | ROA |
Health Check
The
/health
endpoints let you check overall health of Grufity API Server.