quick-reference.md

sidebar_position: 3

API Quick Reference

This document provides brief descriptions of all public functions, types, and interfaces exposed by the Client API (xxDK).

:::note If you are new to the xxDK, you can start with the Overview and Getting Started docs. :::

Note that if you're running the client locally, you can use go doc to explore the list of functions and interfaces.

// cd into the `client` directory 
go doc -all ./api
go doc -all ./interfaces

How to Use the API

The API exposes multiple functions, as well as types and their associated method sets. For example, browsing through the API will show you there is a GetRoundEvents() callback registration function that lets your client see round events:

func (c *Client) GetRoundEvents() interfaces.RoundEvents

GetRoundEvents() returns a RoundEvents interface. Exploring the broader xxDK for this interface reveals a few functions, such as AddRoundEvent() that enable monitoring of a specified event: