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.
When parsing a returned JSON, the field imageUrl always refers to an image of a character without any captioned text, for example:
When parsing a returned JSON, the field instanceImageUrl always refers to an image of a character with its captioned text, for example:
http://version1.api.memegenerator.net/Generators_Search
Returns a list of search results by the search keyword [q].
| 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. |
http://version1.api.memegenerator.net/Generators_Search?q=insanity&pageIndex=0&pageSize=12
http://version1.api.memegenerator.net/Generators_Select_ByPopular
Returns the most popular generators for the last [days] days.
| 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. |
http://version1.api.memegenerator.net/Generators_Select_ByPopular?pageIndex=0&pageSize=12&days=7
http://version1.api.memegenerator.net/Instance_Create
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.
| 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), Russian (ru), Other (--). |
| generatorID | The GeneratorID of the generator as received from any of the Generators_Select_* methods. |
| 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. |
| 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. |
http://version1.api.memegenerator.net/Instance_Create?username=&password=&languageCode=en&generatorID=45&imageID=20&text0=push a hipster down the stairs&text1=now look who's tumbling
http://version1.api.memegenerator.net/Generators_Select_ByTrending
Returns recently trending generators.
No parameters required.
http://version1.api.memegenerator.net/Generators_Select_ByTrending
http://version1.api.memegenerator.net/Instances_Select_ByPopular
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) for a particular generator ([urlName] != null) or for all generators ([urlName] == null). Only shows moderator approved content.
| 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), Russian (ru), Other (--). |
| 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. |
| 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. |
http://version1.api.memegenerator.net/Instances_Select_ByPopular?languageCode=en&pageIndex=0&pageSize=12&urlName=Insanity-Wolf&days=7
http://version1.api.memegenerator.net/Generators_Select_ByNew
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.
| 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. |
http://version1.api.memegenerator.net/Generators_Select_ByNew?pageIndex=0&pageSize=12
http://version1.api.memegenerator.net/Instances_Select_ByNew
Returns recently created instances, for a particular generator ([urlName] != null) or for all generators ([urlName] == null). Only shows moderator approved content.
| 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), Russian (ru), Other (--). |
| 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. |
| urlName | The URL name of the requested generator, e.g. 'Insanity-Wolf'. Leave as [null] to show all the generators. |
http://version1.api.memegenerator.net/Instances_Select_ByNew?languageCode=en&pageIndex=0&pageSize=12&urlName=Insanity-Wolf
http://version1.api.memegenerator.net/Generator_Select_ByUrlNameOrGeneratorID
Returns information about a specific generator, either by its [generatorID] or by its [urlName].
|
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. |
http://version1.api.memegenerator.net/Generator_Select_ByUrlNameOrGeneratorID?generatorID=45&urlName=Insanity-Wolf
http://version1.api.memegenerator.net/Generators_Select_Related_ByDisplayName
Returns generators that are related to a particular generator, a sort of 'see also' list.
| displayName | The display name of the requested generator, e.g. 'Insanity Wolf'. |
http://version1.api.memegenerator.net/Generators_Select_Related_ByDisplayName?displayName=Insanity Wolf
