client-python icon indicating copy to clipboard operation
client-python copied to clipboard

I want to add `net_income_loss` field for stock financials vx api

Open tsugumi-sys opened this issue 1 year ago • 1 comments

The net_income_loss field is not found in this library (data model definition), but the original api endpoint returns the net_income_loss field.

image https://polygon.io/docs/stocks/get_vx_reference_financials

Can we add this field and other related fields for this library? I'd like to contribute if it's ok :)

tsugumi-sys avatar Jul 24 '24 06:07 tsugumi-sys

Thanks for posting this I'll check it out. Thanks for the PR.

justinpolygon avatar Jul 24 '24 20:07 justinpolygon

This is fixed now via https://github.com/polygon-io/client-python/pull/817 and is in the latest release https://github.com/polygon-io/client-python/releases/tag/v1.14.3.

You should be able to just run pip install -U polygon-api-client to get the latest update.

Here's an example for fetching diluted_earnings_per_share and net_income_loss:

from polygon import RESTClient

client = RESTClient()  # POLYGON_API_KEY environment variable is used

financials = []
for f in client.vx.list_stock_financials("AAPL", filing_date="2024-11-01"):
    financials.append(f)

    # get diluted_earnings_per_share
    print(f.financials.income_statement.diluted_earnings_per_share)

    # get net_income_loss
    print(f.financials.income_statement.net_income_loss)

Here's the output:

$ python3 examples/rest/stocks-stock_financials.py

DataPoint(
    label="Diluted Earnings Per Share",
    order=4300,
    unit="USD / shares",
    value=6.08,
    derived_from=None,
    formula=None,
    source=None,
    xpath=None,
)
DataPoint(
    label="Net Income/Loss",
    order=3200,
    unit="USD",
    value=93736000000.0,
    derived_from=None,
    formula=None,
    source=None,
    xpath=None,
)
DataPoint(
    label="Diluted Earnings Per Share",
    order=4300,
    unit="USD / shares",
    value=6.08,
    derived_from=None,
    formula=None,
    source=None,
    xpath=None,
)
DataPoint(
    label="Net Income/Loss",
    order=3200,
    unit="USD",
    value=93736000000.0,
    derived_from=None,
    formula=None,
    source=None,
    xpath=None,
)

justinpolygon avatar Jan 09 '25 17:01 justinpolygon