/deviantart/users/favourites

POST /api/deviantart/users/favourites

Price: 20 credits

Get DeviantArt User Favourites

How to use it

Get the favourited deviations of a DeviantArt user. Provide folder_id to browse a specific favourites folder. Returns title, author, image, and favourite/comment/view counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — DeviantArt username or profile URL (examples: "irenbee"; minLength: 1)
• count integer required — Max result count (examples: 24; min: 1)
• folder_id string nullable — Favourites folder ID to browse; omit for all favourites (examples: "52759334")

Response

• @type string (default: "DeviantartDeviation")
• id string required
• deviation_title string nullable
• url string nullable
• short_url string nullable
• deviation_type string nullable
• file_type string nullable
• is_journal boolean (default: false)
• is_video boolean (default: false)
• is_mature boolean (default: false)
• is_ai_generated boolean (default: false)
• is_downloadable boolean (default: false)
• is_daily_deviation boolean (default: false)
• license string nullable
• image string nullable
• published_at integer nullable
• description string nullable
• tags array (default: [])
• width integer nullable
• height integer nullable
• file_size integer nullable
• comment_count integer nullable
• favourite_count integer nullable
• view_count integer nullable
• download_count integer nullable
• private_collection_count integer nullable
• group_count integer nullable
• awarded_badge_count integer nullable
• author object nullable
  • @type string (default: "DeviantartUser")
  • id string required
  • alias string required
  • url string nullable
  • image string nullable
  • account_type string nullable
  • is_group boolean (default: false)
  • is_new_deviant boolean (default: false)
  • tagline string nullable
  • country string nullable
  • gender string nullable
  • website string nullable
  • is_artist boolean nullable
  • artist_level integer nullable
  • artist_specialty integer nullable
  • is_open_for_commissions boolean nullable
  • registered_at integer nullable
  • social_links array (default: [])
    • @type string (default: "DeviantartSocialLink")
    • service string required
    • url string required
  • interests array (default: [])
    • @type string (default: "DeviantartInterest")
    • label string required
    • value string required
  • deviation_count integer nullable
  • watcher_count integer nullable
  • watching_count integer nullable
  • pageview_count integer nullable
  • favourite_count integer nullable
  • friend_count integer nullable
  • profile_comment_count integer nullable
  • comment_made_count integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — User or favourites folder not found. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.