API Methods

Here are the available API methods for FeedPress.

All API requests must be made to https://api.feed.press with POST or GET method and answers are JSON formatted.

All API requests must have a key parameter with your API key.

If you want a specific method that is not in this list, please contact us.

GET /login.json

Redirects the user to the FeedPress authentication page. See Authentication for more details.

callback URL to send the user to after the authentication. Mandatory

GET /logout.json

Deletes the authenticated user's token.

token Authenticated user's token. Mandatory

Response example:

{
    errors: [ ],
    data: [ ],
    code: 1,
    message: "The token has been deleted."
}

GET /account.json

Retrieves various informations about the authenticated user.

token Authenticated user's token. Mandatory

Response example:

{
    login: "maxime",
    premium: true,
    feeds: [
        {
            id: 1,
            name: "maxime",
            subscribers: 962,
            url: "http://feedpress.me/maxime"
        }
    ],
    code: 1
}

POST /feeds/create.json

Creates a new feed for the authenticated user.

token Authenticated user's token. Mandatory
url The current feed's URL (Not a FeedBurner URL). Mandatory
alias Desired feed alias on FeedPress. Mandatory
tracking If sent, enables click tracking and link opening. Not enabled by default.
locale Desired locale for the feed: "en" or "fr". Default value: "en"

Response example:

{
    "errors": [ ],
    "data": [ ],
    "code": 1,
    "message": "The feed has been created."
}

POST /feeds/update.json

Updates a new feed for the authenticated user according to the submitted parameters.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
url Updates the original feed URL.

Response example:

{
    "errors": [ ],
    "data": [ ],
    "code": 1,
    "message": "The feed has been updated."
}

GET /feeds/subscribers.json

Retrieves subscribers statistics for the last 30 days about a specific feed.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory

Response example:

{
    "stats": [
        {
            "day": 1364425200,
            "greader": 742,
            "other": 13,
            "direct": 186,
            "newsletter": 21
        },
        ...
    ],
    "code": 1
}

GET /feeds/readers.json

Retrieves the last readers statistics about a specific feed.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory

Response example:

{
    "readers": [
        {
            "name": "NewsBlur Feed Fetcher",
            "feedId": null,
            "subscribers": 12
        },
        {
            "name": "Feedfetcher-Google",
            "feedId": 4161868654975714300,
            "subscribers": 51
        },
        {
            "name": "Netvibes",
            "feedId": 20818948,
            "subscribers": 4
        },
        ...
    ],
    "code": 1
}

GET /feeds/ping.json

Tells FeedPress to refresh the specified feed.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory

Response example:

{
    "errors": [],
    "data": [],
    "code": 1,
    "message": "The feed has been refreshed."
}

GET /feeds/hit.json

Tells FeedPress to record a "virtual" hit for the specified feed.

Useful if you don't want FeedPress to distribute your feed but still want the analytics.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
ua User Agent. Mandatory
ip IP address. Mandatory

Response example:

{
    "errors": [],
    "data": [],
    "code": 1,
    "message": "The hit has been recorded."
}

GET /feeds/tracking/items.json

Returns the tracked items for the specified feed.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
since Start date. Format: YYYY-MM-DD. By default, "0000-00-00".
to End date. Format: YYYY-MM-DD. By default, today's date.

Response example:

{
    "code": 1,
    "items": [
        {
            "id": 1,
            "title": "#1 Welcome to my podcast",
            "url": "http:\/\/feed.mypodcast.com\/shows\/1_Welcome.mp3",
            "type": "podcast",
            "hits": 251,
            "uniques": 228
        }
    ]
}

GET /feeds/tracking/url.json

Returns the FeedPress tracking URL for the specified feed and original URL.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
url Original link URL. Mandatory

Response example:

{
    "errors": [],
    "data": [],
    "code": 1,
    "message": "https://tracking.feedpress.it/link/1/1/podcast.mp3"
}

GET /feeds/newsletter/subscribers.json

Retrieves the subscribers list for the feed's newsletter.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory

Response example:

{
    "subscribers": [
        {
            "email": "[email protected]",
            "confirmed": 1
        }
    ],
}

GET /feeds/newsletter/check.json

Check the status of a particular email in your feed's newsletter.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
feed Email address. Mandatory

Response example:

{
    "subscribers": [
        {
            "email": "[email protected]",
            "confirmed": 1
        }
    ],
}

POST /feeds/newsletter/add.json

Adds an email address to the feed's newsletter.

Notice: This will send an email to the address to confirm its subscription.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
email E-mail address. Mandatory

Response example:

{
    "errors": [],
    "data": [],
    "code": 1,
    "message": "The email has been added to the newsletter."
}

POST /feeds/hosting/upload.json

Uploads an audio file to your podcast hosting storage.

Notice: You need to send it as multipart/form-data.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
file Binary data of the file to upload. Mandatory
artwork Binary data of the file to upload for the audio file artwork. Keeps existing tags by default.
title ID3v2 tag for "Title" field. Keeps existing tags by default.
album ID3v2 tag for "Album" field. Keeps existing tags by default.
artist ID3v2 tag for "Artist" field. Keeps existing tags by default.
comment ID3v2 tag for "Comment" field. Keeps existing tags by default.

Response example:

{
    "message": "The file has been uploaded.",
    "data": {
        "url": "http:\/\/podcasts-1.feedpress.co\/618\/Podcast.mp3"
    },
    "code": 1
}

POST /feeds/hosting/delete.json

Deletes an audio file in your podcast hosting storage.

token Authenticated user's token. Mandatory
feed Feed name. Mandatory
url URL on FeedPress of the uploaded file to delete. Mandatory

Response example:

{
    "message": "The file has been deleted.",
    "data": {
        "url": "http:\/\/podcasts-1.feedpress.co\/618\/Podcast.mp3"
    },
    "code": 1
}

POST /hostnames/record.json

Create a record for a specified hostname.

token Authenticated user's token. Mandatory
hostname_id Hostname numeric ID. Mandatory
path Relative path of the record, for instance / or /myfeed. Mandatory
type Record type: feed for feed redirection or url for standard HTTP redirection. Mandatory
destination Feed ID or URL depending on the type specified. Mandatory

Response example:

{
    "errors": [],
    "data": [],
    "code": 1,
    "message": "The record has been added. The update will be visible in less than 2 minutes."
}