diff --git a/src/broker-client.ts b/src/broker-client.ts index d96816b..bad3bdc 100644 --- a/src/broker-client.ts +++ b/src/broker-client.ts @@ -9,7 +9,10 @@ import { REST_CLIENT_TYPE_ENUM } from './util'; import BaseRestClient from './util/BaseRestClient'; /** - * REST API client for broker APIs + * REST API client for the V1 bitget Broker APIs. These are the previous generation of Bitget's APIs and should be considered deprecated. + * These will be removed in a future release, once Bitget formally deprecates them. + * + * @deprecated use RestClientV2 instead */ export class BrokerClient extends BaseRestClient { getClientType() { diff --git a/src/futures-client.ts b/src/futures-client.ts index f1a9a84..d6d82b4 100644 --- a/src/futures-client.ts +++ b/src/futures-client.ts @@ -31,7 +31,10 @@ import { REST_CLIENT_TYPE_ENUM } from './util'; import BaseRestClient from './util/BaseRestClient'; /** - * REST API client + * REST API client for the V1 bitget Futures APIs. These are the previous generation of Bitget's APIs and should be considered deprecated. + * These will be removed in a future release, once Bitget formally deprecates them. + * + * @deprecated use RestClientV2 instead */ export class FuturesClient extends BaseRestClient { getClientType() { diff --git a/src/spot-client.ts b/src/spot-client.ts index 69b72f9..a500a26 100644 --- a/src/spot-client.ts +++ b/src/spot-client.ts @@ -26,7 +26,8 @@ import { REST_CLIENT_TYPE_ENUM } from './util'; import BaseRestClient from './util/BaseRestClient'; /** - * REST API client + * REST API client for the V1 bitget Spot APIs. These are the previous generation of Bitget's APIs and should be considered deprecated. + * These will be removed in a future release, once Bitget formally deprecates them. * * @deprecated use RestClientV2 instead */