API reference
Base URL https://usefeeds.com. Every request needs Authorization: Bearer fm_live_…. The same description in OpenAPI 3.1:/v1/openapi.json.
GET /v1/me
The organization of the API key.
Responses
200 Organization400 Invalid request401 Missing, unknown, or revoked API key429 Rate limit exceeded; see Retry-After
GET /v1/balance
Credit balance.
Responses
200 Balance400 Invalid request401 Missing, unknown, or revoked API key429 Rate limit exceeded; see Retry-After
GET /v1/ledger
Credit ledger, newest first.
Parameters
| Name | In | Type | Notes |
|---|
limit | query | integer | |
Responses
200 Entries400 Invalid request401 Missing, unknown, or revoked API key429 Rate limit exceeded; see Retry-After
POST /v1/estimates
Monthly credits of a tracker before creating it (free).
Body: EstimateRequest
Responses
200 Estimate400 Invalid request401 Missing, unknown, or revoked API key429 Rate limit exceeded; see Retry-After
GET /v1/trackers
List trackers.
Responses
200 Trackers400 Invalid request401 Missing, unknown, or revoked API key429 Rate limit exceeded; see Retry-After
POST /v1/trackers
Track an account (charges setup).
Body: TrackerCreate
Responses
201 Created400 Invalid request401 Missing, unknown, or revoked API key402 Insufficient credits409 Already tracking this account429 Rate limit exceeded; see Retry-After
GET /v1/trackers/{id}
One tracker.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Tracker id |
Responses
200 Tracker400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
PATCH /v1/trackers/{id}
Change cadence, enabled, or monthly budget.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Tracker id |
Body: TrackerUpdate
Responses
200 Tracker400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
DELETE /v1/trackers/{id}
Stop tracking.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Tracker id |
Responses
204 Deleted400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
GET /v1/trackers/{id}/items
Items delivered to the tracker, newest first.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Tracker id |
limit | query | integer | |
before | query | string | publishedAt of the last item of the previous page |
beforeId | query | integer | id of the last item of the previous page |
Responses
200 Items400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
GET /v1/query
Latest posts of any handle, without tracking it (charged on success).
Parameters
| Name | In | Type | Notes |
|---|
source (required) | query | SourceType | |
handle (required) | query | string | |
limit | query | integer | |
Responses
200 Posts400 Invalid request401 Missing, unknown, or revoked API key402 Insufficient credits404 The account does not exist429 Rate limit exceeded; see Retry-After502 Provider failure (not charged)
GET /v1/webhooks
List webhooks.
Responses
200 Webhooks400 Invalid request401 Missing, unknown, or revoked API key429 Rate limit exceeded; see Retry-After
POST /v1/webhooks
Register a webhook; the response holds its signing secret, shown once.
Body: object
Responses
201 Created400 Invalid request401 Missing, unknown, or revoked API key429 Rate limit exceeded; see Retry-After
DELETE /v1/webhooks/{id}
Delete a webhook and its queued events.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Webhook id |
Responses
204 Deleted400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
GET /v1/webhooks/{id}/events
Delivery log, newest first.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Webhook id |
limit | query | integer | |
Responses
200 Events400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
POST /v1/webhooks/{id}/events/{eventId}/retry
Queue an event again.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Webhook id |
eventId (required) | path | integer | Event id |
Responses
202 Queued400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
POST /v1/webhooks/{id}/ping
Queue a ping event.
Parameters
| Name | In | Type | Notes |
|---|
id (required) | path | integer | Webhook id |
Responses
202 Queued400 Invalid request401 Missing, unknown, or revoked API key404 Not found in this organization429 Rate limit exceeded; see Retry-After
Objects
Error
| Field | Type | Notes |
|---|
error | string | |
Me
| Field | Type | Notes |
|---|
organization | object | |
LedgerEntry
| Field | Type | Notes |
|---|
id | integer | |
kind | "grant" | "purchase" | "debit" | "refund" | "adjustment" | |
credits | integer | Positive adds, negative spends |
operation | string | null | |
quantity | integer | null | |
trackerId | integer | null | |
priceBookVersion | integer | null | |
note | string | null | |
createdAt | string | |
EstimateRequest
| Field | Type | Notes |
|---|
sourceType | SourceType | |
cadenceMinutes | integer | |
handle | string | Uses the observed posting rate when Feeds already knows the account |
postsPerDay | number | |
EstimatePart
| Field | Type | Notes |
|---|
checksPerMonth | integer | |
postsPerMonth | integer | |
creditsPerMonth | integer | |
usdPerMonthAtListPrice | number | |
Estimate
| Field | Type | Notes |
|---|
max | EstimatePart | |
expected | EstimatePart | |
setupCredits | integer | |
priceBookVersion | integer | |
postsPerDay | number | |
postsPerDayBasis | "caller" | "observed" | "assumed" | |
TrackerCreate
| Field | Type | Notes |
|---|
sourceType | SourceType | |
handle | string | Handle, @handle, or profile URL |
cadenceMinutes | integer | At least 5 for X and 60 for LinkedIn, at most 43200 |
monthlyBudgetCredits | integer | null | |
TrackerUpdate
| Field | Type | Notes |
|---|
cadenceMinutes | integer | |
enabled | boolean | |
monthlyBudgetCredits | integer | null | |
Tracker
| Field | Type | Notes |
|---|
id | integer | |
sourceType | SourceType | |
handle | string | |
displayName | string | null | |
cadenceMinutes | integer | |
enabled | boolean | |
monthlyBudgetCredits | integer | null | |
spentThisMonthCredits | integer | |
state | "active" | "abandoned" | |
lastPolledAt | string | null | |
followers | integer | null | |
following | integer | null | |
feedUrl | string | |
Item
| Field | Type | Notes |
|---|
id | integer | |
externalId | string | |
author | string | |
title | string | |
contentHtml | string | |
url | string | |
publishedAt | string | |
media | array of object | |
QueryResult
| Field | Type | Notes |
|---|
source | SourceType | |
handle | string | |
items | array of Item | |
cached | boolean | |
credits | integer | Credits this query was charged |
Webhook
| Field | Type | Notes |
|---|
id | integer | |
url | string | |
events | array of string | |
createdAt | string | |
WebhookEvent
| Field | Type | Notes |
|---|
id | integer | |
type | string | |
attempts | integer | |
nextAttemptAt | string | |
deliveredAt | string | null | |
failedAt | string | null | |
lastStatus | integer | null | |
lastError | string | null | |