foxclient

Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application's access to the API. In future, this may be a mandatory requirement.

To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit.

The requests may be logged for analytics and development purposes.

This Python package is automatically generated by the OpenAPI Generator project:

API version: 6.1.1
Package version: 1.0.0
Generator version: 7.21.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import foxclient

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import foxclient

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import foxclient
from foxclient.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.orangefox.download
# See configuration.py for a list of all supported configuration parameters.
configuration = foxclient.Configuration(
    host = "https://api.orangefox.download"
)



# Enter a context with an instance of the API client
async with foxclient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = foxclient.DeviceApi(api_client)
    device_id = 'device_id_example' # str |  (optional)
    codename = 'codename_example' # str |  (optional)
    id = 'id_example' # str |  (optional)

    try:
        # GET /devices/get - Get a single device by device_id, codename, or _id.
        api_response = await api_instance.get_device(device_id=device_id, codename=codename, id=id)
        print("The response of DeviceApi->get_device:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DeviceApi->get_device: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.orangefox.download

Class	Method	HTTP request	Description
DeviceApi	get_device	GET /devices/get	GET /devices/get - Get a single device by device_id, codename, or _id.
DeviceApi	get_device_by_id	GET /devices/{device_id}	GET /devices/{device_id} - Get device by ID (deprecated).
DeviceApi	get_oems	GET /oems	GET /oems - Get a list of all unique OEM names.
DeviceApi	list_devices	GET /devices	GET /devices/ - List devices with filters.
PasteApi	create_paste	POST /paste	POST /paste/ - Create a new paste.
PasteApi	get_paste	GET /paste/{paste_id}	GET /paste/{paste_id} - Get a paste by ID.
ReleaseApi	download_release	GET /release/{release_id}/dl	GET /release/{release_id}/dl - Download a release binary.
ReleaseApi	get_release	GET /releases/get	GET /releases/get - Get a single release.
ReleaseApi	get_release_by_id	GET /releases/{release_id}	GET /releases/{release_id} - Get release by ID (deprecated).
ReleaseApi	get_updates_after	GET /updates/{last_known_id}	GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
ReleaseApi	list_releases	GET /releases	GET /releases/ - List releases with filters.
ReportApi	new_report	POST /report/{release_id}	POST /report/{release_id} - Submit a bug report.
StatsApi	get_global_stats	GET /stats	GET /stats/ - Get global download statistics.
UptimeApi	get_uptime	GET /uptime	GET /uptime - Aggregated public infrastructure status.
WikiApi	get_asset	GET /wiki/{site}/assets/{path}	GET /wiki/{site}/assets/{path} - Serve asset bytes.
WikiApi	get_page	GET /wiki/{site}/pages/{path}	GET /wiki/{site}/pages/{path} - Fetch one published page.
WikiApi	get_site	GET /wiki/sites/{slug}	GET /wiki/sites/{slug} - Fetch one wiki site.
WikiApi	list_pages	GET /wiki/{site}/pages	GET /wiki/{site}/pages - List every published page in a site.
WikiApi	list_sites	GET /wiki/sites	GET /wiki/sites - List wiki sites.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer_auth

Type: Bearer authentication (JWT)

Author

admin@orangefox.tech

Metadata

Release files for foxclient 6.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foxclient 6.1.1
File	Size	Uploaded	Provenance
foxclient-6.1.1.tar.gz	50.9 kB	Sep 6, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for foxclient 6.1.1
File	Interpreter	ABI	Platform	Reset
foxclient-6.1.1-py3-none-any.whl 100.2 kB Sep 6, 2026 Without provenance	Python 3	none	any	Details

Total release size: 151.1 kB

Release files / foxclient-6.1.1.tar.gz

Download URL	foxclient-6.1.1.tar.gz
Size	50.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`2fd95d590314f8fb4c234cef672b4c63f786177e2fe5a0bfaa580c3d43d7d3b8`
BLAKE2b-256 checksum How to use checksums	`6dbc6123520660ac6f0aaa2b546be9ef0a3c98c41af24c40f5d0e240beaa9d33`
Upload date	Sep 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.4.3 CPython/3.13.14 Linux/7.2.2-1-default`

Release files / foxclient-6.1.1-py3-none-any.whl

Download URL	foxclient-6.1.1-py3-none-any.whl
Size	100.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`90f706b70e59eda711ab2d0789a460f1fd84f23a02b065e81ee4530e6dab0f88`
BLAKE2b-256 checksum How to use checksums	`e729f70f3d84d1aab3e497a180e6c3c2e1dc186e67c151fa1feb544d69be8fb9`
Upload date	Sep 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.4.3 CPython/3.13.14 Linux/7.2.2-1-default`

Security for foxclient 6.1.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.