cobinhood-rx/docs/trade-methods.md

CobinhoodRx is a rxjs node wrapper for the CobinhoodRx Api.

## Trade Methods

### CobinhoodRx.Trade.getOrder(param)

Get the data for the order specified.

#### Parameters

| Parameter | Type   | Example                                |
| --------- | ------ | -------------------------------------- |
| orderId   | string | '0941ef71-effa-425c-a390-0dc837119aca' |

#### Return Type

`Observable<Order>`

#### Example

```js
cobinhoodRx.Trade.getOrder('0941ef71-effa-425c-a390-0dc837119aca')
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.getOrderTrades(param)

Get all the trades for the order specified.

#### Parameters

| Parameter | Type   | Example                                |
| --------- | ------ | -------------------------------------- |
| orderId   | string | '07797042-7f4b-4d09-8c25-e55fa2f80adx' |

#### Return Type

`Observable<OrderTrade[]>`

#### Example

```js
cobinhoodRx.Trade.getOrderTrade('07797042-7f4b-4d09-8c25-e55fa2f80adx')
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.getAllOrder(...params)

Get all open trades.

#### Parameters

| Parameter         | Type   | Example                  |
| ----------------- | ------ | ------------------------ |
| market (Optional) | string | 'BTC-USDT'               |
| limit (Optional)  | number | Default: 10, Maximum: 50 |

#### Return Type

`Observable<AllOrder[]>`

#### Example

```js
cobinhoodRx.Trade.getAllOrder()
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.placeBuyOrder(...params)

Place a buy order.

#### Parameters

| Parameter | Type                | Example                   |
| --------- | ------------------- | ------------------------- |
| market    | string              | 'SNT-ETH'                 |
| type      | PlaceOrderTypeValue | PlaceOrderTypeValue.Limit |
| price     | number              | 0.0000119                 |
| size      | number              | 280                       |

#### Return Type

`Observable<PlaceOrder>`

#### Example

```js
cobinhoodRx.Trade.placeBuyOrder('SNT-ETH', OrderTypeValue.Limit, 0.0000119, 280)
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.placeSellOrder(...params)

Place a sell order.

#### Parameters

| Parameter | Type                | Example                   |
| --------- | ------------------- | ------------------------- |
| market    | string              | 'SNT-ETH'                 |
| type      | PlaceOrderTypeValue | PlaceOrderTypeValue.Limit |
| price     | number              | 0.0000119                 |
| number    | size                | 280                       |

#### Return Type

`Observable<PlaceOrder>`

#### Example

```js
cobinhoodRx.Trade.placeSellOrder('SNT-ETH', OrderTypeValue.Limit, 0.0000119, 280)
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.modifyOrder(...params)

Modify an existing order specified.

#### Parameters

| Parameter | Type   | Example                                |
| --------- | ------ | -------------------------------------- |
| orderId   | string | '0941ef71-effa-425c-a390-0dc837119aca' |
| price     | number | 0.0000110                              |
| number    | size   | 300                                    |

#### Return Type

`Observable<Boolean>`

#### Example

```js
cobinhoodRx.Trade.modifyOrder('0941ef71-effa-425c-a390-0dc837119aca', 0.0000110, 300)
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.cancelOrder(param)

Cancel an existing order specified.

#### Parameters

| Parameter | Type   | Example                                |      |
| --------- | ------ | -------------------------------------- | ---- |
| orderId   | string | '0941ef71-effa-425c-a390-0dc837119aca' |      |

#### Return Type

`Observable<Boolean>`

#### Example

```js
cobinhoodRx.Trade.cancelOrder('0941ef71-effa-425c-a390-0dc837119aca', 0.0000110, 300)
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.getOrderHistory(...params)

Get the order history data.

#### Parameters

| Parameter         | Type   | Example                  |
| ----------------- | ------ | ------------------------ |
| market (Optional) | string | 'SNT-ETH'                |
| limit (Optional)  | number | Default: 10, Maximum: 50 |

#### Return Type

`Observable<OrderHistory[]>`

#### Example

```js
cobinhoodRx.Trade.getOrderHistory('SNT-ETH')
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.getTrade(param)

Get the trade data of a specific for the account.

#### Parameters

| Parameter | Type   | Example                                | Description          |
| --------- | ------ | -------------------------------------- | -------------------- |
| tradeId   | string | 'ecb560bc-a4cc-4366-88c8-cb12ebbd7b23' | The id of the Trade. |

#### Return Type

`Observable<Trade>`

#### Example

```js
cobinhoodRx.Trade.getTrade('ecb560bc-a4cc-4366-88c8-cb12ebbd7b23')
	.subscribe(
		console.log(data);
	});
```



### CobinhoodRx.Trade.getTradeHistory(...params)

Get the historical trade data of a specific for the account.

#### Parameters

| Parameter         | Type   | Example                  |
| ----------------- | ------ | ------------------------ |
| market (Optional) | string | 'SNT-ETH'                |
| limit (Optional)  | number | Default: 10, Maximum: 50 |

#### Return Type

`Observable<Trade[]>`

#### Example

```js
cobinhoodRx.Trade.getTradeHistory('SNT-ETH')
	.subscribe(
		console.log(data);
	});
```