Skip to content

AddressToken

Get info about a specific address token.

GET /address/token/{tokenId}

Parameters:

Name Type Description Default
token_id str

Token ID.

 required

Returns:

Type Description
Dict[str, Any]

Token representation as dict.
Source code in nukiwebapi/address_token.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def get_token_info(self, token_id: str) -> Dict[str, Any]:
    """
    Get info about a specific address token.

    GET /address/token/{tokenId}

    Args:
        token_id (str): Token ID.

    Returns:
        Token representation as dict.
    """
    if not isinstance(token_id, str):
        raise ValueError("token_id must be a string")

    return self.client._request(
        "GET", f"/address/token/{token_id}"
    ).json()

Get info about a redeemed address token.

GET /address/token/{tokenId}/redeem

Parameters:

Name Type Description Default
token_id str

Token ID.

 required

Returns:

Type Description
Dict[str, Any]

Redeemed token representation as dict.
Source code in nukiwebapi/address_token.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def get_redeemed_token(self, token_id: str) -> Dict[str, Any]:
    """
    Get info about a redeemed address token.

    GET /address/token/{tokenId}/redeem

    Args:
        token_id (str): Token ID.

    Returns:
        Redeemed token representation as dict.
    """
    if not isinstance(token_id, str):
        raise ValueError("token_id must be a string")

    return self.client._request(
        "GET", f"/address/token/{token_id}/redeem"
    ).json()

Redeem an address token.

POST /address/token/{tokenId}/redeem

Parameters:

Name Type Description Default
token_id str

Token ID.

 required
email bool

Whether to send an email. Defaults to True.

 True

Returns:

Type Description
Dict[str, Any]

API response as dict.
Source code in nukiwebapi/address_token.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def redeem_token(self, token_id: str, email: bool = True) -> Dict[str, Any]:
    """
    Redeem an address token.

    POST /address/token/{tokenId}/redeem

    Args:
        token_id (str): Token ID.
        email (bool, optional): Whether to send an email. Defaults to True.

    Returns:
        API response as dict.
    """
    if not isinstance(token_id, str):
        raise ValueError("token_id must be a string")
    if not isinstance(email, bool):
        raise ValueError("email must be a boolean")

    return self.client._request(
        "POST",
        f"/address/token/{token_id}/redeem",
        params={"email": email},
        json={}
    ).json()

Get a list of tokens for a specific address.

GET /address/{addressId}/token

Parameters:

Name Type Description Default
address_id int

Address ID.

 required

Returns:

Type Description
List[Dict[str, Any]]

List of token representations.
Source code in nukiwebapi/address_token.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def list_tokens(self, address_id: int) -> List[Dict[str, Any]]:
    """
    Get a list of tokens for a specific address.

    GET /address/{addressId}/token

    Args:
        address_id (int): Address ID.

    Returns:
        List of token representations.
    """
    if not isinstance(address_id, int):
        raise ValueError("address_id must be an integer")

    return self.client._request(
        "GET", f"/address/{address_id}/token"
    ).json()