Skip to main content

A wrapper to the XigniteGlobalHistorical API

Project description

XigniteGH

GitHub Workflow Status PyPI GitHub last commit GitHub issues GitHub

Python module to get historical stock data from the XigniteGlobalHistorical API

XigniteGH is a wrapper to the XigniteGlobalHistorical API. This module implements a python interface to the API provided by Xignite. A token is required.

Install

To install the package use:

pip install xignitegh

Usage

import pandas as pd
from xignitegh import Xignite

xgh = Xignite(_token="TOKEN", _token_userid=USERID)

quotes = xgh.get_quotes(ticker="AAPL", years=1)
if quotes["Outcome"] == "Success":
    name = quotes["Security"]["Name"]

dividends = xgh.get_dividends(ticker="AAPL", years=1)
if dividends["Outcome"] == "Success":
    df = pd.json_normalize(dividends["CashDividends"])

The token may also be stored in the environment variable XIGNITE_TOKEN. The token userid is optional and used only with encrypted tokens.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xignitegh-0.2.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xignitegh-0.2.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file xignitegh-0.2.0.tar.gz.

File metadata

  • Download URL: xignitegh-0.2.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for xignitegh-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bd806924e8c862a5da3a526937eeca5307fefcd267e95ea87ffe93ee9ec8dee5
MD5 0049a8ee27a30911faaf7af8efcc68d6
BLAKE2b-256 a85c22800d516294d5713d6ddb90d2c6b9da190e33b3072f1524584124dca145

See more details on using hashes here.

File details

Details for the file xignitegh-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: xignitegh-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for xignitegh-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b2d870c7b6d412ed84b3cc7862cf33aef3288ca9cebc3c370dfcfd519f4ebb12
MD5 ef480bef32c277cfb6dee1a45378dcd3
BLAKE2b-256 0f32c45c9d19a6821b327dd887af8c49a6528c259387f0dff5b847e77a3e36ee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page