/freelancer/contests

POST /api/freelancer/contests

Price: 1 credit

Get a Freelancer.com design contest by id, SEO slug or contest URL: title, full brief, prize and currency, status, contest type, guaranteed flag, duration and judging period, required skills, paid upgrades, timestamps, and the contest owner's public profile.

How to use it

Fetch one Freelancer.com contest. Accepts a numeric contest id (2766954), a SEO slug (contest/-TechAI-Images-Fast-2766954.html) or a full contest URL. Returns id, contest_title, alias, contest_url, description, status, type, prize with currency, skills, upgrades, entry_count, duration_days, judging_period_days, is_guaranteed, owner (public profile of the client, unlike projects where the client id is not exposed) and submitted_at/ends_at unix seconds. Use the Freelancer contest entries endpoint for the submitted designs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• contest string required — Contest id, SEO slug or a full contest URL (examples: "2766954", "contest/-TechAI-Images-Fast-2766954.html", "https://www.freelancer.com/contest/-TechAI-Images-Fast-2766954.html"; minLength: 1)

Response

• @type string (default: "FreelancerContest")
• id integer required
• contest_title string nullable
• alias string nullable
• contest_url string nullable
• description string nullable
• status string nullable
• contest_type string nullable
• prize number nullable
• currency object nullable
  • @type string (default: "FreelancerCurrency")
  • code string nullable
  • sign string nullable
  • name string nullable
  • country string nullable
  • exchange_rate number nullable
• skills array (default: [])
  • @type string (default: "FreelancerSkill")
  • id integer required
  • name string nullable
  • alias string nullable
  • category_id integer nullable
  • category_name string nullable
  • is_local boolean nullable
• upgrades array (default: [])
• entry_count integer nullable
• duration_days integer nullable
• judging_period_days integer nullable
• language string nullable
• is_extended boolean nullable
• owner object nullable
  • @type string (default: "FreelancerUserBrief")
  • id integer required
  • alias string nullable
  • display_name string nullable
  • tagline string nullable
  • role string nullable
  • company string nullable
  • image string nullable
  • hourly_rate number nullable
  • location object nullable
    • @type string (default: "FreelancerLocation")
    • country string nullable
    • country_code string nullable
    • city string nullable
    • administrative_area string nullable
    • postal_code string nullable
    • latitude number nullable
    • longitude number nullable
  • verification object nullable
    • @type string (default: "FreelancerVerification")
    • is_payment_verified boolean nullable
    • is_email_verified boolean nullable
    • is_phone_verified boolean nullable
    • is_identity_verified boolean nullable
    • is_deposit_made boolean nullable
    • is_profile_complete boolean nullable
    • is_facebook_connected boolean nullable
    • is_linkedin_connected boolean nullable
    • is_freelancer_verified boolean nullable
  • profile_url string nullable
  • registered_at integer nullable
  • is_limited_account boolean nullable
  • is_closed boolean nullable
• submitted_at integer nullable
• posted_at integer nullable
• ends_at 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 — Contest 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.