INinvestbamboo
US Stock Trading

Fetch Order Status

This endpoint is used to check the status of an order that has been placed, providing comprehensive details about order execution and current state.

Order status information includes:

  • Order identification with unique order ID and stock details
  • Execution details showing order type, side (buy/sell), and quantity
  • Pricing information with execution price and total value
  • Fee breakdown in both USD and local currency
  • Current status and any status change reasons
  • Timestamps for order creation and updates

Order Status Types:

  • New: Order received, awaiting execution
  • Filled: Order successfully executed, shares/cash updated
  • Cancelled: Order cancelled by the user before execution
  • Rejected: Order rejected by broker (invalid parameters like the price or quantity passed)
get/api/order/{id}/status

Request

  • Base URL
    https://powered-by-bamboo-sandbox.investbamboo.com
  • Auth
    none declared. Required headers: content-type, accept-language, x-user-id, x-subject-type, x-client-token, x-request-source

Path parameters

idstring required

Order id

Headers

content-typestring required

Acceptable content type

accept-languagestring required

Acceptable language; 'en' for English

x-user-idstring required

Required for user authentication

x-subject-typestring required

For user request -> 'tenant'.

x-client-tokenstring required

API Consumer Authorisation Token

x-request-sourcestring required

The tenant's username

Response

Order status

idstring

Order ID

namestring

Stock name

typestring

Type: Market, Stop, Limit

symbolstring

Symbol

logostring

Stock logo

quantitynumber

Quantity requested

sidestring

Side Buy/Sell

dollar_feeunknown
pricenumber

Price

avatarstring

Stock avatar url

naira_feeunknown
background_colorstring

Background color of stock in hex

order_statusstring

Order status

dollar_priceunknown
naira_priceunknown
limit_pricenumber

Limit price

stop_pricenumber

Stop price

commisionunknown
created_whenstring

Date in ISO 8601

update_reasonstring

Update reason if order was Rejected

Example response

{
  "id": "KJ.836a28cc-46ad-45d8-af25-a48812a9b7ae",
  "name": "2U, Inc.",
  "type": "Market",
  "symbol": "TWOU",
  "logo": "https://d3an3cesqmrf1x.cloudfront.net/images/symbols/twou.png",
  "quantity": 9.70873786,
  "side": "BUY",
  "dollar_fee": 1,
  "price": 2.06,
  "avatar": "https://firebasestorage.googleapis.com/v0/b/bamboo-16d59.appspot.com/o/staging%2Fstocks%2Fimage.png1668765461965?alt=media&token=6467a544-ddd2-4b0d-8e5a-4c4ef4d70510",
  "naira_fee": 868.8,
  "background_color": "121212",
  "order_status": "Filled",
  "dollar_price": 20,
  "naira_price": 17360,
  "commision": 1,
  "created_when": "2023-10-25T15:28:26.779Z",
  "update_reason": "market_order-buy-filled"
}

Changes

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