@ton-api/client

@ton-api/client

Overview

@ton-api/client is an automatically generated SDK that provides seamless access to the endpoints offered by tonapi.io. This client is specifically designed to integrate with the TON blockchain, offering type-safe interactions and full compatibility with @ton/core library.

Documentation

For a detailed view of all methods and endpoints in a Swagger format, refer to the Swagger documentation For detailed API information and endpoint descriptions, please refer to the official documentation or check the Swagger UI for an interactive method list.

Features

• Full coverage of tonapi.io endpoints
• Type-safe interactions with the API
• Seamless integration with @ton/core

Additionally, @ton-api/ton-adapter enables users to work with contracts written for @ton/ton through @ton-api/client, ensuring seamless integration while maintaining their existing code structure.

Prerequisites

To use this SDK, you need to:

• Set up an account at tonconsole.com
• Obtain an API key for authentication

Installation

Install the package and its peer dependencies using npm, yarn, or pnpm:

npm install @ton-api/client @ton/core
# or
yarn add @ton-api/client @ton/core
# or
pnpm add @ton-api/client @ton/core

Quick Start

Here's a basic example to get you started:

import { TonApiClient } from '@ton-api/client';
import { Address } from '@ton/core';

// Initialize the TonApi
const ta = new TonApiClient({
    baseUrl: 'https://tonapi.io',
    apiKey: 'YOUR_API_KEY'
});

// Use the API
async function fetchAccountEvents() {
    const address = Address.parse('YOUR_ADDRESS_HERE');
    const events = await ta.accounts.getAccountEvents(address, { limit: 50 })
    
    console.log('Account events:', events)
}

fetchAccountEvents();

Documentation

For detailed API information and endpoint descriptions, please refer to the official documentation.

Usage Examples

Fetching NFT Collection

const collectionAddress = Address.parse('COLLECTION_ADDRESS_HERE');

ta.nft.getNftCollection(collectionAddress)
    .then(collection => console.log('NFT Collection:', collection))
    .catch(error => console.error('Error fetching NFT collection:', error));

Getting Jetton Information

const jettonAddress = Address.parse('JETTON_ADDRESS_HERE');

ta.jettons.getJettonInfo(jettonAddress)
    .then(jetton => console.log('Jetton Info:', jetton))
    .catch(error => console.error('Error fetching jetton info:', error));

License

MIT

Changelog

[0.3.1] - 2025-01-09

Added

• Support for prefixItems from openapi 3.1.0 in schema
• Example for using Emulation in the client

Fixed

• Corrected type mismatch for operations with inline response schemas (not defined via $ref in components) in OpenAPI. Key transformations from snake_case to camelCase are now properly reflected in the types, making them usable.
• Resolved an internal issue that caused generation failures when the response format was not application/json.