Cancel GTT order

Cancel an existing broker-hosted trigger. Confirm broker state before assuming linked exposure has closed.

Offline source contract; this page is not a production deployment announcement. Replace symbols, expiries, quantities and mode snapshots with current account evidence before use.

POST /api/v1/cancelgttorder

Authentication: apikey JSON; identity checked in route/service. Send a JSON object with Content-Type: application/json.

Parameters

The following table/example is the legacy SINGLE/OCO contract for eligible non-Dhan bindings. Dhan uses the separate SUPER variant documented on this same page below.

Field	Type	Required	Default / omission	Meaning
expected_mode	String	Yes	required	Current server mode: live or analyze.
expected_balance_type	String	Yes	required	Current balance type: live or sandbox.
expected_mode_version	Integer	Yes	required	Current integer version returned by Funds/Analyzer; refresh after a mode switch.
request_id	String	Yes	required	Save before submission. For protected placement retain the same ID and payload for an intentional retry; do not replay an ambiguous submission automatically.
apikey	String	Yes	required	Per-broker IMC key; never use the broker access token.
strategy	String	Yes	required	Strategy name.
trigger_id	String	Yes	required	ID of an existing broker trigger.

Request example

{
  "expected_mode": "analyze",
  "expected_balance_type": "sandbox",
  "expected_mode_version": 7,
  "request_id": "saved-business-request-001",
  "apikey": "YOUR_BROKER_IMC_KEY",
  "strategy": "Python",
  "trigger_id": "YOUR_TRIGGER_ID"
}

Python SDK

from layr0_imc import api

client = api(api_key="YOUR_BROKER_IMC_KEY", host="https://YOUR_IMC_HOST")
# Copy the current snapshot from Funds/Analyzer for this same key.
client.set_mode_context(expected_mode="analyze", expected_balance_type="sandbox", expected_mode_version=7)

result = client.cancelgttorder(request_id='saved-business-request-001', strategy='Python', trigger_id='YOUR_TRIGGER_ID')
print(result)

Response and errors

Illustrative 200 success; values are examples, not broker evidence:

{
  "status": "success",
  "trigger_id": "EXAMPLE_TRIGGER_ID",
  "mode": "analyze",
  "balance_type": "sandbox",
  "mode_version": 7
}

Successful responses retain the selected broker adapter’s fields. Placement/modification/cancellation return legacy trigger identifiers and broker details; the book returns trigger records. See the workflow contract below for broker-specific examples.

All incoming JSON objects and arrays follow recursive forbidden-field validation. A prohibited documentation key returns 400 before execution:

{
  "status": "error",
  "error_code": "FORBIDDEN_JSON_FIELD",
  "message": "Documentation fields are not allowed in request JSON."
}

Schema errors use 400. Authentication and broker-session failures retain endpoint-specific errors. Missing mode preconditions use 428 in services (the REST schema can reject missing fields with 400); stale mode snapshots use 409. See HTTP errors and authentication/mode requirements. No error response authorizes an automatic order retry.

Modes, capabilities and usage

Requires current mode metadata and request_id, including for the book read. GTT retains scoped lease reuse. SINGLE/OCO products are CNC or NRML; MIS is rejected. SINGLE needs a positive triggerprice_sl or triggerprice_tg; OCO needs positive stop/target triggers and leg limits, with stop trigger below target trigger. Broker restrictions remain explicit: Upstox protective-only OCO is unsupported (use protected entry for its native MULTIPLE workflow), Dhan new Super placements require explicit SUPER intent and its extra fields, and other support depends on the current adapter. Existing legacy trigger envelopes are retained; an accepted trigger is not a fill. Both the route and public service participate in the established track_api_usage policy, with existing scoped usage handling retained. See options/GTT workflow and Dhan Super contract.

Source handler: restx_api.cancel_gtt_order.CancelGTTOrder.post. Source services: services.cancel_gtt_order_service.cancel_gtt_order.

Dhan SUPER request variant

Dhan uses explicit order_system=SUPER. New Forever placements are disabled; existing Forever modifications/cancellations require order_system=FOREVER and the legacy fields. The saved request_id and complete mode snapshot are required in both variants.

Field	Type	SUPER requirement / default
apikey, strategy, request_id	string	Required; Dhan-bound key and saved identity.
expected_mode, expected_balance_type	string	Required current mode/balance snapshot.
expected_mode_version	integer	Required current mode version.
order_system	string	Required: SUPER.
trigger_id	string	Required existing Super parent ID.
cancel_scope	string	Required: ALL, EXITS, ENTRY_LEG, TARGET_LEG or STOP_LOSS_LEG.

CNC/MTF requires BUY equity; NRML requires derivatives; MIS is segment/account-dependent. BUY stop trigger must be below target; SELL target must be below stop. LIMIT entry must lie between triggers. Dhan has one price per exit, so trigger and limit must match. Modification after entry fills cannot resize the filled entry; ENTRY_LEG requires an eligible pending/partial entry. ALL/ENTRY_LEG cancellation is refused after any entry fill; EXITS removes pending exits without selling the position. Analyze supports ALL/EXITS/ENTRY_LEG cancellation, not individual simulated exit cancellation. Broker permissions and static-IP requirements apply.

{
  "apikey": "YOUR_BROKER_IMC_KEY",
  "expected_mode": "analyze",
  "expected_balance_type": "sandbox",
  "expected_mode_version": 7,
  "request_id": "saved-super-request-001",
  "strategy": "Python",
  "order_system": "SUPER",
  "trigger_id": "YOUR_TRIGGER_ID",
  "cancel_scope": "EXITS"
}

from layr0_imc import api

client = api(api_key="YOUR_BROKER_IMC_KEY", host="https://YOUR_IMC_HOST")
# This key must be bound to Dhan; copy its current mode snapshot.
client.set_mode_context(expected_mode="analyze", expected_balance_type="sandbox", expected_mode_version=7)

result = client.cancelsuperorder(request_id='saved-super-request-001', strategy='Python', trigger_id='YOUR_TRIGGER_ID', cancel_scope='EXITS')
print(result)