The RentalData.io API can be reached at https://api.rentaldata.io

All requests to our API require an Authorization header containing your API token as provided to you by RentalData.io

curl --request GET \
     --url https://api.rentaldata.io \
     --header 'Authorization: YOUR_TOKEN'

POST to /airbnb_jobs/

REQUEST

The post request should must have a JSON body containing an object with the keys “listing_ids” and “name”.

• “listing_ids” should be an array of all of the Airbnb listing ids that you would like to include in this job.
• “name” is the name of the job, and will be used for the filename prefix (ie. NAME_2020-01-01.gz where 2020-01-01 is the date of the file).
• “frequency” can optionally be included to specify the frequency in days the job should be run. Default is 1 (every day).

Note: Airbnb Listings Jobs are charged per successfully captured listing / per day.

{
   "name": "test_job",
   "listing_ids": [
      1234567,
      8754321,
   ]
}

RESPONSE

The response will be the job id for the newly created job.

{
   "id": 34
}

GET to /airbnb_jobs/

RESPONSE

The response will be an array of objects, each job will be an object with a job id and a name.

[
   {
      "id": 34,
      "name": "test_job"
   },
   {
      "id": 45,
      "name": "poland"
   }
]

GET to /airbnb_jobs/[JOB_ID]

RESPONSE

The response will be an object with the job id, name, listing_ids, and frequency.

{

   "id": 32,
   "name": "test_job",
   "listing_ids": [
      1234567,
      8754321
   ],

   "frequency": 1
}

DELETE to /airbnb_jobs/

Note: Deleting a job may take up to 24 hours for new files to stop being created and billing to end.

RESPONSE

200 OK