# MaveFund API Client Library
<img alt="logo" height="120" src="mavefund.jpg" title="mavefund logo" />
The official library for [mavefund](https://mavefund.com) used to download data from
the API as pandas dataframes for easy accessibility.
created and maintained by [ddjerqq](https://github.com/ddjerqq)
## Installation
Run this in your terminal:
```bash
pip install mavefund
```
## Getting started
* To use the library you need to acquire an API key from [the official website](https://mavefund.com)
* After that import the library into your python code
```python
import mavefund as mf
with mf.Client(api_key="YOUR KEY") as client:
apple_df = client("AAPL")
# access the dataframe here
```
## Documentation
### [Client](https://github.com/ddjerqq/mavefund_library/blob/master/mavefund/client.py)
#### creation:
There are two ways to create a client, a context manager and a regular object.
```python
from mavefund import Client
# context manager (recommended)
with Client(api_key="KEY") as client:
apple_df = client("AAPL")
# regular object
client = Client("KEY")
df = client("AAPL")
client.close()
```
### [Symbol Mapping](https://github.com/ddjerqq/mavefund_library/blob/master/mavefund/symbol.py)
#### General
cnm -> company_name
tck -> symbol
dt -> symbol_date
#### GrowthProfitability
gp_rum -> gp_revenue_usd_mil
gp_gm -> gp_gross_margin
gp_oim -> gp_operating_income_usd_mil
gp_om -> gp_operating_margin
gp_nim -> gp_net_income_usd_mil
gp_eps -> gp_earnings_per_share_usd
gp_d -> gp_dividends_usd
gp_pr -> gp_payout_ratio
gp_sm -> gp_shares_mil
gp_bvps -> gp_book_value_per_share_usd
gp_ocf -> gp_operation_cash_flow_usd_mil
gp_csp -> gp_cap_spending_usd_mil
gp_fcf -> gp_free_cash_flow_usd_mil
gp_fcfps -> gp_free_cash_flow_per_share_usd
gp_wc -> gp_working_capital_usd_mil
#### ProfitabilityMargin
pm_r -> pm_revenue
pm_cogs -> pm_cogs
pm_gm -> pm_gross_margin
pm_sga -> pm_sg_and_a
pm_rd -> pm_r_and_d
pm_o -> pm_other
pm_om -> pm_operating_margin
pm_nii -> pm_net_interest_income_and_other
pm_ebm -> pm_ebt_margin
#### Profitability
p_trp -> p_tax_rate_perc
p_nm -> p_net_margin_perc
p_at -> p_asset_turnover
p_roa -> p_return_on_assets
p_fl -> p_financial_leverage
p_roe -> p_return_on_equity
p_roic -> p_return_on_invested_capital
p_ic -> p_interest_coverage
#### Growth
g_rp_1 -> g_revenue_perc_over_1_year_average
g_rp_3 -> g_revenue_perc_over_3_years_average
g_rp_5 -> g_revenue_perc_over_5_years_average
g_rp_10 -> g_revenue_perc_over_10_years_average
g_opi_1 -> g_operating_income_perc_over_1_year_average
g_opi_3 -> g_operating_income_perc_over_3_years_average
g_opi_5 -> g_operating_income_perc_over_5_years_average
g_opi_10 -> g_operating_income_perc_over_10_years_average
g_ni_1 -> g_net_income_perc_over_1_year_average
g_ni_3 -> g_net_income_perc_over_3_years_average
g_ni_5 -> g_net_income_perc_over_5_years_average
g_ni_10 -> g_net_income_perc_over_10_years_average
g_eps_1 -> g_eps_perc_over_1_year_average
g_eps_3 -> g_eps_perc_over_3_years_average
g_eps_5 -> g_eps_perc_over_5_years_average
g_eps_10 -> g_eps_perc_over_10_years_average
#### CashFlow
cf_ocf -> cf_operating_cash_flow_growth_perc_yoy
cf_fcfgp -> cf_free_cash_flow_growth_perc_yoy
cf_ceag -> cf_cap_ex_as_growth_perc_of_sales
cf_fcfos -> cf_free_cash_flow_over_sales_perc
cf_fcfoni -> cf_free_cash_flow_over_net_income
#### FinancialHealth
fh_casti -> fh_cash_and_short_term_investments
fh_ar -> fh_accounts_receivable
fh_inv -> fh_inventory
fh_oca -> fh_other_current_assets
fh_tca -> fh_total_current_assets
fh_nppe -> fh_net_pp_and_e
fh_int -> fh_intangibles
fh_olta -> fh_other_long_term_assets
fh_ta -> fh_total_assets
fh_ap -> fh_accounts_payable
fh_std -> fh_short_term_debt
fh_tp -> fh_taxes_payable
fh_al -> fh_accrued_liabilities
fh_ostl -> fh_other_short_term_liabilities
fh_tcl -> fh_total_current_liabilities
fh_ltd -> fh_long_term_debt
fh_oltl -> fh_other_long_term_liabilities
fh_tl -> fh_total_liabilities
fh_tse -> fh_total_stockholders_equity
fh_tle -> fh_total_liabilities_and_equity
#### Liquidity
lqd_cr -> lqd_current_ratio
lqd_qr -> lqd_quick_ratio
lqd_fl -> lqd_financial_leverage
lqd_doe -> lqd_debt_over_equity
#### Efficiency
efc_dso -> efc_days_sales_outstanding
efc_di -> efc_days_inventory
efc_pp -> efc_payable_period
efc_ccc -> efc_cash_conversion_cycle
efc_rt -> efc_receivable_turnover
efc_it -> efc_inventory_turnover
efc_fat -> efc_fixed_asset_turnover
efc_at -> efc_asset_turnover
Raw data
{
"_id": null,
"home_page": "https://github.com/ddjerqq/mavefund",
"name": "mavefund",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mavefund stocks investing datascience finance",
"author": "ddjerqq",
"author_email": "ddjerqq@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/07/15/a765b949d1ff49d0d798be8edb7e95253a52b99e983972c9ee996f754c5c/mavefund-0.0.8.tar.gz",
"platform": null,
"description": "# MaveFund API Client Library\n\n<img alt=\"logo\" height=\"120\" src=\"mavefund.jpg\" title=\"mavefund logo\" />\n\nThe official library for [mavefund](https://mavefund.com) used to download data from\nthe API as pandas dataframes for easy accessibility.\n\ncreated and maintained by [ddjerqq](https://github.com/ddjerqq)\n\n## Installation\n\nRun this in your terminal:\n```bash\npip install mavefund\n```\n\n## Getting started\n\n* To use the library you need to acquire an API key from [the official website](https://mavefund.com)\n* After that import the library into your python code\n\n```python\nimport mavefund as mf\nwith mf.Client(api_key=\"YOUR KEY\") as client:\n apple_df = client(\"AAPL\")\n# access the dataframe here\n```\n\n## Documentation\n\n### [Client](https://github.com/ddjerqq/mavefund_library/blob/master/mavefund/client.py)\n#### creation:\nThere are two ways to create a client, a context manager and a regular object.\n\n```python\nfrom mavefund import Client\n\n# context manager (recommended)\nwith Client(api_key=\"KEY\") as client:\n apple_df = client(\"AAPL\")\n\n \n# regular object\nclient = Client(\"KEY\")\ndf = client(\"AAPL\")\nclient.close()\n```\n\n### [Symbol Mapping](https://github.com/ddjerqq/mavefund_library/blob/master/mavefund/symbol.py)\n\n#### General\n\n cnm -> company_name\n tck -> symbol\n dt -> symbol_date\n\n#### GrowthProfitability\n\n gp_rum -> gp_revenue_usd_mil\n gp_gm -> gp_gross_margin\n gp_oim -> gp_operating_income_usd_mil\n gp_om -> gp_operating_margin\n gp_nim -> gp_net_income_usd_mil\n gp_eps -> gp_earnings_per_share_usd\n gp_d -> gp_dividends_usd\n gp_pr -> gp_payout_ratio\n gp_sm -> gp_shares_mil\n gp_bvps -> gp_book_value_per_share_usd\n gp_ocf -> gp_operation_cash_flow_usd_mil\n gp_csp -> gp_cap_spending_usd_mil\n gp_fcf -> gp_free_cash_flow_usd_mil\n gp_fcfps -> gp_free_cash_flow_per_share_usd\n gp_wc -> gp_working_capital_usd_mil\n \n#### ProfitabilityMargin\n\n pm_r -> pm_revenue\n pm_cogs -> pm_cogs\n pm_gm -> pm_gross_margin\n pm_sga -> pm_sg_and_a\n pm_rd -> pm_r_and_d\n pm_o -> pm_other\n pm_om -> pm_operating_margin\n pm_nii -> pm_net_interest_income_and_other\n pm_ebm -> pm_ebt_margin\n\n#### Profitability\n\n p_trp -> p_tax_rate_perc\n p_nm -> p_net_margin_perc\n p_at -> p_asset_turnover\n p_roa -> p_return_on_assets\n p_fl -> p_financial_leverage\n p_roe -> p_return_on_equity\n p_roic -> p_return_on_invested_capital\n p_ic -> p_interest_coverage\n\n#### Growth\n\n g_rp_1 -> g_revenue_perc_over_1_year_average\n g_rp_3 -> g_revenue_perc_over_3_years_average\n g_rp_5 -> g_revenue_perc_over_5_years_average\n g_rp_10 -> g_revenue_perc_over_10_years_average\n\n g_opi_1 -> g_operating_income_perc_over_1_year_average\n g_opi_3 -> g_operating_income_perc_over_3_years_average\n g_opi_5 -> g_operating_income_perc_over_5_years_average\n g_opi_10 -> g_operating_income_perc_over_10_years_average\n\n g_ni_1 -> g_net_income_perc_over_1_year_average\n g_ni_3 -> g_net_income_perc_over_3_years_average\n g_ni_5 -> g_net_income_perc_over_5_years_average\n g_ni_10 -> g_net_income_perc_over_10_years_average\n\n g_eps_1 -> g_eps_perc_over_1_year_average\n g_eps_3 -> g_eps_perc_over_3_years_average\n g_eps_5 -> g_eps_perc_over_5_years_average\n g_eps_10 -> g_eps_perc_over_10_years_average\n\n#### CashFlow\n\n cf_ocf -> cf_operating_cash_flow_growth_perc_yoy\n cf_fcfgp -> cf_free_cash_flow_growth_perc_yoy\n cf_ceag -> cf_cap_ex_as_growth_perc_of_sales\n cf_fcfos -> cf_free_cash_flow_over_sales_perc\n cf_fcfoni -> cf_free_cash_flow_over_net_income\n\n#### FinancialHealth\n\n fh_casti -> fh_cash_and_short_term_investments\n fh_ar -> fh_accounts_receivable\n fh_inv -> fh_inventory\n fh_oca -> fh_other_current_assets\n fh_tca -> fh_total_current_assets\n fh_nppe -> fh_net_pp_and_e\n fh_int -> fh_intangibles\n fh_olta -> fh_other_long_term_assets\n fh_ta -> fh_total_assets\n fh_ap -> fh_accounts_payable\n fh_std -> fh_short_term_debt\n fh_tp -> fh_taxes_payable\n fh_al -> fh_accrued_liabilities\n fh_ostl -> fh_other_short_term_liabilities\n fh_tcl -> fh_total_current_liabilities\n fh_ltd -> fh_long_term_debt\n fh_oltl -> fh_other_long_term_liabilities\n fh_tl -> fh_total_liabilities\n fh_tse -> fh_total_stockholders_equity\n fh_tle -> fh_total_liabilities_and_equity\n\n#### Liquidity\n\n lqd_cr -> lqd_current_ratio\n lqd_qr -> lqd_quick_ratio\n lqd_fl -> lqd_financial_leverage\n lqd_doe -> lqd_debt_over_equity\n\n#### Efficiency\n\n efc_dso -> efc_days_sales_outstanding\n efc_di -> efc_days_inventory\n efc_pp -> efc_payable_period\n efc_ccc -> efc_cash_conversion_cycle\n efc_rt -> efc_receivable_turnover\n efc_it -> efc_inventory_turnover\n efc_fat -> efc_fixed_asset_turnover\n efc_at -> efc_asset_turnover\n\n\n",
"bugtrack_url": null,
"license": "GNU",
"summary": "The official API client for the MaveFund.com",
"version": "0.0.8",
"split_keywords": [
"mavefund",
"stocks",
"investing",
"datascience",
"finance"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "a9286eea799de5f1eb7748074891aea7",
"sha256": "c8ed98e54b0c870eaa4f4c5db006f3dc186dcf7c9c2fd61807d55c8d5a47a89c"
},
"downloads": -1,
"filename": "mavefund-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "a9286eea799de5f1eb7748074891aea7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14318,
"upload_time": "2022-12-29T20:43:45",
"upload_time_iso_8601": "2022-12-29T20:43:45.318278Z",
"url": "https://files.pythonhosted.org/packages/07/15/a765b949d1ff49d0d798be8edb7e95253a52b99e983972c9ee996f754c5c/mavefund-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-29 20:43:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ddjerqq",
"github_project": "mavefund",
"lcname": "mavefund"
}
JSON
