Streamline API

https://streamline-api.readme.io/reference
Admin
Streamline API is a public API that provides programmatic access to a comprehensive icon library...
Tokens:6,738
Snippets:11
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Streamline API Search Response Example

Source: https://streamline-api.readme.io/reference/quick-start-guide

This JSON object represents a successful response from the Streamline API's Global search endpoint when querying for 'home' icons. It includes details about the query, a list of icon results with properties like hash, name, and image URLs, and pagination information.

```json
{
  "query": "home",
  "results": [
    {
      "hash": "ico_VgC1LXreoNRxANay",
      "name": "Home 2",
      "imagePreviewUrl": "icons/common-icons/home-2-vqpcd601vmikz9f3zzemzd.png/home-2-xuqkrmr56x43m3v6dkbwr",
      "isFree": true,
      "familySlug": "core-line-free",
      "familyName": "Core Line - Free",
      "categorySlug": "common-icons",
      "categoryName": "Common icons",
      "subcategorySlug": "common-icons",
      "subcategoryName": "Common icons"
    },
    {
      "hash": "ico_wEi0Iwv5LpEW0Pxk",
      "name": "Home 1",
      "imagePreviewUrl": "icons/places/home-1-e5zyd25fdm7ihkk8wq9pm.png/home-1-996o8ls1sfnvuxdevf4jt9",
      "isFree": false,
      "familySlug": "cyber-duotone",
      "familyName": "Cyber Duotone",
      "categorySlug": "category",
      "categoryName": "Category",
      "subcategorySlug": "places",
      "subcategoryName": "Places"
    },
   [...more results will appear here]
  ],
  "pagination": {
    "total": 1350,
    "hasMore": true,
    "offset": 0,
    "nextSkip": 50
  }
}

```

--------------------------------

### Search for Icons using Streamline API (cURL)

Source: https://streamline-api.readme.io/reference/quick-start-guide

This cURL command demonstrates how to search for 'home' icons using the Streamline API's Global search endpoint. It specifies the GET request, URL, and necessary headers including the API key.

```bash
curl --request GET \
     --url 'https://public-api.streamlinehq.com/v1/search/global?productType=icons&query=home' \
     --header 'accept: application/json' \
     --header 'x-api-key: PASTE_YOUR_API_KEY_HERE'

```

--------------------------------

### Search for Icons using Streamline API (Node.js)

Source: https://streamline-api.readme.io/reference/quick-start-guide

This Node.js snippet demonstrates how to search for 'home' icons using the Streamline API's Global search endpoint. It includes setting up the URL, request options with the API key, and handling the JSON response or errors.

```javascript
const url = 'https://public-api.streamlinehq.com/v1/search/global?productType=icons&query=home';
const options = {
  method: 'GET',
  headers: {accept: 'application/json', 'x-api-key': 'PASTE_YOUR_API_KEY_HERE'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

```

--------------------------------

### Connect to Streamline MCP Server (JSON)

Source: https://streamline-api.readme.io/reference/mcp-server

Configuration example for connecting an MCP-compatible client to the Streamline MCP Server. It includes the server URL and requires an API key for authentication.

```JSON
{
  "mcpServers": {
    "streamlineMCPServer": {
      "name": "Streamline MCP Server",
      "url": "https://public-api.streamlinehq.com/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY_HERE"
      }
    }
  }
}
```

--------------------------------

### Global Search API Request (cURL)

Source: https://streamline-api.readme.io/reference/globalsearch

Example of how to perform a global search using cURL. This request searches for 'icons' and includes the necessary headers for a successful API interaction.

```Shell
curl --request GET \
     --url 'https://public-api.streamlinehq.com/v1/search/global?productType=icons' \
     --header 'accept: application/json'
```

--------------------------------

### Get Icon by Hash (cURL)

Source: https://streamline-api.readme.io/reference/geticonbyhash

This snippet demonstrates how to retrieve icon details using a cURL request to the Streamline API. It specifies the GET method, the API endpoint, and the necessary headers for a JSON response.

```Shell
curl --request GET \
     --url https://public-api.streamlinehq.com/v1/icons/hash \
     --header 'accept: application/json'
```

--------------------------------

### Download Icon as SVG (cURL)

Source: https://streamline-api.readme.io/reference/downloadiconassvg

This snippet demonstrates how to download an icon in SVG format using cURL. It includes the GET request URL with query parameters for size and responsiveness, and sets the appropriate 'accept' header.

```Shell
curl --request GET \
     --url 'https://public-api.streamlinehq.com/v1/icons/hash/download/svg?size=48&responsive=false' \
     --header 'accept: image/svg+xml'
```

--------------------------------

### Search Family Icons (cURL)

Source: https://streamline-api.readme.io/reference/familysearch

This snippet demonstrates how to search for icons within a specific family using a cURL request. It includes the GET method, the API endpoint, and the necessary 'accept' header.

```Shell
curl --request GET \
     --url https://public-api.streamlinehq.com/v1/search/family/familySlug \
     --header 'accept: application/json'
```

--------------------------------

### Download Icon as PNG (cURL)

Source: https://streamline-api.readme.io/reference/downloadiconaspng

This snippet demonstrates how to download an icon as a PNG using cURL. It specifies the API endpoint, the icon hash, and query parameters for size and color.

```Shell
curl --request GET \
     --url 'https://public-api.streamlinehq.com/v1/icons/hash/download/png?size=48' \
     --header 'accept: image/png'
```

--------------------------------

### Download SVG Icon with Customizations

Source: https://streamline-api.readme.io/reference/mcp-server

This function allows you to download an icon as an SVG file. You can customize its size, colors, background, stroke width, and responsiveness. The 'strokeToFill' option converts strokes to fills, ignoring 'strokeWidth' if set to true. The 'base64' option allows you to receive the SVG data as a base64 encoded string.

```curl
curl -X GET \
  'https://api.streamlineicons.com/download/svg?icon_hash={iconHash}&size={size}&colors={colors}&backgroundColor={backgroundColor}&responsive={responsive}&strokeWidth={strokeWidth}&strokeToFill={strokeToFill}&base64={base64}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
```

--------------------------------

### API Pagination Response Structure

Source: https://streamline-api.readme.io/reference/pagination

This JSON structure represents the pagination metadata returned in API responses. It includes the total number of items, a flag indicating if more items are available, the current offset, and the offset for the next page.

```JSON
"pagination": {
    "total": 135,
    "hasMore": true,
    "offset": 0,
    "nextOffset": 50
}
```
Tokens:
Raw