Skip to content
Get started

Get the API version.

ApiVersionGetVersionResponse v1().apiVersion().getVersion(ApiVersionGetVersionParamsparams = ApiVersionGetVersionParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/version

Returns the current version string for this API endpoint.

ParametersExpand Collapse
ApiVersionGetVersionParams params
ReturnsExpand Collapse
class ApiVersionGetVersionResponse:
Version data

API version information

String version

API version string

Get the API version.

package com.clear_street.api.example;

import com.clear_street.api.client.ClearStreetClient;
import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient;
import com.clear_street.api.models.v1.apiversion.ApiVersionGetVersionParams;
import com.clear_street.api.models.v1.apiversion.ApiVersionGetVersionResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        ApiVersionGetVersionResponse response = client.v1().apiVersion().getVersion();
    }
}
{
  "data": {
    "version": "2025-10-31"
  },
  "error": null,
  "metadata": {
    "request_id": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f"
  }
}
Returns Examples
{
  "data": {
    "version": "2025-10-31"
  },
  "error": null,
  "metadata": {
    "request_id": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f"
  }
}