HomeGuidesAPI ReferenceAnnouncements
AnnouncementsGuidesAPI ReferenceSupportFAQ
API Reference

요청 포맷

연결이 성공적으로 이루어졌다면 웹소켓 서버에 여러가지 요청을 할 수 있습니다.
요청은 JSON Object를 이용하며 응답 또한 JSON Object 입니다.

요청은 크게 ticket field, type field, format field 로 나누어지며 각각의 필드는 다음 구성요소로 이루어져 있습니다.

📘

Request format

[{Ticket Field},{Type Field},....,{Type Field},{Format Field}]

Ticket Field

일반적으로 용도를 식별하기 위해 ticket 이라는 필드값이 필요합니다.
이 값은 시세를 수신하는 대상을 식별하며 되도록 유니크한 값을 사용하도록 권장합니다. (UUID 등)

필드명
타입
내용
필수 여부
ticketString요청자를 식별할 수 있는 값O

Type Field

수신하고 싶은 시세 정보를 나열하는 필드입니다.
isOnlySnapshot, isOnlyRealtime 필드는 생략 가능하며 모두 생략시 스냅샷과 실시간 데이터 모두를 수신합니다.

하나의 요청에 {type field}는 여러개를 명시할 수 있습니다. 자세한 요청 방법은 타입별 요청 및 응답을 참고하시길 바랍니다.

Format Field

마지막으로 포맷 정보입니다. Simple로 지정될 경우 응답의 필드명이 모두 간소화됩니다. 트래픽 부담이 클 때 사용하는 방법입니다.

필드명
타입
내용
필수 여부
기본 값
formatString수신할 포맷
- DEFAULT: 기본형
- SIMPLE: 축약형
XDEFAULT