Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Simple read-only interface to http://apartments.gaijinpot.com/
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.gitignore
LICENSE.md
README.md
index.js
package.json

README.md

Gaijinpot Apartments

Simple read-only interface to http://apartments.gaijinpot.com/

Overview

This module allows you to query the gaijinpot apartments website for various information about apartments.

Installation

$ npm install gaijinpot-apartments

OR

$ git clone git://github.com/deoxxa/gaijinpot-apartments.git node_modules/gaijinpot-apartments

Usage

More documentation is pending, but take a look at this in the meantime.

#!/usr/bin/env node

var GaijinpotApartments = require("gaijinpot-apartments"),
    client = new GaijinpotApartments("http://apartments.gaijinpot.com/", "rentals");

// Getting information about a specific listing

apartments.get(1234, function(err, res) {
  if (err) {
    return console.log(err);
  }

  console.log(JSON.stringify(res, null, 2));
});

// Performing a search

apartments.search({order: 1}, function(err, res) {
  if (err) {
    return console.log(err);
  }

  console.log(JSON.stringify(res, null, 2));
});

License

3-clause BSD. A copy is included with the source.

Contact

Something went wrong with that request. Please try again.