mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-14 07:26:47 +00:00
ba92ba3254
* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
50 lines
3.0 KiB
Markdown
50 lines
3.0 KiB
Markdown
# GoCryptoTrader package Apiserver
|
|
|
|
<img src="/common/gctlogo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
|
|
[](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader/engine/apiserver)
|
|
[](https://codecov.io/gh/thrasher-corp/gocryptotrader)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
|
|
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 our [GoCryptoTrader Kanban board](https://github.com/orgs/thrasher-corp/projects/3).
|
|
|
|
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/zt-38z8abs3l-gH8AAOk8XND6DP5NfCiG_g)
|
|
|
|
## 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` |
|
|
|
|
## Donations
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70">
|
|
|
|
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
|
|
|
|
***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc***
|