Aller au contenu

GET /pals/{player_identifier}

Point final : GET /v1/pdapi/pals/<player_identifier>

Auth : Jeton du porteur

Autorisation : REST.Pals.Read

Objectif

Répertorie le Pals du joueur cible. Les identifiants Pal dans les réponses peuvent être recherchés sur paldeck.cc/pals.

Paramètres du chemin

  • player_identifier : UserId ou PlayerUID pour le joueur cible.

Paramètres de requête

Aucun.

Corps de la demande

Aucun corps de requête.

Schéma de réponse

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.

Réponses aux erreurs

Les corps d'erreur utilisent cette forme :

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Code d'erreur Quand ça arrive
401 INVALID_TOKEN L'en-tête Authorization est manquant, mal formé ou ne correspond pas à un jeton de support configuré.
403 MISSING_PERMISSION Le jeton est valide, mais il n'inclut pas cette autorisation de point de terminaison.
400 INVALID_JSON Un corps de requête a été fourni, mais il n'a pas pu être analysé comme JSON.
400 REQUEST_FAILED Le rappel du thread de jeu a généré une exception ou un résolveur player/resource partagé a échoué.
500 REQUEST_TIMEOUT Le rappel du thread de jeu interne ne s'est pas terminé dans les 5 secondes.
404 PLAYER_NOT_FOUND Aucun joueur en ligne ne correspond au player_identifier fourni.
404 PLAYER_STATE_NOT_FOUND Le lecteur existe, mais son APalPlayerState n'était pas disponible.

Exemples

Lisez Pals pour un lecteur PS5

GET /v1/pdapi/pals/ps5_0f4b8c2d91aa34ef

Lire Pals par PlayerUID

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

Scénarios

  • Examinez un joueur avant les actions de support.
  • Confirmez qu'une récompense Pal est arrivée après avoir utilisé POST /give/pals ou POST /give/paltemplate.
  • Enquêter sur les rapports concernant des Pals manquants ou inattendus.