/artstation/projects

POST /api/artstation/projects

Price: 1 credit

Get ArtStation artwork (project) details by hash id or URL

How to use it

Get full details of an ArtStation artwork by its hash id or artwork URL. Returns title, description, all image and video assets, medium, subject-matter categories, software used, tags, artist, and view/like/comment counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• project string required — ArtStation artwork hash id or artwork URL (examples: "Vy0deg", "https://www.artstation.com/artwork/Vy0deg"; minLength: 1)

Response

• @type string (default: "ArtstationProject")
• id integer required
• hash_id string nullable
• project_title string nullable
• description string nullable
• slug string nullable
• url string nullable
• image string nullable
• view_count integer nullable
• like_count integer nullable
• comment_count integer nullable
• is_adult boolean (default: false)
• is_editor_pick boolean (default: false)
• published_at integer nullable
• created_at integer nullable
• updated_at integer nullable
• mediums array (default: [])
• categories array (default: [])
• software array (default: [])
• tags array (default: [])
• assets array (default: [])
  • @type string (default: "ArtstationAsset")
  • id integer nullable
  • asset_type string nullable
  • image string nullable
  • width integer nullable
  • height integer nullable
  • position integer nullable
  • has_image boolean (default: false)
  • has_embedded_player boolean (default: false)
  • player_embedded string nullable
  • asset_title string nullable
• user object nullable
  • @type string (default: "ArtstationUserBrief")
  • id integer required
  • alias string nullable
  • full_name string nullable
  • headline string nullable
  • image string nullable
  • cover string nullable
  • is_pro boolean (default: false)
  • is_staff boolean (default: false)
  • is_plus_member boolean (default: false)
  • is_artist boolean (default: false)
  • is_studio_account boolean (default: false)
  • is_school_account boolean (default: false)
  • has_recruiter_badge boolean (default: false)
  • follower_count integer nullable
  • project_count integer nullable
  • city string nullable
  • country string nullable
  • location string nullable
  • available_full_time boolean (default: false)
  • available_freelance boolean (default: false)
  • available_contract boolean (default: false)
  • skills array (default: [])
  • software array (default: [])
    • @type string (default: "ArtstationSoftware")
    • name string required
    • image string nullable
  • sample_project_images array (default: [])
  • url string 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 — Artwork not found. Verify the hash id or artwork URL. 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.