Meme Generator API

Table of Contents

Basics

Methods

Authentication

Authentication to the API can be done with credentials of any user from the website. Only some of the methods require authentication. There is currently no token mechanism and all authentication is done by sending the user credentials as method parameters when necessary.

Methods that require authentication explicitly specify the username and password parameters in their signature.

Images

imageUrl

When parsing a returned JSON, the field imageUrl always refers to an image of a character without any captioned text, for example:

The image can be resized by changing the URL: Any number can be used as the width or height, though the image will not be resized to a size larger than it originally is.

instanceImageUrl

When parsing a returned JSON, the field instanceImageUrl always refers to an image of a character with its captioned text, for example:

The instance image can be resized by changing the URL: Any number can be used as the width or height, though the image will not be resized to a size larger than it originally is.

JavaScript Library

JavaScript bindings to the API calls can be used from http://version1.api.memegenerator.net/javascript.js.

Comment_Create

http://version1.api.memegenerator.net/Comment_Create

Description

Post a comment to an instance. Use [entityType=1].

Parameters

entityType
entityID
parentCommentID
may be omitted
text

Example

http://version1.api.memegenerator.net/Comment_Create?entityType=1&entityID=72628355&parentCommentID=&text=first post best post

Comment_Delete

http://version1.api.memegenerator.net/Comment_Delete

Description

Delete a comment, will only work if the user has created it or is admin.

Parameters

commentID The ID of the comment

Example

http://version1.api.memegenerator.net/Comment_Delete?commentID=-1

Comments_Select

http://version1.api.memegenerator.net/Comments_Select

Description

Returns all the comments for a specific entity. User entityType=1 for instance, with entityID=[instanceID].

Parameters

entityType
entityID
parentCommentID
may be omitted

Example

http://version1.api.memegenerator.net/Comments_Select?entityType=1&entityID=72628355&parentCommentID=

ContentFlag_Create

http://version1.api.memegenerator.net/ContentFlag_Create

Description

Flag content for removal, for cases of harassment etc.

Parameters

contentUrl The URL on the website which contains the offending content.
reason A short description of why the content should be removed.
email Email address for notification of removal.

Example

http://version1.api.memegenerator.net/ContentFlag_Create?contentUrl=https://memegenerator.net/John-Doe&reason=personal information exposed&email=email@domain.com

Generator_Select_ByUrlNameOrGeneratorID

http://version1.api.memegenerator.net/Generator_Select_ByUrlNameOrGeneratorID

Description

Returns information about a specific generator, either by its [generatorID] or by its [urlName].

Parameters

generatorID
may be omitted
The GeneratorID of the generator as received from any of the Generators_Select_* methods.
urlName The URL name of the requested generator, e.g. 'Insanity-Wolf'. Leave as [null] to show all the generators.

Example

http://version1.api.memegenerator.net/Generator_Select_ByUrlNameOrGeneratorID?generatorID=45&urlName=Insanity-Wolf

Generators_Search

http://version1.api.memegenerator.net/Generators_Search

Description

Returns a list of search results by the search keyword [q].

Parameters

q
pageIndex Page index of the requested result set. Defaults to 0 if not specified.
pageSize Page size of the requested result set. Defaults to 12 if not specified.

Example

http://version1.api.memegenerator.net/Generators_Search?q=insanity&pageIndex=0&pageSize=12

Generators_Select_ByNew

http://version1.api.memegenerator.net/Generators_Select_ByNew

Description

Returns the most recently created generators. This list gets updated whenever the website moderators approve another batch of generators to appear on the website. Some generators may not be approved due to poor quality, nsfw content, etc, so this list is highly selective.

Parameters

pageIndex Page index of the requested result set. Defaults to 0 if not specified.
pageSize Page size of the requested result set. Defaults to 12 if not specified.

Example

http://version1.api.memegenerator.net/Generators_Select_ByNew?pageIndex=0&pageSize=12

Generators_Select_ByPopular

http://version1.api.memegenerator.net/Generators_Select_ByPopular

Description

Returns the most popular generators for the last [days] days.

Parameters

pageIndex Page index of the requested result set. Defaults to 0 if not specified.
pageSize Page size of the requested result set. Defaults to 12 if not specified.
days
may be omitted
The time period for which to filter the result set. ([days] == null) for all time.

Example

http://version1.api.memegenerator.net/Generators_Select_ByPopular?pageIndex=0&pageSize=12&days=

Generators_Select_ByRecentlyCaptioned

http://version1.api.memegenerator.net/Generators_Select_ByRecentlyCaptioned

Description

Returns generators that were recently used to create an instence. Sort of most-recently-used list.

Parameters

username The credentials of a signed up user. Use the website to sign up.
password The credentials of a signed up user. Use the website to sign up.

Example

http://version1.api.memegenerator.net/Generators_Select_ByRecentlyCaptioned?username=test8&password=test8

Generators_Select_BySubscriber

http://version1.api.memegenerator.net/Generators_Select_BySubscriber

Description

Returns the list of generators that a particular user is subscribed to.

Parameters

subscriberMgUserID

Example

http://version1.api.memegenerator.net/Generators_Select_BySubscriber?subscriberMgUserID=1

Generators_Select_ByTrending

http://version1.api.memegenerator.net/Generators_Select_ByTrending

Description

Returns recently trending generators.

Parameters

No parameters required.

Example

http://version1.api.memegenerator.net/Generators_Select_ByTrending

Generators_Select_Related_ByDisplayName

http://version1.api.memegenerator.net/Generators_Select_Related_ByDisplayName

Description

Returns generators that are related to a particular generator, a sort of 'see also' list.

Parameters

displayName The display name of the requested generator, e.g. 'Insanity Wolf'.

Example

http://version1.api.memegenerator.net/Generators_Select_Related_ByDisplayName?displayName=Insanity Wolf

Instance_Create

http://version1.api.memegenerator.net/Instance_Create

Description

Creates a captioned image. Images created with this method are created in the database and may appear on the website. User credentials of an ordinary user must be provided to create images. Sign up on http://{memegenerator.net}/ to create your user. ImageID may by omitted to use the default template for the character, or specified to use one of the alternative templates.

Parameters

username The credentials of a signed up user. Use the website to sign up.
password The credentials of a signed up user. Use the website to sign up.
languageCode The language to filter the result set by, or the language of the text on the created image, indicated by a 2-letter language code. Currently supported languages are English (en), Spanish (es), Hebrew (he), Russian (ru), Other (--).
generatorID The GeneratorID of the generator as received from any of the Generators_Select_* methods.
imageID
may be omitted
The background image on which to caption the text. If generatorID is also requested then imageID must be one of the images of the specified generator, e.g. for Insanity Wolf (generatorID 45) the imageID must be 20, as received from any of the Generators_Select_* methods.
text0 The first line to appear on the image. If only one line is specified it will appear on the bottom of the image. If two lines are specified ([text0] and [text1]), [text0] will appear on the top and [text1] will appear on the bottom on the image. Both lines are automatically converted to uppercase.
text1 The second line to appear on the image. Will appear on the bottom of the image. Automatically converted to uppercase.

Example

http://version1.api.memegenerator.net/Instance_Create?username=test8&password=test8&languageCode=en&generatorID=45&imageID=20&text0=push a hipster down the stairs&text1=now look who's tumbling

Instance_Select

http://version1.api.memegenerator.net/Instance_Select

Description

Select an instance by its instanceID.

Parameters

instanceID The ID of the instance.

Example

http://version1.api.memegenerator.net/Instance_Select?instanceID=72628355

Instances_Search

http://version1.api.memegenerator.net/Instances_Search

Description

Returns a list of search results of instances by the search keyword [q].

Parameters

q
pageIndex Page index of the requested result set. Defaults to 0 if not specified.
pageSize Page size of the requested result set. Defaults to 12 if not specified.

Example

http://version1.api.memegenerator.net/Instances_Search?q=insanity&pageIndex=0&pageSize=12

Instances_Select_ByNew

http://version1.api.memegenerator.net/Instances_Select_ByNew

Description

Returns recently created instances, for a particular generator ([urlName] != null) or for all generators ([urlName] == null). Only shows moderator approved content.

Parameters

languageCode The language to filter the result set by, or the language of the text on the created image, indicated by a 2-letter language code. Currently supported languages are English (en), Spanish (es), Hebrew (he), Russian (ru), Other (--).
pageIndex Page index of the requested result set. Defaults to 0 if not specified.
urlName The URL name of the requested generator, e.g. 'Insanity-Wolf'. Leave as [null] to show all the generators.

Example

http://version1.api.memegenerator.net/Instances_Select_ByNew?languageCode=en&pageIndex=0&urlName=Insanity-Wolf

Instances_Select_ByPopular

http://version1.api.memegenerator.net/Instances_Select_ByPopular

Description

Returns the most popular instances for a particular period ([days]=null for all time, [days]=1 for the last day, [days]=7 for the last week, [days]=30 for the last month) for a particular generator ([urlName] != null) or for all generators ([urlName] == null). Only shows moderator approved content.

Parameters

languageCode The language to filter the result set by, or the language of the text on the created image, indicated by a 2-letter language code. Currently supported languages are English (en), Spanish (es), Hebrew (he), Russian (ru), Other (--).
pageIndex Page index of the requested result set. Defaults to 0 if not specified.
urlName The URL name of the requested generator, e.g. 'Insanity-Wolf'. Leave as [null] to show all the generators.
days
may be omitted
The time period for which to filter the result set. ([days] == null) for all time.

Example

http://version1.api.memegenerator.net/Instances_Select_ByPopular?languageCode=en&pageIndex=0&urlName=Insanity-Wolf&days=

MgUser_Update_ImageID

http://version1.api.memegenerator.net/MgUser_Update_ImageID

Description

Change a user's profile image.

Parameters

imageID The background image on which to caption the text. If generatorID is also requested then imageID must be one of the images of the specified generator, e.g. for Insanity Wolf (generatorID 45) the imageID must be 20, as received from any of the Generators_Select_* methods.

Example

http://version1.api.memegenerator.net/MgUser_Update_ImageID?imageID=20

MgUser_Update_Username

http://version1.api.memegenerator.net/MgUser_Update_Username

Description

Change a user's username. This can be done by the user only once, when setting up their account.

Parameters

username The credentials of a signed up user. Use the website to sign up.

Example

http://version1.api.memegenerator.net/MgUser_Update_Username?username=test8

MgUsers_Select_ByPublisher

http://version1.api.memegenerator.net/MgUsers_Select_ByPublisher

Description

Returns the list of users that are following a particular user.

Parameters

publisherMgUserID

Example

http://version1.api.memegenerator.net/MgUsers_Select_ByPublisher?publisherMgUserID=1

MgUsers_Select_BySubscriber

http://version1.api.memegenerator.net/MgUsers_Select_BySubscriber

Description

Returns the list of users that a user follows.

Parameters

subscriberMgUserID

Example

http://version1.api.memegenerator.net/MgUsers_Select_BySubscriber?subscriberMgUserID=1

MgWebUser_Select

http://version1.api.memegenerator.net/MgWebUser_Select

Description

Used to check if credentials are valid. Returns details of the user, if found. This method does not login the user. Credentials must be sent on every other request as well to assume a user's context.

Parameters

username The credentials of a signed up user. Use the website to sign up.
password The credentials of a signed up user. Use the website to sign up.

Example

http://version1.api.memegenerator.net/MgWebUser_Select?username=test8&password=test8

Templates_Select_ByUrlName

http://version1.api.memegenerator.net/Templates_Select_ByUrlName

Description

Returns a list of alternative images for a generator.

Parameters

urlName The URL name of the requested generator, e.g. 'Insanity-Wolf'. Leave as [null] to show all the generators.

Example

http://version1.api.memegenerator.net/Templates_Select_ByUrlName?urlName=Insanity-Wolf

Vote

http://version1.api.memegenerator.net/Vote

Description

Vote (like/dislike) on generators and instances. VoteScore can be 1 (like), -1 (dislike) or 0 (no vote).

Parameters

entityName
entityID
voteScore

Example

http://version1.api.memegenerator.net/Vote?entityName=Instance&entityID=72628355&voteScore=1