Skip to content

Commit 127f5de

Browse files
authored
Add docs for GET /fc/starter-pack-members (base#408)
<!-- start pr-codex --> ## PR-Codex overview This PR introduces a new API endpoint for retrieving members of a starter pack in the Warpcast application, including details on the response format and example usage. ### Detailed summary - Added documentation for a new endpoint: `GET /fc/starter-pack-members`. - Described the purpose: to fetch members of a starter pack, ordered by addition time. - Listed query parameter: `id` for the starter pack. - Specified the response structure, including `members` array and example JSON response. - Provided a usage example using `curl`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
1 parent 739ef70 commit 127f5de

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/reference/warpcast/api.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,3 +1051,43 @@ Example:
10511051
```bash
10521052
curl 'https://api.warpcast.com/v1/creator-rewards-winner-history'
10531053
```
1054+
1055+
## Get Starter Pack Members
1056+
1057+
`GET /fc/starter-pack-members`
1058+
1059+
Starter pack members. Ordered by the time when they were added to the pack, descending. Paginated. Not authenticated.
1060+
1061+
Query parameters:
1062+
1063+
- `id` - starter pack id found as a part of the public Warpcast pack URL or in the non-authed public API of starter pack metadata.
1064+
1065+
Returns: a `members` array:
1066+
1067+
- `fid` - account Farcaster id
1068+
- `memberAt` - time when member was added to the starter pack, in milliseconds
1069+
1070+
```json
1071+
{
1072+
"result": {
1073+
"members": [
1074+
{
1075+
"fid": 3,
1076+
"memberAt": 1740172669691
1077+
},
1078+
{
1079+
"fid": 296646,
1080+
"memberAt": 1740172669691
1081+
},
1082+
...
1083+
]
1084+
},
1085+
"next": { "cursor": "..." }
1086+
}
1087+
```
1088+
1089+
Example:
1090+
1091+
```bash
1092+
curl 'https://api.warpcast.com/fc/starter-pack-members?id=Underrated-CT-1y7n9b'
1093+
```

0 commit comments

Comments
 (0)