/freelancer/projects/search

POST /api/freelancer/projects/search

Price: 10 credits

Search open Freelancer.com projects by keyword and filters: project type (fixed/hourly), skill ids, client country, project language, paid upgrades, posted budget range, posted hourly-rate range, average bid range, average hourly-bid range and a latitude/longitude radius for local jobs. Results carry the same fields as the project endpoint.

How to use it

Search currently open Freelancer.com projects. All filters are optional except count. Use query for keywords, project_types (fixed/hourly), skills (numeric skill ids), countries (two-letter codes such as us/gb/in), languages (two-letter codes), upgrades (featured/urgent/sealed/NDA/ip_contract/assisted/nonpublic/fulltime/qualified), min_budget/max_budget for the budget the client posted on fixed-price work, min_hourly_rate/max_hourly_rate for the rate posted on hourly work, min_avg_bid/max_avg_bid and min_avg_hourly_bid/max_avg_hourly_bid to filter by what freelancers actually bid, and latitude+longitude+distance for local jobs. sort accepts time_updated (newest), bid_count or relevance. Each item is a full project — pass its id to the Freelancer project endpoint for the client panel. To search closed and completed projects use the Freelancer project archive endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Keyword to match against project title and description (examples: "python scraper")
• project_types array nullable — Keep only fixed-price and/or hourly projects (one of: "fixed", "hourly")
• skills array nullable — Skill ids the project must be tagged with (examples: [3,13])
• countries array nullable — Two-letter country codes of the client posting the project (examples: ["us","gb"])
• languages array nullable — Two-letter language codes the project is written in (examples: ["en"])
• upgrades array nullable — Keep only projects carrying these paid upgrades (one of: "featured", "urgent", "sealed", "NDA", "ip_contract", "assisted", "nonpublic", "fulltime", "qualified")
• min_budget number nullable — Lowest fixed-price budget the client posted (examples: 500; >: 0)
• max_budget number nullable — Highest fixed-price budget the client posted (examples: 5000; >: 0)
• min_avg_bid number nullable — Lowest average bid freelancers placed on the project (examples: 500; >: 0)
• max_avg_bid number nullable — Highest average bid freelancers placed on the project (examples: 5000; >: 0)
• min_hourly_rate number nullable — Lowest hourly rate the client posted (examples: 25; >: 0)
• max_hourly_rate number nullable — Highest hourly rate the client posted (examples: 150; >: 0)
• min_avg_hourly_bid number nullable — Lowest average hourly rate freelancers bid on the project (examples: 25; >: 0)
• max_avg_hourly_bid number nullable — Highest average hourly rate freelancers bid on the project (examples: 150; >: 0)
• latitude number nullable — Latitude to search local projects around (examples: 40.7128; min: -90; max: 90)
• longitude number nullable — Longitude to search local projects around (examples: -74.006; min: -180; max: 180)
• distance number nullable — Radius in kilometres around latitude/longitude (examples: 100; >: 0)
• sort string nullable — Ordering of the result list (one of: "time_updated", "bid_count", "relevance")
• reverse_sort boolean nullable — Flip the chosen ordering
• count integer required — Max number of projects to return (min: 1)

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 — The entity was not found, or a precondition failed 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.