/freelancer/projects

POST /api/freelancer/projects

Price: 10 credits

Get a Freelancer.com project by its numeric id, SEO slug or project URL: title, full description, status, fixed or hourly type, budget range, hourly commitment, currency, bid statistics (bid count and average bid), required skills with categories, paid upgrades, attachments, location, language and timestamps. Set client_details to also return the client panel from the project page.

How to use it

Fetch one Freelancer.com project. Accepts a numeric project id (40591790), a SEO slug (web-development/HSE-Compliance-System-Development) or a full project URL. Returns one item with id, project_title, alias, project_url, description, status, type (fixed/hourly), currency, budget (minimum/maximum), hourly_info, bid_stats (bid_count, bid_avg), bid_period_days, skills, upgrades, attachments, location, language and submitted_at/updated_at unix seconds. The list of individual bids is not public. client_details=true additionally returns the project's client panel (country, city, rating, review_count, member_since, verifications) — the client's user id and alias are not exposed publicly.

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 id, SEO slug or a full project URL (examples: "40591790", "web-development/HSE-Compliance-System-Development", "https://www.freelancer.com/projects/web-development/HSE-Compliance-System-Development"; minLength: 1)
• client_details boolean — Also return the client panel shown on the project page (country, city, rating, review count, member-since, verification labels). Adds a second, much heavier request (default: false)

Response

• @type string (default: "FreelancerProject")
• id integer required
• project_title string nullable
• alias string nullable
• project_url string nullable
• description string nullable
• preview_description string nullable
• status string nullable
• sub_status string nullable
• frontend_status string nullable
• project_type string nullable
• currency object nullable
  • @type string (default: "FreelancerCurrency")
  • code string nullable
  • sign string nullable
  • name string nullable
  • country string nullable
  • exchange_rate number nullable
• budget object nullable
  • @type string (default: "FreelancerProjectBudget")
  • minimum number nullable
  • maximum number nullable
• hourly_info object nullable
  • @type string (default: "FreelancerProjectHourlyInfo")
  • commitment_hours integer nullable
  • commitment_interval string nullable
  • duration string nullable
• bid_stats object nullable
  • @type string (default: "FreelancerProjectBidStats")
  • bid_count integer nullable
  • bid_avg number nullable
• bid_period_days integer 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: [])
• attachments array (default: [])
  • @type string (default: "FreelancerProjectAttachment")
  • filename string nullable
  • url string 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
• language string nullable
• is_local boolean nullable
• is_hidden_bids boolean nullable
• is_nonpublic boolean nullable
• is_escrow_project boolean nullable
• submitted_at integer nullable
• updated_at integer nullable
• client object nullable
  • @type string (default: "FreelancerProjectClient")
  • country string nullable
  • city string nullable
  • rating number nullable
  • review_count integer nullable
  • member_since string nullable
  • verifications array (default: [])

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.