API Reference

Welcome to the OCAP Client API Reference. This section provides a comprehensive and searchable reference for all available classes, methods, and data types. Whether you're looking for the specifics of a GraphQL method, the parameters for a transaction helper, or the structure of a response object, you'll find the detailed information you need here.
Explore the following sections to dive deeper into the client's capabilities:
Helper Methods
Detailed documentation for core client helper methods, such as `getType`, `decodeTx`, and `fromUnitToToken`.
Query & Mutation Methods
A complete list of all available GraphQL query and mutation methods for reading from and writing to the chain.
High-level API
Reference for high-level functions that simplify common workflows like transferring tokens and managing assets.
Low-level API
Learn how to manually construct, sign, and send transactions for full control over the transaction lifecycle.
Data Types
Defines all the custom data structures, input parameters, and response objects used throughout the client API.

Overview

Getting Started

How-to Guides

Core Concepts

API Reference

API Reference

Helper Methods

Query & Mutation Methods

High-level API

Low-level API

Data Types

Gas Payment

Helper Methods