{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://paltoolkit.com/api/v1/schema.json","title":"PalToolkit Palworld API v1","description":"Every file except index.json and schema.json is {meta, data}. $defs.endpoints maps each path pattern to the schema of the whole file.","$defs":{"slug":{"type":"string","pattern":"^[a-z0-9]+(-[a-z0-9]+)*$"},"url":{"type":["string","null"],"pattern":"^https?://"},"date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pair":{"type":"array","items":{"$ref":"#/$defs/slug"},"minItems":2,"maxItems":2},"meta":{"type":"object","required":["api","game_version","data_updated","license","attribution","docs","sources"],"properties":{"api":{"const":"v1"},"game_version":{"type":"string"},"data_updated":{"$ref":"#/$defs/date"},"license":{"type":"string"},"attribution":{"const":"Data by PalToolkit (paltoolkit.com)"},"docs":{"$ref":"#/$defs/url"},"sources":{"type":"array","items":{"type":"string"}}}},"point":{"type":"object","required":["map","x","y"],"properties":{"map":{"enum":["palpagos","tree"]},"x":{"type":"number"},"y":{"type":"number"}}},"envelope":{"type":"object","required":["meta","data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/$defs/meta"},"data":{}}},"work":{"type":"object","additionalProperties":{"type":"integer","minimum":1}},"pal_row":{"type":"object","required":["slug","name","paldeck","elements","rarity","work","stats","url","api_url"],"properties":{"slug":{"$ref":"#/$defs/slug"},"name":{"type":"string"},"paldeck":{"type":["string","null"]},"paldeck_no":{"type":["integer","null"]},"variant":{"type":"boolean"},"elements":{"type":"array","items":{"$ref":"#/$defs/slug"},"minItems":0,"maxItems":2,"description":"empty for Astralym (no element)"},"rarity":{"type":["integer","null"]},"combi_rank":{"type":["integer","null"]},"work":{"$ref":"#/$defs/work"},"stats":{"type":"object"},"egg":{"type":["string","null"]},"image":{"$ref":"#/$defs/url"},"url":{"$ref":"#/$defs/url"},"api_url":{"$ref":"#/$defs/url"}}},"pal":{"type":"object","required":["slug","name","elements","stats","work","active_skills","innate_passives","spawns","breeding","url"],"properties":{"slug":{"$ref":"#/$defs/slug"},"name":{"type":"string"},"elements":{"type":"array","items":{"$ref":"#/$defs/slug"}},"stats":{"type":"object","required":["hp","attack","defense"]},"work":{"$ref":"#/$defs/work"},"active_skills":{"type":"array","items":{"type":"object","required":["skill"],"properties":{"skill":{"$ref":"#/$defs/slug"},"level":{"type":["integer","null"]}}}},"innate_passives":{"type":"array","items":{"$ref":"#/$defs/slug"}},"egg":{"type":["object","null"],"properties":{"slug":{"$ref":"#/$defs/slug"}}},"spawns":{"type":"object"},"breeding":{"type":"object","required":["combo_count","earliest_pair","api_url"],"properties":{"combo_count":{"type":"integer","minimum":0},"earliest_pair":{"oneOf":[{"$ref":"#/$defs/pair"},{"type":"null"}]},"api_url":{"$ref":"#/$defs/url"}}},"images":{"type":["object","null"]},"url":{"$ref":"#/$defs/url"}}},"breeding_child":{"type":"object","required":["child","name","combo_count","combo_count_definition","earliest_pair","pairs","gender_required","url"],"properties":{"child":{"$ref":"#/$defs/slug"},"combo_count":{"type":"integer","minimum":0},"earliest_pair":{"type":["object","null"],"properties":{"parents":{"$ref":"#/$defs/pair"},"catch_level":{"type":["integer","null"]}}},"pairs":{"type":"array","items":{"$ref":"#/$defs/pair"}},"gender_required":{"type":"array","items":{"type":"object","required":["parents","gender"]}}}},"matrix":{"type":"object","required":["pals","n","layout","child","gendered"],"properties":{"pals":{"type":"array","items":{"$ref":"#/$defs/slug"}},"n":{"type":"integer"},"layout":{"type":"string"},"child":{"type":"array","items":{"type":"integer","minimum":-1}},"gendered":{"type":"array"}}},"item_row":{"type":"object","required":["slug","id","name","category","rarity","price","url","api_url"],"properties":{"slug":{"$ref":"#/$defs/slug"},"id":{"type":"string"},"name":{"type":"string"},"category":{"type":["string","null"]},"subcategory":{"type":["string","null"]},"rarity":{"type":["integer","null"]},"price":{"type":["number","null"]},"max_stack":{"type":["integer","null"]},"image":{"$ref":"#/$defs/url"},"url":{"$ref":"#/$defs/url"},"api_url":{"$ref":"#/$defs/url"}}},"item":{"type":"object","required":["slug","id","name","category","sold_by"],"properties":{"slug":{"$ref":"#/$defs/slug"},"sold_by":{"type":"array"},"teaches_skill":{"type":["string","null"]},"implants_passive":{"type":["string","null"]},"hatches":{"type":["array","null"],"items":{"$ref":"#/$defs/slug"}}}},"passive":{"type":"object","required":["slug","name","rank","effects"],"properties":{"slug":{"$ref":"#/$defs/slug"},"rank":{"type":["integer","null"]},"effects":{"type":"array"},"innate_on":{"type":"array","items":{"$ref":"#/$defs/slug"}}}},"skill":{"type":"object","required":["slug","name","element","learned_by"],"properties":{"slug":{"$ref":"#/$defs/slug"},"power":{"type":["number","null"]},"learned_by":{"type":"array"}}},"element":{"type":"object","required":["slug","name","strong_against","weak_to","pals"]},"work_type":{"type":"object","required":["slug","name","pals"]},"merchant":{"allOf":[{"$ref":"#/$defs/point"},{"type":"object","required":["name","currency"]}]},"endpoints":{"type":"object","properties":{"pals.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/pal_row"}}}}]},"pals/{slug}.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"$ref":"#/$defs/pal"}}}]},"breeding.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"object","required":["rule","pair_count","unique_recipes","children"]}}}]},"breeding/matrix.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"$ref":"#/$defs/matrix"}}}]},"breeding/{child}.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"$ref":"#/$defs/breeding_child"}}}]},"items.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/item_row"}}}}]},"items/{slug}.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"$ref":"#/$defs/item"}}}]},"passives.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/passive"}}}}]},"skills.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/skill"}}}}]},"elements.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/element"}}}}]},"work.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/work_type"}}}}]},"eggs.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"object","required":["rule","eggs","wild_spawns"]}}}]},"bosses.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"object","required":["alpha","bounty","towers"],"properties":{"alpha":{"type":"array","items":{"$ref":"#/$defs/point"}},"bounty":{"type":"array","items":{"$ref":"#/$defs/point"}},"towers":{"type":"array","items":{"$ref":"#/$defs/point"}}}}}}]},"collectibles.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"object","required":["types"]}}}]},"collectibles/{type}.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/point"}}}}]},"merchants.json":{"allOf":[{"$ref":"#/$defs/envelope"},{"properties":{"data":{"type":"array","items":{"$ref":"#/$defs/merchant"}}}}]},"index.json":{"type":"object","required":["api_version","game_version","generated_at","endpoints","license","sources","excluded"]}}}}}