-
Notifications
You must be signed in to change notification settings - Fork 2
All Methods
-
KSoftApi
- KSoftAPI(accountToken)
- AddBan(userID, reason, proof, mod, userName, userDiscriminator, appealPossible)
- AdvancedWeather(latitude, longitude, reportType, units, language, icons)
- AlbumByID(id)
- ArtistByID(id)
- BanCheck(userID)
- BanInfo(userID)
- BanList(page, perPage)
- BanUpdates(timestamp)
- BasicWeather(reportType, query, units, language, icons)
- CurrencyConversion(from, to, value)
- DeleteBan(userID,force)
- Execute(request)
- GeoIP(ip)
- ImageFromSnowflake(snowflake)
- RandomAww()
- RandomImage(tag, nsfw)
- RandomMeme()
- RandomNsfw(gifs)
- RandomReddit(subreddit, removeNsfw, span)
- RandomWikiHow(nsfw)
- SearchLocation(query, fast, more, mapZoom, includeMap)
- SearchLyrics(query, textOnly, limit)
- TagSearch(query)
- Tags()
- TrackByID(id)
KSoft API class
| Name | Type | Description |
|---|---|---|
| accountToken | System.String | Token from your dashboard https://api.ksoft.si/dashboard |
This endpoint allows you to add bans to the list. If you don't have BAN_MANAGER permission your ban will be automatically converted to a ban report and we will take a look and act accordingly.
KSoftBan
| Name | Type | Description |
|---|---|---|
| userID | System.Int64 | Users Discord ID that you are banning/reporting |
| reason | System.String | Reason why user should be globally banned |
| proof | System.String | URL of the image showing the act |
| mod | System.Int64 | Users Discord ID who posted/reported the ban |
| userName | System.String | Users Discord username |
| userDiscriminator | System.String | Users Discord discriminator |
| appealPossible | System.Boolean | If appeal should be disabled for that user. |
Gets weather by coordinates, this endpoint is faster than weather - easy, because it doesn't need to lookup the location.
KSoftWeather
| Name | Type | Description |
|---|---|---|
| latitude | System.Single | Latitude coordinate |
| longitude | System.Single | Longitude coordinate |
| reportType | System.String | Select weather type. Can be one of: "currently", "minutely", "hourly", "daily" |
| units | System.String | Default: auto, select units, you can choose from: "si", "us", "uk2", "ca", "auto" |
| language | System.String | Default: en, select language, all available languages: 'ar', 'az', 'be', 'bg', 'bs', 'ca', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'he', 'hr', 'hu', 'id', 'is', 'it', 'ja', 'ka', 'ko', 'kw', 'nb', 'nl', 'no', 'pl', 'pt', 'ro', 'ru', 'sk', 'sl', 'sr', 'sv', 'tet', 'tr', 'uk', 'x-pig-latin', 'zh', 'zh-tw' |
| icons | System.String | Default: original, select icon pack |
Retrieves artist name and all tracks in the album.
KSoftAlbumInfo
| Name | Type | Description |
|---|---|---|
| id | System.Int32 | Album ID, you can get it from the lyrics search |
Retrieves all albums and songs by that artist.
KSoftArtistInfo
| Name | Type | Description |
|---|---|---|
| id | System.Int32 | Artist ID, you can get it from the lyrics search |
Simple way to check if the user is banned
KSoftBanCheck
| Name | Type | Description |
|---|---|---|
| userID | System.Int64 | Users Discord ID that you'd like to check |
Get more information about a ban
KSoftBanInfo
| Name | Type | Description |
|---|---|---|
| userID | System.Int64 | Users Discord ID who's ban you'd like to check |
Pagination of bans, you can request up to 1000 records per page, default is 20.
KSoftBanList
| Name | Type | Description |
|---|---|---|
| page | System.Int32 | Page number (default: 1) |
| perPage | System.Int32 | Number of bans per page (default: 20) |
Gets updates from the previous update
KSoftBanUpdates
| Name | Type | Description |
|---|---|---|
| timestamp | System.DateTimeOffset | Timestamp in seconds from 1.1.1970 (epoch time) |
Gets weather by location.
KSoftWeather
| Name | Type | Description |
|---|---|---|
| reportType | System.String | Select weather report type. Can be one of: "currently", "minutely", "hourly", "daily" |
| query | System.String | Location query |
| units | System.String | Default: auto, select units, you can choose from: "si", "us", "uk2", "ca", "auto" |
| language | System.String | Default: en, select language, all available languages: 'ar', 'az', 'be', 'bg', 'bs', 'ca', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'he', 'hr', 'hu', 'id', 'is', 'it', 'ja', 'ka', 'ko', 'kw', 'nb', 'nl', 'no', 'pl', 'pt', 'ro', 'ru', 'sk', 'sl', 'sr', 'sv', 'tet', 'tr', 'uk', 'x-pig-latin', 'zh', 'zh-tw' |
| icons | System.String | Default: original, select icon pack |
Currency conversion.
KSoftCurrency
| Name | Type | Description |
|---|---|---|
| from | System.String | ISO Standard for 3 letter currency naming: https://en.wikipedia.org/wiki/ISO_4217#Active_codes |
| to | System.String | ISO Standard for 3 letter currency naming: https://en.wikipedia.org/wiki/ISO_4217#Active_codes |
| value | System.Single | Float or Integer you want to convert |
Delete a ban, only users with BAN_MANAGER permission can use this.
KSoftBanDeletion
| Name | Type | Description |
|---|---|---|
| userID | System.Int64 | Users Discord ID |
| force | System.Boolean | Default: false, if true it deletes the entry from the database instead of deactivating |
Method to execute requests
Type provided
| Name | Type | Description |
|---|---|---|
| request | RestSharp.RestRequest | Rest request to execute |
| Name | Description |
|---|---|
| T | Type to return |
Gets location data from the IP address.
KSoftGeoIP
| Name | Type | Description |
|---|---|---|
| ip | System.String | IP address |
Retrieve image data.
KSoftImage
| Name | Type | Description |
|---|---|---|
| snowflake | System.String | Image snowflake (unique ID) |
Get random cute pictures, mostly animals.
KSoftRedditPost
This method has no parameters.
Gets random image from the specified tag.
KSoftImage
| Name | Type | Description |
|---|---|---|
| tag | System.String | Default: false, if to show nsfw content |
| nsfw | System.Boolean | Name of the tag |
Retrieves a random meme from the cache. Source: reddit
KSoftRedditPost
This method has no parameters.
Retrieves random NSFW pics. (real life stuff)
KSoftRedditPost
| Name | Type | Description |
|---|---|---|
| gifs | System.Boolean | Default: false, if to retrieve gifs instead of images |
Retrieve images from the specified subreddit.
KSoftRedditPost
| Name | Type | Description |
|---|---|---|
| subreddit | System.String | Specified subreddit |
| removeNsfw | System.Boolean | Default: false, if set to true, endpoint will filter out nsfw posts. |
| span | System.String | Default: "day", select range from which to get the images. Can be one of the following: "hour", "day", "week", "month", "year", "all" |
Retrieves weird images from WikiHow
KSoftWikiHowPost
| Name | Type | Description |
|---|---|---|
| nsfw | System.Boolean | Default: false, if to display nsfw content. |
You can get coordinates and more information about the searched location, if needed image of the area is generated.
KSoftLocation
| Name | Type | Description |
|---|---|---|
| query | System.String | Your location query |
| fast | System.Boolean | Default: fast, return location data faster, but with less information |
| more | System.Boolean | Default: false, return more than one location |
| mapZoom | System.Int32 | Default: 12, set your own zoom level, if fast is not set or false, then this setting will be ignored because map zoom is calculated |
| includeMap | System.Boolean | Default: false, if to include an image of the area |
Searches for lyrics and returns a list of results.
KSoftLyrics
| Name | Type | Description |
|---|---|---|
| query | System.String | Search query. |
| textOnly | System.Boolean | Default: false, if set to 'true' then it only searches inside the lyrcis. |
| limit | System.Int32 | Default: 10, how many results should the endpoint return. |
Search for tags.
KSoftTags
| Name | Type | Description |
|---|---|---|
| query | System.String | Search query |
Retrieve the list of all available tags.
KSoftTags
This method has no parameters.
Get info about a song.
KSoftTrackInfo
| Name | Type | Description |
|---|---|---|
| id | System.Int32 | Track ID, you can get it from artist by id, album by id or lyrics search endpoints |