horizonclient

horizonclient

horizonclient is a Stellar Go SDK package that provides client access to a horizon server. It supports all endpoints exposed by the horizon API.

This project is maintained by the Stellar Development Foundation.

Getting Started

This library is aimed at developers building Go applications that interact with the Stellar network. It allows users to query the network and submit transactions to the network. The recommended transaction builder for Go programmers is txnbuild. Together, these two libraries provide a complete Stellar SDK.

• The horizonclient API reference.
• The txnbuild API reference.

Prerequisites

• Go 1.10 or greater

Installing

• Download the Stellar Go monorepo: git clone git@github.com:stellar/go.git
• Enter the source directory: cd $GOPATH/src/github.com/stellar/go
• Download external dependencies: dep ensure -v

Usage

    ...
    import hClient "github.com/stellar/go/clients/horizonclient"
    ...

    // Use the default pubnet client
    client := hClient.DefaultPublicNetClient

    // Create an account request
    accountRequest := hClient.AccountRequest{AccountID: "GCLWGQPMKXQSPF776IU33AH4PZNOOWNAWGGKVTBQMIC5IMKUNP3E6NVU"}

    // Load the account detail from the network
    account, err := client.AccountDetail(accountRequest)
    if err != nil {
        fmt.Println(err)
        return
    }
    // Account contains information about the stellar account
    fmt.Print(account)

For more examples, refer to the documentation.

Running the tests

Run the unit tests from the package directory: go test

Contributing

Please read Code of Conduct to understand this project's communication rules.

To submit improvements and fixes to this library, please see CONTRIBUTING.

License

This project is licensed under the Apache License - see the LICENSE file for details.