# Stacking Claims ## Overview After CityCoins are Stacked in the contract, Stackers are required to claim their rewards and unlocked CityCoins after a cycle ends. Claiming rewards from Stacking CityCoins happens by calling the contract function [`claim-stacking-rewards`](#claim-stacking-reward). ## Details The payouts are based on the amount Stacked by the user `R`, the total STX reward that cycle `S`, and the total of all Stackers`T`using the formula:\ `STX Rewards = (R * S) / T` ## Contract Functions ### [API Ref: Stacking Claims](https://api.citycoins.co/docs#tag/Stacking-Claims) ### claim-stacking-reward Type: Public Function Input: `targetCycle as uint` Success: `(ok true)` Errors: * `ERR_USER_ID_NOT_FOUND u1003` * `ERR_STACKING_NOT_AVAILABLE u1015` * `ERR_REWARD_CYCLE_NOT_COMPLETED u1017` * `ERR_NOTHING_TO_REDEEM u1018` Claiming Stacking rewards happens through calling the `claim-stacking-reward` function in the contract, which accepts a reward cycle and checks both the entitled STX reward from miners and the amount of CityCoins to return, then transfers them to the user. ### get-stacking-reward Type: Read-only Function Input: `userId as uint` and `targetCycle as uint` Returns: `entitledStackingReward as uint, or default (u0)` Returns the amount of STX a user can claim in a given reward cycle in uSTX. This method will only return a positive value if: * the current block height is in a subsequent reward cycle * the Stacker locked up CityCoins in the target reward cycle * the Stacker locked up *enough* CityCoins to receive at least one uSTX --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.citycoins.co/contract-functions/stacking-claims.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.