authentication

with query param

curl 'https://api.getowl.co/v1/query/profile?api-key=YOUR-API-KEY&q=woodpecker.co'
        

with header

curl 'https://api.getowl.co/v1/query/profile?q=woodpecker.co' -H 'x-api-key: YOUR-API-KEY'
        

query

Domain or email address for which you want to search for information.

In case of email if the domain is a known email services provider like gmail.com empty response will be returned.

response schema

{
  "company": {
    "name": "Woodpecker.co",
    "founded": "2015",
    "locality": "Wroclaw, Dolnoslaskie, Poland",
    "size": "51-200",
    "tags": [
      "SaaS",
      "marketing"
    ]
  },
  "webpage": {
    "url": "https://woodpecker.co/",
    "domain": "woodpecker.co",
    "title": "Cold emails & follow-ups | Woodpecker.co",
    "description": "Email outreach takes you way too much time? We felt that too.",
    "links": {
      "jobs": [],
      "blog": [
        "https://blog.woodpecker.co/",
        "https://www.blog.woodpecker.co"
      ],
      "partner": [
        "https://woodpecker.co/landings/partner-program/"
      ]
    },
    "social": {
      "twitter": [
        "https://twitter.com/woodpeckerapp"
      ],
      "facebook": [
        "https://www.facebook.com/woodpeckerapp"
      ],
      "youtube": [],
      "instagram": [],
      "linkedin": [
        "https://www.linkedin.com/company/woodpecker-co"
      ],
      "github": [],
      "clutch": []
    },
    "tech": [
      "wordpress"
    ]
  },
  "domain": {
    "emailProvider": {
      "name": "google.com",
      "free": "no",
      "disposable": "unknown"
    }
  }
}

Please note tht if any information will be missing it can be replaced with null or [] in the response.

batch api

curl 'https://api.getowl.co/v1/query/batch?api-key=YOUR-API-KEY' \
            -d '{"queries":["woodpecker.co", "google.com"]}' \
            -H 'content-type: application/json'
        

[
  {"id":"5e8e1d7fa4b89d0001effc7a","q":"woodpecker.co"},
  {"id":"5e8e1d7fa4b89d0001effc7b","q":"google.com"}
]
        

curl 'https://api.getowl.co/v1/query/5e8e1d7fa4b89d0001effc7a/profile?api-key=YOUR-API-KEY'
        

error handling

Please prepare API integration to handle standard HTTP status codes, especially for those cases:

service unavailable

{"status":503,"error":"Service Unavailable","message":"Service Unavailable"}

Retry in a couple of seconds should solve the issue.

not enough search credits

{"status":403,"error":"Forbidden","message":"limit has been reached"}

Contact with Owl Team will be needed to increase the limits.