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
• Request Options
• Advanced
  • Response Headers
  • Retries
  • Timeouts
  • Explicit Null

API reference documentation is available here.

A full reference for this library is available here.

Instantiate and use the client with the following:

package example

import (
    client "sdk/client"
    option "sdk/option"
    sdk "sdk"
    context "context"
)

func do() {
    client := client.NewClient(
        option.WithAPIKey(
            "<value>",
        ),
    )
    request := &sdk.CryptoGetQuoteRequest{
        Symbol: "BTC-USD",
        Precision: sdk.Int(
            2,
        ),
    }
    client.Crypto.GetQuote(
        context.TODO(),
        request,
    )
}

You can choose between different environments by using the option.WithBaseURL option. You can configure any arbitrary base URL, which is particularly useful in test environments.

client := client.NewClient(
    option.WithBaseURL(api.Environments.Default),
)

Structured error types are returned from API calls that return non-success status codes. These errors are compatible with the errors.Is and errors.As APIs, so you can access the error like so:

response, err := client.Crypto.GetQuote(...)
if err != nil {
    var apiError *core.APIError
    if errors.As(err, apiError) {
        // Do something with the API error ...
    }
    return err
}

A variety of request options are included to adapt the behavior of the library, which includes configuring authorization tokens, or providing your own instrumented *http.Client.

These request options can either be specified on the client so that they're applied on every request, or for an individual request, like so:

Providing your own *http.Client is recommended. Otherwise, the http.DefaultClient will be used, and your client will wait indefinitely for a response (unless the per-request, context-based timeout is used).

// Specify default options applied on every request.
client := client.NewClient(
    option.WithToken("<YOUR_API_KEY>"),
    option.WithHTTPClient(
        &http.Client{
            Timeout: 5 * time.Second,
        },
    ),
)

// Specify options for an individual request.
response, err := client.Crypto.GetQuote(
    ...,
    option.WithToken("<YOUR_API_KEY>"),
)

You can access the raw HTTP response data by using the WithRawResponse field on the client. This is useful when you need to examine the response headers received from the API call. (When the endpoint is paginated, the raw HTTP response data will be included automatically in the Page response object.)

response, err := client.Crypto.WithRawResponse.GetQuote(...)
if err != nil {
    return err
}
fmt.Printf("Got response headers: %v", response.Header)
fmt.Printf("Got status code: %d", response.StatusCode)

The SDK is instrumented with automatic retries with exponential backoff. 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)

If the Retry-After header is present in the response, the SDK will prioritize respecting its value exactly over the default exponential backoff.

Use the option.WithMaxAttempts option to configure this behavior for the entire client or an individual request:

client := client.NewClient(
    option.WithMaxAttempts(1),
)

response, err := client.Crypto.GetQuote(
    ...,
    option.WithMaxAttempts(1),
)

Setting a timeout for each individual request is as simple as using the standard context library. Setting a one second timeout for an individual API call looks like the following:

ctx, cancel := context.WithTimeout(ctx, time.Second)
defer cancel()

response, err := client.Crypto.GetQuote(ctx, ...)

If you want to send the explicit null JSON value through an optional parameter, you can use the setters
that come with every object. Calling a setter method for a property will flip a bit in the explicitFields bitfield for that setter's object; during serialization, any property with a flipped bit will have its omittable status stripped, so zero or nil values will be sent explicitly rather than omitted altogether:

type ExampleRequest struct {
    // An optional string parameter.
    Name *string `json:"name,omitempty" url:"-"`

    // Private bitmask of fields set to an explicit value and therefore not to be omitted
    explicitFields *big.Int `json:"-" url:"-"`
}

request := &ExampleRequest{}
request.SetName(nil)

response, err := client.Crypto.GetQuote(ctx, request, ...)