System

EndpointDescription
GET
api/v1/system/banned/domains

Gets Voat's currently banned domain list

GET
api/v1/system/status

Gets the current operational state of the Api.

GET
api/v1/system/time

Gets the current time on the server. Use this to calculate offsets in your application.

Submissions

EndpointDescription
GET
api/v1/v/{subverse}

Gets submissions for a subverse. Supports Search Options querystring arguments.

POST
api/v1/v/{subverse}

Posts a new submission to the specified subverse.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

Submission

EndpointDescription
DELETE
api/v1/v/{subverse}/{submissionID}

Deletes a submission

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/v/{subverse}/{submissionID}

Gets a single submission by Id.

PUT
api/v1/v/{subverse}/{submissionID}

Edits a submission.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

DELETE
api/v1/submissions/{submissionID}

Deletes a submission

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/submissions/{submissionID}

Gets a single submission by Id.

PUT
api/v1/submissions/{submissionID}

Edits a submission.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

Subverse

EndpointDescription
GET
api/v1/v/{subverse}/info

Retrieves subverse information

POST
api/v1/v/{subverse}/block

Blocks a subverse

Authentication Required

This endpoint requires authentication in order to successfully execute it.

DELETE
api/v1/v/{subverse}/block

Unblocks a previously blocked subverse

Authentication Required

This endpoint requires authentication in order to successfully execute it.

POST
api/v1/v/{subverse}/subscribe

Subscribes a user to a subverse

Authentication Required

This endpoint requires authentication in order to successfully execute it.

DELETE
api/v1/v/{subverse}/subscribe

Unsubscribes a user to a subverse

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/subverse/defaults

Gets Voat's current Default Subverse list

GET
api/v1/subverse/new

Gets Voat's Newest Subverses

GET
api/v1/subverse/top

Gets Voat's Top Subverses by Subscriber count

GET
api/v1/subverse/search?phrase={phrase}

Searches Voat's Subverse catalog for search phrase

Comments

EndpointDescription
GET
api/v1/v/{subverse}/{submissionID}/comments

Gets a comment segment for a submission.

GET
api/v1/v/{subverse}/{submissionID}/comments/{parentID}

Gets a comment segment for a submission starting from a specified parent comment starting at index of 0.

GET
api/v1/v/{subverse}/{submissionID}/comments/{parentID}/{index}

Gets a comment segment for a submission starting from a specified parent comment and starting at a specified index.

Comment

EndpointDescription
DELETE
api/v1/comments/{commentID}

Deletes an existing comment.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/comments/{commentID}

Retrieves a single comment

POST
api/v1/comments/{commentID}

Post a REPLY to an existing comment. Use this method for inbox comment replies.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

PUT
api/v1/comments/{commentID}

Edits an existing comment.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

POST
api/v1/v/{subverse}/{submissionID}/comment/{commentID}

Post a REPLY to an existing comment in a submission.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

POST
api/v1/v/{subverse}/{submissionID}/comment

Post a top level comment to a submission.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

User

EndpointDescription
POST
api/v1/u/{user}/block

Blocks a user. Blocks hide a blocked user’s submissions, comments, and messages from appearing.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

DELETE
api/v1/u/{user}/block

Unblocks a previously blocked user

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/u/{user}/info

Retrieves user information

GET
api/v1/u/{user}/comments

Get comments for a user. Supports Search Options querystring arguments.

GET
api/v1/u/{user}/submissions

Gets submissions for a user. Supports Search Options querystring arguments.

GET
api/v1/u/subscriptions

Gets subscriptions for a user

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/u/{user}/subscriptions

Gets subscriptions for a user

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/u/saved

Gets saved items for current user. This method is not implemented currently. More info to come soon.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/u/blocked/subverses

Gets blocked subverses for current user.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/u/blocked/users

Gets blocked users for current user.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

UserPreferences

EndpointDescription
GET
api/v1/u/preferences

Retrieves user preferences.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

PUT
api/v1/u/preferences

No documentation available.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

UserMessages

EndpointDescription
GET
api/v1/u/messages/counts

Gets unread message counts for logged in user.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

POST
api/v1/u/messages/reply/{id}

Replies to a user message.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/u/messages/{type}/{state}

Gets messages for the logged in user.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

POST
api/v1/u/messages

Sends a new Private Message to a user

Authentication Required

This endpoint requires authentication in order to successfully execute it.

Vote

EndpointDescription
POST
api/v1/vote/{type}/{id}/{vote}

Submit votes of a user

Authentication Required

This endpoint requires authentication in order to successfully execute it.

POST
api/v1/vote/{type}/{id}/{vote}?revokeOnRevote={revokeOnRevote}

Submit votes of a user

Authentication Required

This endpoint requires authentication in order to successfully execute it.

Save

EndpointDescription
POST
api/v1/submissions/{submissionID}/save

Saves a submission to a users saved items collection

Authentication Required

This endpoint requires authentication in order to successfully execute it.

DELETE
api/v1/submissions/{submissionID}/save

Deletes a saved submission from a users saved item collection

Authentication Required

This endpoint requires authentication in order to successfully execute it.

POST
api/v1/comments/{commentID}/save

Saves a comment to a users saved items collection

Authentication Required

This endpoint requires authentication in order to successfully execute it.

DELETE
api/v1/comments/{commentID}/save

Deletes a saved comment from a users saved items collection

Authentication Required

This endpoint requires authentication in order to successfully execute it.

Stream

This is a bot endpoint. Endpoint keeps time of last call and returns entries that have been created since previous call. This key expires every 60 minutes and thus resets your last call time. Explicit permission must be granted to your API key to access this endpoint.

EndpointDescription
GET
api/v1/stream/submissions

Returns a stream of submissions since the last call made to this endpoint. Used for live monitoring.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/stream/submissions/v/{subverse}

Returns a stream of submissions since the last call made to this endpoint. Used for live monitoring.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/stream/comments

Returns a stream of comments since the last call made to this endpoint. Used for live monitoring.

Authentication Required

This endpoint requires authentication in order to successfully execute it.

GET
api/v1/stream/comments/v/{subverse}

Returns a stream of comments from subverse since the last call made to this endpoint. Used for live monitoring.

Authentication Required

This endpoint requires authentication in order to successfully execute it.