specs

Documentation

Index

• Variables
• func DefaultMethodForPath(path string) (string, bool)
• func DocumentedEndpointSpecCount() int
• type TossEndpointSpec
  • func LookupDocumentedEndpointSpec(method, path string) (TossEndpointSpec, bool)

Variables

var DocumentedTossEndpointSpecs = map[string]TossEndpointSpec{
	"GET /api/v1/accounts": {
		Path:            "/api/v1/accounts",
		Method:          "GET",
		OperationID:     "getAccounts",
		Tag:             "Account",
		Summary:         "계좌 목록 조회",
		RateLimitGroup:  "ACCOUNT",
		AccountRequired: false,
	},
	"GET /api/v1/buying-power": {
		Path:            "/api/v1/buying-power",
		Method:          "GET",
		OperationID:     "getBuyingPower",
		Tag:             "Order Info",
		Summary:         "매수 가능 금액 조회",
		RateLimitGroup:  "ORDER_INFO",
		AccountRequired: true,
	},
	"GET /api/v1/candles": {
		Path:            "/api/v1/candles",
		Method:          "GET",
		OperationID:     "getCandles",
		Tag:             "Market Data",
		Summary:         "캔들 차트 조회",
		RateLimitGroup:  "MARKET_DATA_CHART",
		AccountRequired: false,
	},
	"GET /api/v1/commissions": {
		Path:            "/api/v1/commissions",
		Method:          "GET",
		OperationID:     "getCommissions",
		Tag:             "Order Info",
		Summary:         "매매 수수료 조회",
		RateLimitGroup:  "ORDER_INFO",
		AccountRequired: true,
	},
	"GET /api/v1/exchange-rate": {
		Path:            "/api/v1/exchange-rate",
		Method:          "GET",
		OperationID:     "getExchangeRate",
		Tag:             "Market Info",
		Summary:         "환율 조회",
		RateLimitGroup:  "MARKET_INFO",
		AccountRequired: false,
	},
	"GET /api/v1/holdings": {
		Path:            "/api/v1/holdings",
		Method:          "GET",
		OperationID:     "getHoldings",
		Tag:             "Asset",
		Summary:         "보유 주식 조회",
		RateLimitGroup:  "ASSET",
		AccountRequired: true,
	},
	"GET /api/v1/market-calendar/KR": {
		Path:            "/api/v1/market-calendar/KR",
		Method:          "GET",
		OperationID:     "getKrMarketCalendar",
		Tag:             "Market Info",
		Summary:         "국내 장 운영 정보 조회",
		RateLimitGroup:  "MARKET_INFO",
		AccountRequired: false,
	},
	"GET /api/v1/market-calendar/US": {
		Path:            "/api/v1/market-calendar/US",
		Method:          "GET",
		OperationID:     "getUsMarketCalendar",
		Tag:             "Market Info",
		Summary:         "해외 장 운영 정보 조회",
		RateLimitGroup:  "MARKET_INFO",
		AccountRequired: false,
	},
	"GET /api/v1/orderbook": {
		Path:            "/api/v1/orderbook",
		Method:          "GET",
		OperationID:     "getOrderbook",
		Tag:             "Market Data",
		Summary:         "호가 조회",
		RateLimitGroup:  "MARKET_DATA",
		AccountRequired: false,
	},
	"GET /api/v1/orders": {
		Path:            "/api/v1/orders",
		Method:          "GET",
		OperationID:     "getOrders",
		Tag:             "Order History",
		Summary:         "주문 목록 조회",
		RateLimitGroup:  "ORDER_HISTORY",
		AccountRequired: true,
	},
	"POST /api/v1/orders": {
		Path:            "/api/v1/orders",
		Method:          "POST",
		OperationID:     "createOrder",
		Tag:             "Order",
		Summary:         "주문 생성",
		RateLimitGroup:  "ORDER",
		AccountRequired: true,
	},
	"GET /api/v1/orders/{orderId}": {
		Path:            "/api/v1/orders/{orderId}",
		Method:          "GET",
		OperationID:     "getOrder",
		Tag:             "Order History",
		Summary:         "주문 상세 조회",
		RateLimitGroup:  "ORDER_HISTORY",
		AccountRequired: true,
	},
	"POST /api/v1/orders/{orderId}/cancel": {
		Path:            "/api/v1/orders/{orderId}/cancel",
		Method:          "POST",
		OperationID:     "cancelOrder",
		Tag:             "Order",
		Summary:         "주문 취소",
		RateLimitGroup:  "ORDER",
		AccountRequired: true,
	},
	"POST /api/v1/orders/{orderId}/modify": {
		Path:            "/api/v1/orders/{orderId}/modify",
		Method:          "POST",
		OperationID:     "modifyOrder",
		Tag:             "Order",
		Summary:         "주문 정정",
		RateLimitGroup:  "ORDER",
		AccountRequired: true,
	},
	"GET /api/v1/price-limits": {
		Path:            "/api/v1/price-limits",
		Method:          "GET",
		OperationID:     "getPriceLimit",
		Tag:             "Market Data",
		Summary:         "상/하한가 조회",
		RateLimitGroup:  "MARKET_DATA",
		AccountRequired: false,
	},
	"GET /api/v1/prices": {
		Path:            "/api/v1/prices",
		Method:          "GET",
		OperationID:     "getPrices",
		Tag:             "Market Data",
		Summary:         "현재가 조회",
		RateLimitGroup:  "MARKET_DATA",
		AccountRequired: false,
	},
	"GET /api/v1/sellable-quantity": {
		Path:            "/api/v1/sellable-quantity",
		Method:          "GET",
		OperationID:     "getSellableQuantity",
		Tag:             "Order Info",
		Summary:         "판매 가능 수량 조회",
		RateLimitGroup:  "ORDER_INFO",
		AccountRequired: true,
	},
	"GET /api/v1/stocks": {
		Path:            "/api/v1/stocks",
		Method:          "GET",
		OperationID:     "getStocks",
		Tag:             "Stock Info",
		Summary:         "종목 기본 정보 조회",
		RateLimitGroup:  "STOCK",
		AccountRequired: false,
	},
	"GET /api/v1/stocks/{symbol}/warnings": {
		Path:            "/api/v1/stocks/{symbol}/warnings",
		Method:          "GET",
		OperationID:     "getStockWarnings",
		Tag:             "Stock Info",
		Summary:         "매수 유의사항 조회",
		RateLimitGroup:  "STOCK",
		AccountRequired: false,
	},
	"GET /api/v1/trades": {
		Path:            "/api/v1/trades",
		Method:          "GET",
		OperationID:     "getTrades",
		Tag:             "Market Data",
		Summary:         "최근 체결 내역 조회",
		RateLimitGroup:  "MARKET_DATA",
		AccountRequired: false,
	},
	"POST /oauth2/token": {
		Path:            "/oauth2/token",
		Method:          "POST",
		OperationID:     "issueOAuth2Token",
		Tag:             "Auth",
		Summary:         "OAuth2 액세스 토큰 발급",
		RateLimitGroup:  "AUTH",
		AccountRequired: false,
	},
}

DocumentedTossEndpointSpecs is generated from the Toss OpenAPI snapshot.

Functions

func DefaultMethodForPath

func DefaultMethodForPath(path string) (string, bool)

DefaultMethodForPath returns the only documented method for a path.

func DocumentedEndpointSpecCount

func DocumentedEndpointSpecCount() int

DocumentedEndpointSpecCount returns the number of generated Toss operations.

Types

type TossEndpointSpec

type TossEndpointSpec struct {
	Path            string
	Method          string
	OperationID     string
	Tag             string
	Summary         string
	RateLimitGroup  string
	AccountRequired bool
}

TossEndpointSpec defines one operation from the Toss Open API document.

func LookupDocumentedEndpointSpec

func LookupDocumentedEndpointSpec(method, path string) (TossEndpointSpec, bool)

LookupDocumentedEndpointSpec finds one generated Toss operation spec by method/path.