MintzyDocs

API Section

Mintzy is a financial information technology company delivering data-driven market forecasting and financial consulting across global financial markets. Our API-driven framework enables scenario-based forecasting for equities, derivatives, and crypto assets.

Getting Started

This guide helps you set up the Mintzy SDK and make your first API request within minutes. The SDK is designed for developers, quantitative researchers, and system integrators who require programmatic access to market forecasting and analytical services.

Get Your Access Token

All Mintzy API requests require authentication via an access token.

To generate your token:

  1. Sign in to the Mintzy dashboard
  2. Navigate to the API or account settings section
  3. Generate a new access token

Important: Store your access token securely. Requests made with invalid or expired tokens will return authentication errors.

Authentication

Access Token Authentication

Mintzy uses token-based authentication to validate API requests. Each client instance must be initialized with a valid access token before making any API calls.

Initialization Example
python
from Minting import Client

client = Client(access_token="<TOKEN_GENERATED>")

Installation

Python Requirements

The Mintzy SDK requires Python 3.7 or higher. Download Python from the official website and follow the installation instructions for your operating system:

https://www.python.org/downloads

Verify Python Installation

Confirm that Python is installed correctly:

bash
python --version

Install the Mintzy SDK

Install the Mintzy SDK using pip. All required dependencies are installed automatically, including requests, pymongo, pandas, and flask.

bash
pip install Minting

Verify SDK Installation

Verify that the SDK is installed and accessible:

bash
python -c "import Minting; print(Minting.__version__)"

Make Your First Prediction

Use the Mintzy client to fetch scenario-based market predictions. Initialize the client with your access token and call the prediction method to retrieve forecasted data.

example.py
python
from Minting import Client

# Initialize Client
client = Client(access_token="YOUR_ACCESS_TOKEN")

# Make Prediction
prediction = client.get_prediction(
    tickers=["RELIANCE"], 
    timeframe="4 hours", 
    parameters=["close"]
)

print(prediction)

API Reference

METHODclient.get_prediction

Retrieves market predictions for one or more tickers and returns the results in a structured table.

Response Format

The response is formatted with the following columns:

TickerDateTimePredicted Price

Parameters

ParametersTypeDescription
tickerslistList of stock tickers
timeframestringPrediction horizon (e.g., "4 hours")
parameterslistPrediction fields such as "close"

Supported Tickers

A non-exhaustive list of supported assets available for forecasting.

ABBACCADANIGREENADANITOTALAPOLLOHOSPBAJAJHLDNGBANDHANBNKBERGEPAINTBOSCHLTDCANBKCIPLADABURDLFDRREDDYHAVELLSHDFCAMCICICIGIICICIPRULIINDUSTOWERINFOEDGEJINDALSTELJSWENERGYLUPINMARICOMOTHERSONMUTHOOTFINNMDCOILPAGEINDPIINDPNBRECLTDSHREECEMSIEMENSSRFTATACHEMTATACONSUMTATAELXSITORNTPHARMTRENTUBLZOMATOALKEMASTRALAUROPHARMACOLPALCONCORFEDERALBNKLICIMRFNAUKRITORNTPOWERTCSHDFCBANKBHARTIARTLICICIBANKSBININFYBAJFINANCEHINDUNILVRITCMARUTIHCLTECHSUNPHARMAKOTAKBANKAXISBANKULTRACEMCOBAJAJFINSVADANIPORTSNTPCONGCASIANPAINTJSWSTEELADANIPOWERWIPROADANIENTPOWERGRIDNESTLEINDCOALINDIAINDIGOHINDZINCTATASTEELVEDLSBILIFEEICHERMOTGRASIMHINDALCOLTIMTVSMOTORDIVISLABHDFCLIFEPIDILITINDCHOLAFINBRITANNIAAMBUJACEMGAILBANKBARODAGODREJCPHEROMOTOCOTATAPOWER

Tutorials

Troubleshooting Summary

For a complete list of error codes and detailed fixes, please see the above.

Invalid Access Token
Unsupported Tickers
No Data Available
Installation Errors