This page serves as the single source of truth for all data models and enumeration values used across the JusPredict Backend API. Use these definitions to interpret response data and structure requests correctly.
All numeric values in the API correspond to the following enumeration definitions.
| Value | Name | Description |
|---|
0 | SUCCESS | Operation completed successfully. |
1 | WARN | Completed with non-critical warnings. |
2 | ERROR | Operation failed. |
| Value | Name | Description |
|---|
0 | UNKNOWN | Status unavailable. |
1 | SERVING | Service is healthy. |
2 | NOT_SERVING | Service is down. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Default or unknown status. |
1 | CREATED | Account created, pending activation. |
2 | PENDING_ACTIVATION | Waiting for OTP verification. |
3 | PENDING_PASSWORDUPDATE | Required password change. |
4 | ACTIVE | Account is fully functional. |
5 | INACTIVE | Account is manually disabled. |
6 | DISABLED | System-level account suspension. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Unknown status. |
1 | UNREAD | Message has not been seen. |
2 | READ | Message has been acknowledged. |
3 | ARCHIVED | Hidden from main list. |
4 | DELETED | Soft-deleted from system. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Default or unknown platform. |
1 | GOOGLE | Google authentication. |
2 | APPLE | Apple authentication. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Status unknown. |
1 | UPCOMING | Event is scheduled but not started. |
2 | ACTIVE | Event is currently live. |
3 | CLOSED | Event has finished. |
4 | CANCELLED | Event was aborted. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Status unknown. |
1 | ACCEPTED | Order placed and accepted. |
2 | MATCHED | Prediction matched with another user. |
3 | SETTLED | Final outcome determined and paid out. |
4 | CANCELLED | Cancelled by user. |
6 | EXITED | Position closed early by user. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Status unknown. |
1 | ACTIVE | Question is open for predictions. |
2 | INACTIVE | Question is temporarily closed. |
3 | COMPLETED | Question has been resolved. |
4 | UPCOMING | Question is scheduled for later. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Status unknown. |
1 | OPEN | Order is active in the book. |
2 | PENDING | Waiting for processing. |
5 | PARTIALLY_FILLED | Some volume matched. |
6 | FILLED | Entire volume matched. |
7 | CANCELLED | Order removed by user. |
| Value | Name | Description |
|---|
0 | UNKNOWN | Type not specified. |
1 | NEW_PREDICTION | Initial entry order. |
2 | EXIT_PREDICTION | Position closing order. |
The standard response wrapper for almost all API calls.
| Field | Type | Description |
|---|
type | StatusType | Overall outcome (Success/Warn/Error). |
details | StatusDetails[] | Collection of specific error codes and messages. |
Detailed diagnostic information for a status.
| Field | Type | Description |
|---|
type | StatusType | Severity of this specific detail. |
code | uint64 | Internal error or warning code. |
message | string | Human-readable diagnostic message. |
Detailed user profile information.
| Field | Type | Description |
|---|
username | string | Unique system identifier. |
email | string | Verified email address. |
first_name | string | User’s legal first name. |
last_name | string | User’s legal last name. |
user_status | UserStatus | Current account state. |
is_masked_email | bool | Privacy flag for email display. |
The core object representing a sports match or tournament.
| Field | Type | Description |
|---|
id | string (uuid) | Unique event identifier. |
name | string | Full name of the event. |
status | EventStatus | Current lifecycle stage of the event. |
category | int32 | Category ID (1: Sports, 2: Politics, etc). |
start_date | int64 | Start time in epoch seconds. |
A specific outcome that can be predicted within an event.
| Field | Type | Description |
|---|
question_id | string (uuid) | Unique question identifier. |
name | string | The text of the prediction question. |
status | QuestionStatus | Current availability of the question. |
event_id | string (uuid) | Parent event identifier. |
Full data for a single prediction record.
| Field | Type | Description |
|---|
prediction_id | string (uuid) | Unique identifier for the prediction. |
event_name | string | Name of the related event. |
question | string | The text of the question. |
investment_amt | string | Amount of credits wagered. |
prediction_status | PredictionStatus | Current state of the prediction. |
Tracking data for a prediction order in the book.
| Field | Type | Description |
|---|
order_id | string (uuid) | Unique order identifier. |
matched_amt | string | Portion of order currently matched. |
order_status | OrderStatus | Current matching state. |
order_type | OrderType | Entry vs Exit order. |
Real-time market statistics for a question outcome.
| Field | Type | Description |
|---|
question_id | string (uuid) | Target question identifier. |
outcome | string | Name of the outcome (e.g., “Yes”, “Team A”). |
implied_probability | string | Market-derived probability (0.0 to 1.0). |
invested_amount | string | Total volume for this outcome. |
Used for registering user hardware for notifications.
| Field | Type | Description |
|---|
device_id | string | Unique hardware UUID. |
os_type | DeviceOSType | 1: Android, 2: iOS. |
fcm_token | string | Firebase Cloud Messaging token. |
| Value | Name | Description |
|---|
0 | UNSPECIFIED | Unknown OS. |
1 | ANDROID | Google Android platform. |
2 | IOS | Apple iOS platform. |
Metadata returned in all paginated list responses.
| Field | Type | Description |
|---|
current_page | int32 | The current page index. |
page_size | int32 | Number of records per page. |
total_pages | int32 | Total available pages. |
total_records | int32 | Grand total of records across all pages. |