Get one online player
Look up the Dark Pawns admin API request and response contract. Sign in with a level 40 character and use the authenticated admin console session.
GET
/admin/players/{name}
const url = 'https://example.com/admin/players/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/admin/players/exampleParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
ac
required
integer format: int64
affects
required
integer format: int64
alignment
required
integer format: int64
bank_gold
required
integer format: int64
class
required
integer format: int64
connected_at
required
string
damroll
required
integer format: int64
equipment
required
Array<object> | null
object
count
required
integer format: int64
name
required
string
slot
string
vnum
required
integer format: int64
exp
required
integer format: int64
gold
required
integer format: int64
health
required
integer format: int64
hitroll
required
integer format: int64
inventory
required
Array<object> | null
object
count
required
integer format: int64
name
required
string
slot
string
vnum
required
integer format: int64
last_active
required
string
level
required
integer format: int64
mana
required
integer format: int64
max_health
required
integer format: int64
max_mana
required
integer format: int64
max_move
required
integer format: int64
move
required
integer format: int64
name
required
string
race
required
integer format: int64
room
required
integer format: int64
sex
required
integer format: int64
stats
required
object
key
additional properties
integer format: int64
thac0
required
integer format: int64
Example generated
{ "ac": 1, "affects": 1, "alignment": 1, "bank_gold": 1, "class": 1, "connected_at": "example", "damroll": 1, "equipment": [ { "count": 1, "name": "example", "slot": "example", "vnum": 1 } ], "exp": 1, "gold": 1, "health": 1, "hitroll": 1, "inventory": [ { "count": 1, "name": "example", "slot": "example", "vnum": 1 } ], "last_active": "example", "level": 1, "mana": 1, "max_health": 1, "max_mana": 1, "max_move": 1, "move": 1, "name": "example", "race": 1, "room": 1, "sex": 1, "stats": { "additionalProperty": 1 }, "thac0": 1}default
Section titled “default”Error
Media typeapplication/problem+json
object
detail
A human-readable explanation specific to this occurrence of the problem.
string
errors
Optional list of individual error details
Array<object> | null
object
location
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
string
message
Error message text
string
value
The value at the given location
instance
A URI reference that identifies the specific occurrence of the problem.
string format: uri
status
HTTP status code
integer format: int64
title
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
string
type
A URI reference to human-readable documentation for the error.
string format: uri
Example
{ "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}