Welcome to slskd-python-api’s documentation!

slskd-api is a Python library to interact with slskd.

Check out the Usage section for further information, including installation and basic examples.

Note

This project is under active development.

Contents

• Usage
  • Installation
  • Send requests to the server
• API
  • client.py
    • SlskdClient
  • apis/_types.py
    • AppVersion
      • AppVersion.full
      • AppVersion.current
      • AppVersion.latest
      • AppVersion.isUpdateAvailable
      • AppVersion.isCanary
      • AppVersion.isDevelopment
    • AppState
      • AppState.version
      • AppState.pendingReconnect
      • AppState.pendingRestart
      • AppState.server
      • AppState.connectionWatchdog
      • AppState.relay
      • AppState.user
      • AppState.distributedNetwork
      • AppState.shares
      • AppState.rooms
      • AppState.users
    • Message
      • Message.timestamp
      • Message.id
      • Message.username
      • Message.direction
      • Message.message
      • Message.isAcknowledged
      • Message.wasReplayed
    • Conversation
      • Conversation.username
      • Conversation.isActive
      • Conversation.unAcknowledgedMessageCount
      • Conversation.hasUnAcknowledgedMessages
      • Conversation.messages
    • Event
      • Event.timestamp
      • Event.type
      • Event.data
      • Event.id
    • File
      • File.name
      • File.fullName
      • File.length
      • File.attributes
      • File.createdAt
      • File.modifiedAt
    • Directory
      • Directory.name
      • Directory.fullName
      • Directory.attributes
      • Directory.createdAt
      • Directory.modifiedAt
      • Directory.files
      • Directory.directories
    • LogEntry
      • LogEntry.timestamp
      • LogEntry.context
      • LogEntry.level
      • LogEntry.message
    • RoomMessage
      • RoomMessage.timestamp
      • RoomMessage.username
      • RoomMessage.message
      • RoomMessage.roomName
    • RoomInfo
      • RoomInfo.name
      • RoomInfo.userCount
      • RoomInfo.isPrivate
      • RoomInfo.isOwned
      • RoomInfo.isModerated
    • RoomUser
      • RoomUser.averageSpeed
      • RoomUser.countryCode
      • RoomUser.directoryCount
      • RoomUser.fileCount
      • RoomUser.slotsFree
      • RoomUser.status
      • RoomUser.uploadCount
      • RoomUser.username
    • Room
      • Room.name
      • Room.isPrivate
      • Room.users
      • Room.messages
    • SearchFile
      • SearchFile.filename
      • SearchFile.size
      • SearchFile.code
      • SearchFile.isLocked
      • SearchFile.extension
      • SearchFile.bitRate
      • SearchFile.bitDepth
      • SearchFile.length
      • SearchFile.sampleRate
    • SearchResponseItem
      • SearchResponseItem.fileCount
      • SearchResponseItem.files
      • SearchResponseItem.hasFreeUploadSlot
      • SearchResponseItem.lockedFileCount
      • SearchResponseItem.lockedFiles
      • SearchResponseItem.queueLength
      • SearchResponseItem.token
      • SearchResponseItem.uploadSpeed
      • SearchResponseItem.username
    • SearchState
      • SearchState.endedAt
      • SearchState.fileCount
      • SearchState.id
      • SearchState.isComplete
      • SearchState.lockedFileCount
      • SearchState.responseCount
      • SearchState.responses
      • SearchState.searchText
      • SearchState.startedAt
      • SearchState.state
      • SearchState.token
    • ServerState
      • ServerState.address
      • ServerState.ipEndPoint
      • ServerState.state
      • ServerState.isConnected
      • ServerState.isConnecting
      • ServerState.isLoggedIn
      • ServerState.isLoggingIn
      • ServerState.isTransitioning
    • SessionStatus
      • SessionStatus.expires
      • SessionStatus.issued
      • SessionStatus.name
      • SessionStatus.notBefore
      • SessionStatus.token
      • SessionStatus.tokenType
    • ShareInfo
      • ShareInfo.id
      • ShareInfo.alias
      • ShareInfo.isExcluded
      • ShareInfo.localPath
      • ShareInfo.raw
      • ShareInfo.remotePath
      • ShareInfo.directories
      • ShareInfo.files
    • Shares
      • Shares.local
    • TransferedFile
      • TransferedFile.id
      • TransferedFile.username
      • TransferedFile.direction
      • TransferedFile.filename
      • TransferedFile.size
      • TransferedFile.startOffset
      • TransferedFile.state
      • TransferedFile.requestedAt
      • TransferedFile.enqueuedAt
      • TransferedFile.startedAt
      • TransferedFile.endedAt
      • TransferedFile.bytesTransferred
      • TransferedFile.averageSpeed
      • TransferedFile.bytesRemaining
      • TransferedFile.elapsedTime
      • TransferedFile.percentComplete
      • TransferedFile.remainingTime
    • TransferedDirectory
      • TransferedDirectory.directory
      • TransferedDirectory.fileCount
      • TransferedDirectory.files
    • Transfer
      • Transfer.username
      • Transfer.directories
    • UserAddress
      • UserAddress.addressFamily
      • UserAddress.address
      • UserAddress.port
    • BrowsingStatus
      • BrowsingStatus.bytesTransferred
      • BrowsingStatus.bytesRemaining
      • BrowsingStatus.percentComplete
      • BrowsingStatus.size
      • BrowsingStatus.username
    • UserInfo
      • UserInfo.description
      • UserInfo.hasFreeUploadSlot
      • UserInfo.hasPicture
      • UserInfo.picture
      • UserInfo.queueLength
      • UserInfo.uploadSlots
    • UserStatus
      • UserStatus.isPrivileged
      • UserStatus.presence
    • FileAttribute
      • FileAttribute.type
      • FileAttribute.value
    • UserFile
      • UserFile.attributeCount
      • UserFile.attributes
      • UserFile.code
      • UserFile.extension
      • UserFile.filename
      • UserFile.size
    • UserDirectory
      • UserDirectory.name
      • UserDirectory.fileCount
      • UserDirectory.files
    • UserRootDir
      • UserRootDir.directories
      • UserRootDir.directoryCount
      • UserRootDir.lockedDirectories
      • UserRootDir.lockedDirectoryCount
  • apis/application.py
    • ApplicationApi
      • ApplicationApi.state()
      • ApplicationApi.stop()
      • ApplicationApi.restart()
      • ApplicationApi.version()
      • ApplicationApi.check_updates()
      • ApplicationApi.gc()
  • apis/conversations.py
    • ConversationsApi
      • ConversationsApi.acknowledge()
      • ConversationsApi.acknowledge_all()
      • ConversationsApi.delete()
      • ConversationsApi.get()
      • ConversationsApi.send()
      • ConversationsApi.get_all()
      • ConversationsApi.get_messages()
  • apis/events.py
    • EventsApi
      • EventsApi.get()
      • EventsApi.create()
  • apis/files.py
    • FilesApi
      • FilesApi.get_downloads_dir()
      • FilesApi.get_downloaded_directory()
      • FilesApi.delete_downloaded_directory()
      • FilesApi.delete_downloaded_file()
      • FilesApi.get_incomplete_dir()
      • FilesApi.get_incomplete_directory()
      • FilesApi.delete_incomplete_directory()
      • FilesApi.delete_incomplete_file()
  • apis/logs.py
    • LogsApi
      • LogsApi.get()
  • apis/options.py
    • OptionsApi
      • OptionsApi.get()
      • OptionsApi.get_startup()
      • OptionsApi.debug()
      • OptionsApi.yaml_location()
      • OptionsApi.download_yaml()
      • OptionsApi.upload_yaml()
      • OptionsApi.validate_yaml()
  • apis/relay.py
    • RelayApi
      • RelayApi.connect()
      • RelayApi.disconnect()
      • RelayApi.download_file()
      • RelayApi.upload_file()
      • RelayApi.upload_share_info()
  • apis/rooms.py
    • RoomsApi
      • RoomsApi.get_all_joined()
      • RoomsApi.join()
      • RoomsApi.get_joined()
      • RoomsApi.leave()
      • RoomsApi.send()
      • RoomsApi.get_messages()
      • RoomsApi.set_ticker()
      • RoomsApi.add_member()
      • RoomsApi.get_users()
      • RoomsApi.get_all()
  • apis/searches.py
    • SearchesApi
      • SearchesApi.search_text()
      • SearchesApi.get_all()
      • SearchesApi.state()
      • SearchesApi.stop()
      • SearchesApi.delete()
      • SearchesApi.search_responses()
  • apis/server.py
    • ServerApi
      • ServerApi.connect()
      • ServerApi.disconnect()
      • ServerApi.state()
  • apis/session.py
    • SessionApi
      • SessionApi.auth_valid()
      • SessionApi.login()
      • SessionApi.security_enabled()
  • apis/shares.py
    • SharesApi
      • SharesApi.get_all()
      • SharesApi.start_scan()
      • SharesApi.cancel_scan()
      • SharesApi.get()
      • SharesApi.all_contents()
      • SharesApi.contents()
  • apis/telemetry.py
    • TelemetryApi
      • TelemetryApi.get_metrics()
      • TelemetryApi.get_kpis()
      • TelemetryApi.get_transfer_summary()
      • TelemetryApi.get_transfer_histogram()
      • TelemetryApi.get_transfer_leaderboard()
      • TelemetryApi.get_user_transfers()
      • TelemetryApi.get_transfer_exceptions()
      • TelemetryApi.get_transfer_exceptions_pareto()
      • TelemetryApi.get_most_dl_directories()
  • apis/transfers.py
    • TransfersApi
      • TransfersApi.cancel_download()
      • TransfersApi.get_download()
      • TransfersApi.remove_completed_downloads()
      • TransfersApi.cancel_upload()
      • TransfersApi.get_upload()
      • TransfersApi.remove_completed_uploads()
      • TransfersApi.enqueue()
      • TransfersApi.get_downloads()
      • TransfersApi.get_all_downloads()
      • TransfersApi.get_queue_position()
      • TransfersApi.get_all_uploads()
      • TransfersApi.get_uploads()
  • apis/users.py
    • UsersApi
      • UsersApi.address()
      • UsersApi.browse()
      • UsersApi.browsing_status()
      • UsersApi.directory()
      • UsersApi.info()
      • UsersApi.status()