Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 3.84 KB

apiserver.md

File metadata and controls

62 lines (40 loc) · 3.84 KB
Raw

GoCryptoTrader package Apiserver

Build Status Software License GoDoc Coverage Status Go Report Card

This apiserver package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Current Features for Apiserver

  • The API server subsystem is a deprecated service used to host a REST or websocket server to interact with some functions of GoCryptoTrader
  • This subsystem is no longer maintained and it is highly encouraged to interact with GRPC endpoints directly where possible
  • In order to modify the behaviour of the API server subsystem, you can edit the following inside your config file:

deprecatedRPC

Config Description Example
enabled If enabled will create a REST server which will listen to commands on the listen address true
listenAddress If enabled will listen for REST requests on this address and return a JSON response localhost:9050

websocketRPC

Config Description Example
enabled If enabled will create a REST server which will listen to commands on the listen address true
listenAddress If enabled will listen for requests on this address and return a JSON response localhost:9051
connectionLimit Defines how many connections the websocket RPC server can handle simultanesoly 1
maxAuthFailures For authenticated endpoints, the amount of failed attempts allowed before disconnection 3
allowInsecureOrigin Allows use of insecure connections true

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc