cancelOrder
Cancel an existing order that has not been filled. Use with confirmation to submit the cancellation.
Instructions
주문 취소
기존 주문을 취소합니다. 이미 체결된 주문은 취소할 수 없습니다.
Rate Limits Group: ORDER
[POST /api/v1/orders/{orderId}/cancel]
tags: Order
⚠️ 실제 자산에 영향을 주는 주문 API 입니다. 기본값은 dryRun=true 이며 실행하려면 TOSSINVEST_ENABLE_TRADING=true 와 confirmation 이 필요합니다.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | 요청 본문 (application/json). 금액·수량·가격은 정밀도 보존을 위해 문자열로 전달합니다. | |
| path | Yes | URL 경로 파라미터 | |
| dryRun | No | 기본값 true. true 이면 토스증권 서버로 어떤 네트워크 요청도 보내지 않고 실행 계획만 반환합니다. 실제 주문을 내려면 false 로 명시해야 합니다. | |
| account | No | 요청에 사용할 계좌의 accountSeq. getAccounts 응답의 accountSeq 값을 사용합니다. 미지정 시 TOSSINVEST_DEFAULT_ACCOUNT 환경변수를 사용하며, 둘 다 없으면 호출하지 않고 오류를 반환합니다. | |
| confirmation | No | 실주문 확인 문자열. TOSSINVEST_MUTATION_CONFIRMATION 환경변수 값과 정확히 일치해야 실제 주문이 실행됩니다. |