Create an automated order

This endpoint allows partners to create an automated buy order for a user.

Users can specify a price target at which a buy order will be executed. Once the market price reaches the set target price, a market buy order will be automatically placed.

The target price can be above the current price to initiate an stop buy order or below the current price to initiate a limit-market order.

Coming soon: automated sell orders are expected in the future iterations. This feature will allow your users to set the target price below the current price to initiate a stop loss order or above the current price to initiate a take-profit order. We will keep you posted.

SecuritybearerAuth
Request
header Parameters
bp-user-id
required
string <uuid>

User ID

Request Body schema: application/json

The automated order to be created.

type
required
string

Order Type

Enum: "buy" "sell"
fiat_id
required
string <uuid>

Fiat ID

asset_id
required
string <uuid>

Asset ID

amount
required
string

Fiat amount for the automated order.

target_price
required
string

The asset price at which the automated order is triggered. It can be above or below the current price.

Responses
201

Success Response (New order has been created)

400

Error

401

Unauthorized

403

Account is inactive

404

Not Found

405

Not Allowed

422

Unprocessable Entity

500

Error

503

Maintenance or Service unavailable

post/v1/orders
Request samples
application/json
{
  • "type": "buy",
  • "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
  • "asset_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
  • "amount": "1.99",
  • "target_price": "40743.41527688"
}
Response samples
application/json
{
  • "data": {
    }
}