Official SDK for the TradeWatch.io API.

TradeWatch.io is a market data platform and API for real-time and historical prices across crypto, stocks, indices, currencies, and commodities.

Want to test endpoints without writing code first? Use the TradeWatch Interactive API Playground to run requests directly in your browser.

• REST API reference: https://tradewatch.io/docs/api-reference/introduction
• WebSocket API reference: https://tradewatch.io/docs/websocket-api/introduction
• Support channels: https://tradewatch.io/docs/platform/support

1. Create an API key in the TradeWatch Dashboard.
2. Follow platform setup docs: Getting started.

• Documentation
• Reference
• Usage
• Environments
• Errors
• Advanced
  • Retries
  • Timeouts
  • Additional Headers
  • Additional Query Parameters
• Contributing

API reference documentation is available here.

A full reference for this library is available here.

Instantiate and use the client with the following:

require "tradewatch"

client = Tradewatch::Client.new(api_key: "<value>")

client.crypto.get_quote(
  symbol: "BTC-USD",
  precision: 2
)

This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.

require "tradewatch"

tradewatch = Tradewatch::Client.new(
    base_url: Tradewatch::Environment::DEFAULT
)

require "tradewatch"

client = Tradewatch::Client.new(
    base_url: "https://example.com"
)

Failed API calls will raise errors that can be rescued from granularly.

require "tradewatch"

client = Tradewatch::Client.new(
    base_url: "https://example.com"
)

begin
    result = client.crypto.get_quote
rescue Tradewatch::Errors::TimeoutError
    puts "API didn't respond before our timeout elapsed"
rescue Tradewatch::Errors::ServiceUnavailableError
    puts "API returned status 503, is probably overloaded, try again later"
rescue Tradewatch::Errors::ServerError
    puts "API returned some other 5xx status, this is probably a bug"
rescue Tradewatch::Errors::ResponseError => e
    puts "API returned an unexpected status other than 5xx: #{e.code} #{e.message}"
rescue Tradewatch::Errors::ApiError => e
    puts "Some other error occurred when calling the API: #{e.message}"
end

The SDK is instrumented with automatic retries. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries option to configure this behavior.

require "tradewatch"

client = Tradewatch::Client.new(
    base_url: "https://example.com",
    max_retries: 3  # Configure max retries (default is 2)
)

The SDK defaults to a 60 second timeout. Use the timeout option to configure this behavior.

require "tradewatch"

response = client.crypto.get_quote(
    ...,
    timeout: 30  # 30 second timeout
)

If you would like to send additional headers as part of the request, use the additional_headers request option.

require "tradewatch"

response = client.crypto.get_quote(
    ...,
    request_options: {
        additional_headers: {
            "X-Custom-Header" => "custom-value"
        }
    }
)

If you would like to send additional query parameters as part of the request, use the additional_query_parameters request option.

require "tradewatch"

response = client.crypto.get_quote(
    ...,
    request_options: {
        additional_query_parameters: {
            "custom_param" => "custom-value"
        }
    }
)

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!