\n\n## Installation\n\n```shell\nnpm install imgur\n```\n\n## Usage\n\n### Migrating to version 2\n\nVersion 2 of the imgur api drops automatic support for filesystem usage. For uploading files from a filesystem, please see the examples using `createReadStream`.\n\n### Import and instantiate with credentials:\n\n```ts\n// ESModule syntax\nimport { ImgurClient } from 'imgur';\n\n// CommonJS syntax\nconst { ImgurClient } = require('imgur');\n\n// browser script include\nconst client = new imgur({ clientId: env.CLIENT_ID });\n\n// if you already have an access token acquired\nconst client = new ImgurClient({ accessToken: process.env.ACCESS_TOKEN });\n\n// or your client ID\nconst client = new ImgurClient({ clientId: process.env.CLIENT_ID });\n\n// all credentials with a refresh token, in order to get access tokens automatically\nconst client = new ImgurClient({\n clientId: process.env.CLIENT_ID,\n clientSecret: process.env.CLIENT_SECRET,\n refreshToken: process.env.REFRESH_TOKEN,\n});\n```\n\nIf you don't have any credentials, you'll need to:\n\n1. [Create an Imgur account](https://imgur.com/register)\n1. [Register an application](https://api.imgur.com/#registerapp)\n\n### **⚠️ For brevity, the rest of the examples will leave out the import and/or instantiation step.**\n\n### Upload one or more images and videos\n\n```ts\n// upload multiple images via fs.createReadStream (node)\nconst response = await client.upload({\n image: createReadStream('/home/kai/dank-meme.jpg'),\n type: 'stream',\n});\nconsole.log(response.data);\n```\n\nIf you want to provide metadata, such as a title, description, etc., then pass an object instead of a string:\n\n```ts\n// upload image via url\nconst response = await client.upload({\n image: 'https://i.imgur.com/someImageHash',\n title: 'Meme',\n description: 'Dank Meme',\n});\nconsole.log(response.data);\n```\n\nAcceptable key/values match what [the Imgur API expects](https://apidocs.imgur.com/#c85c9dfc-7487-4de2-9ecd-66f727cf3139):\n\n| Key | Description |\n| --------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `image` | A string, stream, or buffer that is a URL pointing to a remote image or video (up to 10MB) |\n| `album` | The id of the album you want to add the media to. For anonymous albums, album should be the deletehash that is returned at creation |\n| `type` | The type of the media that's being transmitted; `stream`, `base64` or `url` |\n| `name` | The name of the media. This is automatically detected, but you can override |\n| `title` | The title of the media |\n| `description` | The description of the media |\n| `disable_audio` | `1` will remove the audio track from a video file |\n\n### Upload and track progress of uploads\n\nInstances of `ImgurClient` emit `uploadProgress` events so that you can track progress with event listeners.\n\n```ts\nconst client = new ImgurClient({ accessToken: process.env.ACCESS_TOKEN });\n\nclient.on('uploadProgress', (progress) => console.log(progress));\nawait client.upload('/home/kai/cat.mp4');\n```\n\nThe progress object looks like the following:\n\n```ts\n{\n percent: 1,\n transferred: 577,\n total: 577,\n id: '/home/user/trailer.mp4'\n}\n```\n\n| Key | Description |\n| ------------- | ------------------------------------------------------------------------------------------------- |\n| `percent` | 0 to 1, measures the percentage of upload (e.g., 0, 0.5, 0.8, 1). Basically `transferred / total` |\n| `transferred` | total number of bytes transferred thus far |\n| `total` | total number of bytes to be transferred |\n| `id` | unique id for the media being transferred; useful when uploading multiple things concurrently |\n\n### Delete an image\n\nRequires an image hash or delete hash, which are obtained in an image upload response\n\n```ts\nclient.deleteImage('someImageHash');\n```\n\n### Update image information\n\nUpdate the title and/or description of an image\n\n```ts\nclient.updateImage({\n imageHash: 'someImageHash',\n title: 'A new title',\n description: 'A new description',\n});\n```\n\nUpdate multiple images at once:\n\n```ts\nclient.updateImage({\n imageHash: 'someImageHash',\n title: 'A new title',\n description: 'A new description',\n});\n```\n\nFavorite an image:\n\n```ts\nclient.favoriteImage('someImageHash');\n```\n\n### Get gallery images\n\n```ts\nclient.getGallery({\n section: 'hot',\n sort: 'viral',\n mature: false,\n});\n```\n\n`getGallery()` accepts an object of type `GalleryOptions`. The follow options are available:\n\n| Key | Required | Description |\n| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `section` | required | `hot` \\| `top` \\| `user` |\n| `sort` | optional | `viral` \\| `top` \\| `time` \\| `rising` (only available with user section). Defaults to viral |\n| `page` | optional | `number` - the data paging number |\n| `window` | optional | Change the date range of the request if the section is `top`. Accepted values are `day` \\| `week` \\| `month` \\| `year` \\| `all`. Defaults to `day` |\n| `showViral` | optional | `true` \\| `false` - Show or hide viral images from the `user` section. Defaults to `true` |\n| `mature` | optional | `true` \\| `false` - Show or hide mature (nsfw) images in the response section. Defaults to `false`. NOTE: This parameter is only required if un-authed. The response for authed users will respect their account setting |\n| `album_previews` | optional | `true` \\| `false` - Include image metadata for gallery posts which are albums |\n\n### Get subreddit gallery images\n\n```ts\nclient.getSubredditGallery({\n subreddit: 'wallstreetbets',\n sort: 'time',\n});\n```\n\n`getSubredditGallery()` accepts an object of type `SubredditGalleryOptions`. The follow options are available:\n\n| Key | Required | Description |\n| ----------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `subreddit` | required | A valid subreddit name |\n| `sort` | optional | `time` \\| `top` - defaults to time |\n| `page` | optional | `number` - the data paging number |\n| `window` | optional | Change the date range of the request if the section is `top`. Accepted values are `day` \\| `week` \\| `month` \\| `year` \\| `all`. Defaults to `week` |\n\n### Search the gallery\n\n```ts\nclient.searchGallery({\n query: 'title: memes',\n});\n```\n\n`searchGallery()` accepts an object of type `SearchGalleryOptions`. The follow options are available:\n\n| Key | Required | Description |\n| -------------- | -------- | --------------------------------------------------------------------- | ------ | ------- | ------ | ------------------------- |\n| `query` or `q` | required | Query string |\n| `sort` | optional | `time` \\| `viral` \\| `top` - defaults to time |\n| `page` | optional | `number` - the data paging number |\n| `window` | optional | Change the date range of the request if the sort is `top` -- to `day` | `week` | `month` | `year` | `all`, defaults to `all`. |\n\nAdditionally, the following advanced search query options can be set (NOTE: if any of the below are set in the options, the `query` option is ignored and these will take precedent):\n\n| Key | Required | Description |\n| ----------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `q_all` | optional | Search for all of these words (and) |\n| `q_any` | optional | Search for any of these words (or) |\n| `q_exactly` | optional | Search for exactly this word or phrase |\n| `q_not` | optional | Exclude results matching this string |\n| `q_type` | optional | Show results for any file type, `jpg` \\| `png` \\| `gif` \\| `anigif` (animated gif) \\| `album` |\n| `q_size_px` | optional | Size ranges, `small` (500 pixels square or less) \\| `med` (500 to 2,000 pixels square) \\| `big` (2,000 to 5,000 pixels square) \\| `lrg` (5,000 to 10,000 pixels square) \\| `huge` (10,000 square pixels and above) |\n\n### Get album info\n\n```ts\nconst album = await client.getAlbum('XtMnA');\n```\n","readmeFilename":"README.md","users":{"jmm23":true,"hagb4rd":true,"cmdaniels":true,"turt2live":true,"rocket0191":true,"adrian.arroyocalle":true}}
![\"npm](\"https://img.shields.io/npm/v/imgur/latest.svg\")
\n \n \n ![\"Build](\"https://github.com/keneucker/imgur/workflows/Tests/badge.svg\"){kind=icon}
\n \n![\"Join](\"https://img.shields.io/badge/Join%20the%20community-on%20GitHub%20Discussions-blue\"){kind=icon}