{"info":{"_postman_id":"5245bced-2000-4842-95fc-0d71ca1702e0","name":"Find82 API Documentation","description":"

This is the API Documentation for the Find82 API that allows for finding lead.

The Find82 API provides many API products, tools, and resources that enable you to find lead faster and cheaper.

For more information on Find82 or to try it for free go to Find82.com

Getting started guide

You must use a valid API Key to send requests to the API endpoints. Go to your Find82.com portal to access.
\n
The API has rate and usage limits.
\n
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\n
The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\n

Authentication

Find82 uses API keys for authentication. You can generate a Find82 API key in the API keys section of your Find82 account settings.

You must include an API key in each request to the Postman API with the X-Api-Key request header.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access rate limits apply at a per-API key basis in unit time. The limit is 30 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
`X-RateLimit-Limit`	The maximum number of requests that the consumer is permitted to make per minute.
`X-RateLimit-Remaining`	The number of requests remaining in the current rate limit window.
`X-RateLimit-Reset`	The time at which the current rate limit window resets in UTC epoch seconds.

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

Need some help?

In case you have questions, go through our tutorials. Or visit our FAQ page.

Or you can check out our community forum, there’s a good chance our community has an answer for you. Visit our developer forum ((link to developer forum)) to review topics, ask questions, and learn from others.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27927892","collectionId":"5245bced-2000-4842-95fc-0d71ca1702e0","publishedId":"2s9Yyv9z4x","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0299b9"},"publishDate":"2024-02-01T21:01:57.000Z"},"item":[{"name":"Lead Listener","item":[{"name":"Get material","event":[{"listen":"test","script":{"id":"269adbc4-4c87-44e3-98ce-f5bd91fc8147","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9a35d055-e526-412e-8399-6023bfaf2bbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"api-key","value":"your-api-key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"

audio file in .wav, mp3, or m4a format

\n","type":"file","src":"postman-cloud:///1ef90bd8-27dd-4cc0-a439-bcda0cf01d79"}]},"url":"https://api.find82.com/v3/get-material","description":"

Creates a request to the Lead Listener API to analyze a file for lead.

audio file in .wav, mp3, or m4a format

\n","type":"file","src":"postman-cloud:///1ef90bd8-27dd-4cc0-a439-bcda0cf01d79"}]},"url":"https://api.find82.com/v3/is-lead","description":"

Creates a request to the Lead Listener API to analyze a file for lead.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"5245bced-2000-4842-95fc-0d71ca1702e0","id":"5245bced-2000-4842-95fc-0d71ca1702e0","name":"Find82 API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","is-lead"],"host":["api","find82","com"],"query":[],"variable":[]}},"response":[{"id":"7a693841-cdf8-45f7-938c-aafe581b46a1","name":"Successful Response Lead","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"your-api-key","description":"Sign up at find82.com to get your api key.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"audio file in .wav, mp3, or m4a format","type":"file","src":"postman-cloud:///1ef90bd8-27dd-4cc0-a439-bcda0cf01d79"}],"options":{"raw":{"language":"json"}}},"url":"https://api.find82.com/v3/is-lead"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"is_lead\": {\n \"value\": true,\n \"confidence\": 0.9\n }\n}"},{"id":"2c932c62-9b82-4aab-99ae-08ec5dd77c31","name":"Successful Response Not Lead","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"your-api-key","description":"Sign up at find82.com to get your api key.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"audio file in .wav, mp3, or m4a format","type":"file","src":"postman-cloud:///1ef90bd8-27dd-4cc0-a439-bcda0cf01d79"}],"options":{"raw":{"language":"json"}}},"url":"https://api.find82.com/v3/is-lead"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"is_lead\": {\n \"value\": false,\n \"confidence\": 0.9\n }\n}"}],"_postman_id":"9eb34e24-5032-474b-aa47-50d80bb6acab"},{"name":"Is Segmented","event":[{"listen":"test","script":{"id":"269adbc4-4c87-44e3-98ce-f5bd91fc8147","exec":[""],"type":"text/javascript","packages":{}}}],"id":"496fea75-826d-4adc-aaae-a95a06220f41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"api-key","value":"your-api-key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"

audio file in .wav, mp3, or m4a format

\n","type":"file","src":"postman-cloud:///1ef90bd8-27dd-4cc0-a439-bcda0cf01d79"}]},"url":"https://api.find82.com/v3/is-segmented","description":"

Creates a request to the Lead Listener API to analyze a file for lead.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"5245bced-2000-4842-95fc-0d71ca1702e0","id":"5245bced-2000-4842-95fc-0d71ca1702e0","name":"Find82 API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","is-segmented"],"host":["api","find82","com"],"query":[],"variable":[]}},"response":[{"id":"f51b0d93-025e-40b8-950f-d6e376afc579","name":"Successful Response Is Segmented","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"your-api-key","description":"Sign up at find82.com to get your api key.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"audio file in .wav, mp3, or m4a format","type":"file","src":"postman-cloud:///1ef90bd8-27dd-4cc0-a439-bcda0cf01d79"}],"options":{"raw":{"language":"json"}}},"url":"https://api.find82.com/v3/is-segmented"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"is_segmented\": {\n \"value\": true,\n \"confidence\": 0.9\n }\n}"},{"id":"2edfc374-9f16-4f34-a635-9b6ff1d0472e","name":"Successful Response No Joint","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"your-api-key","description":"Sign up at find82.com to get your api key.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"audio file in .wav, mp3, or m4a format","type":"file","src":"postman-cloud:///1ef90bd8-27dd-4cc0-a439-bcda0cf01d79"}],"options":{"raw":{"language":"json"}}},"url":"https://api.find82.com/v3/is-segmented"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"is_segmented\": {\n \"value\": false,\n \"confidence\": 0.9\n }\n}"}],"_postman_id":"496fea75-826d-4adc-aaae-a95a06220f41"}],"id":"59a18a33-47e9-4748-8c1d-96dcb40a0892","description":"

The Lead Listener endpoints let you use and manage models that allow for the identification of lead in water service line using sound from tapping on the exposed parts of a pipe.

\n","_postman_id":"59a18a33-47e9-4748-8c1d-96dcb40a0892","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"5245bced-2000-4842-95fc-0d71ca1702e0","id":"5245bced-2000-4842-95fc-0d71ca1702e0","name":"Find82 API Documentation","type":"collection"}}},{"name":"User","item":[{"name":"Get authenticated user","event":[{"listen":"test","script":{"id":"270f012a-e081-49cb-9bb2-0467c987cc6c","exec":[""],"type":"text/javascript"}}],"id":"dfae7ed4-7fc5-48fb-80fd-df3ceb039a5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"api_key\": \"YOUR_API_KEY_HERE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://the-normal-company-find82api--endpoints.modal.run/api-key/api-key-info","description":"

Gets information about the authenticated user.

The /api-key endpoints let you manage information about the authenticated user and get API useage information.

\n","_postman_id":"55b1bea2-982a-43d0-bd27-5abcf0b8b02e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"5245bced-2000-4842-95fc-0d71ca1702e0","id":"5245bced-2000-4842-95fc-0d71ca1702e0","name":"Find82 API Documentation","type":"collection"}}},{"name":"Logs","item":[{"name":"Get user logs","event":[{"listen":"test","script":{"id":"abd6a99c-ba04-4f2e-8cc8-4b0bda9b17c0","exec":[""],"type":"text/javascript"}}],"id":"76bf5d0e-10af-476f-afca-ba316acd439c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"api_key\": \"YOUR_API_KEY_HERE\",\r\n \"date\": \"START_DATE_(YYYY-MM-DD)\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://the-normal-company-find82api--endpoints.modal.run/logs/api-calls","description":"

Gets information about the authenticated user.

The /logs endpoints let you manage information about the api calls and get past results.

\n","_postman_id":"68424f03-b3ce-43cf-b7b5-ddd9fa294772","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"5245bced-2000-4842-95fc-0d71ca1702e0","id":"5245bced-2000-4842-95fc-0d71ca1702e0","name":"Find82 API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"id":"5d81b02b-ccba-4db4-851b-eaf28be047f4","key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}