{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3e896421-2fb7-4bbf-967b-1ed2caa718a9","name":"The Stake API","description":"Stake is the industry leader in giving Cash Back to renters. Stake offers customizable Cash Back campaigns for real estate owners and operators and Proptech companies to incentivize resident action, build loyalty, align incentives, and drive outperformance. Stake integrates with all major property management software, and offers a fully managed API that includes money movement, comps data, Stake's Guest Card Registration Service, and more. This allows engineering teams to focus on the resident experience, while reaping the benefits of offering Cash Back to residents.\n\n# **Use Cases for The Stake API**\n\n1. Property Management teams can be empowered with leasing insights from our free Comps Data. Leasing teams can get faster, more qualified prospects with Stake's Guest Card Registration Service.\n    \n2. Owners and Operators of multifamily rentals can offer Cash Back to their residents inside their own resident-facing mobile app or website as a reward for paying rent on time each month.\n    \n3. Owners and Operators of affordable housing communities can offer Cash Back to their residents as a reward for submitting income verification documents, such as those required to maintain important subsidy eligibility. Property Management teams can be empowered with leasing insights from our free Comps Data. Leasing teams can get faster, more qualified prospects with Stake's Guest Card Registration Service.\n    \n4. Proptech companies that offer technology-driven solutions for residents can increase conversion rates and drive higher resident engagement by offering Cash Back as a reward for completing key actions in the user funnel, or take advantage of Stake's Guest Card Registration Service to increase revenue.\n    \n\n# **Getting Set Up**\n\n## Integration with PMS Systems\n\nIn order to get started using the Stake API, Stake needs to know who your residents are.\n\nIf you are a Real Estate owner or operator, Stake can integrate directly with your Property Management Software (PMS) systems. Stake currently offers integrations with the following PMS systems\\*:\n\n- Yardi\n    \n- Entrata\n    \n- RealPage\n    \n- MRI\n    \n- ResMan\n    \n- Rentmanager\n    \n- AppFolio\n    \n- Fortress\n    \n- RentEGI AIM\n    \n\nSetting up a direct PMS integration allows Stake to retrieve all necessary details about your residents, saving you from having to re-create all your end user resources in our ecosystem. Speak with your Stake Customer Success manager to set up your PMS integration.\n\n_\\*Stake also supports custom integrations with many other bespoke PMS software systems. Speak with your Stake Customer Success for more information on custom PMS integrations._\n\n## One Off Integrations\n\nIf you are a Proptech company looking to embed Cash Back rewards in your resident-facing applications, Stake's API can be integrated directly into your backend application to give your users a way to earn Cash Back in your own UI/UX.\n\n#### Delegated Rewards for Proptech Service Providers with Mutual Clients\n\nStake serves many of the top owners and operators of residential real estate. If you are a Proptech company that serves one of the same owner/operator clients as Stake, you may be eligible to take advantage of Stake's pre-existing integrations with our mutual client's PMS software and their residents pre-existing Stake accounts. This allows you to give residents Cash Back in their Stake Account for completing key actions in your application, as an incentive to move along your user funnel, or other ad-hoc use cases. Ask your Stake Customer Success Manager about setting up Delegated Rewards for your account.\n\n# Other Technical Info\n\n## Rate and usage limits\n\nAPI access rate limits apply at a per-API key basis in unit time. The limit is 200 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.\n\nEach API response returns the following set of headers to help you identify your use status:\n\n| Header | Description |\n| --- | --- |\n| `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |\n| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11897643","team":2245619,"collectionId":"3e896421-2fb7-4bbf-967b-1ed2caa718a9","publishedId":"2sA3drHEL8","public":true,"publicUrl":"https://docs.stake.rent","privateUrl":"https://go.postman.co/documentation/11897643-3e896421-2fb7-4bbf-967b-1ed2caa718a9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009CDE"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Stake API"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/8a7daac1-5ebb-4b9a-906a-4fe1f0cd7afe/c3Rha2UtbG9nb3R5cGUtd2hpdGUucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"009CDE"}},{"name":"light","logo":"https://content.pstmn.io/08e4701a-55ac-48d2-8104-7a5e02b30e4e/c3Rha2UtbG9nb3R5cGUtY2hhcmNvYWwucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009CDE"}}]}},"version":"8.10.1","publishDate":"2025-07-29T19:46:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Stake API","description":""},"logos":{"logoLight":"https://content.pstmn.io/08e4701a-55ac-48d2-8104-7a5e02b30e4e/c3Rha2UtbG9nb3R5cGUtY2hhcmNvYWwucG5n","logoDark":"https://content.pstmn.io/8a7daac1-5ebb-4b9a-906a-4fe1f0cd7afe/c3Rha2UtbG9nb3R5cGUtd2hpdGUucG5n"}},"statusCode":200},"environments":[{"name":"Stake API Sandbox","id":"2fd1d27b-1cf9-44f4-8360-9658f62e3dd4","owner":"11897643","values":[{"key":"server_url","value":"https://core-api-staging.stake.rent","enabled":true},{"key":"STAKE_API_CLIENT_ID","value":"your_client_id_here","enabled":true,"type":"default"},{"key":"STAKE_API_CLIENT_SECRET","value":"your_client_secret_here","enabled":true,"type":"default"},{"key":"access_token","value":"your_access_token_here","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/9dcc059aa53718619ee393113cca4d4de8689897668983baa07dd1f535550d48","favicon":"https://res.cloudinary.com/postman/image/upload/v1636485746/team/xpoyaj22agshjhov6js7.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Stake API Sandbox","value":"11897643-2fd1d27b-1cf9-44f4-8360-9658f62e3dd4"}],"canonicalUrl":"https://docs.stake.rent/view/metadata/2sA3drHEL8"}