Skip to main content
GET
/
v1
/
accounts
/
{account_id}
Get Account Details
curl --request GET \
  --url https://api.predictamarkets.com/v1/accounts/{account_id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": 1042,
  "qid": "ACC-1042",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@example.com",
  "account_type": "PLAYER",
  "currency": "KES",
  "language": "EN",
  "phone_number": "+254700000000",
  "date_of_birth": "1990-05-15",
  "national_id": null,
  "gender": "female",
  "address": "123 Main St",
  "city": "Nairobi",
  "country": "KE",
  "photo_url": null,
  "display_currency": null,
  "balance": "4500.00",
  "blocked_balance": "0.00",
  "is_verified": true,
  "referral_code": "JANE42",
  "external_user_id": "550e8400-e29b-41d4-a716-446655440000",
  "blocked_from_chatting_at": null,
  "blocked_from_wagering_at": null,
  "blocked_from_withdrawal_at": null,
  "reputation_score": 12,
  "created_at": "2024-03-01T10:00:00Z",
  "updated_at": "2025-05-01T08:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.predictamarkets.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
default:your-api-key-here
required

Path Parameters

​
account_id
required

Account ID (integer) or QID string (e.g. ACC-1042) Flexible identifier type that accepts either a numeric integer ID or a human-readable qualified ID string (QID). QIDs follow a prefix convention: MA for markets, MAA for market assets, AP for account payouts. Most path parameters that accept an ID use this type so callers can use whichever form is more convenient.

Response

Account details

Full account profile returned by GET /v1/accounts/{account_id} and account mutation endpoints. Includes identity fields, balance totals, verification status, and moderation flags.

​
first_name
string
required
​
last_name
string
required
​
account_type
enum<string>
required

Role of the account: PLAYER (standard user) or HUB (B2B operator sub-platform).

Available options:
PLAYER,
HUB
​
currency
enum<string>
required

ISO currency code or platform token. PT is Predicta's internal token used for most markets. USDC and USDT are supported stablecoins. All other values are standard ISO 4217 fiat codes.

Available options:
NGN,
USD,
KES,
GHS,
ZAR,
XOF,
TZS,
EUR,
GBP,
CAD,
AUD,
CHF,
CNY,
INR,
MXN,
NZD,
RUB,
SEK,
SGD,
THB,
TRY,
UAH,
VND,
JPY,
UGX,
RWF,
USDC,
USDT,
PT
​
language
enum<string>
required
Available options:
EN,
KIS
​
id
integer
required
​
balance
string
required

Total account balance in the account's primary currency (available + suspense). For a detailed breakdown see GET /v1/accounts/{account_id}/balances.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
email
string
required
​
is_verified
boolean
required

True if the account has passed identity verification (KYC). Some features and higher withdrawal limits require verification.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
reputation_score
integer
required

Platform reputation score for the account. Increases through activity (trading, winning, referrals) and decreases through policy violations. May gate certain platform features.

​
phone_number
string | null
​
date_of_birth
string<date> | null
​
national_id
string | null
​
gender
string | null
​
address
string | null
​
city
string | null
​
country
string | null
​
photo_url
string | null
​
display_currency
enum<string> | null

ISO currency code or platform token. PT is Predicta's internal token used for most markets. USDC and USDT are supported stablecoins. All other values are standard ISO 4217 fiat codes.

Available options:
NGN,
USD,
KES,
GHS,
ZAR,
XOF,
TZS,
EUR,
GBP,
CAD,
AUD,
CHF,
CNY,
INR,
MXN,
NZD,
RUB,
SEK,
SGD,
THB,
TRY,
UAH,
VND,
JPY,
UGX,
RWF,
USDC,
USDT,
PT
​
qid
string | null

Human-readable qualified ID for this account (e.g. ACC-1042). Computed from the numeric id — not stored as a column. Can be used interchangeably with the numeric id in path parameters.

​
blocked_balance
string
default:0

Amount currently blocked/frozen by an operator (e.g. for compliance review). This is separate from suspense and cannot be used for trading or withdrawal.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
external_user_id
string<uuid> | null

UUID assigned by the authentication provider (OAuth2 sub claim). Links this account to the identity record in the auth system.

​
referral_code
string | null

This account's unique referral code. Share this code or append it to a link to earn referral commissions when new users sign up and trade.

​
blocked_from_chatting_at
string<date-time> | null

If set, the timestamp when this account was blocked from the platform chat. Null if not blocked.

​
blocked_from_wagering_at
string<date-time> | null

If set, the timestamp when this account was blocked from placing orders (wagering). Null if not blocked.

​
blocked_from_withdrawal_at
string<date-time> | null

If set, the timestamp when this account was blocked from withdrawing funds. Null if not blocked.