Skip to main content

A Python client for the trackerstatus.info API

Project description

trackerstatus

PyPI Python Version License

CodeQL CI Release

A Python wrapper for the trackerstatus.info API and its tracker-specific endpoints. This library provides a simple interface to monitor the status of various trackers and their services.

  • Rate-limited API client (1 request per minute as per API requirements)
  • Support for all tracker-specific endpoints:
    • AlphaRatio (ar.trackerstatus.info)
    • BroadcastTheNet (btn.trackerstatus.info)
    • GazelleGames (ggn.trackerstatus.info)
    • PassThePopcorn (ptp.trackerstatus.info)
    • Redacted (red.trackerstatus.info)
    • Orpheus (ops.trackerstatus.info)
    • Nebulance (nbl.trackerstatus.info)
    • Anthelion (ant.trackerstatus.info)
  • Comprehensive status information including:
    • Current status
    • Latency metrics
    • Uptime statistics
    • Record uptimes
    • Downtime tracking
  • Type hints and detailed documentation
  • Extensive test coverage

Documentation

The project includes comprehensive documentation:

Features

  • Check tracker status and response times
  • Support for multiple tracker protocols (HTTP, HTTPS, UDP)
  • Detailed status information including:
    • Response time
    • Status code
    • Error messages
    • Protocol information
  • Easy-to-use API with subdomain-based endpoints
  • Comprehensive documentation

Installation

pip install trackerstatus

Quick Start

from trackerstatus import APIClient, StatusEndpoint, BTNEndpoint

# Create an API client
client = APIClient()

# Get overall status of all trackers
status_endpoint = StatusEndpoint(client)
all_statuses = status_endpoint.get_status()
print("Overall Status:")
for tracker, info in all_statuses.items():
    print(f"{tracker.upper()}: {info['status_message']}")
    if info['details']:
        details = info['details']
        print(f"  Description: {details.get('Description', 'N/A')}")
        print(f"  Services: {details.get('Services', {})}")
        print(f"  Last Update: {details.get('tweet', {}).get('date', 'N/A')}")

# Get specific tracker status (using subdomain-based endpoint)
btn = BTNEndpoint(client)
btn_status = btn.get_status()  # Uses https://btn.trackerstatus.info/api/status
print(f"\nBTN Status: {btn_status['status_code']['Description']}")

For more detailed examples, see the examples documentation.

Documentation

Development

This project uses Poetry for dependency management and development tools:

# Install dependencies
poetry install

# Run tests
poetry run pytest

# Format code
poetry run black .
poetry run isort .

# Type checking
poetry run mypy .

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

trackerstatus-1.0.10.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trackerstatus-1.0.10-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file trackerstatus-1.0.10.tar.gz.

File metadata

  • Download URL: trackerstatus-1.0.10.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.9.21 Linux/6.8.0-1021-azure

File hashes

Hashes for trackerstatus-1.0.10.tar.gz
Algorithm Hash digest
SHA256 2e0be7322692669ee88e7667ea44565ab81f9e3fd0c1e70333190e4175be3cf1
MD5 c2ae775f77b2b76b491f7524f39a459f
BLAKE2b-256 bc525ed1fed143d71c204c092c4b03d6e1e3d7a9bc350f85b3fbdaf78d395707

See more details on using hashes here.

File details

Details for the file trackerstatus-1.0.10-py3-none-any.whl.

File metadata

  • Download URL: trackerstatus-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.9.21 Linux/6.8.0-1021-azure

File hashes

Hashes for trackerstatus-1.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 9fd410094cbcf350ec17f5778e641bc9b29fe4564ffdc445cb00d1e2e3e3eefb
MD5 5336dd8d934325d81aa56ea0e294576c
BLAKE2b-256 de6b0513d58046099689dc6dfba978f9ed714102a286a36e872bb3dcb78d14d0

See more details on using hashes here.

Supported by

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