Piloterr

NPI Search

GET
/v2/npi/search

Search the NPPES NPI registry by person name, organization, or 10-digit NPI. With NPI-2, a text query is the organization name. total_results is null, and next is set only when the page is full.

Credit cost: 1 credit per call

Autorização

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parâmetros de consulta

query?string

Optional when another criterion is set. Example: Anthony Fauci. Also a 10-digit NPI such as 1972813608, or an NPPES search URL. With enumeration_type=NPI-2 this text is the organization name, for example Mayo Clinic. A provider-view URL is rejected here.

first_name?string

Optional. Example: Anthony. Used as the given name when you do not want query to be split.

last_name?string

Optional. Example: Fauci. A single-word query such as Smith is used as the last name.

organization_name?string

Optional. Example: Mayo Clinic. You can also pass that name in query with enumeration_type=NPI-2.

city?string

Optional. Practice city. Example: Washington.

state?string

Optional. Two-letter state code. Example: DC. Any other value is rejected.

postal_code?string

Optional. Postal code. Example: 20016.

taxonomy?string

Optional. Taxonomy description. Example: Internal Medicine.

enumeration_type?string

Optional. NPI-1 for a person or NPI-2 for an organization. Example: NPI-2. NPI-2 treats a text query as an organization name.

page?number

Optional. Page number, starting at 1. Example: 2. Defaults to 1.

limit?number

Optional. Page size. Example: 10. Defaults to 10 and cannot exceed 200. next is a URL only when the page contains this many rows.

Corpo da resposta

Successful response

application/json
  1. response
results?array<>
pagination?
Example Request
curl -X GET 'https://api.piloterr.com/v2/npi/search'
Example Response
{  "results": [    {      "npi": "1972813608",      "url": "https://npiregistry.cms.hhs.gov/provider-view/1972813608",      "city": "WASHINGTON",      "name": "Dr. ANTHONY STEPHEN FAUCI",      "phone": "301-496-2263",      "state": "DC",      "status": "A",      "address": "3012 - 43RD STREET, N.W.",      "taxonomy": "Internal Medicine, Infectious Disease",      "last_name": "FAUCI",      "credential": "M.D.",      "first_name": "ANTHONY",      "middle_name": "STEPHEN",      "postal_code": "200163547",      "taxonomy_code": "207RI0200X",      "enumeration_date": "2010-10-15",      "enumeration_type": "NPI-1",      "organization_name": null    }  ],  "pagination": {    "next": null,    "page": 1,    "per_page": 10,    "total_pages": null,    "total_results": null  }}