Zum Inhalt

GET /pals/{player_identifier}

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

Auth: Bearer-Token

Berechtigung: REST.Pals.Read

Zweck

Listet die Pals des Zielspielers. Pal-Identifier aus Antworten können auf paldeck.cc/pals gesucht werden.

Pfadparameter

  • player_identifier: UserId oder PlayerUID des Zielspielers.

Query-Parameter

Keine.

Request-Body

Kein Request-Body.

Antwortschema

200 response schema

Field Type Description
Meta object Target player metadata and Pal counts.
Pals object Team, Palbox, and base camp Pals for the target player.

Meta object schema:

Field Type Description
PlayerUID string Player UID used by Palworld save data.
Player string Player identifier supplied in the request path.
TeamCount integer Number of Pals in the player team.
PalboxCount integer Number of Pals in the player Palbox.
BaseCampCount integer Number of base camps included.

Pals object schema:

Field Type Description
Team object Team Pals keyed by Pal instance ID.
Palbox object Palbox Pals keyed by Pal instance ID.
BaseCamps object[] Guild base camps and their assigned worker Pals.

Pal object schema:

Field Type Description
PalID string Pal species identifier.
UniqueNPCID string Unique NPC ID, when present.
Nickname string Custom Pal nickname, or an empty string.
SkinId string Skin ID, or an empty string.
Gender string Pal gender.
Level integer Pal level.
Exp integer Pal EXP.
Shiny boolean Whether this is a rare Pal.
PartnerSkillLevel integer Partner skill rank.
CondensedPals integer Condense rank progress.
UnusedStatusPoints integer Unused Pal status points.
FriendshipPoints integer Friendship point value.
PhysicalHealth string Physical health state.
WorkerSick string Worker sickness state.
ImportedCharacter boolean Whether this is marked as imported.
HP number Current HP.
MP number Current MP, when present.
SP number Current stamina, when present.
Shield number Current shield value, when present.
Hunger number Current hunger value.
MaxHunger number Maximum hunger value.
SAN number Sanity value.
Support integer Support value.
CraftSpeed integer Craft speed value.
PalSouls object Pal soul ranks with Health, Attack, Defense, and CraftSpeed.
IVs object IV values with Health, AttackMelee, AttackShot, and Defense.
ActiveSkills string[] Equipped active skills.
LearntSkills string[] Learned skills.
Passives string[] Passive skill IDs.
ExtraWorkSuitabilities object Additional work suitability ranks keyed by suitability ID.
DisableWorkPreferences string[] Disabled work preference IDs.
team_slot_index integer Team slot index, only on Team Pals.
page integer Palbox page index, only on Palbox Pals.
slot integer Palbox slot index, only on Palbox Pals.
base_camp_slot_index integer Base camp worker slot index, only on base camp Pals.

BaseCamps[] item schema:

Field Type Description
id string Base camp GUID.
level integer Base camp level.
world_pos object Base camp world coordinates.
map_pos object Converted map coordinates.
state string Current base camp state.
pals object Base camp worker Pals keyed by Pal instance ID.

Coordinate 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_STATE_NOT_FOUND Der Spieler existiert, aber sein APalPlayerState war nicht verfügbar.

Beispiele

Read Pals for a PS5 player

GET /v1/pdapi/pals/ps5_0f4b8c2d91aa34ef

Read Pals by PlayerUID

GET /v1/pdapi/pals/6d2e8b40-73ef-4f11-9bb8-2e91a36e2f09

Szenarien