Queries
filingType
Description
Get a list of Filing Types matching the given query
Response
Returns MetaDataOfMiscCode!
Arguments
Name | Description |
---|---|
query - String!
|
Search query |
Example
Query
query filingType($query: String!) {
filingType(query: $query) {
meta {
...MetaFragment
}
data {
...MiscCodeFragment
}
}
}
Variables
{"query": "church"}
Response
{
"data": {
"filingType": {
"meta": Meta,
"data": [MiscCode]
}
}
}
foundationType
Description
Get a list of Foundation Types matching the given query
Response
Returns MetaDataOfMiscCode!
Arguments
Name | Description |
---|---|
query - String!
|
Search query |
Example
Query
query foundationType($query: String!) {
foundationType(query: $query) {
meta {
...MetaFragment
}
data {
...MiscCodeFragment
}
}
}
Variables
{"query": "foundation"}
Response
{
"data": {
"foundationType": {
"meta": Meta,
"data": [MiscCode]
}
}
}
geoChildren
Description
Get the children of a given geography
Response
Returns MetaDataOfGeoChild!
Example
Query
query geoChildren(
$parentId: Int!,
$parentLevel: GeoLevel!,
$childLevel: GeoLevel!,
$limit: Int
) {
geoChildren(
parentId: $parentId,
parentLevel: $parentLevel,
childLevel: $childLevel,
limit: $limit
) {
meta {
...MetaFragment
}
data {
...GeoChildFragment
}
}
}
Variables
{"parentId": 5165418, "parentLevel": "ADM1", "childLevel": "ADM2", "limit": 1000}
Response
{
"data": {
"geoChildren": {
"meta": Meta,
"data": [GeoChild]
}
}
}
geoSearch
Description
Get a list of geographical properties, where the name of the location matches the given searchTerm
Response
Returns MetaDataOfGeoData!
Example
Query
query geoSearch(
$searchTerms: String!,
$parentId: Int,
$parentLevel: GeoLevel,
$geoLevel: GeoLevel,
$limit: Int
) {
geoSearch(
searchTerms: $searchTerms,
parentId: $parentId,
parentLevel: $parentLevel,
geoLevel: $geoLevel,
limit: $limit
) {
meta {
...MetaFragment
}
data {
...GeoDataFragment
}
}
}
Variables
{
"searchTerms": "hudson",
"parentId": 5128638,
"parentLevel": "ADM0",
"geoLevel": "PPL",
"limit": 10
}
Response
{
"data": {
"geoSearch": {
"meta": Meta,
"data": [GeoData]
}
}
}
msa
Description
Get a list of MSA codes matching the given query
Response
Returns MetaDataOfMiscCode!
Arguments
Name | Description |
---|---|
query - String!
|
Search query |
Example
Query
query msa($query: String!) {
msa(query: $query) {
meta {
...MetaFragment
}
data {
...MiscCodeFragment
}
}
}
Variables
{"query": "dallas"}
Response
{
"data": {
"msa": {
"meta": Meta,
"data": [MiscCode]
}
}
}
nteeMajor
Description
Get a list of NTEE major codes matching the given query
Response
Returns MetaDataOfNteeMiscCode!
Arguments
Name | Description |
---|---|
query - String!
|
Search query |
Example
Query
query nteeMajor($query: String!) {
nteeMajor(query: $query) {
meta {
...MetaFragment
}
data {
...NteeMiscCodeFragment
}
}
}
Variables
{"query": "art"}
Response
{
"data": {
"nteeMajor": {
"meta": Meta,
"data": [NteeMiscCode]
}
}
}
nteeMinor
Description
Get a list of NTEE minor codes matching the given query
Response
Returns MetaDataOfNteeMiscCode!
Arguments
Name | Description |
---|---|
query - String!
|
Search query |
Example
Query
query nteeMinor($query: String!) {
nteeMinor(query: $query) {
meta {
...MetaFragment
}
data {
...NteeMiscCodeFragment
}
}
}
Variables
{"query": "animal"}
Response
{
"data": {
"nteeMinor": {
"meta": Meta,
"data": [NteeMiscCode]
}
}
}
subsection
Description
Get a list of IRS Subsections matching the given query
Response
Returns MetaDataOfMiscCode!
Arguments
Name | Description |
---|---|
query - String!
|
Search query |
Example
Query
query subsection($query: String!) {
subsection(query: $query) {
meta {
...MetaFragment
}
data {
...MiscCodeFragment
}
}
}
Variables
{"query": "public charity"}
Response
{
"data": {
"subsection": {
"meta": Meta,
"data": [MiscCode]
}
}
}
termsByCode
Description
Get a list of taxonomy codes matching the given code query
Response
Returns MetaDataOfTerm!
Arguments
Name | Description |
---|---|
pcsCodes - [PCSCodeInput!]
|
Search query |
Example
Query
query termsByCode($pcsCodes: [PCSCodeInput!]) {
termsByCode(pcsCodes: $pcsCodes) {
meta {
...MetaFragment
}
data {
...TermFragment
}
}
}
Variables
{"pcsCodes": [PCSCodeInput]}
Response
{
"data": {
"termsByCode": {
"meta": Meta,
"data": [Term]
}
}
}
termsByFacet
Description
Get a list of taxonomy codes matching the given facet query
Response
Returns MetaDataOfTerm!
Arguments
Name | Description |
---|---|
facet - FacetType!
|
Search query |
Example
Query
query termsByFacet($facet: FacetType!) {
termsByFacet(facet: $facet) {
meta {
...MetaFragment
}
data {
...TermFragment
}
}
}
Variables
{"facet": "SUBJECT"}
Response
{
"data": {
"termsByFacet": {
"meta": Meta,
"data": [Term]
}
}
}
termsByMatch
Description
Get a list of taxonomy codes based on the relevant match of the searchTerm. Will return exact matches, approximate matches and relevant matches based on name, descriptions, and codes
Response
Returns MetaDataOfTerm!
Arguments
Name | Description |
---|---|
match - MatchInput
|
Search query |
Example
Query
query termsByMatch($match: MatchInput) {
termsByMatch(match: $match) {
meta {
...MetaFragment
}
data {
...TermFragment
}
}
}
Variables
{"match": MatchInput}
Response
{
"data": {
"termsByMatch": {
"meta": Meta,
"data": [Term]
}
}
}
termsByName
Description
Get a list of taxonomy codes that exactly match the name queried
Response
Returns MetaDataOfTerm!
Arguments
Name | Description |
---|---|
pcsNames - [PCSNameInput!]
|
Search query |
Example
Query
query termsByName($pcsNames: [PCSNameInput!]) {
termsByName(pcsNames: $pcsNames) {
meta {
...MetaFragment
}
data {
...TermFragment
}
}
}
Variables
{"pcsNames": [PCSNameInput]}
Response
{
"data": {
"termsByName": {
"meta": Meta,
"data": [Term]
}
}
}
Types
AdministrativeArea
Fields
Field Name | Description |
---|---|
id - Int!
|
Geoname ID |
name - String!
|
Geography Name |
Example
{"id": 123, "name": "abc123"}
CountryLevel
Fields
Field Name | Description |
---|---|
id - Int!
|
Geoname ID |
name - String!
|
Geography Name |
iso3 - String!
|
Geography Name 3 characters abbreviation |
Example
{
"id": 987,
"name": "abc123",
"iso3": "xyz789"
}
FacetType
Values
Enum Value | Description |
---|---|
|
Describes what is being supported – grantmaker areas of focus, primary work of nonprofits and activities being funded |
|
Describes who is being supported - details characteristics (age, sex, race/ethnic heritage, etc.) of the population(s) being targeted as the intended beneficiary of support and services being provided |
|
Describes how an organization is providing or receiving support |
|
Describes what type of organization is providing or receiving support |
|
Describes how the goals of a program or grant are being implemented or supported |
Example
"SUBJECT"
GeoChild
Description
Geo Child Object
Fields
Field Name | Description |
---|---|
id - Int!
|
Geoname ID |
name - String!
|
Geography Name |
displayName - String!
|
Geoname Display Name |
geoLevel - GeoLevel!
|
Level for the geography |
admin1Code - String!
|
First administrative unit code |
Example
{
"id": 123,
"name": "xyz789",
"displayName": "xyz789",
"geoLevel": "CONT",
"admin1Code": "abc123"
}
GeoData
Fields
Field Name | Description |
---|---|
id - Int!
|
Geography ID |
name - String!
|
Geography Name |
displayName - String!
|
Geography Display Name |
countryCode - String!
|
Country Code |
geoLevel - GeoLevel!
|
Level for the Geography |
country - CountryLevel!
|
Country Details |
admin1 - AdministrativeArea!
|
State or Province Details |
admin2 - AdministrativeArea
|
County Details |
Example
{
"id": 123,
"name": "abc123",
"displayName": "abc123",
"countryCode": "xyz789",
"geoLevel": "CONT",
"country": CountryLevel,
"admin1": AdministrativeArea,
"admin2": AdministrativeArea
}
GeoLevel
Values
Enum Value | Description |
---|---|
|
Continent |
|
Country |
|
State or province |
|
Region |
|
County |
|
US census Metropolitan Statistical Area |
|
Populated place (city/town) |
|
Congressional District |
Example
"CONT"
MatchInput
Fields
Input Field | Description |
---|---|
searchTerm - String!
|
Term to be Searched on |
limit - Int!
|
Limit of Number of Terms to be Searched |
Example
{"searchTerm": "abc123", "limit": 123}
Meta
Fields
Field Name | Description |
---|---|
code - Int!
|
HTTP status code |
message - String!
|
Diagnostic message for response status |
took - Int!
|
Time taken for request to process |
resultsCount - Int!
|
Number of results returned |
Example
{
"code": 123,
"message": "xyz789",
"took": 987,
"resultsCount": 987
}
MetaDataOfGeoChild
Fields
Field Name | Description |
---|---|
meta - Meta!
|
Array of Metadata for Term Search. |
data - [GeoChild!]!
|
Array of Response Data. |
Example
{"meta": Meta, "data": [GeoChild]}
MetaDataOfGeoData
Fields
Field Name | Description |
---|---|
meta - Meta!
|
Array of Metadata for Term Search. |
data - [GeoData!]!
|
Array of Response Data. |
Example
{"meta": Meta, "data": [GeoData]}
MetaDataOfMiscCode
Fields
Field Name | Description |
---|---|
meta - Meta!
|
Array of Metadata for Term Search. |
data - [MiscCode!]!
|
Array of Response Data. |
Example
{"meta": Meta, "data": [MiscCode]}
MetaDataOfNteeMiscCode
Fields
Field Name | Description |
---|---|
meta - Meta!
|
Array of Metadata for Term Search. |
data - [NteeMiscCode!]!
|
Array of Response Data. |
Example
{
"meta": Meta,
"data": [NteeMiscCode]
}
MetaDataOfTerm
MiscCode
Fields
Field Name | Description |
---|---|
key - String!
|
Value of Key |
value - String!
|
Description of Organization |
searchValue - String!
|
Search Value |
type - String!
|
Type of Organization |
Example
{
"key": "abc123",
"value": "abc123",
"searchValue": "xyz789",
"type": "abc123"
}
NteeMiscCode
Fields
Field Name | Description |
---|---|
pcsCrosswalk - PcsCrosswalk
|
NTEE to PCS crosswalk value. |
key - String!
|
Value of Key |
value - String!
|
Description of Organization |
searchValue - String!
|
Search Value |
type - String!
|
Type of Organization |
Example
{
"pcsCrosswalk": PcsCrosswalk,
"key": "abc123",
"value": "xyz789",
"searchValue": "abc123",
"type": "abc123"
}
PCSCodeInput
Fields
Input Field | Description |
---|---|
code - String!
|
PCS code |
facet - FacetType
|
PCS facet to be searched |
Example
{"code": "abc123", "facet": "SUBJECT"}
PCSNameInput
Fields
Input Field | Description |
---|---|
name - String!
|
PCS name |
facet - FacetType
|
PCS facet to be searched |
Example
{"name": "xyz789", "facet": "SUBJECT"}
PcsCrosswalk
Fields
Field Name | Description |
---|---|
code - String!
|
PCS crosswalk code. |
name - String!
|
PCS crosswalk name. |
exact_match - Boolean!
|
Specifies whether PCS crosswalk is an exact match. |
Example
{
"code": "abc123",
"name": "xyz789",
"exact_match": false
}
Term
Fields
Field Name | Description |
---|---|
facet - FacetType!
|
The taxonomy or PCS facet of the term. |
name - String!
|
The name of the term. |
code - String!
|
The code of the term. |
searchValue - String!
|
The code of the term to be used in some search values. |
description - String!
|
The description of the term. |
parents - [Term!]!
|
The parent terms of the term queried. |
children - [Term!]!
|
The child terms of the term queried. |
hasChildren - Boolean!
|
Indicates that the current term has a children terms. |
depth - Int!
|
Indicates the number of parent levels the current term has. |
Example
{
"facet": "SUBJECT",
"name": "abc123",
"code": "abc123",
"searchValue": "abc123",
"description": "abc123",
"parents": [Term],
"children": [Term],
"hasChildren": false,
"depth": 987
}