/kickstarter/projects

POST /api/kickstarter/projects

Price: 10 credits

Get Kickstarter reward-crowdfunding project details by slug or URL

How to use it

Get full details of a Kickstarter crowdfunding project by slug ('creator/project-name') or URL. Returns funding progress (goal, pledged, usd_pledged, percent_funded, backer_count), campaign dates (launched_at, deadline, created_at), state, currency, category, creator, location, the campaign story and risks, and comment/update/faq 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 — Project slug ('creator/project-name') or full project URL ('https://www.kickstarter.com/projects/creator/project-name') (examples: "elanlee/exploding-kittens"; minLength: 1)

Response

• @type string (default: "KickstarterProject")
• id integer required
• name string required
• alias string required
• description string nullable
• project_url string nullable
• image string nullable
• video_url string nullable
• state string nullable
• goal number nullable
• pledged number nullable
• usd_pledged number nullable
• converted_pledged_amount number nullable
• percent_funded number nullable
• backer_count integer nullable
• currency string nullable
• currency_symbol string nullable
• current_currency string nullable
• static_usd_rate number nullable
• fx_rate number nullable
• usd_exchange_rate number nullable
• country string nullable
• country_displayable_name string nullable
• created_at integer nullable
• launched_at integer nullable
• deadline integer nullable
• state_changed_at integer nullable
• updated_at integer nullable
• successful_at integer nullable
• is_staff_pick boolean nullable
• is_starrable boolean nullable
• is_launched boolean nullable
• is_prelaunch_activated boolean nullable
• is_in_post_campaign_pledging_phase boolean nullable
• is_spotlight boolean nullable
• disable_communication boolean nullable
• tags array (default: [])
• comment_count integer nullable
• update_count integer nullable
• faq_count integer nullable
• has_community boolean nullable
• creator object nullable
  • @type string (default: "KickstarterCreator")
  • id integer nullable
  • name string required
  • alias string nullable
  • image string nullable
  • profile_url string nullable
• category object nullable
  • @type string (default: "KickstarterProjectCategory")
  • id integer nullable
  • name string required
  • alias string nullable
  • parent_id integer nullable
  • parent_name string nullable
• location object nullable
  • @type string (default: "KickstarterLocation")
  • id integer nullable
  • name string nullable
  • displayable_name string nullable
  • country string nullable
  • state string nullable
  • location_type string nullable
  • alias string nullable
• story string nullable
• risks 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 — Project 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.