DeviantArtFs 0.7.0

DeviantArtFs

A .NET / F# library to interact with the DeviantArt / Sta.sh API.

If you're using this library in a .NET Framework project and it doesn't run, make sure that the dependencies (FSharp.Core, FSharp.Json, FSharp.Control.AsyncSeq) are installed via NuGet.

Notes

Each request that can be made to DeviantArt is represented by a module somewhere in the DeviantArtFs.Requests namespace. These modules have static methods that take an IDeviantArtAccessToken (see "Authentication" below) and usually at least one other parameter.

In most cases, these static methods exist in pairs - one method will use F# async and use F# features such as records and option types, while the other will return a Task<T> and use interfaces and null values for interoperability with C# and VB.NET.

Some modules also have ToAsyncSeq and ToArrayAsync methods, which can be used to fetch an arbitary amount of data as needed. (Keep in mind that some of the endpoints under /browse/ might consist of many, many pages...)

Currently unsupported features

• The following groups of endpoints are not currently implemented:
  • Feed
  • Messages
  • Notes
• The "expand" parameter (user.details, user.geo, etc) is not currently supported.
• The "ext_preload" parameter (gallery/folders, collections/folders) is not currently supported.
• The "mature_content" parameter is not currently supported.

Supported endpoints

Browse

• GET /browse/categorytree
• GET /browse/dailydeviations
• GET /browse/hot
• GET /browse/morelikethis
• GET /browse/morelikethis/preview
• GET /browse/newest
• GET /browse/popular
• GET /browse/tags
• GET /browse/tags/search
• GET /browse/undiscovered
• GET /browse/user/journals

Collections

• GET /collections/{folderid}
• GET /collections/folders
• POST /collections/fave
• POST /collections/unfave
• POST /collections/folders/create
• GET /collections/folders/remove/{folderid}

Comments

• GET /comments/{commentid}/siblings
• GET /comments/deviation/{deviationid}
• POST /comments/post/deviation/{deviationid}
• POST /comments/post/profile/{username}
• POST /comments/post/status/{statusid}
• GET /comments/profile/{username}
• GET /comments/status/{statusid}

Data

• GET /data/countries
• GET /data/privacy
• GET /data/submission
• GET /data/tos

Deviation

• GET /deviation/{deviationid}
• GET /deviation/content
• GET /deviation/download/{deviationid}
• GET /deviation/embeddedcontent
• GET /deviation/metadata
• GET /deviation/whofaved

Gallery

• GET /gallery/gallery/{folderid}
• GET /gallery/all
• GET /gallery/folders
• POST /gallery/folders/create
• GET /gallery/folders/remove/{folderid}

Stash

• GET /stash/{stackid}
• GET /stash/{stackid}/contents
• POST /stash/delete
• GET /stash/delta
• GET /stash/item/{itemid}
• POST /stash/move/{stackid}
• POST /stash/position/{stackid}
• POST /stash/publish
• GET /stash/publish/categorytree
• GET /stash/publish/userdata
• GET /stash/space
• POST /stash/submit
• POST /stash/update/{stackid}

The DeviantArtFs.Stash.Marshal library (https://github.com/libertyernie/DeviantArtFs.Stash.Marshal) provides a StashRoot object that can process delta entries.

User

• GET /user/damntoken
• GET /user/friends/{username}
• GET /user/friends/search
• GET /user/friends/unwatch/{username}
• POST /user/friends/watch/{username}
• GET /user/friends/watching/{username}
• GET /user/profile/{username}
• POST /user/profile/update
• GET /user/statuses
• GET /user/statuses/{statusid}
• POST /user/statuses/post
• GET /user/watchers/{username}
• GET /user/whoami
• POST /user/whois

Util

• GET /placebo

Usage

Example (C#):

var list = new List<IBclDeviation>();
int offset = 0;
while (true) {
    var req = new DeviantArtFs.Requests.Gallery.GalleryAllViewRequest();
    var paging = new PagingParams {
        Offset = offset,
        Limit = 24
    };
    IBclDeviantArtPagedResult<IBclDeviation> resp =
        await DeviantArtFs.Requests.Gallery.GalleryAllView.ExecuteAsync(token, paging, req);
    list.AddRange(resp.Results);
    offset = resp.NextOffset ?? 0;
    if (!resp.HasMore) break;
}

Example (F#):

let list = new ResizeArray<Deviation>()
let mutable offset = 0
let mutable more = true
while more do
    let req = new DeviantArtFs.Requests.Gallery.GalleryAllViewRequest()
    let paging = new PagingParams(Offset = 0, Limit = Nullable 24)
    let! (resp: DeviantArtPagedResult<Deviation>) = DeviantArtFs.Requests.Gallery.GalleryAllView.AsyncExecute token paging req
    list.AddRange(resp.results)
    offset <- resp.next_offset |> Option.defaultValue 0
    more <- resp.has_more

Note how the result from AsyncExecute is DeviantArtPagedResult, which has a next_offset field of int option, while the result from ExecuteAsync is IBclDeviantArtPagedResult, which has a NextOffset field of int?.

See ENDPOINTS.md for more information.

Examples

The Examples folder in the source code repository contains small applications that use DeviantArtFs:

• RecentSubmissions.CSharp: A C# console application that shows the most recent submission, journal, and status for a user, along with any favorites or comments. (WinForms is needed for the login window, however.) Uses the Implicit grant and stores tokens in a file.
• RecentSubmissions.FSharp: As above, but in F#, to demonstrate how DeviantArtFs has both F#-style and .NET-style functions and types.
• GalleryViewer: A VB.NET app that lets you see the "All" view of someone's gallery and read the descriptions of individual submissions. Uses the Client Credentials grant and stores tokens in a file.
• WebApp: An ASP.NET Core 2.1 app written in C# that lets you view someone's gallery folders and corresponding submission thumbnails. Uses the Client Credentials grant and stores tokens in a database.

Authentication

See also: https://www.deviantart.com/developers/authentication

Both Authorization Code (recommended) and Implicit grant types are supported. If you are writing a Windows desktop application, you can use the forms in the DeviantArtFs.WinForms package to get a code or token from the user using either grant type.

The DeviantArtAuth class provides methods to support the Authorization Code grant type (getting tokens from an authorization code and refreshing tokens).