Skip to content
/ wtdpy Public

Basic calls to the World Trading Data API with Python.

Notifications You must be signed in to change notification settings

uijl/wtdpy

Repository files navigation

CircleCI Status Documentation Status Coverage Badge PyPI Latest Release

WTDpy

Basic calls to the World Trading Data API with Python. You can find the documentation over here.

Installation

Installing WTDpy via pip is the preferred method, as it will always install the most recent stable release. If you do not have pip installed, this Python installation guide can guide you through the process.

To install WTDpy, run this command in your terminal:

# Use pip to install wtdpy
pip install wtdpy

Downloading and installing WTDpy from source is also possible, follow the code below.

# Download the package
git clone https://github.com/uijl/wtdpy

# Go to the correct folder
cd wtdpy

# Install package
pip install -e .

Starting up

The code snip below shows how you can initialise the WTDpy class. As soon as you have the WTDpy class initialised you can start calling the various functions.

# Import wtdpy library
from wtdpy import WTDpy

# Specifiy your api key
api_token = "Your_API_Token"

# Initialise class
wtdpy = WTDpy(api_token=api_token)

# Search for a stock or index
MSFT = wtdpy.search("Microsoft")