Zum Inhalt

GET /player/{player_identifier}

Endpunkt: GET /v1/pdapi/player/<player_identifier>

Auth: Bearer-Token

Berechtigung: REST.Player.Read

Zweck

Gibt einen Spieler zurück. Der Identifier kann ein unterstützter Spieler-Identifier wie UserId oder PlayerUID sein.

Pfadparameter

  • player_identifier: UserId oder PlayerUID des Zielspielers.

Query-Parameter

Keine.

Request-Body

Kein Request-Body.

Antwortschema

200 response schema

Field Type Description
Player object Player details.

Player object schema:

Field Type Description
Name string Current or saved player name.
IP string Player IP address, or an empty string when unavailable.
PlayerUID string Player UID used by Palworld save data.
UserId string Platform user ID, or an empty string when unavailable.
GuildName string Guild name, or an empty string when unavailable.
GuildUUID string Guild UUID, or a zero GUID when unavailable.
Status string Saved player account state.
WorldLocation object Current or last saved world coordinates.
MapLocation object Converted map coordinates.

Location object schema:

Field Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

Fehlerantworten

Fehlerantworten verwenden dieses Format:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Für Menschen lesbare Nachricht",
        "Details": {}
    }
}
HTTP Fehlercode Wann es passiert
401 INVALID_TOKEN Der Authorization-Header fehlt, ist fehlerhaft oder passt zu keinem konfigurierten Bearer-Token.
403 MISSING_PERMISSION Das Token ist gültig, enthält aber nicht die Berechtigung für diesen Endpunkt.
400 INVALID_JSON Ein Request-Body wurde gesendet, konnte aber nicht als JSON gelesen werden.
400 REQUEST_FAILED Der Game-Thread-Callback hat eine Ausnahme ausgelöst oder ein gemeinsamer Spieler-/Ressourcen-Resolver ist fehlgeschlagen.
500 REQUEST_TIMEOUT Der interne Game-Thread-Callback wurde nicht innerhalb von 5 Sekunden abgeschlossen.
404 PLAYER_NOT_FOUND No online player matched the supplied player_identifier.
404 PLAYER_ACCOUNT_NOT_FOUND Der Spieler wurde gefunden, aber die Player-Account-Daten konnten nicht geladen werden.

Beispiele

Lookup by Steam UserID

GET /v1/pdapi/player/steam_76561198012345678

Lookup by PlayerUID

GET /v1/pdapi/player/b7f4e91a-2c53-4d8f-a6e1-93c4bb62a7d1

Szenarien

  • Öffne eine Spieler-Detailseite, nachdem du eine Zeile aus GET /players ausgewählt hast.
  • Confirm the target before giving rewards or applying punishments.
  • Check whether the player can currently be resolved by the server.