No description, website, or topics provided.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
mappings
.dockerignore
.gitignore
Dockerfile
LICENSE
README.md
index.js
model.js
package.json
server.js

README.md

Koop-Craigslist

A provider for the Craigslist Apartment search API

How to use

You can use this as a plugin to an existing Koop server or use the default server or docker implementations.

API

All data can be accessed at http://adapters.koopernetes.com/craigslist/:city/:type/FeatureServer/0

Cities follow the url subdomain for Craigslist (https://washingtondc.craigslist.org/)

e.g.

  • washingtondc
  • philadelphia
  • baltimore

Types:

  • apartments
  • jobs
  • forsale
  • services
  • gigs
  • community

Test it out

Run server:

  • npm install
  • npm start

Example API Query:

  • curl localhost:8080/craigslist/atlanta/apartments/FeatureServer/0/query?returnCountOnly=true

With Docker

  • docker build -t koop-provider-craigslist .
  • docker run -it -p 8080:8080 koop-provider-craigslist

In an existing Koop Server

//clean shutdown
process.on('SIGINT', () => process.exit(0))
process.on('SIGTERM', () => process.exit(0))

// Initialize Koop
const Koop = require('koop')
const koop = new Koop()

// Install the craigslist Provider
const craigslist = require('koop-craigslist')
koop.register(craigslist)

// Start listening for http traffic
const config = require('config')
const port = config.port || 8080
koop.server.listen(port)
console.log(`Koop Craigslist listening on ${port}`)