Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions .github/workflows/release-doctor.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.5.0"
".": "0.6.0"
}
8 changes: 4 additions & 4 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 49
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cryptech%2Fneptune-api-v2-99a21fdf9159c28a75eb60c0b7ad4710d01b0a98dd0474267a07e9914039fa83.yml
openapi_spec_hash: f58f326c00c34bc45b28b09b9530566c
config_hash: 27aff5f3f84397a9b3c2cb8a3c1d1e71
configured_endpoints: 50
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cryptech%2Fneptune-api-v2-40d8045cda417d4c8a7a4a0d014345cdeb273fb5fdfa48eea08493bc5a5079ce.yml
openapi_spec_hash: 71ca66dcf6e775aae3f49b42cd6ce2cc
config_hash: f5ca3bc259f95069f0db4114d34e29ef
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## 0.6.0 (2026-04-17)

Full Changelog: [v0.5.0...v0.6.0](https://github.com/cryptechdev/neptune-api-v2-typescript/compare/v0.5.0...v0.6.0)

### Features

* **api:** add TVL, missing balance variants ([6983754](https://github.com/cryptechdev/neptune-api-v2-typescript/commit/69837543ef6ddc5cc9fff7ba256ce27860299184))


### Chores

* **ci:** remove release-doctor workflow ([7b26cae](https://github.com/cryptechdev/neptune-api-v2-typescript/commit/7b26cae978ed8a0521371ddade2e72a376ef4be8))
* update SDK settings ([c94d985](https://github.com/cryptechdev/neptune-api-v2-typescript/commit/c94d9855135f6fc9765fce2bd21851107f6249b4))
* update SDK settings ([248d321](https://github.com/cryptechdev/neptune-api-v2-typescript/commit/248d321679c47fb8b7598d7c338a34578aaf0eec))

## 0.5.0 (2026-04-09)

Full Changelog: [v0.4.0...v0.5.0](https://github.com/cryptechdev/neptune-api-v2-typescript/compare/v0.4.0...v0.5.0)
Expand Down
3 changes: 3 additions & 0 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,20 @@ Types:
- <code><a href="./src/resources/markets/markets.ts">GlobalMarketConfig</a></code>
- <code><a href="./src/resources/markets/markets.ts">MarketRate</a></code>
- <code><a href="./src/resources/markets/markets.ts">MergedMarket</a></code>
- <code><a href="./src/resources/markets/markets.ts">Tvl</a></code>
- <code><a href="./src/resources/markets/markets.ts">MarketGetMergedResponse</a></code>
- <code><a href="./src/resources/markets/markets.ts">MarketGetMergedByAssetResponse</a></code>
- <code><a href="./src/resources/markets/markets.ts">MarketGetOverviewResponse</a></code>
- <code><a href="./src/resources/markets/markets.ts">MarketGetParamsResponse</a></code>
- <code><a href="./src/resources/markets/markets.ts">MarketGetTvlResponse</a></code>

Methods:

- <code title="get /api/v1/markets/merged">client.markets.<a href="./src/resources/markets/markets.ts">getMerged</a>({ ...params }) -> MarketGetMergedResponse</code>
- <code title="get /api/v1/markets/merged/lookup">client.markets.<a href="./src/resources/markets/markets.ts">getMergedByAsset</a>({ ...params }) -> MarketGetMergedByAssetResponse</code>
- <code title="get /api/v1/markets">client.markets.<a href="./src/resources/markets/markets.ts">getOverview</a>({ ...params }) -> MarketGetOverviewResponse</code>
- <code title="get /api/v1/markets/config">client.markets.<a href="./src/resources/markets/markets.ts">getParams</a>({ ...params }) -> MarketGetParamsResponse</code>
- <code title="get /api/v1/markets/tvl">client.markets.<a href="./src/resources/markets/markets.ts">getTvl</a>({ ...params }) -> MarketGetTvlResponse</code>

## Lend

Expand Down
18 changes: 0 additions & 18 deletions bin/check-release-environment

This file was deleted.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@neptunefinance/api-v2",
"version": "0.5.0",
"version": "0.6.0",
"description": "The official TypeScript library for the Neptune API V2 API",
"author": "Neptune API V2 <>",
"types": "dist/index.d.ts",
Expand Down
6 changes: 6 additions & 0 deletions src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,12 @@ import {
MarketGetOverviewResponse,
MarketGetParamsParams,
MarketGetParamsResponse,
MarketGetTvlParams,
MarketGetTvlResponse,
MarketRate,
Markets,
MergedMarket,
Tvl,
} from './resources/markets/markets';
import { Swap } from './resources/swap/swap';
import {
Expand Down Expand Up @@ -871,14 +874,17 @@ export declare namespace NeptuneAPIV2 {
type GlobalMarketConfig as GlobalMarketConfig,
type MarketRate as MarketRate,
type MergedMarket as MergedMarket,
type Tvl as Tvl,
type MarketGetMergedResponse as MarketGetMergedResponse,
type MarketGetMergedByAssetResponse as MarketGetMergedByAssetResponse,
type MarketGetOverviewResponse as MarketGetOverviewResponse,
type MarketGetParamsResponse as MarketGetParamsResponse,
type MarketGetTvlResponse as MarketGetTvlResponse,
type MarketGetMergedParams as MarketGetMergedParams,
type MarketGetMergedByAssetParams as MarketGetMergedByAssetParams,
type MarketGetOverviewParams as MarketGetOverviewParams,
type MarketGetParamsParams as MarketGetParamsParams,
type MarketGetTvlParams as MarketGetTvlParams,
};

export {
Expand Down
3 changes: 3 additions & 0 deletions src/resources/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,17 @@ export {
type GlobalMarketConfig,
type MarketRate,
type MergedMarket,
type Tvl,
type MarketGetMergedResponse,
type MarketGetMergedByAssetResponse,
type MarketGetOverviewResponse,
type MarketGetParamsResponse,
type MarketGetTvlResponse,
type MarketGetMergedParams,
type MarketGetMergedByAssetParams,
type MarketGetOverviewParams,
type MarketGetParamsParams,
type MarketGetTvlParams,
} from './markets/markets';
export {
Nept,
Expand Down
6 changes: 6 additions & 0 deletions src/resources/markets/borrow/collaterals.ts
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ export namespace BorrowCollateralState {
* `true`.
*/
export interface Text {
balance: string;

collateral_sum: string;
}

Expand All @@ -239,6 +241,8 @@ export namespace BorrowCollateralState {
* specified as well.
*/
export interface Value {
balance: string;

collateral_sum: string;

extra: Value.Extra;
Expand All @@ -264,6 +268,8 @@ export namespace BorrowCollateralState {
* `with_text` and `with_value` are `true`.
*/
export interface Text {
balance: string;

collateral_sum: string;

/**
Expand Down
3 changes: 3 additions & 0 deletions src/resources/markets/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,15 @@ export {
type GlobalMarketConfig,
type MarketRate,
type MergedMarket,
type Tvl,
type MarketGetMergedResponse,
type MarketGetMergedByAssetResponse,
type MarketGetOverviewResponse,
type MarketGetParamsResponse,
type MarketGetTvlResponse,
type MarketGetMergedParams,
type MarketGetMergedByAssetParams,
type MarketGetOverviewParams,
type MarketGetParamsParams,
type MarketGetTvlParams,
} from './markets';
88 changes: 88 additions & 0 deletions src/resources/markets/markets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,16 @@ export class Markets extends APIResource {
): APIPromise<MarketGetParamsResponse> {
return this._client.get('/api/v1/markets/config', { query, ...options });
}

/**
* Get market TVL
*/
getTvl(
query: MarketGetTvlParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<MarketGetTvlResponse> {
return this._client.get('/api/v1/markets/tvl', { query, ...options });
}
}

export interface GlobalMarketConfig {
Expand Down Expand Up @@ -238,6 +248,49 @@ export interface MergedMarket {
lend: LendAPI.LendMarketData | null;
}

export interface Tvl {
/**
* Market TVL in USD - collateral portion
*/
collateral_value: string;

extra: Tvl.Extra;

/**
* Market TVL in USD - lend portion
*/
lend_value: string;

/**
* Market TVL in USD
*/
total_value: string;
}

export namespace Tvl {
export interface Extra {
/**
* Human-readable field variants. Will not be null when query param `with_text` is
* `true`.
*/
text: Extra.Text | null;
}

export namespace Extra {
/**
* Human-readable field variants. Will not be null when query param `with_text` is
* `true`.
*/
export interface Text {
collateral_value: string;

lend_value: string;

total_value: string;
}
}
}

export interface MarketGetMergedResponse {
/**
* Total number of objects irrespective of any pagination parameters.
Expand Down Expand Up @@ -322,6 +375,11 @@ export namespace MarketGetOverviewResponse {
* Current lending markets
*/
lend: Array<LendAPI.LendMarket>;

/**
* Market TVL
*/
tvl: MarketsAPI.Tvl;
}
}

Expand All @@ -345,6 +403,26 @@ export interface MarketGetParamsResponse {
status_text: string;
}

export interface MarketGetTvlResponse {
data: Tvl;

/**
* Error data. Guaranteed `null` for successful response.
*/
error: null;

/**
* HTTP status. Successful responses are guaranteed to be < `400`. Conversely,
* error responses are guaranteed to be >= `400`.
*/
status: number;

/**
* HTTP status text
*/
status_text: string;
}

export interface MarketGetMergedParams {
/**
* Include text variation fields
Expand Down Expand Up @@ -393,6 +471,13 @@ export interface MarketGetParamsParams {
with_text?: boolean;
}

export interface MarketGetTvlParams {
/**
* Include text variation fields
*/
with_text?: boolean;
}

Markets.Lend = Lend;
Markets.Borrow = Borrow;

Expand All @@ -401,14 +486,17 @@ export declare namespace Markets {
type GlobalMarketConfig as GlobalMarketConfig,
type MarketRate as MarketRate,
type MergedMarket as MergedMarket,
type Tvl as Tvl,
type MarketGetMergedResponse as MarketGetMergedResponse,
type MarketGetMergedByAssetResponse as MarketGetMergedByAssetResponse,
type MarketGetOverviewResponse as MarketGetOverviewResponse,
type MarketGetParamsResponse as MarketGetParamsResponse,
type MarketGetTvlResponse as MarketGetTvlResponse,
type MarketGetMergedParams as MarketGetMergedParams,
type MarketGetMergedByAssetParams as MarketGetMergedByAssetParams,
type MarketGetOverviewParams as MarketGetOverviewParams,
type MarketGetParamsParams as MarketGetParamsParams,
type MarketGetTvlParams as MarketGetTvlParams,
};

export {
Expand Down
2 changes: 1 addition & 1 deletion src/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const VERSION = '0.5.0'; // x-release-please-version
export const VERSION = '0.6.0'; // x-release-please-version
20 changes: 20 additions & 0 deletions tests/api-resources/markets/markets.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,24 @@ describe('resource markets', () => {
client.markets.getParams({ with_text: true }, { path: '/_stainless_unknown_path' }),
).rejects.toThrow(NeptuneAPIV2.NotFoundError);
});

// Mock server tests are disabled
test.skip('getTvl', async () => {
const responsePromise = client.markets.getTvl();
const rawResponse = await responsePromise.asResponse();
expect(rawResponse).toBeInstanceOf(Response);
const response = await responsePromise;
expect(response).not.toBeInstanceOf(Response);
const dataAndResponse = await responsePromise.withResponse();
expect(dataAndResponse.data).toBe(response);
expect(dataAndResponse.response).toBe(rawResponse);
});

// Mock server tests are disabled
test.skip('getTvl: request options and params are passed correctly', async () => {
// ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
await expect(
client.markets.getTvl({ with_text: true }, { path: '/_stainless_unknown_path' }),
).rejects.toThrow(NeptuneAPIV2.NotFoundError);
});
});
Loading