{"id":16327501,"url":"https://github.com/shinigami92/satisfactory-server-api-client","last_synced_at":"2025-03-20T22:31:55.227Z","repository":{"id":256440845,"uuid":"855293443","full_name":"Shinigami92/satisfactory-server-api-client","owner":"Shinigami92","description":"Universal Satisfactory Server API client for JavaScript","archived":false,"fork":false,"pushed_at":"2024-09-18T17:04:38.000Z","size":259,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-15T13:49:58.441Z","etag":null,"topics":["api-client","api-wrapper","coffeestain","dedicated-server","esm","fetch","fetch-api","ky","satisfactory","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/satisfactory-server-api-client","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Shinigami92.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-09-10T16:28:30.000Z","updated_at":"2024-11-16T09:16:42.000Z","dependencies_parsed_at":"2024-10-28T09:23:58.667Z","dependency_job_id":null,"html_url":"https://github.com/Shinigami92/satisfactory-server-api-client","commit_stats":null,"previous_names":["shinigami92/satisfactory-server-api-client"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shinigami92%2Fsatisfactory-server-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shinigami92%2Fsatisfactory-server-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shinigami92%2Fsatisfactory-server-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shinigami92%2Fsatisfactory-server-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Shinigami92","download_url":"https://codeload.github.com/Shinigami92/satisfactory-server-api-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244703980,"owners_count":20496221,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-client","api-wrapper","coffeestain","dedicated-server","esm","fetch","fetch-api","ky","satisfactory","typescript"],"created_at":"2024-10-10T23:11:38.064Z","updated_at":"2025-03-20T22:31:54.909Z","avatar_url":"https://github.com/Shinigami92.png","language":"TypeScript","readme":"# Satisfactory Server API Client\n\n![Satisfactory](https://raw.githubusercontent.com/Shinigami92/satisfactory-server-api-client/main/.github/logo.png \"Satisfactory logo\")\n\n[![npm version](https://badgen.net/npm/v/satisfactory-server-api-client)](https://www.npmjs.com/package/satisfactory-server-api-client)\n[![npm downloads](https://badgen.net/npm/dm/satisfactory-server-api-client)](https://www.npmjs.com/package/satisfactory-server-api-client)\n\nThis is an unofficial HTTP API wrapper for Satisfactory Dedicated Server API.\n\nThe project is in an early state and will not document changelogs until v1.0.0 release.  \nIf you want a specific API Endpoint prioritized, please open an issue.\n\nOfficial API Docs can be found at `Steam/steamapps/common/Satisfactory/CommunityResources/DedicatedServerAPIDocs.md` or at [satisfactory.wiki.gg HTTPS API](https://satisfactory.wiki.gg/wiki/Dedicated_servers/HTTPS_API).\n\nYou can obtain an `accessToken` by executing `server.GenerateAPIToken` in your server console.\n\n## Usage\n\n```ts\nimport { createClient } from \"satisfactory-server-api-client\";\n\n// If your dedicated server uses a self-signed certificate (generated by default),\n// you can disable SSL verification by configuring the following environment variable.\n//process.env.NODE_TLS_REJECT_UNAUTHORIZED = \"0\";\n\nconst client = createClient({\n  accessToken: \"\u003cyour-access-token\u003e\",\n});\n\nclient.v1\n  .HealthCheck({\n    data: {\n      clientCustomData: \"\",\n    },\n  })\n  .then((response) =\u003e {\n    console.log(\"HealthCheck Response:\", response);\n  });\n\nclient.v1.VerifyAuthenticationToken().then(() =\u003e {\n  // response will be an empty string if valid\n});\n\nclient.v1.QueryServerState().then((response) =\u003e {\n  console.log(\"QueryServerState Response:\", response);\n});\n\nclient.v1.GetServerOptions().then((response) =\u003e {\n  console.log(\"GetServerOptions Response:\", response);\n});\n\nclient.v1.GetAdvancedGameSettings().then((response) =\u003e {\n  console.log(\"GetAdvancedGameSettings Response:\", response);\n});\n\nclient.v1\n  .PasswordlessLogin({\n    data: {\n      minimumPrivilegeLevel: PrivilegeLevel.NotAuthenticated,\n    },\n  })\n  .then((response) =\u003e {\n    console.log(\"PasswordlessLogin Response:\", response);\n  });\n\nclient.v1\n  .PasswordLogin({\n    data: {\n      minimumPrivilegeLevel: PrivilegeLevel.NotAuthenticated,\n      password: \"your-password\",\n    },\n  })\n  .then((response) =\u003e {\n    console.log(\"PasswordLogin Response:\", response);\n  });\n\nclient.v1\n  .ApplyAdvancedGameSettings({\n    data: {\n      appliedAdvancedGameSettings: {\n        \"FG.GameRules.NoPower\": \"False\",\n      },\n    },\n  })\n  .then(() =\u003e {\n    // response will be an empty string if valid\n  });\n\nclient.v1\n  .ClaimServer({\n    data: {\n      serverName: \"your-server\",\n      adminPassword: \"your-password\",\n    },\n  })\n  .then((response) =\u003e {\n    console.log(\"ClaimServer Response:\", response);\n  });\n\nclient.v1\n  .RenameServer({\n    data: {\n      serverName: \"Shinigami-PC localhost\",\n    },\n  })\n  .then(() =\u003e {\n    // response will be an empty string if valid\n  });\n\nclient.v1.EnumerateSessions().then((response) =\u003e {\n  console.log(\"EnumerateSessions Response:\", response);\n});\n```\n\n## See Also\n\n- [wolveix/satisfactory-server](https://github.com/wolveix/satisfactory-server) - A Docker image for running a Satisfactory Dedicated Server.\n- [satisfactory-server-prometheus-exporter](https://github.com/Shinigami92/satisfactory-server-prometheus-exporter) - A Prometheus Exporter for Satisfactory Dedicated Server.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinigami92%2Fsatisfactory-server-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinigami92%2Fsatisfactory-server-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinigami92%2Fsatisfactory-server-api-client/lists"}