Rated API Python SDK

Python bindings for the Rated API

CI/CD
Package
Meta

👋 Introduction

The Rated SDK (Software Development Kit) for Python, which allows Python developers to write software that makes use of the Rated dataset. You can find the latest, most up to date, documentation at our docs site.

The Rated SDK is maintained and published by Rated Labs.

We’ve curated many examples which will help you kickstart your integration but to get a full list of all available endpoints, you are recommended to check out our API Reference and Swagger.

🛟 Getting Help / Links

• Documentation
• API Reference
• Feedback
• Discord
• Twitter

We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

Please use these community resources for getting help:

• Ask a question on our feedback board
• If it turns out that you may have found a bug, please open an issue

🚀 Getting started

Requirements

• Python>=3.8
• A valid Rated API key (Get your key)

Installation

Install using pip:

pip install rated-python

Usage

Example: how to get a validator effectiveness rating by pubkey

from rated import Rated
from rated.ethereum import MAINNET

RATED_KEY = "ey..."
r = Rated(RATED_KEY)
eth = r.ethereum(network=MAINNET)
for eff in eth.validator.effectiveness("0x123456789...", from_day=873, size=1): 
    print(f"Day: {eff.day}, Eff: {eff.validator_effectiveness}")

>>> Day: 873, Eff: 98.82005899705014

Running tests

First install tox

pip install tox

Once tox has been installed you can run all tests:

tox

🤝 Contributing

We value feedback and contributions from our community. Whether it's a bug report, new feature, correction, or additional documentation, we welcome your issues and pull requests.

Please read through this CONTRIBUTING document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your contribution.