Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Giving Compass Insights API
Introduction
chat
nonprofits
articles

Giving Compass Insights API

The Giving Compass Insights API provides various ways to search for nonprofits and content.

For the /chat endpoint, some examples of the q pameter value are:

  • Find articles about clean water

  • Find nonprofits in Chicago with revenue over 100k

  • Show nonprofits in TX that help the blind

  • Nonprofits that are similar to JDRF

  • Nonprofits that focus on SDG 5 with revenue between 1M and 5M

Book a call

Get Trial Key

chat

search

GETChat Search

https://api.givingcompass.org/insights/chat/search?q=<string>&city=<string>&state=<string>&zip=97595&min_total_revenue=<integer>&max_total_revenue=<integer>&gc_vetted=<boolean>&sdg=<integer>
AUTHORIZATIONAPI Key
Key

X-API-Key

Value

{{apiKey}}

HEADERS
x-session-id

<uuid>

A unique UUID value to maintain context

Accept

application/json

PARAMS
q

<string>

(Required) Query string for searching the vector database

city

<string>

City string for filtering search results

state

<string>

State string for filtering the vector database (2 character abbreviation)

zip

97595

5 Zip Code for filtering search results

min_total_revenue

<integer>

Returns nonprofits with total revenue more than min total revenue

max_total_revenue

<integer>

Returns nonprofits with total revenue less than max total revenue

gc_vetted

<boolean>

Query string for selecting vetted Giving Compass nonprofits

sdg

<integer>

List of Sustainable Development Goals (SDGs) to filter search results by

Example Request
Successful Response
curl
curl --location 'https://api.givingcompass.org/insights/chat/search?q=%3Cstring%3E&city=%3Cstring%3E&state=%3Cstring%3E&zip=97595&min_total_revenue=%3Cinteger%3E&max_total_revenue=%3Cinteger%3E&gc_vetted=%3Cboolean%3E&sdg=%3Cinteger%3E' \
--header 'x-session-id: <uuid>' \
--header 'Accept: application/json' \
--header 'X-API-Key: <API Key>'
200 OK
Example Response
json
{
  "messageId": "<string>",
  "message": "<string>",
  "intent": "<string>",
  "intentDetails": {
    "llm_response": {
      "function_name": "<string>",
      "arguments": {},
      "message": "<string>"
    },
    "intent": "<string>",
    "prompt": "<string>",
    "cause": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "min_revenue": "<number>",
    "max_revenue": "<number>",
    "gc_vetted": "<boolean>",
    "sdgs": [
      "<integer>",
      "<integer>"
    ],
    "ntee_codes": [
      "<string>",
      "<string>"
    ],
    "organization_name": "<string>",
    "organization_ein": "<string>",
    "keywords": "<string>",
    "query": "<string>",
    "article_id": "<integer>"
  },
  "nonprofits": [
    {
      "ein": "<string>",
      "name": "<string>",
      "url": "<string>",
      "summary": "<string>",
      "streetAddress": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode5": "<string>",
      "ntee": "<string>",
      "issueArea": "<string>",
      "yearFounded": "<integer>",
      "filingYear": "<integer>",
      "revenueGrandTotal": "<number>",
      "netAssets": "<number>",
      "foundation": "<boolean>",
      "inactive": "<boolean>",
      "gcVetted": "<boolean>",
      "irsRulingDate": "<date>",
      "sdgs": [
        "<integer>",
        "<integer>"
      ],
      "logo": "<string>",
      "formType": "<string>",
      "gcVideoUrl": "<string>",
      "gcDonationUrl": "<string>",
      "lat": "<number>",
      "lng": "<number>",
      "alt_name": "<string>"
    },
    {
      "ein": "<string>",
      "name": "<string>",
      "url": "<string>",
      "summary": "<string>",
      "streetAddress": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode5": "<string>",
      "ntee": "<string>",
      "issueArea": "<string>",
      "yearFounded": "<integer>",
      "filingYear": "<integer>",
      "revenueGrandTotal": "<number>",
      "netAssets": "<number>",
      "foundation": "<boolean>",
      "inactive": "<boolean>",
      "gcVetted": "<boolean>",
      "irsRulingDate": "<date>",
      "sdgs": [
        "<integer>",
        "<integer>"
      ],
      "logo": "<string>",
      "formType": "<string>",
      "gcVideoUrl": "<string>",
      "gcDonationUrl": "<string>",
      "lat": "<number>",
      "lng": "<number>",
      "alt_name": "<string>"
    }
  ],
  "articles": [
    {
      "id": "<integer>",
      "title": "<string>",
      "excerpt": "<string>",
      "url": "<string>",
      "publisher": "<string>",
      "is_gc_original": "<boolean>",
      "date_added": "<string>",
      "date_modified": "<string>",
      "evergreen": "<boolean>"
    },
    {
      "id": "<integer>",
      "title": "<string>",
      "excerpt": "<string>",
      "url": "<string>",
      "publisher": "<string>",
      "is_gc_original": "<boolean>",
      "date_added": "<string>",
      "date_modified": "<string>",
      "evergreen": "<boolean>"
    }
  ],
  "article": {
    "id": "<integer>",
    "title": "<string>",
    "url": "<string>",
    "text": "<string>"
  },
  "suggestions": [
    {
      "label": "<string>",
      "message": "<string>",
      "url": "<string>",
      "content_id": "<string>"
    },
    {
      "label": "<string>",
      "message": "<string>",
      "url": "<string>",
      "content_id": "<string>"
    }
  ],
  "kbSources": [
    {
      "article_id": "<string>",
      "title": "<string>",
      "url": "<string>"
    },
    {
      "article_id": "<string>",
      "title": "<string>",
      "url": "<string>"
    }
  ],
  "funds": [
    {
      "id": "<integer>",
      "title": "<string>",
      "content": "<string>",
      "purpose": "<string>",
      "sponsor": "<string>",
      "about_sponsor": "<string>",
      "fund_url": "<string>",
      "fund_sponsor_url": "<string>",
      "fund_minimum_investment": "<string>",
      "gc_medium_image": "<string>",
      "address": {},
      "website": "<string>",
      "logo": "<string>",
      "ein": "<string>",
      "type": "<string>",
      "category": {}
    },
    {
      "id": "<integer>",
      "title": "<string>",
      "content": "<string>",
      "purpose": "<string>",
      "sponsor": "<string>",
      "about_sponsor": "<string>",
      "fund_url": "<string>",
      "fund_sponsor_url": "<string>",
      "fund_minimum_investment": "<string>",
      "gc_medium_image": "<string>",
      "address": {},
      "website": "<string>",
      "logo": "<string>",
      "ein": "<string>",
      "type": "<string>",
      "category": {}
    }
  ]
}
Content-Type

application/json

GETProcess User Message

https://api.givingcompass.org/insights/chat?q=<string>&city=<string>&state=<string>&zip=97595&min_total_revenue=<integer>&max_total_revenue=<integer>&gc_vetted=<boolean>&sdg=<integer>
AUTHORIZATIONAPI Key
Key

X-API-Key

Value

{{apiKey}}

HEADERS
x-session-id

<uuid>

A unique UUID value to maintain context

Accept

application/json

PARAMS
q

<string>

(Required) Query string for searching the vector database

city

<string>

City string for filtering search results

state

<string>

State string for filtering the vector database (2 character abbreviation)

zip

97595

5 Zip Code for filtering search results

min_total_revenue

<integer>

Returns nonprofits with total revenue more than min total revenue

max_total_revenue

<integer>

Returns nonprofits with total revenue less than max total revenue

gc_vetted

<boolean>

Query string for selecting vetted Giving Compass nonprofits

sdg

<integer>

List of Sustainable Development Goals (SDGs) to filter search results by

Example Request
Successful Response
curl
curl --location 'https://api.givingcompass.org/insights/chat?q=%3Cstring%3E&city=%3Cstring%3E&state=%3Cstring%3E&zip=97595&min_total_revenue=%3Cinteger%3E&max_total_revenue=%3Cinteger%3E&gc_vetted=%3Cboolean%3E&sdg=%3Cinteger%3E' \
--header 'x-session-id: <uuid>' \
--header 'Accept: application/json' \
--header 'X-API-Key: <API Key>'
200 OK
Example Response
json
{
  "messageId": "<string>",
  "message": "<string>",
  "intent": "<string>",
  "intentDetails": {
    "llm_response": {
      "function_name": "<string>",
      "arguments": {},
      "message": "<string>"
    },
    "intent": "<string>",
    "prompt": "<string>",
    "cause": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "min_revenue": "<number>",
    "max_revenue": "<number>",
    "gc_vetted": "<boolean>",
    "sdgs": [
      "<integer>",
      "<integer>"
    ],
    "ntee_codes": [
      "<string>",
      "<string>"
    ],
    "organization_name": "<string>",
    "organization_ein": "<string>",
    "keywords": "<string>",
    "query": "<string>",
    "article_id": "<integer>"
  },
  "nonprofits": [
    {
      "ein": "<string>",
      "name": "<string>",
      "url": "<string>",
      "summary": "<string>",
      "streetAddress": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode5": "<string>",
      "ntee": "<string>",
      "issueArea": "<string>",
      "yearFounded": "<integer>",
      "filingYear": "<integer>",
      "revenueGrandTotal": "<number>",
      "netAssets": "<number>",
      "foundation": "<boolean>",
      "inactive": "<boolean>",
      "gcVetted": "<boolean>",
      "irsRulingDate": "<date>",
      "sdgs": [
        "<integer>",
        "<integer>"
      ],
      "logo": "<string>",
      "formType": "<string>",
      "gcVideoUrl": "<string>",
      "gcDonationUrl": "<string>",
      "lat": "<number>",
      "lng": "<number>",
      "alt_name": "<string>"
    },
    {
      "ein": "<string>",
      "name": "<string>",
      "url": "<string>",
      "summary": "<string>",
      "streetAddress": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode5": "<string>",
      "ntee": "<string>",
      "issueArea": "<string>",
      "yearFounded": "<integer>",
      "filingYear": "<integer>",
      "revenueGrandTotal": "<number>",
      "netAssets": "<number>",
      "foundation": "<boolean>",
      "inactive": "<boolean>",
      "gcVetted": "<boolean>",
      "irsRulingDate": "<date>",
      "sdgs": [
        "<integer>",
        "<integer>"
      ],
      "logo": "<string>",
      "formType": "<string>",
      "gcVideoUrl": "<string>",
      "gcDonationUrl": "<string>",
      "lat": "<number>",
      "lng": "<number>",
      "alt_name": "<string>"
    }
  ],
  "articles": [
    {
      "id": "<integer>",
      "title": "<string>",
      "excerpt": "<string>",
      "url": "<string>",
      "publisher": "<string>",
      "is_gc_original": "<boolean>",
      "date_added": "<string>",
      "date_modified": "<string>",
      "evergreen": "<boolean>"
    },
    {
      "id": "<integer>",
      "title": "<string>",
      "excerpt": "<string>",
      "url": "<string>",
      "publisher": "<string>",
      "is_gc_original": "<boolean>",
      "date_added": "<string>",
      "date_modified": "<string>",
      "evergreen": "<boolean>"
    }
  ],
  "article": {
    "id": "<integer>",
    "title": "<string>",
    "url": "<string>",
    "text": "<string>"
  },
  "suggestions": [
    {
      "label": "<string>",
      "message": "<string>",
      "url": "<string>",
      "content_id": "<string>"
    },
    {
      "label": "<string>",
      "message": "<string>",
      "url": "<string>",
      "content_id": "<string>"
    }
  ],
  "kbSources": [
    {
      "article_id": "<string>",
      "title": "<string>",
      "url": "<string>"
    },
    {
      "article_id": "<string>",
      "title": "<string>",
      "url": "<string>"
    }
  ],
  "funds": [
    {
      "id": "<integer>",
      "title": "<string>",
      "content": "<string>",
      "purpose": "<string>",
      "sponsor": "<string>",
      "about_sponsor": "<string>",
      "fund_url": "<string>",
      "fund_sponsor_url": "<string>",
      "fund_minimum_investment": "<string>",
      "gc_medium_image": "<string>",
      "address": {},
      "website": "<string>",
      "logo": "<string>",
      "ein": "<string>",
      "type": "<string>",
      "category": {}
    },
    {
      "id": "<integer>",
      "title": "<string>",
      "content": "<string>",
      "purpose": "<string>",
      "sponsor": "<string>",
      "about_sponsor": "<string>",
      "fund_url": "<string>",
      "fund_sponsor_url": "<string>",
      "fund_minimum_investment": "<string>",
      "gc_medium_image": "<string>",
      "address": {},
      "website": "<string>",
      "logo": "<string>",
      "ein": "<string>",
      "type": "<string>",
      "category": {}
    }
  ]
}
Content-Type

application/json

nonprofits