Skip to content

Commit

Permalink
Update REFERENCE.md
Browse files Browse the repository at this point in the history
Update REFERENCE.md

Update REFERENCE.md
  • Loading branch information
FrRichard committed Oct 7, 2015
1 parent 9ebb595 commit 40b613b
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/REFERENCE.md
Expand Up @@ -14,6 +14,8 @@ __(More examples coming soon!)__
+ [Transaction requests](REFERENCE.md#transaction-requests)
3. [`Transaction` constructors](REFERENCE.md#transaction-constructors)
+ [Transaction events](REFERENCE.md#transaction-events)
4. [Subscriptions](REFERENCE.md#subscriptions)
+ [Orderbook subscription](REFERENCE.md#orderbook-subscription)

###Also see:

Expand Down Expand Up @@ -352,3 +354,24 @@ transaction.submit(function(err, res) {
#Amount objects

Coming Soon

#Subscriptions

##Orderbook subscription

Subscribes to an orderbook (including autobridged books). Send the orderbook on subscribe then notifies updates.
Available events: ['transaction', 'model', 'trade', 'offer_added', 'offer_removed', 'offer_changed', 'offer_funds_changed']
```js
parameters = {
currency_pays: <string>,
issuer_pays: <string>,
currency_gets: <string>,
issuer_gets: <string>
}
```
Basic subscription:
```js
var Orderbook = Remote.book(parameters);
Orderbook.on('model', handler);

```

0 comments on commit 40b613b

Please sign in to comment.