Skip to content

Commit

Permalink
📝 Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MateoGreil committed May 7, 2024
1 parent 3a803d2 commit e581b3a
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# xStation5 API Golang Library

This project makes it possible to get data from Forex market, execute market or limit order with Golang through WebSocket connection

This module may can be used for [X-Trade Brokers](https://www.xtb.com/en) xStation5 accounts

API documentation: [http://developers.xstore.pro/documentation](http://developers.xstore.pro/documentation)

## Disclaimer

This xStation5 API Python library is not affiliated with, endorsed by, or in any way officially connected to the xStation5 trading platform or its parent company. The library is provided as-is and is not guaranteed to be suitable for any particular purpose. The use of this library is at your own risk, and the author(s) of this library will not be liable for any damages arising from the use or misuse of this library.
<!-- Please refer to the license file for more information. -->

## Usage

### Authentication
```go
xapiDemoClient, err := NewClient(os.Getenv("XAPI_USER_ID"), os.Getenv("XAPI_PASSWORD"), "demo")
// or
xapiRealClient, err := NewClient(os.Getenv("XAPI_USER_ID"), os.Getenv("XAPI_PASSWORD"), "real")
```

0 comments on commit e581b3a

Please sign in to comment.