Skip to content

Interface: ApiResponse<T> ​

Base API response wrapper used by all U-KOMI API endpoints. The API may return code as either a string or number.

Type Parameters ​

T ​

T

Properties ​

code ​

ts
code: string | number;

HTTP status code or API error code (may be string or number)


data? ​

ts
optional data?: T;

Response data payload (primary field)


response? ​

ts
optional response?: T;

Alternative response data field (used by some endpoints)


status ​

ts
status: string;

Response status (typically 'OK' for successful requests)