> ## Documentation Index > Fetch the complete documentation index at: https://developers.apartmentiq.io/llms.txt > Use this file to discover all available pages before exploring further. # Create Batch Job > Submit a new batch job request to retrieve historical property data. The job will process asynchronously and return results in the specified format (CSV, JSONL, or Parquet). Use the job_id from the response to check job status and download results when complete. ## OpenAPI ````yaml /openapi/v1/schema.json post /bulk_api/jobs openapi: 3.0.3 info: title: ApartmentIQ API version: 1.14.0 termsOfService: https://www.getapartmentiq.com/terms x-logo: url: https://developers.apartmentiq.io/logo.svg altText: ApartmentIQ description: >- ApartmentIQ API providing Accounts, Market Surveys, Markets, Market Narratives, and Forecasts endpoints to access accounts, comp sets, market survey tables, units, floorplans, and market-based property data. See documentation pages for authentication, errors, and rate limits. servers: - url: https://data.apartmentiq.io/apartmentiq/api/v1 security: - oauth2: [] tags: - name: Accounts description: >- Endpoints for listing the ApartmentIQ accounts accessible to the authenticated user. - name: Market Surveys description: >- Market Survey endpoints can be used to access data related to your market surveys within ApartmentIQ. The ApartmentIQ API refers to the list of properties within your market surveys as a comp set, or competitive set. In the rest of this document, comp set and competitive set will be used interchangeably. - name: Markets description: Endpoints used to access market data. - name: Bulk Data Export description: >- Endpoints for requesting and downloading historical property data through asynchronous batch jobs. Submit a job request, monitor its status, and download results when ready. - name: Forecasts description: >- Endpoints for retrieving modeled future time-series forecast data for geographic boundaries and properties. Forecast data spans from the beginning of the current month up to 5 years in the future. Requires Explore Pro access. paths: /bulk_api/jobs: post: tags: - Bulk Data Export summary: Create Batch Job description: >- Submit a new batch job request to retrieve historical property data. The job will process asynchronously and return results in the specified format (CSV, JSONL, or Parquet). Use the job_id from the response to check job status and download results when complete. operationId: createBatchJob requestBody: required: true content: application/json: schema: type: object required: - report_type - output_format - start_date - end_date - property_ids properties: report_type: $ref: '#/components/schemas/ReportType' description: Type of report to generate. output_format: $ref: '#/components/schemas/FileType' description: Format for the output file. start_date: type: string format: date description: Start date for bulk data export (YYYY-MM-DD). example: '2025-12-01' end_date: type: string format: date description: End date for bulk data export (YYYY-MM-DD). example: '2025-12-31' property_ids: type: array items: type: integer description: Array of property IDs to include in the report. example: - 99001416 - 99001470 callback_url: type: string format: uri description: Optional webhook URL to notify when the job completes. example: https://example.com/webhook responses: '200': description: Job created successfully content: application/json: schema: $ref: '#/components/schemas/BatchJob' '400': description: The request was invalid or malformed. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Invalid Parameter: value: error: Invalid parameter message: start_date must be in YYYY-MM-DD format '401': description: Unauthorized - Invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Unauthorized message: Missing or invalid bearer token '403': description: Forbidden - Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Forbidden message: You do not have permission to create batch jobs components: schemas: ReportType: type: string enum: - floorplans - property - units title: FileType FileType: type: string enum: - csv - jsonl - parquet title: FileType BatchJob: properties: job_id: type: string format: uuid title: Job Id report_type: $ref: '#/components/schemas/ReportType' status: $ref: '#/components/schemas/JobStatus' output_format: $ref: '#/components/schemas/FileType' property_ids: items: type: integer type: array title: Property Ids start_date: type: string format: date title: Start Date end_date: type: string format: date title: End Date callback_url: type: string title: Callback URL error_message: type: string title: Error Message created_at: type: string format: date-time title: Created updated_at: type: string format: date-time title: Updated type: object required: - output_format - property_ids - report_type - start_date - end_date title: Job Error: type: object description: >- Error response payload. Most errors include error and optional message; some validation responses include errors; quota responses include quota fields. properties: error: type: string description: Short error message example: Invalid parameter message: type: string description: Optional detailed message example: account_id is required errors: type: array description: Optional list of validation errors. items: type: string quota_limit: type: integer description: >- Quota limit that applied to the request when an account quota was exceeded. quota_usage: type: integer description: Current quota usage when an account quota was exceeded. JobStatus: type: string enum: - submitted - cancelled - failed - succeeded title: JobStatus securitySchemes: oauth2: type: oauth2 description: >- Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings. flows: clientCredentials: tokenUrl: https://data.apartmentiq.io/oauth/token scopes: {} ````