falconx-go

command module
v0.0.0-...-0205a2a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 11, 2023 License: MIT Imports: 4 Imported by: 0

README

Documentation

FalconX Go Client

Go Client to connect to FalconX Rest/WebSocket APIs. Library contains clients for rest and websocket interfaces, and example files for using them.

Comprehensive Rest API Docs

Comprehensive Socket IO API Docs

Installing and building the library

This project requires Go 1.14. As of the time of writing. To use this package in your own code, make sure your GO_PATH environment variable is correctly set, and install it using go get:

go get github.com/falconxio/falconx-go

Then, you can include it in your project( Please refer to client_examples for detailed examples of usage.)

import "github.com/falconxio/falconx-go/clients"

Alternatively, you can clone it yourself:

git clone github.com/falconxio/falconx-go.git

How to run examples?

go run run_examples -api_key=XXX -secret=XXX -passphrase=XXX -example_set=rest
go run run_examples -api_key=XXX -secret=XXX -passphrase=XXX -example_set=websocket

Questions?

In case of any questions please contact support@falconx.io

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL