nta_ruby

NtaRuby

国税庁APIで企業情報を取得するためのgemです。各種情報がobjectとして扱えるようになります。

インストール

この行をgemfileに追記して、

gem 'nta_ruby'

これを実行してください。

$ bundle

もしくは、以下のコマンドをシェルから実行してください。

$ gem install nta_ruby

使用法

国税庁へのAPIのリクエストを送りたいファイルで、まずこの行を追加し、国税庁とのネットワークを確立してください。

# AAAAAAAA: あなたの国税庁APIの認証ID
# 4: 利用したい国税庁APIのバージョン
conn = NtaRuby.new(id: 'AAAAAAAAA', version: 4)

接続できたら、検索条件を指定するとそれに応じたレスポンスが加工されて返却されます。

resp = conn.throw_request(type: :diff, divide: 2, from: Time.zone.local(2019, 9, 1), to: Time.zone.local(2019, 10, 1))
resp.first.name # => '株式会社○△□'

法人番号検索

法人番号が「1111111111111」のもので検索したい場合

resp = conn.throw_request(type: :number, divide: false, number: 1111111111111)
resp.size # => 1
resp.first.name # => '株式会社○△□'

法人番号が「1111111111111」のもので検索したい場合(履歴付き)

resp = conn.throw_request(type: :number, divide: false, number: 1111111111111, history: true)
resp.size # => 3
resp.first.name # => '株式会社○△□'
resp[1].name # => '株式会社×××'

期間検索

2019年9月1日から2019年10月1日の間に更新されたもので検索したい場合

resp = conn.throw_request(type: :diff, divide: 2, from: Time.zone.local(2019, 9, 1), to: Time.zone.local(2019, 10, 1))
resp.size # => 2000
resp.first.name # => '株式会社○△□'

名称検索

名前が「test」のもので検索したい場合(前方一致)

resp = conn.throw_request(type: :name, divide: false, history: true, mode: 1)
resp.size # => 600
resp.first.name # => 'test株式会社'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nta_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the NtaRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.