Skip to content

feat: Add JSONClient to allow access to raw JSON response from J-Quants API #60

@hiohiohio

Description

@hiohiohio

Is there an existing issue for this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe.

As a user of the jquants-api-client-python library, I would like to request the addition of a JSONClient to provide access to the raw JSON response from the J-Quants API. Currently, the library does not offer an option to access the JSON data directly, as it converts the API responses into Pandas dataframes by default.

By implementing a JSONClient, users who prefer to work with raw JSON data or use other data processing libraries can easily access the API responses in their desired format. This added flexibility will cater to a wider range of use cases and user preferences.

A potential example of how the JSONClient could be used is as follows:

import jquantsapi

my_mail_address = "*****"
my_password = "*****"
json_cli = jquantsapi.JSONClient(mail_address=my_mail_address, password=my_password)

response_json = json_cli.get_prices_daily_quotes(
    start_dt=datetime(2022, 7, 25, tzinfo=tz.gettz("Asia/Tokyo")),
    end_dt=datetime(2022, 7, 26, tzinfo=tz.gettz("Asia/Tokyo")),
)

In this example, response_json would contain the raw JSON response from the J-Quants API.

Thank you for considering this feature request. Adding a JSONClient would improve the overall user experience of the jquants-api-client-python library by offering greater flexibility and catering to diverse user needs.

Describe the solution you'd like.

No response

Describe an alternate solution.

No response

Anything else? (Additional Context)

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions