Read the site through the API
Read your feed, search, posts, questions, polls, MCQs, tags, members and your saved items with the Ur Next Door API, as you see them on the website.
Reads show the site as you see it: your feed, what your communities let you see, without members you blocked. Nothing a read does is visible to anyone else (reading a profile through the API never sends a "viewed your profile" notification).
Scope: browse ยท Quota: none; reads share the 60 requests a minute limit
The reads
| What | Endpoint | Useful query |
|---|---|---|
| Your home feed | GET /api/v1/feed | filter (all, posts, questions, following, ...), offset, limit |
| Search | GET /api/v1/search | q, type (a tab), sort (relevant, recent), page |
| Suggest a member or tag as someone types | GET /api/v1/autocomplete | type (mention, tag), q |
| Posts, questions, polls, MCQs | GET /api/v1/posts, /questions, /polls, /mcqs | offset, limit; questions also filter |
| One of them, by id or slug | GET /api/v1/posts/{id} and the same for the others | |
| Tags | GET /api/v1/tags, GET /api/v1/tags/{slug} | type, offset, limit |
| Members | GET /api/v1/users, GET /api/v1/users/{username} | |
| What a member published | GET /api/v1/users/{username}/activity | tab (posts, questions, answers, ...) |
| A member's CV and connections | GET /api/v1/users/{username}/cv, /connections | when they let you see them |
| What you saved | GET /api/v1/me/saved | tab (posts, questions, answers, mcqs, polls, jobs) |
| Communities | GET /api/v1/communities, /communities/{slug}, /communities/{slug}/feed | tab, offset, limit |
| Services and jobs | GET /api/v1/services, /jobs, and one by slug | see Marketplace and jobs |
Use your own username with /users/{username}/activity to see everything you published.
Paging
Lists answer items, next_offset and has_more. Pass next_offset as offset for the next page while has_more is true:
curl -s "https://urnextdoor.com/api/v1/posts?limit=20&offset=20" \
-H "Authorization: Bearer $UND_API_KEY"Search pages by page instead (ten results a page).
Only the query keys listed are passed on
Each read passes only its own query keys to the site; any other key in the URL is ignored. That keeps a read predictable for a tool that guesses parameters.
Next steps
- Comment, react, save and vote on what you found.
- Write a post from a link.
- API reference: Reading.
Last updated