pyaudius

Audius V1 API

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0.0
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/samgutentag/pyaudius.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/samgutentag/pyaudius.git)

Then import the package:

import pyaudius

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pyaudius

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pyaudius
from pyaudius.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://discoveryprovider.audius.co/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pyaudius.Configuration(
    host = "https://discoveryprovider.audius.co/v1"
)



# Enter a context with an instance of the API client
with pyaudius.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pyaudius.ChallengesApi(api_client)
    offset = 56 # int | The number of items to skip. Useful for pagination (page number * limit) (optional)
    limit = 56 # int | The number of items to fetch (optional)
    user_id = 'user_id_example' # str | A User ID to filter the undisbursed challenges to a particular user (optional)
    completed_blocknumber = 56 # int | Starting blocknumber to retrieve completed undisbursed challenges (optional)

    try:
        api_response = api_instance.get_undisbursed_challenges(offset=offset, limit=limit, user_id=user_id, completed_blocknumber=completed_blocknumber)
        print("The response of ChallengesApi->get_undisbursed_challenges:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ChallengesApi->get_undisbursed_challenges: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://discoveryprovider.audius.co/v1

Class	Method	HTTP request	Description
ChallengesApi	get_undisbursed_challenges	GET /challenges/undisbursed
CommentsApi	get_comment_replies	GET /comments/{comment_id}/replies
CommentsApi	get_unclaimed_comment_id	GET /comments/unclaimed_id
DashboardWalletUsersApi	bulk_get_dashboard_wallet_users	GET /dashboard_wallet_users
DeveloperAppsApi	get_developer_app	GET /developer_apps/{address}
PlaylistsApi	get_bulk_playlists	GET /playlists
PlaylistsApi	get_playlist	GET /playlists/{playlist_id}
PlaylistsApi	get_playlist_access_info	GET /playlists/{playlist_id}/access-info
PlaylistsApi	get_playlist_by_handle_and_slug	GET /playlists/by_permalink/{handle}/{slug}
PlaylistsApi	get_playlist_tracks	GET /playlists/{playlist_id}/tracks
PlaylistsApi	get_trending_playlists	GET /playlists/trending
PlaylistsApi	search_playlists	GET /playlists/search
ResolveApi	resolve	GET /resolve	Resolves and redirects a provided Audius app URL to the API resource URL it represents
TipsApi	get_tips	GET /tips
TracksApi	download_track	GET /tracks/{track_id}/download	Download the original or MP3 file of a track
TracksApi	get_bulk_tracks	GET /tracks
TracksApi	get_track	GET /tracks/{track_id}
TracksApi	get_track_access_info	GET /tracks/{track_id}/access-info
TracksApi	get_track_stems	GET /tracks/{track_id}/stems
TracksApi	get_track_top_listeners	GET /tracks/{track_id}/top_listeners
TracksApi	get_trending_tracks	GET /tracks/trending
TracksApi	get_underground_trending_tracks	GET /tracks/trending/underground
TracksApi	inspect_track	GET /tracks/{track_id}/inspect	Inspects the details of the file for a track
TracksApi	search_tracks	GET /tracks/search
TracksApi	stream_track	GET /tracks/{track_id}/stream	Get the streamable MP3 file of a track
TracksApi	track_comment_count	GET /tracks/{track_id}/comment_count
TracksApi	track_comment_notification_setting	GET /tracks/{track_id}/comment_notification_setting
TracksApi	track_comments	GET /tracks/{track_id}/comments
UsersApi	download_purchases_as_csv	GET /users/{id}/purchases/download
UsersApi	download_sales_as_csv	GET /users/{id}/sales/download
UsersApi	download_sales_as_json	GET /users/{id}/sales/download/json
UsersApi	download_usdc_withdrawals_as_csv	GET /users/{id}/withdrawals/download
UsersApi	get_ai_attributed_tracks_by_user_handle	GET /users/handle/{handle}/tracks/ai_attributed
UsersApi	get_albums_by_user	GET /users/{id}/albums
UsersApi	get_authorized_apps	GET /users/{id}/authorized_apps
UsersApi	get_bulk_users	GET /users
UsersApi	get_connected_wallets	GET /users/{id}/connected_wallets
UsersApi	get_developer_apps	GET /users/{id}/developer_apps
UsersApi	get_favorites	GET /users/{id}/favorites
UsersApi	get_followers	GET /users/{id}/followers
UsersApi	get_following	GET /users/{id}/following
UsersApi	get_muted_users	GET /users/{id}/muted
UsersApi	get_playlists_by_user	GET /users/{id}/playlists
UsersApi	get_purchasers	GET /users/{id}/purchasers
UsersApi	get_related_users	GET /users/{id}/related
UsersApi	get_remixers	GET /users/{id}/remixers
UsersApi	get_reposts	GET /users/{id}/reposts
UsersApi	get_sales_aggregate	GET /users/{id}/sales/aggregate
UsersApi	get_subscribers	GET /users/{id}/subscribers
UsersApi	get_supported_users	GET /users/{id}/supporting
UsersApi	get_supporters	GET /users/{id}/supporters
UsersApi	get_top_track_tags	GET /users/{id}/tags	Fetch most used tags in a user's tracks
UsersApi	get_tracks_by_user	GET /users/{id}/tracks
UsersApi	get_user	GET /users/{id}
UsersApi	get_user_by_handle	GET /users/handle/{handle}
UsersApi	get_user_challenges	GET /users/{id}/challenges
UsersApi	get_user_id_from_wallet	GET /users/id
UsersApi	get_user_tracks_remixed	GET /users/{id}/tracks/remixed
UsersApi	search_users	GET /users/search
UsersApi	verify_id_token	GET /users/verify_token

Documentation For Models

• Access
• AccessInfoResponse
• Activity
• AlbumsResponse
• AuthorizedApp
• AuthorizedApps
• BlobInfo
• ChallengeResponse
• CollectionActivity
• Comment
• CommentMention
• CommentNotificationSetting
• CommentResponse
• ConnectedWallets
• ConnectedWalletsResponse
• CoverPhoto
• DashboardWalletUser
• DashboardWalletUsersResponse
• DecodedUserToken
• DeveloperApp
• DeveloperAppResponse
• DeveloperApps
• EncodedUserId
• ExtendedPaymentSplit
• ExtendedPurchaseGate
• ExtendedUsdcGate
• Favorite
• FavoritesResponse
• FollowGate
• FollowersResponse
• FollowingResponse
• GetChallenges
• GetSupportedUsers
• GetSupporters
• GetTipsResponse
• NftCollection
• NftGate
• Playlist
• PlaylistAddedTimestamp
• PlaylistArtwork
• PlaylistResponse
• PlaylistSearchResult
• PlaylistTracksResponse
• PlaylistsResponse
• ProfilePicture
• PurchasersResponse
• RelatedArtistResponse
• RemixParent
• RemixedTrackAggregate
• RemixersResponse
• ReplyComment
• Reposts
• SalesAggregate
• SalesAggregateResponse
• Stem
• StemsResponse
• StreamUrlResponse
• SubscribersResponse
• Supporter
• Supporting
• TagsResponse
• Tip
• TipGate
• TopListener
• Track
• TrackAccessInfo
• TrackActivity
• TrackArtwork
• TrackCommentCountResponse
• TrackCommentNotificationResponse
• TrackCommentsResponse
• TrackElement
• TrackInspect
• TrackResponse
• TrackSearch
• TracksResponse
• TrendingPlaylistsResponse
• UnclaimedIdResponse
• UndisbursedChallenge
• UndisbursedChallenges
• User
• UserAssociatedWalletResponse
• UserResponse
• UserSearch
• UserTracksRemixedResponse
• UsersResponse
• VerifyToken

Documentation For Authorization

Endpoints do not require authorization.

Author

Build and Deploy with poetry

1. install poetry with pip install poetry
2. install dependencies with poetry install
3. build package with poetry build
4. publish with poetry publish --build

PyPi Distribution

If you plan to distribute via PyPI, ensure you have a PyPI account and an API token configured in Poetry: poetry config pypi-token.pypi your-token