The Nextdoor APIs use the OAuth 2.0 protocol to authorize API requests.
Please apply for access and the Nextdoor Partnerships team will provide client_id and client_secret credentials that will be used to get an access token.
Once you have the client_id and client_secret, you must get a Bearer token to access Nextdoor APIs. Add a new header with client_id:client_secret
when requesting the access token.
The token service will return the Bearer token with the expiration time.
The value of scope varies depending on which API you are trying to integrate.
Search API
For Search API, the following scopes are supported:
openid
: Always include thiscontent_api
: Include this super scope if you are interested in all the following products.content_api.search_post
: Include this scope if you are interested in neighbour's post as part of your search result.content_api.search_business
: Include this scope if you are interested in the business results as part of your search result.content_api.search_sale_item
: Include this scope if you are interested in the Buy & Sell Free items as part of your search result.
Here is an example of what to include for all scopes:
scope = content_api.search_post content_api.search_business content_api.search_sale_item openid
Trending + Agency Posts API
For the Trending + Agency Post API, the following scopes are supported:
openid
: Always include thispartner_api
: Always include this
After getting your Bearer token you need to add the token to your request header to access the APIs. Here is an example header with the Bearer token:
Authorization: Bearer <access_token>