BIbity
Orders

Estimate the amount of an order

The endpoint is similar to the endpoints allowing an order to be placed. However, only the currencies and the input or output amount are necessary in the request.

Providing optional information, such as type in the input and output objects will result in a more precise estimate being returned.

post/orders/estimate

Request

  • Base URL
    https://exchange.api.bity.com/v2
  • Auth
    • none
    • or OAuth 2
      Authorization codehttps://connect.bity.com/oauth2/auth
      Token URLhttps://connect.bity.com/oauth2/token
    • or OAuth 2
      Client credentials
      Token URLhttps://connect.bity.com/oauth2/token
      Scopeshttps://auth.bity.com/scopes/exchange.place
    • or OAuth 2
      Client credentials
      Token URLhttps://connect.bity.com/oauth2/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

OR

Example request

{
  "input": {
    "currency": "BTC"
  },
  "output": {
    "currency": "BTC"
  }
}

Response

Successful operation

Example response

{
  "input": {
    "currency": "BTC",
    "minimum_amount": "12.34"
  },
  "output": {
    "currency": "BTC",
    "minimum_amount": "12.34"
  },
  "price_breakdown": {
    "customer_trading_fee": {
      "amount": "12.34",
      "currency": "BTC"
    },
    "instant_payment_fee": {
      "amount": "12.34",
      "currency": "BTC"
    },
    "non-verified_fee": {
      "amount": "12.34",
      "currency": "BTC"
    },
    "output_transaction_cost": {
      "amount": "12.34",
      "currency": "BTC"
    },
    "partner_fee": {
      "amount": "12.34",
      "currency": "BTC"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.