{"id":17435552,"url":"https://github.com/ju0x/palworldapi","last_synced_at":"2026-03-04T12:03:52.418Z","repository":{"id":257826771,"uuid":"871956509","full_name":"Ju0x/palworldapi","owner":"Ju0x","description":"Easy to use wrapper for the Palworld REST API","archived":false,"fork":false,"pushed_at":"2024-10-14T14:52:33.000Z","size":26,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-16T03:55:49.632Z","etag":null,"topics":["api","go","golang","palworld","palworld-dedicated-server","palworld-server","rest","server"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ju0x.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-13T12:20:19.000Z","updated_at":"2025-02-17T21:57:43.000Z","dependencies_parsed_at":"2024-10-19T08:52:23.952Z","dependency_job_id":null,"html_url":"https://github.com/Ju0x/palworldapi","commit_stats":null,"previous_names":["ju0x/palworldapi"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Ju0x/palworldapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ju0x%2Fpalworldapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ju0x%2Fpalworldapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ju0x%2Fpalworldapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ju0x%2Fpalworldapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ju0x","download_url":"https://codeload.github.com/Ju0x/palworldapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ju0x%2Fpalworldapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30079565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T11:57:42.557Z","status":"ssl_error","status_checked_at":"2026-03-04T11:56:10.793Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","go","golang","palworld","palworld-dedicated-server","palworld-server","rest","server"],"created_at":"2024-10-17T10:00:38.715Z","updated_at":"2026-03-04T12:03:51.265Z","avatar_url":"https://github.com/Ju0x.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Palworld API Wrapper\n![GitHub License](https://img.shields.io/github/license/Ju0x/palworldapi)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/96c7fd4725fa49c88121c7e1af158899)](https://app.codacy.com/gh/Ju0x/palworldapi/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![Go Report Card](https://goreportcard.com/badge/github.com/Ju0x/palworldapi)](https://goreportcard.com/report/github.com/Ju0x/palworldapi)\n\n\n\u003cdiv align=\"center\"\u003e\n\n\n\u003cimg src=\"https://github.com/user-attachments/assets/c2693a70-0c25-4308-937f-e5f97137176c\" width=\"240px\" height=\"104px\"\u003e\n\n\n\nEasy to use wrapper for the Palworld REST API\n\n[Set up a Palworld Server](https://tech.palworldgame.com/)\n\n[Read the API Docs](https://tech.palworldgame.com/category/rest-api)\n\u003c/div\u003e\n\n## Installation\n\nYou can install the package by using `go get` in your Go Project.\n\n```\ngo get -u github.com/Ju0x/palworldapi\n```\nThis will pull the latest release.\n\n## Usage\n\nFirst you need to initialize a new PalworldAPI instance with credentials.\n\n```go\npal := palworldapi.New(\"http://localhost:8212\", \"admin\", \"admin password\")\n```\n\nTypically the username is `admin`.\n\nThe `AdminPassword` is set in the Server Configuration. ([How to configure the Palworld Server](https://tech.palworldgame.com/settings-and-operation/configuration))\n\n\nThe REST API must be activated on the server with the `RESTAPIEnabled=True` option.\n\n\n### First Hello World\n\nWith the palworldapi instance you are now able to use the wrapper functions.\n\n```go\npackage main\n\nimport \"github.com/Ju0x/palworldapi\"\n\nfunc main() {\n    pal := palworldapi.New(\"http://localhost:8212\", os.Getenv(\"USERNAME\"), os.Getenv(\"ADMIN_PASSWORD\"))\n\n    // Sends the message to the server globally\n    pal.Announce(\"Hello World!\")\n}\n```\n\nThen run it\n```\nUSERNAME=admin ADMIN_PASSWORD=your_admin_password go run .\n```\n\nThe result should look like this:\n\n\u003cimg src=\"https://github.com/user-attachments/assets/d2d986da-5295-4a3d-ad83-57ea1cd058d4\" height=\"48px\"\u003e\n\n\n## Examples\n\nYou can find some examples [here](https://github.com/Ju0x/palworldapi/tree/main/examples)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fju0x%2Fpalworldapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fju0x%2Fpalworldapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fju0x%2Fpalworldapi/lists"}