Icon Search API for Bootstrap Icons - [\"vector pen\"]

This API was created for the formstrap form editor to allow user-selection of icons for input fields utilising Bootstrap input-group addons.

formstrap is a WYSIWYG editor for creating complex, dynamic, responsive and standards compliant online forms compatible with Bootstrap 5.3.

You can use the API service to implement icon search in your own application. Search for Bootstrap Icons by name, category, class or tag. Retrieve full metadata in JSON format including icon HTML code, SVG code, class names, tags, categories and icon titles.

The service is an open API. It is rate-limited (by the IP address of the requesting device). 150 requests per hour. This will be kept under review.

Currently serving Bootstrap Icons Version: v1.11.3.

Endpoint

POST https://formstrap.com/IconSearchAPI/v1/search

property: search search string (see Search and Advanced Search tips)

Search Tips

By default, search matches whole words and will find icons matching any or all keywords.

Advanced Search Tips

Adding + prefix will require the term matches
e.g. +file +word
Adding - prefix will require term DOES NOT match
e.g. +people -fill
Adding * suffix will facilitate wildcard match
e.g. pen*
Enclose in quotes for exact phrase
e.g. "vector pen"
Use _ for single character wildcard matching
e.g. organi_ation (can't be combined with other search types)

Do you find this service useful? Optionally a small contribution to running costs. Thank you

Do you have feedback, questions or suggestions? Visit the formstrap About page and click the feedback link.

Give it a try!
Run a search by entering a search string below. You'll see the results in a table - scroll down for code samples and the JSON response

Example Request Types

$.ajax(
	{
		method:"POST",
		url:"https://formstrap.com/IconSearchAPI/v1/search",
		data:{"search":"\"vector pen\""},
		dataType:"json"
	}).done(function(response)
	{
		if(response.responseCode==200)
		{
			// PROCESS THE RESPONSE	
		}
		else
		{
			// THERE WAS AN ERROR
			console.log(response.responseCode + ":" + response.responseVerbose);
		}
	}).fail(function(e)
	{	
		// THE REQUEST FAILED
		console.log(e)
	});

const url = "https://formstrap.com/IconSearchAPI/v1/search";
const data = { search: "\"vector pen\"" };
fetch(url, {
    method: "POST",
    headers: {
        "Content-Type": "application/x-www-form-urlencoded",
    },
    body: new URLSearchParams(data), 
})
    .then(response => response.json()) 
    .then(response => {
        if (response.responseCode === 200) {
            // PROCESS THE RESPONSE
        } else {
            // THERE WAS AN ERROR
            console.log(`${response.responseCode}: ${response.responseVerbose}`);
        }
    })
    .catch(error => {
        // Handle any errors
        console.error("Error:", error);
    });

curl -X POST "https://formstrap.com/IconSearchAPI/v1/search" \
     -d "search=\"vector pen\"" \
     -o /folder/response.json

<?php	
	$url = "https://formstrap.com/IconSearchAPI/v1/search";
	$searchstring="\"vector pen\"";
	$data = array('search' => $searchstring);
	$ch = curl_init();
	curl_setopt($ch, CURLOPT_URL, $url);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
	curl_setopt($ch, CURLOPT_POST, true); 
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data)); 
	$response = curl_exec($ch);
	if ($response === false) 
	{
		echo "cURL Error: " . curl_error($ch);
	}
	curl_close($ch);
	$response_data = json_decode($response, true);
	if($response_data["responseCode"]==200)
	{
		// PROCESS THE RESPONSE
	}
	else
	{
		// THERE WAS AN ERROR
		error_log($response_data["responseCode"] .  " : " . $response_data["responseVerbose"]);
	}
?>

formstrap » Icon Search API