{"id":20995679,"url":"https://github.com/ddjerqq/mavefund_library","last_synced_at":"2025-09-02T22:33:24.540Z","repository":{"id":115431781,"uuid":"581563889","full_name":"ddjerqq/mavefund_library","owner":"ddjerqq","description":"The official library for mavefund used to download data from the API as pandas dataframes for easy accessibility. created and maintained by ddjerqq","archived":false,"fork":false,"pushed_at":"2022-12-29T20:46:11.000Z","size":72,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-04T09:39:58.270Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ddjerqq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-23T15:03:45.000Z","updated_at":"2025-03-01T16:40:52.000Z","dependencies_parsed_at":"2023-07-23T13:00:44.524Z","dependency_job_id":null,"html_url":"https://github.com/ddjerqq/mavefund_library","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddjerqq%2Fmavefund_library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddjerqq%2Fmavefund_library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddjerqq%2Fmavefund_library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddjerqq%2Fmavefund_library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ddjerqq","download_url":"https://codeload.github.com/ddjerqq/mavefund_library/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243410445,"owners_count":20286395,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T07:25:28.020Z","updated_at":"2025-03-13T13:11:45.119Z","avatar_url":"https://github.com/ddjerqq.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MaveFund API Client Library\n\n\u003cimg alt=\"logo\" height=\"120\" src=\"mavefund.jpg\" title=\"mavefund logo\" /\u003e\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 -\u003e company_name\n    tck -\u003e symbol\n    dt -\u003e symbol_date\n\n#### GrowthProfitability\n\n    gp_rum    -\u003e gp_revenue_usd_mil\n    gp_gm     -\u003e gp_gross_margin\n    gp_oim    -\u003e gp_operating_income_usd_mil\n    gp_om     -\u003e gp_operating_margin\n    gp_nim    -\u003e gp_net_income_usd_mil\n    gp_eps    -\u003e gp_earnings_per_share_usd\n    gp_d      -\u003e gp_dividends_usd\n    gp_pr     -\u003e gp_payout_ratio\n    gp_sm     -\u003e gp_shares_mil\n    gp_bvps   -\u003e gp_book_value_per_share_usd\n    gp_ocf    -\u003e gp_operation_cash_flow_usd_mil\n    gp_csp    -\u003e gp_cap_spending_usd_mil\n    gp_fcf    -\u003e gp_free_cash_flow_usd_mil\n    gp_fcfps  -\u003e gp_free_cash_flow_per_share_usd\n    gp_wc     -\u003e gp_working_capital_usd_mil\n    \n#### ProfitabilityMargin\n\n    pm_r      -\u003e pm_revenue\n    pm_cogs   -\u003e pm_cogs\n    pm_gm     -\u003e pm_gross_margin\n    pm_sga    -\u003e pm_sg_and_a\n    pm_rd     -\u003e pm_r_and_d\n    pm_o      -\u003e pm_other\n    pm_om     -\u003e pm_operating_margin\n    pm_nii    -\u003e pm_net_interest_income_and_other\n    pm_ebm    -\u003e pm_ebt_margin\n\n#### Profitability\n\n    p_trp     -\u003e p_tax_rate_perc\n    p_nm      -\u003e p_net_margin_perc\n    p_at      -\u003e p_asset_turnover\n    p_roa     -\u003e p_return_on_assets\n    p_fl      -\u003e p_financial_leverage\n    p_roe     -\u003e p_return_on_equity\n    p_roic    -\u003e p_return_on_invested_capital\n    p_ic      -\u003e p_interest_coverage\n\n#### Growth\n\n    g_rp_1    -\u003e g_revenue_perc_over_1_year_average\n    g_rp_3    -\u003e g_revenue_perc_over_3_years_average\n    g_rp_5    -\u003e g_revenue_perc_over_5_years_average\n    g_rp_10   -\u003e g_revenue_perc_over_10_years_average\n\n    g_opi_1   -\u003e g_operating_income_perc_over_1_year_average\n    g_opi_3   -\u003e g_operating_income_perc_over_3_years_average\n    g_opi_5   -\u003e g_operating_income_perc_over_5_years_average\n    g_opi_10  -\u003e g_operating_income_perc_over_10_years_average\n\n    g_ni_1    -\u003e g_net_income_perc_over_1_year_average\n    g_ni_3    -\u003e g_net_income_perc_over_3_years_average\n    g_ni_5    -\u003e g_net_income_perc_over_5_years_average\n    g_ni_10   -\u003e g_net_income_perc_over_10_years_average\n\n    g_eps_1   -\u003e g_eps_perc_over_1_year_average\n    g_eps_3   -\u003e g_eps_perc_over_3_years_average\n    g_eps_5   -\u003e g_eps_perc_over_5_years_average\n    g_eps_10  -\u003e g_eps_perc_over_10_years_average\n\n#### CashFlow\n\n    cf_ocf    -\u003e cf_operating_cash_flow_growth_perc_yoy\n    cf_fcfgp  -\u003e cf_free_cash_flow_growth_perc_yoy\n    cf_ceag   -\u003e cf_cap_ex_as_growth_perc_of_sales\n    cf_fcfos  -\u003e cf_free_cash_flow_over_sales_perc\n    cf_fcfoni -\u003e cf_free_cash_flow_over_net_income\n\n#### FinancialHealth\n\n    fh_casti  -\u003e fh_cash_and_short_term_investments\n    fh_ar     -\u003e fh_accounts_receivable\n    fh_inv    -\u003e fh_inventory\n    fh_oca    -\u003e fh_other_current_assets\n    fh_tca    -\u003e fh_total_current_assets\n    fh_nppe   -\u003e fh_net_pp_and_e\n    fh_int    -\u003e fh_intangibles\n    fh_olta   -\u003e fh_other_long_term_assets\n    fh_ta     -\u003e fh_total_assets\n    fh_ap     -\u003e fh_accounts_payable\n    fh_std    -\u003e fh_short_term_debt\n    fh_tp     -\u003e fh_taxes_payable\n    fh_al     -\u003e fh_accrued_liabilities\n    fh_ostl   -\u003e fh_other_short_term_liabilities\n    fh_tcl    -\u003e fh_total_current_liabilities\n    fh_ltd    -\u003e fh_long_term_debt\n    fh_oltl   -\u003e fh_other_long_term_liabilities\n    fh_tl     -\u003e fh_total_liabilities\n    fh_tse    -\u003e fh_total_stockholders_equity\n    fh_tle    -\u003e fh_total_liabilities_and_equity\n\n#### Liquidity\n\n    lqd_cr    -\u003e lqd_current_ratio\n    lqd_qr    -\u003e lqd_quick_ratio\n    lqd_fl    -\u003e lqd_financial_leverage\n    lqd_doe   -\u003e lqd_debt_over_equity\n\n#### Efficiency\n\n    efc_dso   -\u003e efc_days_sales_outstanding\n    efc_di    -\u003e efc_days_inventory\n    efc_pp    -\u003e efc_payable_period\n    efc_ccc   -\u003e efc_cash_conversion_cycle\n    efc_rt    -\u003e efc_receivable_turnover\n    efc_it    -\u003e efc_inventory_turnover\n    efc_fat   -\u003e efc_fixed_asset_turnover\n    efc_at    -\u003e efc_asset_turnover\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddjerqq%2Fmavefund_library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fddjerqq%2Fmavefund_library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddjerqq%2Fmavefund_library/lists"}