Skip to main content

Python library for API key rotation, rate limit control and load balancing

Project description

APIRotater

APIRotater is a Python library that helps you manage your API keys and control rate limits. By managing multiple API keys, it automatically performs key rotation in case of rate limit exceedance.

Key Features

  • Automatic API Key Rotation: Uses multiple API keys in rotation.
  • Rate Limit Control: You can set a maximum number of uses for each API key within a specific time window.
  • Automatic .env File Loading: Automatically loads API keys from .env files located in the current working directory or parent directory.
  • Usage Statistics: Tracks usage counts of API keys.
  • RateLimitExceeded Exception: Throws an error when all keys have exceeded their rate limit.

Installation

pip install apirotater

Usage

Define your API keys in a .env file as follows:

API_KEY_1=your_api_key_1
API_KEY_2=your_api_key_2
API_KEY_3=your_api_key_3

Basic Usage

import apirotater

# Get an API key
api_key = apirotater.key()

# Make API request
# ...

# Report API key usage
apirotater.hit(api_key)

Usage With Rate Limit

import apirotater

# Get a key with maximum 2 uses in 60 seconds
api_key = apirotater.key(time_window=60, max_uses=2)

# Make API request
# ...

# Report API key usage
apirotater.hit(api_key)

Handling Rate Limit Exceedance

import apirotater
import time

try:
    # Get a key with rate limit
    api_key = apirotater.key(time_window=60, max_uses=2)
    
    # Make API request
    # ...
    
    # Report API key usage
    apirotater.hit(api_key)
    
except apirotater.RateLimitExceeded as e:
    print(f"Rate limit exceeded: {e}")
    # Wait for a while and try again
    time.sleep(60)

API

  • key(time_window=60, max_uses=100): Gets an API key (with rate limit)
  • hit(api_key): Reports API key usage
  • usage(): Returns usage statistics for all keys
  • get_all_keys(): Lists all loaded API keys

License

MIT License

Copyright (c) 2025 APIRotater

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

apirotater-0.4.2.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

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

apirotater-0.4.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file apirotater-0.4.2.tar.gz.

File metadata

  • Download URL: apirotater-0.4.2.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for apirotater-0.4.2.tar.gz
Algorithm Hash digest
SHA256 05a43d5185a1a2c430d77294c8c919ed5f04a4f2dac8d9b9fe4d9d31bb5e9981
MD5 8b3abc5115eec07751f9cb064ae07e93
BLAKE2b-256 1cbdf261e681e9e68d526d4c0fe667eeb05f513e95d42008ce21c6d558688c8f

See more details on using hashes here.

File details

Details for the file apirotater-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: apirotater-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for apirotater-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ee78b3ae116f3a98ca8d6cee91107715e9b93a1c6db88475562fed2452340871
MD5 4aa161434fb7dab0678bcfadaccf79b8
BLAKE2b-256 f26f95323c8e6b14f6436ebf2825c0bd13cd42e2f251d1f3e3f1924b3d86ba8e

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