# Unofficial Immutable X / Gods Unchained  API Docs Documentation

> Documentation for Unofficial Immutable X / Gods Unchained  API Docs

## API Reference
- [Getting Started With Your API](https://imx.readme.io/reference/getting-started-with-your-api.md): This page will help you get started with Awesome New API.
- [Returns a list of token and model cards](https://imx.readme.io/reference/listcards.md): Returns a list of token and model cards
- [Get a card by id](https://imx.readme.io/reference/getcard.md): Returns the token card with id and appropriate metadata. Currently conforms to both the generic and Apollo metadata specifications.
- [Get card image](https://imx.readme.io/reference/getcardprototypeimage.md): Returns an image based on the card prototype with id. To get an image in its card form, use the format and quality parameters.
- [Get a list of protos](https://imx.readme.io/reference/listprotos.md): List protos
- [Get proto by id](https://imx.readme.io/reference/getproto.md): Returns the prototype card with id
- [Get rarity information on protos](https://imx.readme.io/reference/listrarity.md): Returns rarity information about protos
- [Get a pack factory by address](https://imx.readme.io/reference/getpackfactory.md): Returns the pack factory at *address*.
- [Get a list of pack factories](https://imx.readme.io/reference/listfactories.md): Get a list of pack factories
- [Get purchased pack from pack factory](https://imx.readme.io/reference/getpurchasedpack.md): Returns the pack with index from purchase id from the pack factory with address.
- [Get a list of packs](https://imx.readme.io/reference/listpacks.md): Returns a list of packs
- [Get a list of purchases](https://imx.readme.io/reference/listpurchases.md): Returns a list of purchases
- [Get a list of referrals](https://imx.readme.io/reference/listreferrals.md): Returns a list of referrals
- [Get a user](https://imx.readme.io/reference/getuser.md): Get a user. No longer opeational. Use the Immutable X /assets endpoint instead.
- [Get user inventory](https://imx.readme.io/reference/getuserinventory.md): Returns the inventory of the user with address address, including token, shadow and centralized cards.
- [Encodes a deck into a deck string](https://imx.readme.io/reference/encodedeck.md): Encodes a deck into a deck string
- [Decodes a deck string](https://imx.readme.io/reference/decodedeckstring.md): Decodes a deck from a deck string
- [Get a list of applications](https://imx.readme.io/reference/getapplications.md): Get a list of applications
- [Get details of an application with the given ID](https://imx.readme.io/reference/getapplicationdetails.md): Get details of an application with the given ID
- [Get a list of assets](https://imx.readme.io/reference/getassets.md): Get a list of assets
- [Get details of an asset](https://imx.readme.io/reference/getasset.md): Get details of an asset
- [Fetches the WEI balances of the user](https://imx.readme.io/reference/getuserweibalances.md): Fetches the WEI balances of the user
- [Get a list of balances for given user](https://imx.readme.io/reference/getuserbalancelist.md): Get a list of balances for given user
- [Fetches the token balances of the user](https://imx.readme.io/reference/getusertokenbalances.md): Fetches the token balances of the user
- [Get TLV information for a user for a token](https://imx.readme.io/reference/gettlvforuserfortoken.md): Get TLV information for a user for a token. Not yet implemented.
- [Get a list of collections](https://imx.readme.io/reference/getcollections.md): Get a list of collections
- [Create collection](https://imx.readme.io/reference/createcollection.md): Create collection
- [Get details of a collection at the given address](https://imx.readme.io/reference/getcollectiondetails.md): Get details of a collection at the given address
- [Update collection](https://imx.readme.io/reference/updatecollection.md): Update collection
- [Get a list of collection filters](https://imx.readme.io/reference/getcollectionfilters.md): Get a list of collection filters
- [Get collection metadata schema](https://imx.readme.io/reference/getcollectionmetadataschema.md): Get collection metadata schema
- [Add metadata schema to collection](https://imx.readme.io/reference/addmetadataschematocollection.md): Add metadata schema to collection
- [Update metadata schema by name](https://imx.readme.io/reference/updatemetadataschemabyname.md): Update metadata schema by name
- [Get a list of deposits](https://imx.readme.io/reference/getdeposits.md): Get a list of deposits
- [Get details of a deposit with the given ID](https://imx.readme.io/reference/getdepositdetailsbyid.md): Get details of a deposit with the given ID
- [Get details of a mintable token with the given IMX token ID](https://imx.readme.io/reference/get-v1-mintable-token-id.md): Get details of a mintable token with the given IMX token ID
- [Get details of a mintable token with the given token address and token ID](https://imx.readme.io/reference/getmintabletokenbyaddressandtokenid.md): Get details of a mintable token with the given token address and token ID
- [Get a list of mints](https://imx.readme.io/reference/getmints.md): Get a list of mints
- [Mint tokens](https://imx.readme.io/reference/minttokens.md): Mint tokens
- [Get details of a mint with the given ID](https://imx.readme.io/reference/getmintdetailsbyid.md): Get details of a mint with the given ID
- [Mint Tokens V2](https://imx.readme.io/reference/minttokensv2.md): Mint Tokens V2
- [Get a list of orders](https://imx.readme.io/reference/getorders.md): Get a list of orders
- [Create an order](https://imx.readme.io/reference/createorder.md): Create an order
- [Get details of an order with the given ID](https://imx.readme.io/reference/getorderbyid.md): Get details of an order with the given ID
- [Cancel an order](https://imx.readme.io/reference/cancelorder.md): Cancel an order
- [User claim to redeem campaign rewards](https://imx.readme.io/reference/distributecampaignrewards.md): Distribute campaign rewards
- [Get list of reward claims for a user](https://imx.readme.io/reference/get-v1-rewards-etherkey.md): Get list of claims a user can make to redeem campaign rewards
- [Get operator signature to allow clients to register the user](https://imx.readme.io/reference/getoperatorsignature.md): Get operator signature to allow clients to register the user
- [Registers a user](https://imx.readme.io/reference/registeruser.md): Registers a user
- [Get stark keys for a registered user](https://imx.readme.io/reference/getregistereduserstarkkeys.md): Get stark keys for a registered user
- [Get a list of transfers](https://imx.readme.io/reference/gettransfers.md): Get a list of transfers
- [Creates a transfer of tokens between two parties](https://imx.readme.io/reference/createtransferrequest.md): Create a new transfer request
- [Get details of a transfer with the given ID](https://imx.readme.io/reference/gettransferdetailsbyid.md): Get details of a transfer with the given ID
- [Get a list of withdrawals](https://imx.readme.io/reference/getwithdrawals.md): Get a list of withdrawals
- [Creates a withdrawal of a token](https://imx.readme.io/reference/createwithdrawal.md): Creates a withdrawal
- [Gets details of withdrawal with the given ID](https://imx.readme.io/reference/getwithdrawalbyid.md): Gets details of withdrawal with the given ID
- [Get a list of tokens](https://imx.readme.io/reference/gettokens.md): Get a list of tokens
- [Get details of a token](https://imx.readme.io/reference/gettokendetails.md): Get details of a token
- [Get a list of trades](https://imx.readme.io/reference/gettrades.md): Get a list of trades
- [Create a Trade between two parties](https://imx.readme.io/reference/createtrade.md): Create a Trade
- [Get details of a trade with the given ID](https://imx.readme.io/reference/gettradedetailsbyid.md): Get details of a trade with the given ID