Git Product home page Git Product logo

tefas-crawler's Introduction

Tefas Crawler

PyPI version License: MIT Python Versions Package Status CI Build

Crawl public invenstment fund information from Turkey Electronic Fund Trading Platform (TEFAS) with ease.

Installation

pip install tefas-crawler

Usage

Import the Crawler object and create an instance of it.

from tefas import Crawler

tefas = Crawler()

API

fetch(start, end, name, columns)

Argument Type Description Required
start string or datetime.datetime The date that fund information is crawled for. Yes
end string or datetime.datetime End of the period that fund information is crawled for. No
name string Name of the fund. If not given, all funds will be returned. No
columns[] list of string List of columns to be returned. No

Examples

Get all funds for a given day.

data = tefas.fetch(start="2020-11-20")

Get a specific fund for a time period, and select columns.

data = tefas.fetch(start="2020-11-15", end="2020-11-20", name="YAC", columns=["code", "date", "price"])

Data Schema

As of today, we support the following data schema from Tefas:

Column Description Type
date Sate date
price Price of the fund for a given date string
code Short code of the fund string
title Full name of the fund string
market_cap Total value of the fund float
number_of_shares Number of outstanding shares float
number_of_investors Number of participants float
tmm Share of tmm float
repo Share of repo float
other Share of other float
stock Share of stock float
eurobonds Share of eurobonds float
bank_bills Share of bank bills float
derivatives Share of derivatives float
reverse_repo Share of reverse-repo float
term_deposit Share of term deposit float
treasury_bill Share of treasury bill float
foreign_equity Share of foreign equity float
government_bond Share of government bond float
precious_metals Share of precious metals float
commercial_paper Share of commercial paper float
fx_payable_bills Share of fx payable bills float
foreign_securities Share of foreign securities float
private_sector_bond Share of private sector bond float
participation_account Share of participation account float
foreign_currency_bills Share of foreign currency bills float
asset_backed_securities Share of asset-backed securities float
real_estate_certificate Share of real estate certificate float
foreign_debt_instruments Share of foreign debt instruments float
government_lease_certificates Share of government lease certificates float
fund_participation_certificate Share of fund participation certificate float
government_bonds_and_bills_fx Share of government bonds and bills (fx) float
private_sector_lease_certificates Share of private sector lease certificates float

To-do

  • Increase test coverage
  • Request error handling
  • Cache query results

License

MIT

tefas-crawler's People

Contributors

burakyilmaz321 avatar tanerelmalik avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.