FtxExchangeApi

Supports

• Ruby 2.2 ~ 2.7

Installation

gem 'ftx_exchange_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ftx_exchange_api

Configuration

Set timeout time

# default config
FtxExchangeApi.default_config.timeout = 3 # seconds

# custom config
FtxExchangeApi::PublicApi.new(config: { timeout: 12 })
FtxExchangeApi::PrivateApi.new(access_key, secret_key, config: { timeout: 12 })

Logging

require 'logger'

# default config
FtxExchangeApi.default_config.logger = Logger.new(STDOUT) # print log to stdand output
FtxExchangeApi.default_config.logger = Logger.new('log/api.log')

# custom config
FtxExchangeApi::PublicApi.new(config: { logger: Logger.new(STDOUT) })
FtxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: Logger.new(STDOUT) })

Usage

Public Api Examples

@api = FtxExchangeApi::PublicApi.new

GET /markets

Get markets

Show code

@api.markets

GET /markets/{market_name}

Get single market

Show code

@api.markets(market_name)

GET /markets/{market_name}/orderbook?depth={depth}

Get orderbook

Show code

# use default parameters
@api.orderbook(market_name)

# provide all possible parameters
@api.orderbook(market_name, depth: 3)

Private Api Examples

access_key = 'YOUR_ACCESS_KEY'
secret_key = 'YOUR_SECRET_KEY'

@api = FtxExchangeApi::PrivateApi.new(access_key, secret_key)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/khiav223577/ftx_exchange_api. 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.