Halan Borsa

Check whether the EGX (Egyptian Exchange) is currently open for trading. Returns the current open/closed state as of now (isOpen, timestamp in epoch milliseconds), plus, when the market service reports them: willOpenAt (next open time, if currently closed), willCloseAt (next close time, if currently open), and lastClosedAt — all epoch milliseconds, omitted when not available. Use this before advising on order timing, explaining why an order might not execute immediately, or answering any 'is the market open/closed right now' question. Takes no parameters.

is_market_open

Create a draft (temp) limit order for the current user, to be reviewed and confirmed in the mobile app. Only BUY_LIMIT and SELL_LIMIT are supported — no market orders. For a sell order, custodianId and settlementType are required (call get_portfolio_details first to find the custodian holding the ISIN). For a buy order, custodianId/custodianName/custodianShortName should reflect the custodian the user wants to fund from, if known. Sell orders with T+0 or T+1 settlement are day orders: their validity is always GOOD_TILL_TODAY (any validityOption/validTill you pass is ignored for them), and they are rejected while the market session is closed — only create them during trading hours.

create_temp_order

Get the best bid and best ask (top of the live order book) for an EGX symbol by ISIN. A lightweight alternative to get_active_orders when you only need the top of book; check hasBid/hasAsk before reading the prices.

get_best_bid_ask

Get the full live order book for an EGX symbol by ISIN: all active bid orders (highest price first) and ask orders (lowest price first), each with price, quantity, order number, market, and timestamps. Use this for market/depth analysis of ONE symbol — reading spread, liquidity, or where size sits in the book. It always returns the entire current book (no paging, no date filter, no multi-symbol). For just the top of book, use get_best_bid_ask. To browse/filter orders by date range or across multiple symbols instead of analyzing depth, use list_active_orders.

get_active_orders

Get the historical stream of order-book events for an EGX symbol (orders opened, matched, withdrawn, expired). Supports change-data-capture paging via lastRecSerial/nextRecSerial to incrementally pull new events. This is order-by-order event history, not daily price bars — use get_symbol_history for prices.

get_order_book_history

Retrieve detailed holdings information for the current user, optionally filtered by a list of ISINs. Returns structured data per holding: ISIN, total units, average cost in EGP, last updated timestamp, and a per-custodian breakdown (custodian id, custodian name, total units, settled units, settlement cycles). Each custodian's custodianId is the value to pass to create_temp_order as custodianId when placing a sell order for that holding. Each custodian's settlementCycles lists the settlement cycles with their availableUnits; a cycle's type is the value to pass to create_temp_order as settlementType. Only pick a cycle whose availableUnits covers the quantity you want to sell — never guess a settlement type. When presenting results to the user, format each holding clearly: show the ISIN, units, average cost, and list custodians with their settled vs total units.

get_portfolio_details

Get the latest live MDF price quote for an EGX-listed stock by ISIN. Returns the last trade price plus the day's high, low, close and reference prices, cumulative traded volume and value, and number of transactions. Use this for a current price snapshot; for historical daily prices use get_symbol_history instead.

get_stock_quote

Get daily historical price bars for an EGX symbol over a date range: per-day open, high, low, close, traded volume, traded value, and trade count. Requires fromDate and toDate as epoch milliseconds. For the current live price use get_stock_quote instead.

get_symbol_history

Retrieve the current user's brokerage wallet in EGP: balance, withdrawableBalance, settledBalance, underSettlementBalance, frozenBalance, underPaymentBalance, purchasePower (cash available to buy, across the trading and fund accounts) and sellDuringTheDay, plus isActive. This is a snapshot saved the last time the user opened their wallet in the Halan app, not a live value: lastUpdatedAt (epoch milliseconds) says when it was taken — always tell the user that time, and suggest reopening the app if it is old. Use purchasePower to check whether a buy order is affordable before calling create_temp_order. Fails if the user has never opened their wallet in the app. Takes no parameters.

get_wallet_balance

List EGX company bulletins (corporate disclosures categorized by type), optionally filtered by symbol ISIN, bulletin type code, and a date range (epoch milliseconds). Results are paged and may not be exhaustive. The response includes pageSize, pageNumber, and returnedCount; when returnedCount equals pageSize, another page may exist. Each item includes the heading and full content in both English and Arabic, the bulletin type, and a source URL.

list_bulletins