tap-jquants is a Singer tap for JQuants.

Built with the Meltano Tap SDK for Singer Taps.

• Pulls raw data from J-Quants
• Extracts the following resources:
  • daily_quotes
  • announcement
  • dividend
  • fs_details
  • statements
  • index_option
  • topix
  • listed_info
  • breakdown
  • prices_am
  • short_selling
  • trades_spec
  • weekly_margin_interest
  • trading_calendar

Install from GitHub:

pipx install git+https://github.com/stn/tap-jquants.git@main

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening

A full list of supported settings and capabilities for this tap is available by running:

tap-jquants --about

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

You need mail_address and password for J-Quants API.

You can easily run tap-jquants by itself or in a pipeline using Meltano.

tap-jquants --version
tap-jquants --help
tap-jquants --config CONFIG --discover > ./catalog.json

Follow these instructions to contribute to this project.

pipx install poetry
poetry install

Create tests within the tests sub-folder and then run:

poetry run pytest

You can also test the tap-jquants CLI interface directly using poetry run:

poetry run tap-jquants --help

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-jquants
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-jquants --version
# Configure the tap-jquants:
meltano config tap-jquants set --interactive
# Select streams:
meltano select tap-jquants topix "*"
# And run a test `elt` pipeline:
meltano run tap-jquants target-jsonl

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.

• J-Quants API Reference
• J-Quants API Reference (English)
• Meltanoとtap-jquantsを用いたELT