Exciting release!Introducing "safe npm". Learn more
Socket
Log inDemoInstall

rickmortyapi

Package Overview
Dependencies
0
Maintainers
1
Versions
13
Issues
File Explorer

Advanced tools

rickmortyapi

The Rick and Morty API JS client

    2.3.0latest
    GitHub

Version published
Maintainers
1
Weekly downloads
60
decreased by-28.57%

Weekly downloads

Changelog

Source

2.3.0 (2023-01-15)

Features

  • re-export interfaces (50730f5)

Readme

Source

Tests Coverage Status npm version npm downloads Twitter Follow

The Rick and Morty API JavaScript client

A zero dependency client for retrieving content from The Rick and Morty API.

Installation

Node 18 or above is required.

npm i rickmortyapi or yarn add rickmortyapi

Usage

import { getCharacter } from 'rickmortyapi' // or import * as shlaami from 'rickmortyapi' // shlaami.getCharacter() // or const plumbus = require('rickmortyapi') // a Plumbus will provide you with a lifetime of better living and happiness.

Client Reference

Response schema

The response for each method contains the following structure.

{ // The HTTP status code from the API response data: {}, // The HTTP status message from the API response status: 200, // The response that was provided by the API statusMessage: 'OK', }

Examples

All methods return a promise.

Get by Id

const rick = await getCharacter(1) const earth = await getLocation(1) const episodeOne = await getEpisode(1)

Get by Ids

const theSmiths = await getCharacter([ 2, 3, 4, 5 ]) const [ earth, citadel ] = await getLocation([ 1 , 3 ]) const s01 = await getEpisode(Array.from({ length: 11 }, (v, i) => i + 1))

Get all

const characters = await getCharacters() const locations = await getLocations() const episodes = await getEpisodes()

Filter

To know more about filtering check the API documentation or the client reference.

const aliveRicks = await getCharacters({ name: 'rick', status: 'alive' }) const planets = await getLocations({ type: 'planet', page: 2 }) const seasonOne = await getEpisodes({ episode: 's01' })

Pagination

In methods that return a paginated response (getCharacters, getLocations and getEpisodes), you can use a page property to access different pages.

const moreCharacters = await getCharacters({ page: 2 })

Get endpoints

getEndpoints(): This method will response with the available resouces, you can use it to ping the server status.

Support

Help to maintain The Rick and Morty API's infrastructure.

If you want to know more about The Rick and Morty API click here.

Keywords

FAQs

Last updated on 15 Jan 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc