Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neighbor Public API

The Public API from Neighbor — 2 operation(s) for public.

Neighbor Public API is published by Neighbor on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Public. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.neighbor.com.

2 operations 2 paths 0 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.neighbor.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Neighbor Public API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (NeighborApiKey). By default, every request must be authenticated.

  • NeighborApiKey — Use header value NEIGHBOR-API-KEY . Email jon@neighbor.com to request an API key.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Public 2
GET
/public/reports/reservation
Get reservation report
getReservationReport → 200401
GET
/public/reports/transfer
Get transfer/payout report
getTransferReport 2 params → 200401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neighbor-public-api-openapi.yml Raw ↑