Skip to main content

A Unoffical API for OctoEverywhere

Project description


Login into OctoEverywhere and use it in your app, instead of NGROK

We keep the docs of old version here



from octoeverywhere import OctoEverywhere

octo = OctoEverywhere("", "password")

Get current session cookie:

session = octo.currentCookie

Get new session cookie:

session = octo.getSessionCookie("", "password")

If we inserted correct login info, we should get something like this:


Otherwise, an exception will be thrown:

Incorrect login info with status code of 400

Get printer info:

You can get Printer IDs, with getUserInfo() function.

printer = octo.getPrinterInfo("<your printer ID>")

If we inserted correct login info, we should get something like this:

{'Error': '', 'Status': 200, 'Result': {'Id': '<your printer ID>', 'Name': 'example', 'Owners': [''], 'LastConnectionTime': '2021-03-30T15:33:23.4649623Z', 'LastDisconnectTime': '2021-03-30T15:33:13.9014383Z'}}

Otherwise, a following JSON will be thrown:

{'Error': 'No printer found', 'Status': 404, 'Result': None}

Get user info

user = octo.getUserInfo()


{'Error': '', 'Status': 200, 'Result': {'Email': '', 'PrinterIds': ['<printer ID>'], 'IsMfaEnabled': False, 'HasSeenFirstTimePortalCredsMessage': True}}

Get OctoEverywhere Statistics for their website

stats = octo.getStats()


{'Error': '', 'Status': 200, 'Result': {'Stats': {'ConnectedPrinters': 5476, 'WebcamMinutesStreamtedInLast24Hours': 3172}}}

Get Messages

messages = octo.getMessages()


{'Error': '', 'Status': 200, 'Result': {'MessageId': 0, 'HtmlString': None, 'NeedsAck': False, 'OverridePrinterErrors': False}}


Full example is avaiable in file

To Do

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

OctoEverywhereAPI-1.0.3.tar.gz (3.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page