Developer Interface¶
This page of the documentation will cover all methods and classes available to the developer.
-
class
byte_api.
Client
(token: str, headers=None)¶ Initializes the API for the client
- Parameters
token (str) – Authorization token
headers (dict) – Additional headers except Authorization
-
comment
(id: str, text: str) → byte_api.types.Response¶ Comments a byte
- Parameters
id (str) – Byte (post) id
text – Comment text
- Return type
Response
,Comment
-
delete_comment
(id: str) → byte_api.types.Response¶ Deletes a comment
- Parameters
id (str) – Comment id patterned by {post id}-{comment id}
- Return type
Response
-
dislike
(id: str) → byte_api.types.Response¶ Removes like from a byte
- Parameters
id (str) – Byte (post) id
- Return type
Response
-
follow
(id: str) → byte_api.types.Response¶ Subscribes to a user
- Parameters
id (str) – User id
- Return type
Response
-
get_colors
() → byte_api.types.Response¶ Gets available color schemes
- Return type
Response
-
get_user
(id: str) → byte_api.types.Response¶ Gets a user profile
- Parameters
id (str) – User id
- Return type
Response
,Account
-
like
(id: str) → byte_api.types.Response¶ Likes a byte
- Parameters
id (str) – Byte (post) id
- Return type
Response
-
loop
(id: str) → byte_api.types.Response¶ Increments loop counter
- Parameters
id (str) – Byte (post) id
- Return type
Response
-
rebyte
(id: str) → byte_api.types.Response¶ Increments loop counter
- Parameters
id (str) – Byte (post) id
- Return type
Response
-
set_bio
(bio: str) → byte_api.types.Response¶ Sets bio
- Parameters
bio (str) – New bio
- Return type
Response
-
set_color_scheme
(color_scheme: int) → byte_api.types.Response¶ Sets color scheme
- Parameters
color_scheme (str) – Id of new color scheme
- Return type
Response
-
set_display_name
(display_name: str) → byte_api.types.Response¶ Sets name to display
- Parameters
display_name (str) – New name to display
- Return type
Response
-
set_info
(bio: str = None, display_name: str = None, username: str = None, color_scheme: int = None) → byte_api.types.Response¶ Sets profile info
- Parameters
bio (str) – New bio
display_name (str) – New name to display
username (str) – New username
color_scheme (int) – Id of new color scheme
- Return type
Response
-
set_username
(username: str) → byte_api.types.Response¶ Sets username
- Parameters
username (str) – New username
- Return type
Response
-
unfollow
(id: str) → byte_api.types.Response¶ Unsubscribes to a user
- Parameters
id (str) – User id
- Return type
Response