Palworld API

Query basic Pal stats and Pal breeding combinations

Usage

To start using the API, follow these steps:

1. Sign up for RapidAPI.
2. Subscribe to the Palworld API.
3. Obtain your API key from RapidAPI.
4. Make requests to the desired endpoints.

Endpoints

Please visit RapidAPI for usage.

Authentication

The API uses API key authentication. To authenticate your requests, include your API key in the request headers.

Rate Limits

100 requests per day. Might change this later.

Example Usage

Current parameters include the following:

GET api/pals/Lamball

{
  "data": {
    "id": 1,
    "image": "https://static.wikia.nocookie.net/palworld/images/0/01/Lamball_menu.png/",
    "pal": "Lamball",
    "wiki": "https://palworld.fandom.com/wiki/Lamball"
  },
  "status": "success"
}

GET api/skills/Lamball

{
  "data": {
    "id": 1,
    "pal": "Lamball",
    "skills": {
      "skill_0": {
        "desc": "Lamball's special skill. Curls into a ball, rolling after any enemies in its way. Becomes dizzy and unable to move after the attack ends.",
        "name": "roly_poly",
        "power": 35,
        "type": "neutral"
      },
      ...
    }
  },
  "status": "success"
}

GET api/pals_info/Lamball

{
  "data": {
    "genus": "humanoid",
    "id": 1,
    "name": "Lamball",
    "price": 1000,
    "rarity": 1,
    "size": "xs",
    "type_0": "neutral",
    "type_1": null
  },
  "status": "success"
}

POST api/pals/breeding_calc

Body

{
"father": "Lamball",
 "mother": "Cattiva"
}

GET api/pal_drops/Lamball

{
  "data": {
    "drop 0": "wool",
    "drop 1": "lamball_mutton",
    "drop 2": null,
    "drop 3": null,
    "id": 1,
    "name": "Lamball"
  },
  "status": "success"
}

GET api/pal_suitabilities/Lamball

{
  "data": {
    "id": 1,
    "level_0": 1,
    "level_1": 1,
    "level_2": 1,
    "level_3": null,
    "level_4": null,
    "level_5": null,
    "level_6": null,
    "name": "Lamball",
    "suitability_0": "handiwork",
    "suitability_1": "transporting",
    "suitability_2": "farming",
    "suitability_3": null,
    "suitability_4": null,
    "suitability_5": null,
    "suitability_6": null
  },
  "status": "success"
}

Contribution

Setting up

You will need to manually migrate the data found in data into a postgress DB. The table names are the same as the file names. Put your db instance url in a .env file in the root directory of the project.

palworld-api
|
├── .env
├── .git
├── .gitignore
├── Cargo.lock
├── Cargo.toml
├── Dockerfile
├── data
├── src
└── target

The variable should be set up as follows.

DATABASE_URL=[your database url]

Building and testing the project

To build the project just run:

cargo run

You can thest endpoints via curl or postman

curl localhost:8000/api/pal_suitabilities/Lamball

PRs

Please follow these steps

1. Create a new branch for your feature or bug fix.
2. Make your changes and create PR
3. I'll review the PR and once it gets merged an automatic build will start and deploy to google cloud