soundcloud / soundcloud/api

Feature Request: Add IDs Endpoint

Open
#15 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
254
Forks
53
PR merge metrics
No merged PRs in 30d

Description

Feature Request: Add ID's Endpoint

Currently it's not possible to fetch only the Ids of the followers/favorites etc. That makes it really ressource intensive to figure out, which tracks the user has a relationship since we need to page through a lot of data. (the details of the tracks or users are not needed here).

API-v2 is providing this functionality. It would be to see this in the API.

Endpoint(s):
  • GET /users/{id}/followings/ids
  • GET /users/{id}/followers/ids
  • GET /users/{id}/favorites/ids
  • GET /users/{id}/reposts/ids

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the API-v2 behavior referenced in the issue and compare it with the existing Public API relationship endpoints. Define the response and behavior for the four listed ID paths, then add coverage for each endpoint. Done means callers can fetch only followings, followers, favorites, and repost IDs without paging through full resource details.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.