Essentials

API change history

Search GuideStar’s most common set of data about nonprofits to quickly find organizations most relevant to your users, and use those results to get more data from our other APIs. API returns search result in JSON format.

Post Essentials v1

Essentials API does not require the use of Query Parameters. Please use the Request Body to make search requests.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Below JSON request body is an example showing all available elements. Please use the examples from the API Documentation.

{
  "search_terms": "string",
  "from": 0,
  "size": 0,
  "sort": {
    "sort_by": "string",
    "ascending": true
  },
  "filters": {
    "geography": {
      "state": [
        "string"
      ],
      "zip": "string",
      "radius": 0,
      "msa": [
        "string"
      ],
      "city": [
        "string"
      ],
      "county": [
        "string"
      ]
    },
    "organization": {
      "profile_levels": [
        "string"
      ],
      "ntee_major_codes": [
        "string"
      ],
      "ntee_minor_codes": [
        "string"
      ],
      "subsection_codes": [
        "string"
      ],
      "foundation_codes": [
        "string"
      ],
      "bmf_status": true,
      "pub78_verified": true,
      "affiliation_type": {
        "parent": true,
        "subordinate": true,
        "independent": true,
        "headquarter": true
      },
      "specific_exclusions": {
        "exclude_revoked_organizations": true,
        "exclude_defunct_or_merged_organizations": true
      },
      "number_of_employees_range": {
        "min": 0,
        "max": 0
      },
      "form_types": {
        "f990": true,
        "f990pf": true,
        "required_to_file_990t": true
      },
      "audits": {
        "a_133_audit_performed": true
      }
    },
    "financials": {
      "total_revenue": {
        "min": 0,
        "max": 0
      },
      "total_expenses": {
        "min": 0,
        "max": 0
      },
      "total_assets": {
        "min": 0,
        "max": 0
      }
    }
  }
}
{
  "type": "object",
  "properties": {
    "search_terms": {
      "type": "string"
    },
    "from": {
      "format": "int32",
      "type": "integer"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "type": "object",
      "properties": {
        "sort_by": {
          "type": "string"
        },
        "ascending": {
          "type": "boolean"
        }
      }
    },
    "filters": {
      "type": "object",
      "properties": {
        "geography": {
          "type": "object",
          "properties": {
            "state": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "zip": {
              "type": "string"
            },
            "radius": {
              "format": "int32",
              "type": "integer"
            },
            "msa": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "city": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "county": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "organization": {
          "type": "object",
          "properties": {
            "profile_levels": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "ntee_major_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "ntee_minor_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "subsection_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "foundation_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "bmf_status": {
              "type": "boolean"
            },
            "pub78_verified": {
              "type": "boolean"
            },
            "affiliation_type": {
              "type": "object",
              "properties": {
                "parent": {
                  "type": "boolean"
                },
                "subordinate": {
                  "type": "boolean"
                },
                "independent": {
                  "type": "boolean"
                },
                "headquarter": {
                  "type": "boolean"
                }
              }
            },
            "specific_exclusions": {
              "type": "object",
              "properties": {
                "exclude_revoked_organizations": {
                  "type": "boolean"
                },
                "exclude_defunct_or_merged_organizations": {
                  "type": "boolean"
                }
              }
            },
            "number_of_employees_range": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            },
            "form_types": {
              "type": "object",
              "properties": {
                "f990": {
                  "type": "boolean"
                },
                "f990pf": {
                  "type": "boolean"
                },
                "required_to_file_990t": {
                  "type": "boolean"
                }
              }
            },
            "audits": {
              "type": "object",
              "properties": {
                "a_133_audit_performed": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "financials": {
          "type": "object",
          "properties": {
            "total_revenue": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            },
            "total_expenses": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            },
            "total_assets": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}
{
  "search_terms": "string",
  "from": 0,
  "size": 0,
  "sort": {
    "sort_by": "string",
    "ascending": true
  },
  "filters": {
    "geography": {
      "state": [
        "string"
      ],
      "zip": "string",
      "radius": 0,
      "msa": [
        "string"
      ],
      "city": [
        "string"
      ],
      "county": [
        "string"
      ]
    },
    "organization": {
      "profile_levels": [
        "string"
      ],
      "ntee_major_codes": [
        "string"
      ],
      "ntee_minor_codes": [
        "string"
      ],
      "subsection_codes": [
        "string"
      ],
      "foundation_codes": [
        "string"
      ],
      "bmf_status": true,
      "pub78_verified": true,
      "affiliation_type": {
        "parent": true,
        "subordinate": true,
        "independent": true,
        "headquarter": true
      },
      "specific_exclusions": {
        "exclude_revoked_organizations": true,
        "exclude_defunct_or_merged_organizations": true
      },
      "number_of_employees_range": {
        "min": 0,
        "max": 0
      },
      "form_types": {
        "f990": true,
        "f990pf": true,
        "required_to_file_990t": true
      },
      "audits": {
        "a_133_audit_performed": true
      }
    },
    "financials": {
      "total_revenue": {
        "min": 0,
        "max": 0
      },
      "total_expenses": {
        "min": 0,
        "max": 0
      },
      "total_assets": {
        "min": 0,
        "max": 0
      }
    }
  }
}
{
  "type": "object",
  "properties": {
    "search_terms": {
      "type": "string"
    },
    "from": {
      "format": "int32",
      "type": "integer"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "type": "object",
      "properties": {
        "sort_by": {
          "type": "string"
        },
        "ascending": {
          "type": "boolean"
        }
      }
    },
    "filters": {
      "type": "object",
      "properties": {
        "geography": {
          "type": "object",
          "properties": {
            "state": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "zip": {
              "type": "string"
            },
            "radius": {
              "format": "int32",
              "type": "integer"
            },
            "msa": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "city": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "county": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "organization": {
          "type": "object",
          "properties": {
            "profile_levels": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "ntee_major_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "ntee_minor_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "subsection_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "foundation_codes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "bmf_status": {
              "type": "boolean"
            },
            "pub78_verified": {
              "type": "boolean"
            },
            "affiliation_type": {
              "type": "object",
              "properties": {
                "parent": {
                  "type": "boolean"
                },
                "subordinate": {
                  "type": "boolean"
                },
                "independent": {
                  "type": "boolean"
                },
                "headquarter": {
                  "type": "boolean"
                }
              }
            },
            "specific_exclusions": {
              "type": "object",
              "properties": {
                "exclude_revoked_organizations": {
                  "type": "boolean"
                },
                "exclude_defunct_or_merged_organizations": {
                  "type": "boolean"
                }
              }
            },
            "number_of_employees_range": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            },
            "form_types": {
              "type": "object",
              "properties": {
                "f990": {
                  "type": "boolean"
                },
                "f990pf": {
                  "type": "boolean"
                },
                "required_to_file_990t": {
                  "type": "boolean"
                }
              }
            },
            "audits": {
              "type": "object",
              "properties": {
                "a_133_audit_performed": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "financials": {
          "type": "object",
          "properties": {
            "total_revenue": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            },
            "total_expenses": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            },
            "total_assets": {
              "type": "object",
              "properties": {
                "min": {
                  "format": "int32",
                  "type": "integer"
                },
                "max": {
                  "format": "int32",
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}

Responses

200 OK

OK

Representations

{
  "code": 200,
  "message": "OK",
  "took": 0,
  "errors": [
    {
      "resource": "string",
      "reason": "string"
    }
  ],
  "data": {
    "took": 0,
    "total_hits": 0,
    "hits": [
      {
        "organization_id": "string",
        "bridge_id": "string",
        "ein": "string",
        "organization_name": "string",
        "also_known_as": "string",
        "mission": "string",
        "address_line_1": "string",
        "address_line_2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "county": "string",
        "msa": "string",
        "lat_long": "string",
        "ntee_code": "string",
        "profile_level": "string",
        "public_report": "string",
        "subsection_code": "string",
        "number_of_employees": "string",
        "form_type": "string",
        "website_url": "string",
        "foundation_code": "string",
        "parent_orgs": "string",
        "bmf_gross_receipts": "string",
        "bmf_assets": "string",
        "form990_total_revenue": "string",
        "form990_total_expenses": "string",
        "form990_total_assets": "string",
        "contact_email": "string",
        "contact_name": "string",
        "contact_phone": "string",
        "contact_title": "string",
        "properties": {
          "parent": true,
          "subordinate": true,
          "independent": true,
          "national_hq": true,
          "revoked": true,
          "defunct_or_merged": true,
          "audit_a133_performed": true,
          "bmf_status": true,
          "pub78_verified": true,
          "allow_online_giving": true
        }
      }
    ]
  }
}
{
  "type": "object"
}
{}
{
  "type": "object"
}

Code samples

@ECHO OFF

curl -v -X POST "https://apidata.guidestar.org/essentials/v1"
-H "Content-Type: application/json"
-H "Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Subscription-Key", "{subscription key}");

            var uri = "https://apidata.guidestar.org/essentials/v1?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://apidata.guidestar.org/essentials/v1");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://apidata.guidestar.org/essentials/v1?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://apidata.guidestar.org/essentials/v1";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://apidata.guidestar.org/essentials/v1');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('apidata.guidestar.org')
    conn.request("POST", "/essentials/v1?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('apidata.guidestar.org')
    conn.request("POST", "/essentials/v1?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://apidata.guidestar.org/essentials/v1')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body