/apna/jobs/search

POST /api/apna/jobs/search

Price: 5 credits

Search Apna (apna.co) job postings by keyword, location, posting date, work mode, full-time or part-time, shift, department, minimum salary and experience: id, title, company, location with coordinates, salary range and incentives, experience and education requirements, shift, openings and posting, update and expiry dates

How to use it

Leave keyword empty to browse by filters alone. With a keyword, location matches the closest Apna city, region or area; without one it must name a city. Keyword results carry fewer fields than filter-only results. Salaries are INR per month. Pass a returned id to apna/jobs for the full posting, skills, interview details and similar jobs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of results (min: 1; max: 3000)
• keyword string nullable — Job title, skill or company keyword (examples: "accountant"; minLength: 1; maxLength: 100)
• location string nullable — City, region or area name (examples: "Pune", "Andheri"; minLength: 2; maxLength: 100)
• posted_within string nullable — Posting date window (one of: "day", "three_days", "week")
• work_mode string nullable — Where the work happens (one of: "office", "home", "field")
• work_type string nullable — Full-time or part-time (one of: "full_time", "part_time")
• shift string nullable — Work shift (one of: "day", "night")
• department string nullable — Job department (one of: "admin_back_office", "advertising_communication", "aviation_aerospace", "banking_insurance_finance", "beauty_fitness_personal_care", "construction_site_engineering", "consulting", "content_editorial_journalism", "csr_social_service", "customer_support", "data_science_analytics", "delivery_driver_logistics", "domestic_worker", "energy_mining", "engineering_hardware_networks", "environment_health_safety", "facility_management", "finance_accounting", "healthcare_hospital", "maintenance_services", "human_resources", "it_information_security", "legal_regulatory", "marketing_brand_digital", "media_production_entertainment", "purchase_supply_chain", "product_management", "production_manufacturing", "project_program_management", "quality_assurance", "research_development", "restaurant_hospitality_tourism", "retail_ecommerce", "risk_compliance", "sales_bd", "security_services", "shipping_maritime", "software_engineering", "strategic_top_management", "tailoring_apparel_home_furnishing", "teaching_training", "ux_design_architecture", "operations")
• min_salary integer nullable — Minimum monthly salary in INR (examples: 30000; min: 1; max: 10000000)
• experience_years integer nullable — Candidate's years of experience (examples: 2; min: 0; max: 31)
• sort string — Result ordering: default is text relevance with a keyword and highest fixed salary first without one, latest is most recently updated first, salary is highest salary first (default: "default"; one of: "default", "latest", "salary")

Response

• @type string (default: "ApnaJobSearchResult")
• id string required
• url string required
• role string nullable
• description string nullable
• category string nullable
• category_id string nullable
• department string nullable
• department_id string nullable
• company object nullable
  • @type string (default: "ApnaCompany")
  • id string nullable
  • external_id string nullable
  • name string nullable
  • image string nullable
• location_name string nullable
• location_type string nullable
• applicant_location string nullable
• city string nullable
• area string nullable
• address string nullable
• pincode string nullable
• latitude number nullable
• longitude number nullable
• salary_min integer nullable
• salary_max integer nullable
• fixed_salary_min integer nullable
• fixed_salary_max integer nullable
• earning_potential integer nullable
• incentive_amount integer nullable
• has_incentives boolean nullable
• salary_type string nullable
• experience string nullable
• experience_level string nullable
• experience_min_years integer nullable
• experience_max_years integer nullable
• education string nullable
• english_level string nullable
• gender string nullable
• shift string nullable
• is_part_time boolean nullable
• is_work_from_home boolean nullable
• is_flexible boolean nullable
• openings_count integer nullable
• tags array (default: [])
• highlights array (default: [])
  • @type string (default: "ApnaHighlight")
  • kind string nullable
  • description string nullable
• is_urgently_hiring boolean nullable
• deposit object nullable
  • @type string (default: "ApnaDeposit")
  • amount integer nullable
  • timing string nullable
  • reason string nullable
  • purpose string nullable
  • notice string nullable
• salary_note string nullable
• application_mode string nullable
• status string nullable
• is_active boolean nullable
• is_international boolean nullable
• international_city string nullable
• international_country string nullable
• is_external boolean nullable
• external_url string nullable
• accepts_calls boolean nullable
• accepts_whatsapp boolean nullable
• posted_at integer nullable
• updated_at integer nullable
• expires_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 — Apna has no location matching that name; without a keyword the location must be a city 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.