The PythonAnywhere API (beta)

Disclaimer¶

Warning: our API is new and in beta and not officially supported, and may change at any time, and it is not to be relied upon, and may cause unpredictable growth of extra ears. Extra ears not guaranteed.

Getting started and Authentication¶

The PythonAnywhere API uses token-based authentication. You can get your token from your Account page on the API Token tab.

It's used in a header called Authorization, and the value is encoded as the string "Token", followed by a space, followed by your token, like this:

'Authorization': 'Token {}'.format(token)

For example, this code using the requests module would get the details of your CPU usage on PythonAnywhere; you would just need to change the three variables at the top to match your actual username, your API token, and the correct host:

• www.pythonanywhere.com if your account is on our US-based system.
• eu.pythonanywhere.com if your account is on our EU-based system.

import requests
username = 'your username'
token = 'your token'
host = 'your host'

response = requests.get(
    'https://{host}/api/v0/user/{username}/cpu/'.format(
        host=host, username=username
    ),
    headers={'Authorization': 'Token {token}'.format(token=token)}
)
if response.status_code == 200:
    print('CPU quota info:')
    print(response.content)
else:
    print('Got unexpected status code {}: {!r}'.format(response.status_code, response.content))

Once you've generated your token, you can copy and paste it for use in your scripts. You can also access it at any time from PythonAnywhere consoles, webapps and tasks in a pre-populated environment variable, $API_TOKEN.

You will need to reload your webapp and start new consoles for this environment variable to be in place.

Endpoints¶

All endpoints are hosted at https://www.pythonanywhere.com/ or https://eu.pythonanywhere.com/ depending on where your account is registered.

Rate-limits¶

Each endpoint has a 40 requests per minute rate limit, apart from the send_input endpoint on consoles, which is 120 requests per minute.

Always_On¶

/api/v0/user/{username}/always_on/¶

/api/v0/user/{username}/always_on/{id}/¶

/api/v0/user/{username}/always_on/{id}/restart/¶

Consoles¶

/api/v0/user/{username}/consoles/¶

/api/v0/user/{username}/consoles/shared_with_you/¶

/api/v0/user/{username}/consoles/{id}/¶

/api/v0/user/{username}/consoles/{id}/get_latest_output/¶

/api/v0/user/{username}/consoles/{id}/send_input/¶

Cpu¶

/api/v0/user/{username}/cpu/¶

{
    "daily_cpu_limit_seconds": <int>,
    "next_reset_time": <isoformat>,
    "daily_cpu_total_usage_seconds": <float>
}

Default_Python3_Version¶

/api/v0/user/{username}/default_python3_version/¶

{
    "default_python3_version": <str>,
    "available_python3_versions": [<str>],
}

Default_Python_Version¶

/api/v0/user/{username}/default_python_version/¶

{
    "default_python_version": <str>,
    "available_python_versions": [<str>],
}

Default_Save_And_Run_Python_Version¶

/api/v0/user/{username}/default_save_and_run_python_version/¶

{
    "default_save_and_run_python_version": <str>,
    "available_python_versions": [<str>],
}

Files¶

/api/v0/user/{username}/files/path{path}¶

/api/v0/user/{username}/files/sharing/¶

/api/v0/user/{username}/files/sharing/?path={path}¶

/api/v0/user/{username}/files/tree/?path={path}¶

Schedule¶

/api/v0/user/{username}/schedule/¶

/api/v0/user/{username}/schedule/{id}/¶

Students¶

/api/v0/user/{username}/students/¶

{
    "students": [
        {"username": <string>},
        {"username": <string>},
        ...
    ]
}

/api/v0/user/{username}/students/{student}/¶

System_Image¶

/api/v0/user/{username}/system_image/¶

{
    "system_image": <str>,
    "available_system_images": [<str>],
}

Webapps¶

/api/v0/user/{username}/webapps/¶

/api/v0/user/{username}/webapps/{domain_name}/¶

/api/v0/user/{username}/webapps/{domain_name}/disable/¶

/api/v0/user/{username}/webapps/{domain_name}/enable/¶

/api/v0/user/{username}/webapps/{domain_name}/reload/¶

/api/v0/user/{username}/webapps/{domain_name}/ssl/¶

/api/v0/user/{username}/webapps/{domain_name}/static_files/¶

/api/v0/user/{username}/webapps/{domain_name}/static_files/{id}/¶

/api/v0/user/{username}/webapps/{domain_name}/static_headers/¶

/api/v0/user/{username}/webapps/{domain_name}/static_headers/{id}/¶