{"id":15888202,"url":"https://github.com/corecii/api-dump-static","last_synced_at":"2025-03-20T10:30:35.511Z","repository":{"id":39791227,"uuid":"489384189","full_name":"Corecii/api-dump-static","owner":"Corecii","description":"A Roblox API dump generated automatically on each update.","archived":false,"fork":false,"pushed_at":"2024-12-13T18:09:18.000Z","size":2866,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-17T16:11:35.712Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Corecii.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":"2022-05-06T14:25:34.000Z","updated_at":"2024-06-13T18:05:08.000Z","dependencies_parsed_at":"2023-02-17T09:15:32.080Z","dependency_job_id":"bd94255a-c53a-4658-a2d8-7f1aab7dd891","html_url":"https://github.com/Corecii/api-dump-static","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corecii%2Fapi-dump-static","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corecii%2Fapi-dump-static/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corecii%2Fapi-dump-static/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corecii%2Fapi-dump-static/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Corecii","download_url":"https://codeload.github.com/Corecii/api-dump-static/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244594779,"owners_count":20478338,"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":[],"created_at":"2024-10-06T06:06:40.006Z","updated_at":"2025-03-20T10:30:35.094Z","avatar_url":"https://github.com/Corecii.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Dump (Static)\n\nA library that provides static Roblox API dumps.\n\nAPI dumps are updated when Roblox updates and you pull a new version of the package.\n\n[Documentation](https://corecii.github.io/api-dump-static/)\n\nInstall with [wally](https://wally.run):\n```toml\n# wally.toml\n[dependencies]\nApiDumpStatic = \"corecii/api-dump-static@^1.0\"\n```\n\n[or use a packaged release model](https://github.com/Corecii/api-dump-static/releases/latest)\n\nWhen using Wally, `wally install` will automatically grab the newest version by default.\nThis is because we only update the *patch* version for API dump changes, and by default\nwally grabs the newest version that isn't a breaking change.\n\n---\n\nThe primary advantages that this package provides over including the raw API dump in your project are:\n* the dump is pre-processed into multiple files so that it syncs in with Rojo correctly\n* the dump is automatically generated when Roblox updates\n* methods to get all members of a class are provided, where the raw API dump requires you to get the superclass members yourself\n\n---\n\nThis package allows you to inspect instances at runtime without having to download the API dump with HttpService.\n\nFor example:\n```lua\nlocal ApiDump = require(game.ReplicatedStorage.Packages.ApiDumpStatic)\n\nlocal thing = workspace.Baseplate\n\nlocal thingApi = ApiDump.Classes[thing.ClassName]\n\nfor name, info in pairs(thingApi:Properties()) do\n    if info.Security == \"None\" or info.Security.Read == \"None\" and not table.find(info.Tags or {}, \"NotScriptable\") then\n      print(\"Property\", name, \"of\", thing:GetFullName(),\"=\", thing[name])\n    end\nend\n```\n\nThe API is fairly light. It's just a wrapper around [Roblox-Client-Tracker/API-Dump.json](https://github.com/MaximumADHD/Roblox-Client-Tracker/blob/roblox/API-Dump.json) with nice methods for getting *all* members of a class (incl. of superclasses) and caching generated members lists. As such, it follows naming conventions of *Mini-API-Dump.json* for external access (i.e. UpperCamelCase / PascalCase for everything).\n\nThe raw API dump can be accessed using `ApiDump.Raw`. This is equivalent to loading [Roblox-Client-Tracker/API-Dump.json](https://github.com/MaximumADHD/Roblox-Client-Tracker/blob/roblox/API-Dump.json) directly.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorecii%2Fapi-dump-static","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorecii%2Fapi-dump-static","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorecii%2Fapi-dump-static/lists"}