GET
/
api
/
merchants
/
search
curl --request GET \
  --url https://app.herondata.io/api/merchants/search \
  --header 'x-api-key: <api-key>'
{
  "merchants": [
    {
      "categories": [
        {
          "code": "7311",
          "description": "Advertising services",
          "slug": "advertising_services"
        }
      ],
      "group_id": "Uber",
      "heron_id": "mrc_Eajrnqvo7XUoiWkUrfcPRe",
      "icon_url": "<string>",
      "is_priority": true,
      "logo_url": "<string>",
      "name": "<string>",
      "url": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
name
string
required

Full or partial name, minimum 3 characters

​
only_priority
boolean

If true, only returns priority merchants

Response

200 - application/json

A list of up to 5 merchants which match the search term, sorted by descending order of their URL rank and the frequency this merchant has been seen historically.

The response is of type object.

GET
/
api
/
merchants
/
search
curl --request GET \
  --url https://app.herondata.io/api/merchants/search \
  --header 'x-api-key: <api-key>'
{
  "merchants": [
    {
      "categories": [
        {
          "code": "7311",
          "description": "Advertising services",
          "slug": "advertising_services"
        }
      ],
      "group_id": "Uber",
      "heron_id": "mrc_Eajrnqvo7XUoiWkUrfcPRe",
      "icon_url": "<string>",
      "is_priority": true,
      "logo_url": "<string>",
      "name": "<string>",
      "url": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
name
string
required

Full or partial name, minimum 3 characters

​
only_priority
boolean

If true, only returns priority merchants

Response

200 - application/json

A list of up to 5 merchants which match the search term, sorted by descending order of their URL rank and the frequency this merchant has been seen historically.

The response is of type object.