API

API instance is used to make telegram bot api requests.

It is derived from API which guarantees implementation of request and request_raw methods.

telegrinder.API instance is fully typed and implements all the methods provided by telegram bot api.

Initialization:

1
2

from telegrinder import API, Token
api = API(Token("token"))

Using typed methods

All methods are in snake case and return a result of model or APIError.

More about results here.

1
2

user = (await api.get_me()).unwrap()
user.first_name

.request

Makes a request with request_raw, returns result with parsed data (list, dict or boolean) or APIError.

1
2

result = await api.request("getMe", {})
result.unwrap()["first_name"]

.request_raw

Makes a request to telegram instance serving at .request_url.

Returns result with msgspec.Raw data or APIError.

1
2

result = await api.request_raw("getMe", {})
json.loads(result.unwrap())["first_name"]

APIError

telegrinder.APIError contains code and error

1
2
3
4
5
6

from telegrinder import Result, APIError, Error
result: Result[bool, APIError] = get_result()

match result:
    case Error(err):
        print(err.code, err.error)