Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hoppscotch.io/llms.txt

Use this file to discover all available pages before exploring further.

Query parameters help you to filter and request specific data from an API endpoint.
You can add query parameters in two ways:
  1. Add them in the URL.
  2. Add them in the parameters tab.

Adding parameters in the URL

To add a parameter in the URL, append ? at the end of the URL and add a parameter in key=value format. You can add multiple parameters by separating them using &. For example, the below URL is filtered to get the data of the first three Pokemon.
https://pokeapi.co/api/v2/pokemon/?offset=6&limit=3
For which you will get a similar response:
{
  "count": 1281,
  "next": "https://pokeapi.co/api/v2/pokemon?offset=9&limit=3",
  "previous": "https://pokeapi.co/api/v2/pokemon?offset=3&limit=3",
  "results": [
    {
      "name": "squirtle",
      "url": "https://pokeapi.co/api/v2/pokemon/7/"
    },
    {
      "name": "wartortle",
      "url": "https://pokeapi.co/api/v2/pokemon/8/"
    },
    {
      "name": "blastoise",
      "url": "https://pokeapi.co/api/v2/pokemon/9/"
    }
  ]
}

Using the parameters tab

You can use the Parameters tab to set key-value pairs for your API requests. This tab also lets you add a description for each parameter, helping you provide a clear explanation of what each parameter does and why it’s important. Hoppscotch also offers a Bulk edit feature, allowing you to add or modify multiple request parameters at once, with each key-value pair on a new line separated by a colon (:). For example,
param1: value1
param2: value2
# param3: value3
Try using the parameters tab to see if you get the same response as adding parameters in the URL.