{"id":18211968,"url":"https://github.com/jacekmaciag/xtb","last_synced_at":"2025-09-30T07:31:33.605Z","repository":{"id":258205852,"uuid":"871986377","full_name":"jacekmaciag/xtb","owner":"jacekmaciag","description":"XTB API client for Ruby","archived":false,"fork":false,"pushed_at":"2024-12-23T19:40:39.000Z","size":129,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-04T12:11:38.089Z","etag":null,"topics":["gem","rails","ruby-gem","xapi","xtb","xtb-api","xtb-trading"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jacekmaciag.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":"jacekmaciag","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2024-10-13T13:51:06.000Z","updated_at":"2024-12-23T19:40:43.000Z","dependencies_parsed_at":"2024-11-17T15:33:19.562Z","dependency_job_id":"b82ca9eb-88e3-4bee-85a6-f1561bf430c0","html_url":"https://github.com/jacekmaciag/xtb","commit_stats":{"total_commits":21,"total_committers":1,"mean_commits":21.0,"dds":0.0,"last_synced_commit":"3e281c5e1fda57f5b075fa635901de4849358231"},"previous_names":["jacekmaciag/xtb"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekmaciag%2Fxtb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekmaciag%2Fxtb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekmaciag%2Fxtb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekmaciag%2Fxtb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jacekmaciag","download_url":"https://codeload.github.com/jacekmaciag/xtb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234575231,"owners_count":18854925,"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":["gem","rails","ruby-gem","xapi","xtb","xtb-api","xtb-trading"],"created_at":"2024-11-03T15:04:12.792Z","updated_at":"2025-09-30T07:31:33.601Z","avatar_url":"https://github.com/jacekmaciag.png","language":"Ruby","funding_links":["https://patreon.com/jacekmaciag"],"categories":[],"sub_categories":[],"readme":"## ⚠️ End of life notice\n\nXTB has announced that they will be discontinuing the API access on 14th of March 2025.\nThis gem will no longer work after that date and will be archived.\n\n# XTB API client for Ruby\n\nXtb is a Ruby implementation of the [XTB broker API (xAPI) version 2.5.0](http://developers.xstore.pro/documentation/2.5.0).\nAt the time of writing this it's the latest version of the API.\nThis gem allows you to connect to the XTB broker and execute trades, get account information, and more.\n\n## Installation\n\nInstall the gem and add to the application's Gemfile by executing:\n\n    $ bundle add xtb\n\nIf bundler is not being used to manage dependencies, install the gem by executing:\n\n    $ gem install xtb\n\n## Usage\n\n### Configuration\n\nBefore you can connect to the XTB API, you need to configure the connection.\n\n```ruby\nXtb.configure do |config|\n  config.user_id = 'your_user_id'\n  config.password = 'your_password'\nend\n```\n\nNOTE: If you're using the Ruby on Rails framework, you can put the configuration in the `config/application.rb` file.\n\nHere's a list of all available configuration options:\n```ruby\n\n```\n\n### Connect to the XTB API\n\n```ruby\nrequire 'xtb'\n\n# You're ready to use the API\nXtb::Command::CurrentUserData.call\n```\nNote that there is no need to log in first or log out afterwards. The gem handles the connection for you.\n\n### Subscribing to the XTB API streaming commands\n\nYour message handler class should implement the `#call` method that will be called when a message is received from the XTB API.\n\n```ruby\nXtb.configure do |config|\n  config.user_id = 'your_user_id'\n  config.password = 'your_password'\n  config.wss.message_handler = 'SomeClass'\nend\n```\n\n## Development\n\nAfter 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.\n\nTo 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/jacekmaciag/xtb.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacekmaciag%2Fxtb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjacekmaciag%2Fxtb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacekmaciag%2Fxtb/lists"}