{"id":23940223,"url":"https://github.com/ecobee/python_api_sdk","last_synced_at":"2025-10-10T09:12:16.850Z","repository":{"id":42387834,"uuid":"131649654","full_name":"ecobee/python_api_sdk","owner":"ecobee","description":"A pythonic way to interface with the ecobee api","archived":false,"fork":false,"pushed_at":"2022-04-07T15:44:51.000Z","size":31,"stargazers_count":11,"open_issues_count":3,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-16T11:06:53.603Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ecobee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-30T21:43:31.000Z","updated_at":"2023-01-09T22:34:02.000Z","dependencies_parsed_at":"2022-08-12T10:00:18.018Z","dependency_job_id":null,"html_url":"https://github.com/ecobee/python_api_sdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ecobee/python_api_sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecobee%2Fpython_api_sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecobee%2Fpython_api_sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecobee%2Fpython_api_sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecobee%2Fpython_api_sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ecobee","download_url":"https://codeload.github.com/ecobee/python_api_sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecobee%2Fpython_api_sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279003389,"owners_count":26083579,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-01-06T03:12:59.392Z","updated_at":"2025-10-10T09:12:16.834Z","avatar_url":"https://github.com/ecobee.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003chtml\u003e\n  \u003cbody\u003e\n    \u003ch1\u003eEcobee API Python SDK\u003c/h1\u003e\n    \u003cb\u003eThis project provides a simple python interface to interact with the ecobee Web REST API.\u003c/b\u003e\n    \u003cdiv\u003e\n      \u003ch2\u003eOverview\u003c/h2\u003e\n      \u003cb\u003eIt provides the following functionality\u003c/b\u003e\n      \u003cul\u003e\n        \u003cli\u003eManage Tokens Operations like regestering and refreshing\u003c/li\u003e\n        \u003cli\u003eFormat boilerplate api requests.\u003c/li\u003e\n        \u003cli\u003eProvide simple functions to perform common api operations\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/div\u003e\n      \n\n\u003cdiv\u003e\n  \u003ch2\u003eInstall Guide\u003c/h2\u003e\n  \u003cb\u003eBefore you begin Register as an ecobee Developer Here https://www.ecobee.com/developers/\u003c/b\u003e\u003cbr\u003e\n  \u003cb\u003eNote: lines with $ mean execute this command in bash\u003c/b\u003e\u003cbr\u003e\n  \n``` bash\nClone the Repository\n$ git clone https://github.com/ecobee/python_api_sdk.git\n\nNavigate inside the root directory\n$ cd python_api_sdk\n\nInstall the Repository\n$ pip install .\n\n#Run the interactive enviornment setup note this only works for mac / linux\n$ python setup_scripts/env_setup.py\n```\n\u003c/div\u003e\n\n\u003ch2\u003eUser Guide\u003c/h2\u003e\n\u003cdiv\u003e\n\n  \u003cb\u003eNote: Bolded Lines with \u003e\u003e\u003e mean execute this command in python\u003c/b\u003e\n\n  \u003ch3\u003eAdding Users\u003c/h3\u003e\n  \n``` python\n\u003e\u003e\u003e # Create an ApiInterface object\n\u003e\u003e\u003e from ebapi.api_interface import ApiInterface\n\u003e\u003e\u003e interface = ApiInterface()\n\u003e\u003e\u003e \n\u003e\u003e\u003e #Add a user\n\u003e\u003e\u003e interface.add_user()\nEnter the PIN '\u003c4-digit-pin\u003e' into the Add Application window and click Add Application\u003cbr\u003e\nwaiting press enter to continue...\n\u003e\u003e\u003e \n```\n\n\n\u003ch3\u003eAdding an 3rd Party Application\u003c/h3\u003e\n\u003col\u003e\n  \u003cli\u003eNavigate to www.ecobee.com and login with you username and password\u003c/li\u003e\n  \u003cli\u003eMy Account (Top right)\u003c/li\u003e\n  \u003cli\u003eMy Apps (Bottom Left)\u003c/li\u003e\n  \u003cli\u003eAdd application (Bottom Left)\u003c/li\u003e\n  \u003cli\u003eEnter the \u003c4-digit-pin\u003e into the text box\u003c/li\u003e\n  \u003cli\u003eClick Validate (Bottom Right)\u003c/li\u003e\n  \u003cli\u003eClick Add Application\u003c/li\u003e\n\u003c/ol\u003e\n\n\u003cb\u003eReturn to you python session and press Enter\u003c/b\u003e\u003cbr\u003e\nThe SDK will have stored access and refresh tokens for the user accout\u003cbr\u003e\nIt will also store a all the thermostats that the user has\u003cbr\u003e\n\u003c/div\u003e\n\u003cdiv\u003e\n  \u003ch2\u003eMaking Requests\u003c/h2\u003e\n  Requests are made by sepecifying a method of the ApiInterface Object\u003cbr\u003e\n  and a 12 digit Thermostat Identifier.\u003cbr\u003e\n  These can be found on the About My Thermostat (Bottom Right of a Thermostat Page)\u003cbr\u003e\n  \nAll Requests Reutrn Dictionaries from the Ecobee API's JSON format.\n\nReference Documentation: https://www.ecobee.com/home/developer/api/introduction/index.shtml\u003cbr\u003e\nObject Defitions: https://www.ecobee.com/home/developer/api/documentation/v1/auth/auth-intro.shtml\u003cbr\u003e\n\n\n``` python\n\u003e\u003e\u003e # will dispay the Thermostat ID that are stored\n\u003e\u003e\u003e thermostat_identifier.show_users()\n\u003e\u003e\u003e\n\u003e\u003e\u003e #12 digit thermostat ID\n\u003e\u003e\u003e thermostat_identifier = \"123456789012\" \n\u003e\u003e\u003e \n\u003e\u003e\u003e # Return a Dictionary of the thermostats settings\n\u003e\u003e\u003e interface.get_settings(thermostat_identifier)\n\u003e\u003e\u003e \n```\n\u003c/div\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecobee%2Fpython_api_sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fecobee%2Fpython_api_sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecobee%2Fpython_api_sdk/lists"}