{"id":20182963,"url":"https://github.com/theogravity/immutable-x-openapi","last_synced_at":"2026-01-31T10:32:07.961Z","repository":{"id":44715509,"uuid":"443897863","full_name":"theogravity/immutable-x-openapi","owner":"theogravity","description":"Immutable X and Gods Unchained OpenAPI 3.0 definitions","archived":false,"fork":false,"pushed_at":"2022-02-25T05:12:12.000Z","size":309,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-10T09:44:03.253Z","etag":null,"topics":["api","exchange","gods-unchained","immutablex","imx","nft","openapi","openapi3","sdk","typescript"],"latest_commit_sha":null,"homepage":"","language":null,"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/theogravity.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}},"created_at":"2022-01-03T00:07:45.000Z","updated_at":"2023-04-13T17:11:33.000Z","dependencies_parsed_at":"2022-09-11T20:20:33.801Z","dependency_job_id":null,"html_url":"https://github.com/theogravity/immutable-x-openapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/theogravity/immutable-x-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theogravity%2Fimmutable-x-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theogravity%2Fimmutable-x-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theogravity%2Fimmutable-x-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theogravity%2Fimmutable-x-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theogravity","download_url":"https://codeload.github.com/theogravity/immutable-x-openapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theogravity%2Fimmutable-x-openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28938577,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T10:18:23.202Z","status":"ssl_error","status_checked_at":"2026-01-31T10:18:22.693Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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","exchange","gods-unchained","immutablex","imx","nft","openapi","openapi3","sdk","typescript"],"created_at":"2024-11-14T02:43:28.812Z","updated_at":"2026-01-31T10:32:07.946Z","avatar_url":"https://github.com/theogravity.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# immutable-x-openapi\n\nThis contains an *unofficial* OpenAPI 3.0 definitions for \n\n- the [Immutable X APIs](https://docs.x.immutable.com/reference)\n- the [Gods Unchained APIs](https://github.com/immutable/gods-unchained-api)\n\nThe definitions were created using [Stoplight Studio](https://stoplight.io/studio/).\n\nYou can use the definition to [generate your own SDK](https://openapi.tools/), or import into your favorite\nAPI client such as [Insomnia](https://insomnia.rest/) and [Postman](https://www.postman.com/).\n\n![](assets/insomnia.png)\n\n## Using a ready-made SDK\n\nYou can find documentation here that has been generated using the definitions. Select the \nlanguage option on the right side for your client. There is a vanilla Javascript option if you\nclick on the vertical three dots next to the languages, which will show you\nhow to call the API in vanilla JS.\n\nhttps://imx.readme.io/reference/listcards\n\n## Building an SDK\n\n### Typescript (via node.js)\n\nUse the [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen) package to \nbuild an SDK complete with Typescript definitions.\n\nIf you copy the appropriate `reference/*.yaml` file to your project and install `openapi-typescript-codegen`,\nyou can generate the SDK using a `script` command in your `package.json`:\n\n```json\n{\n  \"scripts\": {\n    \"gu-client:build\": \"openapi --input GodsUnchained-API-OpenAPI3.yaml --useOptions --output ./src/gu-api-client\"\n  }\n}\n```\n\n## Notes\n\nThese definitions were crafted by hand using the available documentation.\n\nAlthough a best effort was made to ensure accuracy in results, there may be mistakes in the definition. If you find\nsuch a mistake, please open a pull request with the necessary changes.\n\nFor many endpoints, model definitions have been created for responses, which a code generator can use to create\ncorresponding classes, or typed interfaces if using a Typescript generator.\n\n## Undocumented APIs\n\n### Immutable X\n\nThe following endpoints were unable to be documented at the time due to unavailability of the documentation:\n\n- https://docs.x.immutable.com/reference/post_v1-signable-deposit-details-1\n- https://docs.x.immutable.com/reference/post_v1-signable-order-details-1\n- https://docs.x.immutable.com/reference/post_v1-signable-transfer-details-1\n- https://docs.x.immutable.com/reference/post_v1-signable-withdrawal-details-1\n\n## Contributing\n\n- Fork this repo\n- Use Stoplight Studio to open the repo directory, and make your edits\n- Make sure the linter in Stoplight Studio has no errors/warnings\n- Make a pull request with your changes\n\n## Disclaimer\n\nThe API definitions depend on the community to keep up-to-date, or until the Immutable team\nprovides an official definition. Use at your own risk, not responsible for losses incurred from an incorrect\nAPI definition.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheogravity%2Fimmutable-x-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheogravity%2Fimmutable-x-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheogravity%2Fimmutable-x-openapi/lists"}