Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
fhqvst committed Jul 17, 2017
2 parents 9aac269 + 6fc421b commit 7069f9e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,9 @@ Some methods require certain constants as parameters. These are described below.
| `Avanza.ORDERDEPTHS` | Best five offers and current total volume on each side. Expects an orderbookId. |
| `Avanza.TRADES` | Updates whenever a new trade is made. Data contains volume, price, broker etc. Expects an **orderbookId**. |
| `Avanza.BROKERTRADESUMMARY` | Pushes data about which brokers are long/short and how big their current net volume is. Expects an **orderbookId**. |
| `Avanza.POSITIONS` | Data about your own positions. Expects an accountId or a combination of <orderbookId>\_<accountId>. |
| `Avanza.ORDERS` | Data about your current orders. Expects an accountId or a combination of <orderbookId>\_<accountId>. |
| `Avanza.DEALS` | Data about recent trades you have made. Expects an accountId or a combination of <orderbookId>\_<accountId>. |
| `Avanza.POSITIONS` | Data about your own positions. Expects one or many accountIds or combinations of **\<orderbookId\>\_\<accountId\>**. |
| `Avanza.ORDERS` | Data about your current orders. Expects one or many accountIds or combinations of **\<orderbookId\>\_\<accountId\>**. |
| `Avanza.DEALS` | Data about recent trades you have made. Expects one or many accountIds or combinations of **\<orderbookId\>\_\<accountId\>**. |

#### Transaction Types

Expand All @@ -118,9 +118,9 @@ Authenticate the client.

**Parameters**

- `credentials` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
- `credentials.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
- `credentials.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
- `credentials` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
- `credentials.username` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
- `credentials.password` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**

### getPositions

Expand Down Expand Up @@ -709,7 +709,7 @@ Subscribe to real-time data.

- `channel` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The channel on which to listen. See [Channels](#channels).
- `ids` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** One or many IDs to subscribe to.
- `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)**
- `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)**

### placeOrder

Expand Down Expand Up @@ -817,4 +817,4 @@ marks from `path`.
- `path` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The URL to send the request to. (optional, default `''`)
- `data` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** JSON data to send with the request. (optional, default `{}`)

Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)**

0 comments on commit 7069f9e

Please sign in to comment.