Jobs API Documentation

Introduction

Welcome to the Jobs API, your gateway to real-time job postings aggregated from across the internet. This API provides developers with access to a wealth of job data, enabling the creation of job boards, career sites, or integration of job listings into existing applications.

API Key

To use the Jobs API, you'll need an API key. You can get started for free:

• Subscribe for free at http://indianapi.in/jobs-api to obtain your API key
• For higher usage limits, paid plans are available

Base URL

The base URL for all API requests is:

https://jobs.indianapi.in

Authentication

Include your API key in the header of each request:

X-Api-Key: YOUR_API_KEY_HERE

API Sandbox

To test the API without using your request quota, use our sandbox environment:

http://indianapi.in/sandbox/jobs-api

Endpoints

1. Fetch Jobs Data

Retrieve a list of job postings with detailed information.

Endpoint: /jobs Method: GET

Parameters:

• limit (optional, string): Number of job listings to return
• Other potential parameters (to be confirmed with the API provider):
  • location (string): Filter jobs by location
  • title (string): Search for jobs by title
  • company (string): Filter jobs by company
  • experience (string): Filter by required experience level
  • job_type (string): Filter by job type (e.g., "Full Time", "Part Time")

Example Request:

curl --request GET \
  --url 'https://jobs.indianapi.in/jobs?limit=10' \
  --header 'X-Api-Key: YOUR_API_KEY_HERE'

Example Response:

[
  {
    "id": 1,
    "title": "Software Engineer - Fresher",
    "company": "TechCorp",
    "about_company": "TechCorp is a leading software development company...",
    "job_description": "We are looking for enthusiastic software engineers to join our team...",
    "job_title": "Software Engineer",
    "job_type": "Full Time",
    "location": "Bangalore",
    "experience": "Fresher",
    "role_and_responsibility": "Develop and maintain software applications...",
    "education_and_skills": "B.Tech/B.E. in Computer Science or related field...",
    "apply_link": "https://techcorp.com/careers/software-engineer-fresher",
    "posted_date": "2024-09-27T02:15:00"
  },
  // More job listings...
]

Response Structure

Each job listing in the response will contain the following fields:

• id (integer): Unique identifier for the job posting
• title (string): Full title of the job listing
• company (string): Name of the company offering the job
• about_company (string): Brief description of the company
• job_description (string): Detailed description of the job
• job_title (string): Specific title of the job role
• job_type (string): Type of employment (e.g., "Full Time", "Part Time")
• location (string): Location of the job
• experience (string): Required experience level
• role_and_responsibility (string): Detailed responsibilities of the role
• education_and_skills (string): Required education and skills
• apply_link (string): URL to apply for the job
• posted_date (string): Date and time when the job was posted (ISO 8601 format)

Error Handling

The API uses standard HTTP response codes to indicate the success or failure of requests. Here are some common codes you might encounter:

• 200: Successful request
• 422: Validation error (check your parameters)
• 401: Unauthorized (invalid or missing API key)
• 500: Internal server error

In case of an error, you'll receive a JSON response with more details about the error. For example:

{
  "detail": [
    {
      "type": "string_type",
      "loc": [
        "query",
        "limit"
      ],
      "msg": "Input should be a valid string",
      "input": 10
    }
  ]
}

Rate Limiting

Information about rate limits for free and paid tiers should be provided here. Please check with the API provider for specific details.

Best Practices

1. Always include the limit parameter to control the number of results returned.
2. Use appropriate filters to narrow down job searches and reduce unnecessary data transfer.
3. Cache responses when appropriate to reduce API calls and improve your application's performance.
4. Handle errors gracefully in your application, providing meaningful feedback to users.

Conclusion

The Jobs API provides a powerful tool for accessing real-time job data from across the internet. Whether you're building a job board, a career advice platform, or integrating job listings into an existing application, this API offers the flexibility and data you need.

Remember to keep your API key secure and never expose it in client-side code. If you have any questions or need further assistance, please don't hesitate to contact our support team.

Happy coding, and may your applications connect countless job seekers with their dream opportunities!