DeltaExchange

A Ruby client for the Delta Exchange API.

Quick Links

Resource	Document	Description
Orders	REST API Guide	Create, manage, and cancel orders
Products	REST API Guide	Fetch trading pairs and market specs
WebSocket	WebSocket Guide	Real-time data streams
Auth	Authentication	API Key & Signature management

Installation

Add this line to your application's Gemfile:

gem 'delta_exchange'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install delta_exchange

Releasing

Publishing is handled by GitHub Actions when a version tag is pushed.

One-time RubyGems setup

Configure delta_exchange as a trusted publisher on RubyGems.org:

Open the gem page on RubyGems.org and manage trusted publishers.
Add this GitHub repository:
- Owner: shubhamtaywade82
- Repository: delta_exchange
- Workflow file: release.yml
- Environment: release
Save the publisher configuration.

This uses GitHub OIDC trusted publishing, so the workflow does not need a long-lived RUBYGEMS_API_KEY or OTP secret. RubyGems must match all four values exactly.

Release a new version

Update lib/delta_exchange/version.rb.
Update CHANGELOG.md.
Merge the changes to main.
Create and push a matching tag:

git tag v0.1.2
git push origin v0.1.2

The release workflow validates that the tag matches DeltaExchange::VERSION before publishing the gem to RubyGems.org.

Documentation

For detailed guides and examples, see:

Usage

Configuration

DeltaExchange.configure do |config|
  config.api_key = ENV['DELTA_API_KEY'] || 'YOUR_API_KEY'
  config.api_secret = ENV['DELTA_API_SECRET'] || 'YOUR_API_SECRET'
  config.testnet = true # Optional, defaults to false
  config.websocket_reconnect_delay = 5 # Optional, defaults to 5 seconds
end

Note: If you are testing the client via ./bin/console, it will automatically load any variables from a .env file in the root directory into ENV.

REST API

The client employs a highly robust ActiveRecord-style abstraction via the DeltaExchange::Models:: namespace. Rather than interacting with raw unstructured JSON payloads via Client.new, you query the platform utilizing structured properties and class-level queries.

1. Products & Market Data

Retrieve available trading pairs, orderbooks, and option chains natively.

# Get all products (returns array of Models::Product)
DeltaExchange::Models::Product.all

product = DeltaExchange::Models::Product.find('BTCUSD')
puts product.contract_type # "perpetual_futures"

# Get all live tickers and access price via .close (India API standard)
ticker = DeltaExchange::Models::Ticker.find('BTCUSD')
puts "Current Price: #{ticker.close}"

# Get all live tickers
DeltaExchange::Models::Ticker.all

# Mutating methods like set_leverage return the raw API response hash
response = product.set_leverage(50)
puts "New Leverage: #{response[:leverage]}"

2. Orders

Create, manage, and cancel your active orders.

# Create a new order (Returns a Models::Order)
order = DeltaExchange::Models::Order.create({
  product_id: 1,
  size: 10,
  side: 'buy',
  order_type: 'limit_order',
  limit_price: '50000'
})

# Access properties
puts order.status # "open"

# List your active orders
DeltaExchange::Models::Order.all

# Cancel the order directly from its instance
order.cancel

3. Positions & Fills

Track open derivatives positions and execution histories cleanly.

You can instantly execute commands atop the models natively using class methods. This bypasses structural scaffolding because the library manages connections globally by default!

# Retrieve Native Ruby Objects instead of messy Array Hashes
orders = DeltaExchange::Models::Order.all

# Manipulate endpoints using direct class directives
DeltaExchange::Models::Position.close_all(
  product_id: 27 # BTCUSD testnet
)

# Find an isolated position by Product ID
position = DeltaExchange::Models::Position.find(1)

# Modify your isolated positions natively
position.adjust_margin('150.5', type: 'add')
position.set_auto_topup(true)

# Retrieve recent trade fills (Returns an array of Models::Fill)
DeltaExchange::Models::Fill.all(product_id: 1, limit: 50)

4. Account & Wallet

Monitor balances and configure account-level preferences.

# Get wallet balances across all assets
DeltaExchange::Models::WalletBalance.all

# Isolate a specific currency balance
btc_balance = DeltaExchange::Models::WalletBalance.find_by_asset('BTC')

# List recent wallet transactions
DeltaExchange::Models::WalletTransaction.all

# View your user profile details
profile = DeltaExchange::Models::Profile.fetch
puts "Hello #{profile.first_name}!"

# Update trading preferences natively
prefs = DeltaExchange::Models::TradingPreferences.fetch
puts "User ID: #{prefs.user_id}"
prefs.update(cancel_on_disconnect: true)

5. Assets & Indices

Pull infrastructure parameters mapping indices to component assets.

# Get all platform assets
DeltaExchange::Models::Asset.all

# Get all tracked indices
DeltaExchange::Models::Index.all

Error Handling

The gem wraps network and API responses within native Ruby classes.

begin
  client.orders.create({ product_id: 999999, size: 10 })
rescue DeltaExchange::RateLimitError => e
  puts "Rate limited! Retry after #{e.retry_after_seconds} seconds"
rescue DeltaExchange::ApiError => e
  puts "API rejected the request: #{e.message} (Code: #{e.code})"
rescue DeltaExchange::NetworkError => e
  puts "Could not connect: #{e.message}"
end

WebSocket

Important

The WebSocket client uses EventMachine in a detached thread. While the gem handles automatic reconnections, you must ensure your main process remains alive (e.g., via loop { sleep 1 } or joining the EM thread).

ws = DeltaExchange::Websocket::Client.new

ws.on :open do |event|
  puts "Connected!"
  ws.subscribe([
    { name: "v2/ticker", symbols: ["BTCUSD"] }
  ])
end

ws.on :message do |data|
  puts "Received: #{data}"
end

ws.connect!

# Keep the main thread alive if necessary
loop { sleep 1 }

Debugging

You can enable HTTP traffic logging via the command-line environment variables. The api-key and signature headers are automatically redacted during debug rendering to protect your credentials.

DELTA_DEBUG=true ruby app.rb

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/shubhamtaywade82/delta_exchange.

License

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

delta_exchange

Development

Runtime