Using the Neighbor REST API

The Neighbor API allows trusted users to retrieve reports related to their account.

Obtaining an API Key

To use the Neighbor API, you must acquire an API key that will be attached to your account. This key will then be used as HEADER data in subsequent requests to the API. Email jon@neighbor.com to request an API key.

Making an API call

To make a call to the API, you must pass your Neighbor API key in the Authorization HEADER of your HTTP request:
curl -H "Authorization: NEIGHBOR-API-KEY"  https://api.production.neighbor.com/public/[API Endpoint]

API Resources

GET Reservation report

Get's the reservation report for the useri identified by the NEIGHBOR-API-KEY. The reservation report will return in json format the reservations that the user has that are in the Active state (meaning the listing is reserved)
Example GET command:
curl -H "Authorization: NEIGHBOR-API-KEY" https://api.production.neighbor.com/public/reports/reservation
Example result:
[
  {
    "reservations_id": 1234,
    "start_date": "2022-01-01T00:00:00.000Z",
    "storing": "vehicle",
    "status": "Active",
    "host_fee": 146.34,
    "first_name": "John",
    "last_name": "Smith",
    "length": 25,
    "width": 10,
    "vehicles": [
      {
        "make": "Ford",
        "model": "Taurus",
        "year": "2013",
        "color": "Blue",
        "license": "111AAA"
      }
    ]
  }
]

GET Payout report

Get's the payout/transfer report for the user identified by the NEIGHBOR-API-KEY. The payout/transfer report can be filtered by month and year
Example GET command:
curl -H "Authorization: NEIGHBOR-API-KEY" https://api.production.neighbor.com/public/reports/transfer?year=2022&month=1
Example result:
[
  {
    "reservation_id: 1234,
    "listing_name": "Parking garage on Main Street",
    "renter_first": "John",
    "renter_last": "Smith",
    "start_date": "2022-01-01T00:00:00.000Z",
    "status": "Active",
    "actual_transfer_date": "2021-12-13T00:00:00.000Z",
    "transfer_amount": 146.34,
    "running_total": 292.68
  }
]