본문으로 건너뛰기
HTTP API서비스

Local API 상태

요청 만들기

값을 바꾸면 명령이 함께 바뀝니다. 토큰은 여기에 입력하지 않습니다. 명령은 SPECTRE_LOCAL_API_TOKEN 환경 변수에서 토큰을 읽습니다. 자신의 터미널에서 실행하세요.

명령
curl 'http://127.0.0.1:48180/v1/health' \
  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
GET
/health

인증

bearerToken
header인증Bearer <token>

Local API 토큰입니다: spt_와 16진수 문자 64개. Settings App → 일반 → Local API에서 복사합니다. Authorization 헤더로만 받습니다. 작업에 나열된 이름은 그 작업에 필요한 권한입니다. 터미널의 토큰에는 모든 권한이 있습니다.

응답 본문

Local API의 상태와 카운터입니다.

application/json
  1. response
status*string

API가 응답하는 동안에는 ok입니다.

uptime_ms*integer
형식int64
clients*integer

스트림 연결 수입니다.

streams*integer

API가 지금 제공하고 있는 페어 수입니다.

api_only_instruments*integer

그중 API만을 위해 열린 페어 수입니다.

dropped_events*integer

터미널 과부하로 어떤 클라이언트에도 전달되지 못한 시장 이벤트 수입니다.

형식int64
dropped_frames*integer

너무 느리게 읽는 클라이언트 때문에 버려진 프레임 수입니다.

형식int64
overflow_closes*integer

코드 4008로 닫힌 스트림 연결 수입니다.

형식int64
stream_available*boolean

터미널이 시장 데이터를 포함해 빌드되었는지 여부입니다. 포함되지 않았으면 스트림과 시장 작업은 unsupported로 응답합니다.

요청 예제
curl 'http://127.0.0.1:48180/v1/health' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
응답 예제
{  "status": "ok",  "uptime_ms": 1234,  "clients": 1,  "streams": 3,  "api_only_instruments": 2,  "dropped_events": 0,  "dropped_frames": 0,  "overflow_closes": 0,  "stream_available": true}