NAV Navbar
shell
  • Introduction
  • Authentication
  • Search
  • Account Information
  • Historical Data
  • Reference
  • Search
  • Industry Classification
  • Market Hours
  • Security Type List
  • Errors
  • Introduction

    Welcome to the Fitch Data API! You can use our API to access the Fitch Data Services API endpoints, which can get information on various companies and stocks in our database.

    Authentication

    To authorize, use this code:

    # With shell, you can just pass the correct header with each request
    curl "api_endpoint_here?key=APIKEY"
    

    Make sure to replace APIKEY with your API key.

    Fitch Data uses API keys to allow access to the API. You can register a new Fitch Data API key here.

    Fitch Data expects for the API key to be included in all API requests that handle historical stock data:

    key=APIKEY

    Search

    curl "https://api.fitchdata.com/search?query=AAPL"
    

    The above command returns JSON structured like this:

      {
        "success": true,
        "results": [
          { "symbol": "AAPL", "name": "Apple Inc." },
          { "symbol": "MSFT", "name": "Microsoft Corp." },
          { "symbol": "BBRY", "name": "Blackberry Inc." }
        ]
      }
    
    curl "https://api.fitchdata.com/search/advanced"
    

    The above command returns JSON structured like this:

      {
        "success": true,
        "indusries": {},
        "sectors": {},
        "results": [
    
        ]
      }
    

    Recent IPOs/Listing

    curl "https://api.fitchdata.com/search/ipo"
    

    The above command returns JSON structured like this:

      {
        "success": true,
        "indusries": {},
        "sectors": {},
        "results": [
    
        ]
      }
    

    Account Information

    Access

    curl "https://api.fitchdata.com/account/access"
    

    The above command returns JSON structured like this:

      {
        "success": true,
        "account": {
          "type": "Analyst",
          "status": "Active",
          "limit": 500000
        },
        "month": {
          "start": "2018-01-01 16:00:01",
          "usage": 2234,
          "usagePercent": 10.2,
          "remaining": 22345
        }
      }
    

    Usage History

    curl "https://api.fitchdata.com/account/log"
    

    The above command returns JSON structured like this:

    Historical Data

    Daily (EOD) Data

    curl "https://api.fitchdata.com/pricing/historical/day?symbol=AAPL&key=APIKEY"
    

    The above command returns JSON structured like this:

      {
        "symbol": "AAPL",
        "startDate": "2018-01-03",
        "endDate": "2018-04-10",
        "resolution": "daily",
        "content": {
          "pre": [],
          "intra": [],
          "after": [],
          "preIntra": [],
          "preAfter": [],
          "intraAfter": [],
          "preIntraAfter": []
        }
      }
    

    This endpoint returns daily stock data also known as End of Day (EOD) data for the selected security.

    The data is the aggregate of all stock transaction each day represented in Open, High, Low, Close, Volume (OHLCV) format.

    For each day, data is shown for different combinations of markets hours.

    HTTP Request

    GET https://api.fitchdata.com/pricing/historical/day

    Query Parameters

    Parameter Required Description
    key Yes Your API key
    symbol Yes Security ticker/symbol
    start No Starting date of data range
    end No Ending date of data range

    Minute Data

    curl "https://api.fitchdata.com/pricing/historical/minute?symbol=AAPL&key=APIKEY"
    

    The above command returns JSON structured like this:

      {
        "symbol": "AAPL",
        "date": "2018-01-03",
        "resolution": "minute",
        "content": {
          "pre": [
            { "date": "2018-01-03", "time": "4:00", "open": 12, "high": 13, "low": 14, "close": 15, "volume": 22304 }
            { "date": "2018-01-03", "time": "4:01", "open": 12, "high": 13, "low": 14, "close": 15, "volume": 22304 }
          ],
          "intra": [
            { "date": "2018-01-03", "time": "9:00", "open": 12, "high": 13, "low": 14, "close": 15, "volume": 22304 }
            { "date": "2018-01-03", "time": "9:01", "open": 12, "high": 13, "low": 14, "close": 15, "volume": 22304 }
          ],
          "after": [
            { "date": "2018-01-03", "time": "16:00", "open": 12, "high": 13, "low": 14, "close": 15, "volume": 22304 }
            { "date": "2018-01-03", "time": "16:01", "open": 12, "high": 13, "low": 14, "close": 15, "volume": 22304 }
          ],
        }
      }
    

    This endpoint returns minute stock data for the selected security.

    The data is the aggregate of all stock transaction for each minute of the day, represented in Open, High, Low, Close, Volume (OHLCV) format. The data is split into 3 parts according to market hours, that is Pre-Market, Intra-Day and After-Market.

    HTTP Request

    GET https://api.fitchdata.com/pricing/historical/minute

    Query Parameters

    Parameter Required Description
    key Yes Your API key
    symbol Yes Security ticker/symbol
    day Yes Trading day

    Tick Data

    curl "https://api.fitchdata.com/pricing/historical/tick?symbol=AAPL&key=APIKEY"
    

    The above command returns JSON structured like this:

      {
        "symbol": "AAPL",
        "date": "2018-01-03",
        "resolution": "tick",
        "content": {
          "pre": [],
          "intra": [],
          "after": [],
        }
      }
    

    This endpoint returns tick stock data for the selected security. This data is the set of all transactions on every single U.S. exchange along with relevant information about each trade.

    Just like the minute and day endpoints, tick data is split according to market hours. Bear in mind that tick data can be quite heavy for popular, high volumes stock such as AAPL.

    HTTP Request

    GET https://api.fitchdata.com/pricing/historical/tick

    Query Parameters

    Parameter Required Description
    key Yes Your API key
    symbol Yes Security ticker/symbol
    day Yes Trading day

    Reference

    Security Information

    curl "https://api.fitchdata.com/reference/stock?symbol=AAPL&key=APIKEY"
    

    The above command returns JSON structured like this:

      {
        "symbol": "AAPL",
        "securityName": "Apple Inc.",
        "securityType": "Common Stock",
        "calendar": {
            "start": "2013-01-01",
            "end": "2019-01-04"
        } 
      }
    

    This endpoint retrieves information related to the security matching the symbol provided as parameter. This includes the company address, geo-location, contact information and much more.

    HTTP Request

    GET https://api.fitchdata.com/reference/stock

    Query Parameters

    Parameter Required Description
    key Yes Your API key
    symbol Yes Security ticker/symbol

    Search

    Search by ticker/symbol

    curl "https://api.fitchdata.com/search/securities?query=AA&key=APIKEY"
    

    The above command returns JSON structured like this:

      "count": 220,
      "content": [
        {
          "symbol": "AAPL",
          "securityName": "Apple Inc.",
          "securityType": "Common Stock",
          "exchange": "Nasdaq",
          "logo": "..."
        }
        {
          "symbol": "MSFT",
          "securityName": "Microsoft Corp.",
          "securityType": "Common Stock",
          "exchange": "Nasdaq",
          "logo": "..."
        }
      ]
    

    This endpoint retrieves securities with a ticker/symbol matching the specified query term.

    HTTP Request

    GET https://api.fitchdata.com/search/securities

    Query Parameters

    Parameter Required Description
    key Yes Your API key
    query Yes Search query term to match with ticker/symbol
    curl "https://api.fitchdata.com/search/filter?key=APIKEY"
    

    The above command returns JSON structured like this:

      "exchange": [],
      "sector": [],
      "industry": [],
      "type": [],
      "status": [],
      "stocks": [
        {
          "symbol": "AAPL",
          "securityName": "Apple Inc.",
          "securityType": "Common Stock",
          "exchange": "Nasdaq",
          "logo": "..."
        }
        {
          "symbol": "MSFT",
          "securityName": "Microsoft Corp.",
          "securityType": "Common Stock",
          "exchange": "Nasdaq",
          "logo": "..."
        }
      ]
    

    This endpoint retrieves all securities that match the specified search parameters. Example: To retrieve all preferred shares traded on NYSE, you can set the "exchange" parameter to "NYSE" and the "type" parameter to "Preferred Stock".

    HTTP Request

    GET https://api.fitchdata.com/search/filter

    Query Parameters

    Parameter Required Description
    key Yes Your API key
    exchange No Security's listing stock exchange. Example: NYSE
    type No Security's type. Example: ETF
    sector No Security's affiliated sector. Example: Technology
    industry No Security's affiliated industry. Example: Investment Banks
    status No Security's trading status. You can set it to "Active" or "Inactive"

    Industry Classification

    Sector List

    The following table lists different industry sectors and their definitions. These sectors can be used as a parameter for the filtered search endpoint.

    Sector Definition
    Consumer Discretionary Shares of US companies listed on a US exchange
    Consumer Staples Shares of US companies listed on a US exchange
    Energy Companies engaged in production and distribution of energy products such as electricity
    Finance Companies engaged in financial services such as Banks, Investment Companies
    Health Care Shares of US companies listed on a US exchange
    Industrial Shares of US companies listed on a US exchange
    Materials Companies related to the mining and distribution of
    Real Estate Companies related to buying/leasing land, developing it and managing it.
    Technology This includes computer companies
    Transportation This includes computer companies
    Utilities This includes computer companies
    Other Unclassified companies according to sector affiliation

    Industry List

    The following table lists different industies, their corresponding sector, and their definitions. These industries can be used as a parameter for the filtered search endpoint.

    Industry Sector Definition
    Apparel Consumer Discretionary Garments, Shoes, Clothes
    Automobile Consumer Discretionary Car Engines, Car Manufacturing
    Building Materials Consumer Discretionary Building bricks, building supplies

    Market Hours

    Equity markers are open from 9:30 am to 4:00 pm every trading day in the U.S. Trading does occur though before 9:30 am and after 4:00 pm during trading sessions referred to as extended market hours.

    In order to give you good view of historical data, we decided to include extended hours trading to our historical datasets. The following table showcases the different market hours that apply to U.S. Equity markets and the general activity they reflect.

    Name Time Range Activity
    Pre-Market 4:00 am EST to 9:30 am EST Institutional Trades
    Intraday 9:30 am EST to 4:00 pm EST Retail and Institutional Trades
    After-Market 4:00 pm EST to 8:00 pm EST Institutional Trades

    Security Type List

    The following table lists different security equity types and their definitions. These types can be used as parameter for the filtered search endpoint.

    Type Definition
    Common Stock Shares of US companies listed on a US exchange
    Common Stock (ADR) American Depositary Shares - Shares of foreign company listed in the US
    Preferred Stock Shares of a US company that give more features than common shares
    Preferred Stock (ADR) American Depositary Shares - Preferred Shares of a foreign company listed in the US
    ETF Exchange Traded Fund - Basket of stocks generally tracking an index. Includes ETNs
    Fund Funds listed on US exchanges. This includes mutual funds.
    Structured Product Complied product based on a variety of listed financial products.
    Warrant Derivative that allows buyer to acquire a security for a specified price before expiration.
    Other Unclassified Equity Securities listed on US exchanges.

    Errors

    The Kittn 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 -- The kitten requested is hidden for administrators only.
    404 Not Found -- The specified kitten could not be found.
    405 Method Not Allowed -- You tried to access a kitten with an invalid method.
    406 Not Acceptable -- You requested a format that isn't json.
    410 Gone -- The kitten requested has been removed from our servers.
    418 I'm a teapot.
    429 Too Many Requests -- You're requesting too many kittens! Slow down!
    500 Internal Server Error -- We had a problem with our server. Try again later.
    503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.