NAV
315-370-3089

Introduction

Welcome to the MPIRICA API! You can use our API to access API endpoints, which can get information on various hospitals, procedures and doctors in our database.

All requests must use the application/vnd.api+json Accept without media type parameters.

Authentication

To authenticate, use this code:

# With shell, you can just pass the correct header with each request
curl "/api.mpirica.com/api/v1"
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1cmwiOiJodHRwOi8vYml0Lmx5LzE5YkNUSXMifQ.W1ghuxpzA_LbXMOJYB9uE54z5V4molsFexuzetuGSgk"
  -H "Accept: application/vnd.api+json"

Make sure to put an API Key available on your MPIRICA Profile Page.

MPIRICA API expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer <MPIRICA API Key>

Doctors

Get All Doctors

curl "/api.mpirica.com/api/v1/doctors"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000033356",
      "type": "doctors",
      "links": {
        "self": "/api.mpirica.com/api/v1/doctors/000000033356"
      },
      "attributes": {
        "npi": "1780645531",
        "slug": "johnson-craig",
        "name": "Craig Johnson",
        "specialties": [
          {
            "reference": "000000000002",
            "name": "Physician/General Surgery",
            "primary": true
          }
        ]
      }
    },
    ...
  ],
  "meta": {
    "record-count": 29330
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/doctors?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/doctors?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/doctors?page%5Blimit%5D=10&page%5Boffset%5D=29320"
  }
}

This endpoint retrieves all doctors.

HTTP Request

GET /api.mpirica.com/api/v1/doctors

Filtering

Parameter Default Supported values Description
filter[query] Filters doctors which names loosely matches the given query

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, npi, slug, name Sort by given parameter. Prepend - (minus) sign, to force descending order
curl -g "/api.mpirica.com/api/v1/doctors?filter[query]=steven&page[offset]=1&page[limit]=1&sort=-name"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000054998",
      "type": "doctors",
      "links": {
        "self": "/api.mpirica.com/api/v1/doctors/000000054998"
      },
      "attributes": {
        "npi": "1306908223",
        "slug": "zelko-steven",
        "name": "Steven Zelko",
        "specialties": [
          {
            "reference": "000000000018",
            "name": "Physician/Ophthalmology",
            "primary": true
          }
        ]
      }
    }
  ],
  "meta": {
    "record-count": 410
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/doctors?filter%5Bquery%5D=steven&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-name",
    "prev": "/api.mpirica.com/api/v1/doctors?filter%5Bquery%5D=steven&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-name",
    "next": "/api.mpirica.com/api/v1/doctors?filter%5Bquery%5D=steven&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-name",
    "last": "/api.mpirica.com/api/v1/doctors?filter%5Bquery%5D=steven&page%5Blimit%5D=1&page%5Boffset%5D=409&sort=-name"
  }
}

Get a Specific Doctor

curl "/api.mpirica.com/api/v1/doctors/000000054998"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000054998",
    "type": "doctors",
    "links": {
      "self": "/api.mpirica.com/api/v1/doctors/000000054998"
    },
    "attributes": {
      "npi": "1306908223",
      "slug": "zelko-steven",
      "name": "Steven Zelko",
      "specialties": [
        {
          "reference": "000000000018",
          "name": "Physician/Ophthalmology",
          "primary": true
        }
      ]
    }
  }
}

This endpoint retrieves a specific doctor.

HTTP Request

GET /api.mpirica.com/api/v1/doctors/<ID>

URL Parameters

Parameter Description
ID The ID of the doctor to retrieve

Hospitals

Get All Hospitals

curl "/api.mpirica.com/api/v1/hospitals"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000013",
      "type": "hospitals",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospitals/000000000013"
      },
      "attributes": {
        "ccn": "010023",
        "slug": "baptist-medical-center-south",
        "name": "Baptist Medical Center South",
        "description": null,
        "address": "2105 East South Boulevard",
        "zip": "36116",
        "city": "Montgomery",
        "state": "AL",
        "country": "USA",
        "phone": "3342882100",
        "url": null,
        "corporation": false
      }
    },
    ...
  ],
  "meta": {
    "record-count": 4914
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospitals?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/hospitals?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/hospitals?page%5Blimit%5D=10&page%5Boffset%5D=4904"
  }
}

This endpoint retrieves all hospitals.

HTTP Request

GET /api.mpirica.com/api/v1/hospitals

Filtering

Parameter Default Supported values Description
filter[query] Filters hospitals which names loosely matches the given query

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, ccn, slug, name, description, address, zip, city, state, country, phone, url Sort by given parameter. Prepend - (minus) sign, to force descending order
curl -g "/api.mpirica.com/api/v1/hospitals?filter[query]=evergreen&page[offset]=1&page[limit]=1&sort=-state"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000004547",
      "type": "hospitals",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospitals/000000004547"
      },
      "attributes": {
        "ccn": "500124",
        "slug": "evergreenhealth-medical-center",
        "name": "Evergreenhealth Medical Center",
        "description": null,
        "address": "12040 Ne 128th Street",
        "zip": "98034",
        "city": "Kirkland",
        "state": "WA",
        "country": "USA",
        "phone": "4258991000",
        "url": "/www.evergreenhealth.com/",
        "corporation": false
      }
    }
  ],
  "meta": {
    "record-count": 3
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospitals?filter%5Bquery%5D=evergreen&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-state",
    "prev": "/api.mpirica.com/api/v1/hospitals?filter%5Bquery%5D=evergreen&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-state",
    "next": "/api.mpirica.com/api/v1/hospitals?filter%5Bquery%5D=evergreen&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-state",
    "last": "/api.mpirica.com/api/v1/hospitals?filter%5Bquery%5D=evergreen&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-state"
  }
}

Get a Specific Hospital

curl "/api.mpirica.com/api/v1/hospitals/000000000018"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000000018",
    "type": "hospitals",
    "links": {
      "self": "/api.mpirica.com/api/v1/hospitals/000000000018"
    },
    "attributes": {
      "ccn": "010033",
      "slug": "university-of-alabama-hospital",
      "name": "University Of Alabama Hospital",
      "description": null,
      "address": "619 South 19th Street",
      "zip": "35233",
      "city": "Birmingham",
      "state": "AL",
      "country": "USA",
      "phone": "2059344011",
      "url": null,
      "corporation": false
    }
  }
}

This endpoint retrieves a specific hospital.

HTTP Request

GET /api.mpirica.com/api/v1/hospitals/<ID>

URL Parameters

Parameter Description
ID The ID of the hospital to retrieve

Procedures

Get All Procedures

curl "/api.mpirica.com/api/v1/procedures"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000030",
      "type": "procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/procedures/000000000030"
      },
      "attributes": {
        "mpirica-code": "00000030",
        "slug": "endarterectomy-of-other-vessels-of-head-and-neck",
        "common-name": "Carotid Endarterectomy",
        "description": "Blood vessels can become narrowed or even obstructed through a build-up of fatty plaque on the walls lining the inside of arteries and veins. Plaque build-up in the arteries of the neck poses a particular risk of stroke, and can be addressed with several procedures. In an open Carotid Endarterectomy, the blockage is removed through an incision in the neck. The affected artery is accessed directly and the blockage is surgically removed. ",
        "name": "Carotid Endarterectomy",
        "group": "Endarterectomy of Head and Neck Vessel",
        "available": true
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000030/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/procedures/000000000030/surgical-category"
          }
        }
      }
    },
    ...
  ],
  "meta": {
    "record-count": 950
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/procedures?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/procedures?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/procedures?page%5Blimit%5D=10&page%5Boffset%5D=940"
  }
}

This endpoint retrieves all procedures.

HTTP Request

GET /api.mpirica.com/api/v1/procedures

Filtering

Parameter Default Supported values Description
filter[query] Filters procedures which names loosely matches the given query
filter[category_mpirica_code] Filters procedures by matching category MPIRICA code against it

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, mpirica-code, slug, common-name, description Sort by given parameter. Prepend - (minus) sign, to force descending order

Inclusions

Parameter Default Supported values Description
include surgical-category Include references under incldued key
curl -g "/api.mpirica.com/api/v1/procedures?filter[query]=knee+replacement&page[offset]=1&page[limit]=1&include=surgical-category&sort=-common-name"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000306",
      "type": "procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/procedures/000000000306"
      },
      "attributes": {
        "mpirica-code": "00000306",
        "slug": "revision-surgery-for-previous-knee-replacement",
        "common-name": "Revision Surgery for Previous Knee Replacement",
        "description": "Replacement of a previously placed artificial knee joint with a new mechanical artificial joint.",
        "name": "Revision Surgery for Previous Knee Replacement",
        "group": "Revision of Knee Replacement",
        "available": true
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000306/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/procedures/000000000306/surgical-category"
          },
          "data": {
            "type": "surgical-categories",
            "id": "000000000230"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "000000000230",
      "type": "surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-categories/000000000230"
      },
      "attributes": {
        "mpirica-code": "00000230",
        "slug": "revision-of-knee-replacement",
        "name": "Revision of Knee Replacement"
      }
    }
  ],
  "meta": {
    "record-count": 3
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-common-name",
    "prev": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-common-name",
    "next": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-common-name",
    "last": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-common-name"
  }
}

Get a Specific Procedure

curl "/api.mpirica.com/api/v1/procedures/000000000306"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000000306",
    "type": "procedures",
    "links": {
      "self": "/api.mpirica.com/api/v1/procedures/000000000306"
    },
    "attributes": {
      "mpirica-code": "00000306",
      "slug": "revision-surgery-for-previous-knee-replacement",
      "common-name": "Revision Surgery for Previous Knee Replacement",
      "description": "Replacement of a previously placed artificial knee joint with a new mechanical artificial joint.",
      "name": "Revision Surgery for Previous Knee Replacement",
      "group": "Revision of Knee Replacement",
      "available": true
    },
    "relationships": {
      "surgical-category": {
        "links": {
          "self": "/api.mpirica.com/api/v1/procedures/000000000306/relationships/surgical-category",
          "related": "/api.mpirica.com/api/v1/procedures/000000000306/surgical-category"
        }
      }
    }
  }
}

This endpoint retrieves a specific procedure.

HTTP Request

GET /api.mpirica.com/api/v1/procedures/<ID>

URL Parameters

Parameter Description
ID The ID of the procedure to retrieve

Inclusions

Parameter Default Supported values Description
include surgical-category Include references under incldued key

Surgical Categories

Get All Surgical Categories

curl "/api.mpirica.com/api/v1/surgical-categories"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000013",
      "type": "surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-categories/000000000013"
      },
      "attributes": {
        "mpirica-code": "00000013",
        "slug": "foot-and-toe-surgery-open",
        "name": "Foot and Toe Surgery (Open)"
      }
    },
    ...
  ],
  "meta": {
    "record-count": 105
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=95"
  }
}

This endpoint retrieves all surgical categories.

HTTP Request

GET /api.mpirica.com/api/v1/surgical-categories

Filtering

Parameter Default Supported values Description
filter[query] Filters surgical categories which names loosely matches the given query

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, mpirica-code, slug, name Sort by given parameter. Prepend - (minus) sign, to force descending order
curl -g "/api.mpirica.com/api/v1/surgical-categories?filter[query]=surgery&page[offset]=1&page[limit]=1&sort=-name"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000025",
      "type": "surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-categories/000000000025"
      },
      "attributes": {
        "mpirica-code": "00000025",
        "slug": "forearm-and-wrist-fracture-or-dislocation-surgery-open",
        "name": "Forearm and Wrist Fracture or Dislocation Surgery (Open)"
      }
    }
  ],
  "meta": {
    "record-count": 13
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/surgical-categories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-name",
    "prev": "/api.mpirica.com/api/v1/surgical-categories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-name",
    "next": "/api.mpirica.com/api/v1/surgical-categories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-name",
    "last": "/api.mpirica.com/api/v1/surgical-categories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=12&sort=-name"
  }
}

Get a Specific Surgical Category

curl "/api.mpirica.com/api/v1/surgical-categories/000000000001"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000000001",
    "type": "surgical-categories",
    "links": {
      "self": "/api.mpirica.com/api/v1/surgical-categories/000000000001"
    },
    "attributes": {
      "mpirica-code": "000000000001",
      "slug": "eye-surgery",
      "name": "Eye Surgery"
    }
  }
}

This endpoint retrieves a specific surgical category.

HTTP Request

GET /api.mpirica.com/api/v1/surgical-categories/<ID>

URL Parameters

Parameter Description
ID The ID of the surgical category to retrieve

Surgical Subcategories

Get All Surgical Subcategories

curl "/api.mpirica.com/api/v1/surgical-subcategories"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000013",
      "type": "surgical-subcategories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-subcategories/000000000013"
      },
      "attributes": {
        "mpirica-code": "00000013",
        "slug": "foot-and-toe-surgery-open",
        "name": "Foot and Toe Surgery (Open)"
      }
    },
    ...
  ],
  "meta": {
    "record-count": 105
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/surgical-subcategories?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/surgical-subcategories?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/surgical-subcategories?page%5Blimit%5D=10&page%5Boffset%5D=95"
  }
}

This endpoint retrieves all surgical subcategories.

HTTP Request

GET /api.mpirica.com/api/v1/surgical-subcategories

Filtering

Parameter Default Supported values Description
filter[query] Filters surgical subcategories which names loosely matches the given query

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, mpirica-code, slug, name Sort by given parameter. Prepend - (minus) sign, to force descending order
curl -g "/api.mpirica.com/api/v1/surgical-subcategories?filter[query]=surgery&page[offset]=1&page[limit]=1&sort=-name"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000025",
      "type": "surgical-subcategories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-subcategories/000000000025"
      },
      "attributes": {
        "mpirica-code": "00000025",
        "slug": "forearm-and-wrist-fracture-or-dislocation-surgery-open",
        "name": "Forearm and Wrist Fracture or Dislocation Surgery (Open)"
      }
    }
  ],
  "meta": {
    "record-count": 13
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/surgical-subcategories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-name",
    "prev": "/api.mpirica.com/api/v1/surgical-subcategories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-name",
    "next": "/api.mpirica.com/api/v1/surgical-subcategories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-name",
    "last": "/api.mpirica.com/api/v1/surgical-subcategories?filter%5Bquery%5D=surgery&page%5Blimit%5D=1&page%5Boffset%5D=12&sort=-name"
  }
}

Get a Specific Surgical Subcategory

curl "/api.mpirica.com/api/v1/surgical-subcategories/000000000025"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000000025",
    "type": "surgical-subcategories",
    "links": {
      "self": "/api.mpirica.com/api/v1/surgical-subcategories/000000000025"
    },
    "attributes": {
      "mpirica-code": "00000025",
      "slug": "forearm-and-wrist-fracture-or-dislocation-surgery-open",
      "name": "Forearm and Wrist Fracture or Dislocation Surgery (Open)"
    }
  }
}

This endpoint retrieves a specific surgical subcategory.

HTTP Request

GET /api.mpirica.com/api/v1/surgical-subcategories/<ID>

URL Parameters

Parameter Description
ID The ID of the surgical subcategory to retrieve

Doctor-Procedure pairs

Get All Doctor-Procedure pairs

curl "/api.mpirica.com/api/v1/doctor-procedures"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000195-000000000303-medicare-billed",
      "type": "doctor-procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed"
      },
      "attributes": {
        "score": {
          "value": 460
        },
        "price": {
          "value": 50261.29,
          "health_plan_slug": "medicare-billed",
          "in_network": true,
          "copayment_due": true,
          "bundle_offered": false
        },
        "hospitals": [
          {
            "data": {
              "id": "000000004554",
              "type": "hospitals",
              "links": {
                "self": "/api.mpirica.com/api/v1/hospitals/000000004554"
              },
              "attributes": {
                "ccn": "500151",
                "slug": "st-anthony-hospital-2",
                "name": "St Anthony Hospital",
                "description": null,
                "address": "11567 Canterwood Boulevard Nw",
                "zip": "98332",
                "city": "Gig Harbor",
                "state": "WA",
                "country": "USA",
                "phone": "2535302050",
                "url": "/www.chifranciscan.org/St-Anthony-Hospital/",
                "corporation": false,
                "score": {
                  "value": 795
                }
              }
            }
          }]
      },
      "relationships": {
        "procedure": {
          "links": {
            "self": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/relationships/procedure",
            "related": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/procedure"
          }
        },
        "doctor": {
          "links": {
            "self": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/relationships/doctor",
            "related": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/doctor"
          }
        }
      }
    },
    ...
  ],
  "meta": {
    "record-count": 976
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/doctor-procedures?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/doctor-procedures?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/doctor-procedures?page%5Blimit%5D=10&page%5Boffset%5D=966"
  }
}

This endpoint retrieves all doctor-procedure pairs.

HTTP Request

GET /api.mpirica.com/api/v1/doctor-procedures

Filtering

Parameter Default Supported values Description
filter[location] Filters doctor-procedure pairs by matching a doctor location. City, state and zip codes are allowed
filter[procedure_mpirica_code] Filters doctor-procedure pairs by matching procedure MPIRICA code against it
filter[category_mpirica_code] Filters doctor-procedure pairs by matching category MPIRICA code against it
filter[query] Filters doctor-procedure pairs by matching both doctor and procedure name against it
filter[radius] Filters doctor-procedure pairs location within given radius. Allowed values are: 10, 20, 50, 100, 250 and 500 miles

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, score.value, price.value Sort by given parameter. Prepend - (minus) sign, to force descending order

Inclusions

Parameter Default Supported values Description
include doctor, procedure Include references under incldued key
curl -g "/api.mpirica.com/api/v1/doctor-procedures?&filter[query]=kurt&filter[procedure_mpirica_code]=00000305&filter[location]=Pensacola+FL&filter[radius]=10&page[offset]=0&page[limit]=1&sort=-score.value,price.value&include=doctor,procedure"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000027215-000000000305-medicare-billed",
      "type": "doctor-procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/doctor-procedures/000000027215-000000000305-medicare-billed"
      },
      "attributes": {
        "score": {
          "value": 655
        },
        "price": {
          "value": 41511.95,
          "health_plan_slug": "medicare-billed",
          "in_network": true,
          "copayment_due": true,
          "bundle_offered": false
        },
        "hospitals": [
          {
            "data": {
              "id": "000000000757",
              "type": "hospitals",
              "links": {
                "self": "/api.mpirica.com/api/v1/hospitals/000000000757"
              },
              "attributes": {
                "ccn": "100025",
                "slug": "sacred-heart-hospital",
                "name": "Sacred Heart Hospital",
                "description": null,
                "address": "5151 N 9th Ave",
                "zip": "32504",
                "city": "Pensacola",
                "state": "FL",
                "country": "USA",
                "phone": "8504167000",
                "url": "/www.sacred-heart.org",
                "corporation": false,
                "score": {
                  "value": 795
                }
              }
            }
          }
        ]
      },
      "relationships": {
        "procedure": {
          "links": {
            "self": "/api.mpirica.com/api/v1/doctor-procedures/000000027215-000000000305-medicare-billed/relationships/procedure",
            "related": "/api.mpirica.com/api/v1/doctor-procedures/000000027215-000000000305-medicare-billed/procedure"
          },
          "data": {
            "type": "procedures",
            "id": "000000000305"
          }
        },
        "doctor": {
          "links": {
            "self": "/api.mpirica.com/api/v1/doctor-procedures/000000027215-000000000305-medicare-billed/relationships/doctor",
            "related": "/api.mpirica.com/api/v1/doctor-procedures/000000027215-000000000305-medicare-billed/doctor"
          },
          "data": {
            "type": "doctors",
            "id": "000000027215"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "000000000305",
      "type": "procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/procedures/000000000305"
      },
      "attributes": {
        "mpirica-code": "00000305",
        "slug": "total-knee-replacement",
        "common-name": "Knee Replacement",
        "description": "Replacement of a diseased knee joint with a artificial joint.",
        "name": "Knee Replacement",
        "group": "Knee Replacement",
        "available": true
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000305/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/procedures/000000000305/surgical-category"
          }
        },
        "surgical-subcategory": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000305/relationships/surgical-subcategory",
            "related": "/api.mpirica.com/api/v1/procedures/000000000305/surgical-subcategory"
          }
        }
      }
    },
    {
      "id": "000000027215",
      "type": "doctors",
      "links": {
        "self": "/api.mpirica.com/api/v1/doctors/000000027215"
      },
      "attributes": {
        "npi": "1639354624",
        "slug": "morrison-kurt",
        "name": "Kurt Morrison",
        "specialties": [
          {
            "reference": "000000000020",
            "name": "Physician/Orthopedic Surgery",
            "primary": true
          }
        ]
      }
    }
  ],
  "meta": {
    "record-count": 1
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/doctor-procedures?filter%5Blocation%5D=Pensacola+FL&filter%5Bprocedure_mpirica_code%5D=00000305&filter%5Bquery%5D=kurt&filter%5Bradius%5D=10&include=doctor%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value%2Cprice.value",
    "last": "/api.mpirica.com/api/v1/doctor-procedures?filter%5Blocation%5D=Pensacola+FL&filter%5Bprocedure_mpirica_code%5D=00000305&filter%5Bquery%5D=kurt&filter%5Bradius%5D=10&include=doctor%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value%2Cprice.value"
  }
}

Get a Specific Doctor-Procedure pair

curl "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000000195-000000000303-medicare-billed",
    "type": "doctor-procedures",
    "links": {
      "self": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed"
    },
    "attributes": {
      "score": {
        "value": 555
      },
      "price": {
        "value": 55555.29,
        "health_plan_slug": "medicare-billed",
        "in_network": true,
        "copayment_due": true,
        "bundle_offered": false
      },
      "hospitals": [
        {
          "data": {
            "id": "000000004554",
            "type": "hospitals",
            "links": {
              "self": "/api.mpirica.com/api/v1/hospitals/000000004554"
            },
            "attributes": {
              "ccn": "500151",
              "slug": "st-anthony-hospital-2",
              "name": "St Anthony Hospital",
              "description": null,
              "address": "11567 Canterwood Boulevard Nw",
              "zip": "98332",
              "city": "Gig Harbor",
              "state": "WA",
              "country": "USA",
              "phone": "2535302050",
              "url": "/www.chifranciscan.org/St-Anthony-Hospital/",
              "corporation": false,
              "score": {
                "value": 795
              }
            }
          }
        }]
    },
    "relationships": {
      "procedure": {
        "links": {
          "self": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/relationships/procedure",
          "related": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/procedure"
        }
      },
      "doctor": {
        "links": {
          "self": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/relationships/doctor",
          "related": "/api.mpirica.com/api/v1/doctor-procedures/000000000195-000000000303-medicare-billed/doctor"
        }
      }
    }
  }
}

This endpoint retrieves a specific doctor-procedure pair.

HTTP Request

GET /api.mpirica.com/api/v1/doctor-procedures/<ID>

URL Parameters

Parameter Description
ID The ID of the doctor to retrieve

Inclusions

Parameter Default Supported values Description
include doctor, procedure Include references under incldued key

Hospital-Procedure pairs

Get All Hospital-Procedure pairs

curl "/api.mpirica.com/api/v1/hospital-procedures"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000003856-000000000073-medicare-billed",
      "type": "hospital-procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospital-procedures/000000003856-000000000073-medicare-billed"
      },
      "attributes": {
        "score": {
          "value": 555
        },
        "price": {
          "value": 52222.97,
          "health_plan_slug": "medicare-billed",
          "in_network": true,
          "copayment_due": true,
          "bundle_offered": false
        },
         "doctors": [
            {
              "data": {
                "id": "000000028254",
                "type": "doctors",
                "links": {
                  "self": "/api.mpirica.com/api/v1/doctors/000000028254"
                },
                "attributes": {
                  "npi": "1669436200",
                  "slug": "garcia-evelio",
                  "name": "Evelio Garcia",
                  "specialties": [
                    {
                      "reference": "000000000006",
                      "name": "Physician/Cardiovascular Disease (Cardiology)",
                      "primary": true
                    }
                  ]
                }
              }
            }
          ]
      },
      "relationships": {
        "procedure": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-procedures/000000003856-000000000073-medicare-billed/relationships/procedure",
            "related": "/api.mpirica.com/api/v1/hospital-procedures/000000003856-000000000073-medicare-billed/procedure"
          }
        },
        "hospital": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-procedures/000000003856-000000000073-medicare-billed/relationships/hospital",
            "related": "/api.mpirica.com/api/v1/hospital-procedures/000000003856-000000000073-medicare-billed/hospital"
          }
        }
      }
    },
    ...
  ],
  "meta": {
    "record-count": 27663
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospital-procedures?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/hospital-procedures?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/hospital-procedures?page%5Blimit%5D=10&page%5Boffset%5D=27653"
  }
}
curl -g "/api.mpirica.com/api/v1/hospital-procedures?&filter[query]=sacred&filter[procedure_mpirica_code]=00000305&filter[location]=Pensacola+FL&filter[radius]=10&page[offset]=0&page[limit]=1&sort=-score.value,price.value&include=hospital,procedure"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000757-000000000305-medicare-billed",
      "type": "hospital-procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospital-procedures/000000000757-000000000305-medicare-billed"
      },
      "attributes": {
        "score": {
          "value": 655
        },
        "price": {
          "value": 5321.19,
          "health_plan_slug": "medicare-billed",
          "in_network": true,
          "copayment_due": true,
          "bundle_offered": false
        },
        "doctors": [
          {
            "data": {
              "id": "000000027215",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000027215"
              },
              "attributes": {
                "npi": "1639354624",
                "slug": "morrison-kurt",
                "name": "Kurt Morrison",
                "specialties": [
                  {
                    "reference": "000000000020",
                    "name": "Physician/Orthopedic Surgery",
                    "primary": true
                  }
                ]
              }
            }
          },
         ...
        ]
      },
      "relationships": {
        "procedure": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-procedures/000000000757-000000000305-medicare-billed/relationships/procedure",
            "related": "/api.mpirica.com/api/v1/hospital-procedures/000000000757-000000000305-medicare-billed/procedure"
          },
          "data": {
            "type": "procedures",
            "id": "000000000305"
          }
        },
        "hospital": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-procedures/000000000757-000000000305-medicare-billed/relationships/hospital",
            "related": "/api.mpirica.com/api/v1/hospital-procedures/000000000757-000000000305-medicare-billed/hospital"
          },
          "data": {
            "type": "hospitals",
            "id": "000000000757"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "000000000305",
      "type": "procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/procedures/000000000305"
      },
      "attributes": {
        "mpirica-code": "00000305",
        "slug": "total-knee-replacement",
        "common-name": "Knee Replacement",
        "description": "Replacement of a diseased knee joint with a artificial joint.",
        "name": "Knee Replacement",
        "group": "Knee Replacement",
        "available": true
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000305/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/procedures/000000000305/surgical-category"
          }
        },
        "surgical-subcategory": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000305/relationships/surgical-subcategory",
            "related": "/api.mpirica.com/api/v1/procedures/000000000305/surgical-subcategory"
          }
        }
      }
    },
    {
      "id": "000000000757",
      "type": "hospitals",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospitals/000000000757"
      },
      "attributes": {
        "ccn": "100025",
        "slug": "sacred-heart-hospital",
        "name": "Sacred Heart Hospital",
        "description": null,
        "address": "5151 N 9th Ave",
        "zip": "32504",
        "city": "Pensacola",
        "state": "FL",
        "country": "USA",
        "phone": "8504167000",
        "url": "/www.sacred-heart.org",
        "corporation": false
      }
    }
  ],
  "meta": {
    "record-count": 1
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospital-procedures?filter%5Blocation%5D=Pensacola+FL&filter%5Bprocedure_mpirica_code%5D=00000305&filter%5Bquery%5D=sacred&filter%5Bradius%5D=10&include=hospital%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value%2Cprice.value",
    "last": "/api.mpirica.com/api/v1/hospital-procedures?filter%5Blocation%5D=Pensacola+FL&filter%5Bprocedure_mpirica_code%5D=00000305&filter%5Bquery%5D=sacred&filter%5Bradius%5D=10&include=hospital%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value%2Cprice.value"
  }
}

This endpoint retrieves all hospital-procedure pairs.

HTTP Request

GET /api.mpirica.com/api/v1/hospital-procedures

Filtering

Parameter Default Supported values Description
filter[location] Filters hospital-procedure pairs by matching a hospital location. City, state and zip codes are allowed
filter[procedure_mpirica_code] Filters hospital-procedure pairs by matching procedure MPIRICA code against it
filter[category_mpirica_code] Filters hospital-procedure pairs by matching category MPIRICA code against it
filter[query] Filters hospital-procedure pairs by matching both hospital and procedure name against it
filter[radius] Filters hospital-procedure pairs location within given radius. Allowed values are: 10, 20, 50, 100, 250 and 500 miles

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, score.value, price.value Sort by given parameter. Prepend - (minus) sign, to force descending order

Inclusions

Parameter Default Supported values Description
include hospital, procedure Include references under incldued key
curl -g "/api.mpirica.com/api/v1/hospital-procedures?filter[query]=suburban+knee&filter[location]=Bethesda+MD&filter[radius]=10&page[offset]=1&page[limit]=1&sort=-score.value,price.value&include=hospital,procedure"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000001604-000000000306-medicare-billed",
      "type": "hospital-procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed"
      },
      "attributes": {
        "score": {
          "value": 555
        },
        "price": {
          "value": 33333.11,
          "health_plan_slug": "medicare-billed",
          "in_network": true,
          "copayment_due": true,
          "bundle_offered": false
        },
          "doctors": [
            {
              "data": {
                "id": "000000028254",
                "type": "doctors",
                "links": {
                  "self": "/api.mpirica.com/api/v1/doctors/000000028254"
                },
                "attributes": {
                  "npi": "1669436200",
                  "slug": "garcia-evelio",
                  "name": "Evelio Garcia",
                  "specialties": [
                    {
                      "reference": "000000000006",
                      "name": "Physician/Cardiovascular Disease (Cardiology)",
                      "primary": true
                    }
                  ]
                }
              }
            }
          ]
      },
      "relationships": {
        "procedure": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/relationships/procedure",
            "related": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/procedure"
          },
          "data": {
            "type": "procedures",
            "id": "000000000306"
          }
        },
        "hospital": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/relationships/hospital",
            "related": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/hospital"
          },
          "data": {
            "type": "hospitals",
            "id": "000000001604"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "000000000306",
      "type": "procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/procedures/000000000306"
      },
      "attributes": {
        "mpirica-code": "00000306",
        "slug": "revision-surgery-for-previous-knee-replacement",
        "common-name": "Revision Surgery for Previous Knee Replacement",
        "description": "Replacement of a previously placed artificial knee joint with a new mechanical artificial joint.",
        "name": "Revision Surgery for Previous Knee Replacement",
        "group": "Revision of Knee Replacement",
        "available": true
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000306/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/procedures/000000000306/surgical-category"
          }
        }
      }
    },
    {
      "id": "000000001604",
      "type": "hospitals",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospitals/000000001604"
      },
      "attributes": {
        "ccn": "170197",
        "slug": "kansas-medical-center-llc",
        "name": "Kansas Medical Center Llc",
        "description": null,
        "address": "1124 West 21st Street",
        "zip": "67002",
        "city": "Andover",
        "state": "KS",
        "country": "USA",
        "phone": "3163004000",
        "url": "/ksmedcenter.com/",
        "corporation": false
      }
    }
  ],
  "meta": {
    "record-count": 2678
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospital-procedures?filter%5Blocation%5D=Bethesda+MD&filter%5Bquery%5D=suburban+knee&filter%5Bradius%5D=10&include=hospital%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value%2Cprice.value",
    "prev": "/api.mpirica.com/api/v1/hospital-procedures?filter%5Blocation%5D=Bethesda+MD&filter%5Bquery%5D=suburban+knee&filter%5Bradius%5D=10&include=hospital%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value%2Cprice.value",
    "next": "/api.mpirica.com/api/v1/hospital-procedures?filter%5Blocation%5D=Bethesda+MD&filter%5Bquery%5D=suburban+knee&filter%5Bradius%5D=10&include=hospital%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-score.value%2Cprice.value",
    "last": "/api.mpirica.com/api/v1/hospital-procedures?filter%5Blocation%5D=Bethesda+MD&filter%5Bquery%5D=suburban+knee&filter%5Bradius%5D=10&include=hospital%2Cprocedure&page%5Blimit%5D=1&page%5Boffset%5D=34&sort=-score.value%2Cprice.value"
  }
}

Get a Specific Hospital-Procedure pair

curl "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000001604-000000000306-medicare-billed",
    "type": "hospital-procedures",
    "links": {
      "self": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed"
    },
    "attributes": {
      "score": {
        "value": 444
      },
      "price": {
        "value": 33333.11,
        "health_plan_slug": "medicare-billed",
        "in_network": true,
        "copayment_due": true,
        "bundle_offered": false
      },
      "doctors": [
          {
            "data": {
              "id": "000000034194",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000034194"
              },
              "attributes": {
                "npi": "1801837646",
                "slug": "joseph-james",
                "name": "James Joseph",
                "specialties": [
                  {
                    "reference": "000000000020",
                    "name": "Physician/Orthopedic Surgery",
                    "primary": true
                  }
                ]
              }
            }
          }
        ]
    },
    "relationships": {
      "procedure": {
        "links": {
          "self": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/relationships/procedure",
          "related": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/procedure"
        }
      },
      "hospital": {
        "links": {
          "self": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/relationships/hospital",
          "related": "/api.mpirica.com/api/v1/hospital-procedures/000000001604-000000000306-medicare-billed/hospital"
        }
      }
    }
  }
}

This endpoint retrieves a specific hospital-procedure pair.

HTTP Request

GET /api.mpirica.com/api/v1/hospital-procedures/<ID>

URL Parameters

Parameter Description
ID The ID of the hospital to retrieve

Inclusions

Parameter Default Supported values Description
include hospital, procedure Include references under incldued key

Doctor-Surgical-Category pairs

Get All Doctor-Surgical-Category pairs

curl "/api.mpirica.com/api/v1/doctor-surgical-categories"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
    "id": "000000000005-000000000040",
    "type": "doctor-surgical-categories",
    "links": {
        "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000000005-000000000040"
    },
    "attributes": {
      "score": {
        "value": 350
      },

        "hospitals": [
          {
            "data": {
              "id": "000000000034",
              "type": "hospitals",
              "links": {
                 "self": "/api.mpirica.com/api/v1/hospitals/000000000034"
                },
                "attributes": {
                  "ccn": "010056",
                  "slug": "st-vincents-birmingham",
                  "name": "St Vincent's Birmingham",
                  "description": null,
                  "address": "810 St Vincent'S Drive",
                  "zip": "35205",
                  "city": "Birmingham",
                  "state": "AL",
                  "country": "USA",
                  "phone": "2059397000",
                  "url": null,
                  "corporation": false,
                  "score": {
                     "value": 540
                    }
                }
            }
          }
        ]
    },
    "relationships": {
      "surgical-category": {
        "links": {
          "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000000005-000000000040/relationships/surgical-category",
          "related": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000000005-000000000040/surgical-category"
          }
        },
        "doctor": {
          "links": {
             "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000000005-000000000040/relationships/doctor",
             "related": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000000005-000000000040/doctor"
            }
        }
    }
    },
    ...
  ],
  "meta": {
    "record-count": 976
  },
  "links": {
   "first": "/api.mpirica.com/api/v1/doctor-surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/doctor-surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/doctor-surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=39679"
  }
}

This endpoint retrieves all doctor-surgical-category pairs.

HTTP Request

GET /api.mpirica.com/api/v1/doctor-surgical-categories

Filtering

Parameter Default Supported values Description
filter[location] Filters doctor-surgical-category pairs by matching a doctor location. City, state and zip codes are allowed
filter[category_mpirica_code] Filters doctor-surgical-category pairs by matching category MPIRICA code against it
filter[surgical_category_name] Filters doctor-surgical-category pairs by loosely matching surgical category name against it
filter[radius] Filters doctor-surgical-category pairs location within given radius. Allowed values are: 10, 20, 50, 100, 250 and 500 miles
filter[doctor_npi] Filters doctor-surgical-category pairs by matching a doctor npi.

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, score.value Sort by given parameter. Prepend - (minus) sign, to force descending order

Inclusions

Parameter Default Supported values Description
include doctor, surgical-category Include references under incldued key
curl -g "/api.mpirica.com/api/v1/doctor-surgical-categories?&filter[category_mpirica_code]=00000062&filter[location]=Pensacola+FL&filter[radius]=10&page[offset]=0&page[limit]=1&sort=-score.value&include=doctor,surgical-category"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000027215-000000000062",
    "type": "doctor-surgical-categories",
    "links": {
      "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062"
    },
    "attributes": {
      "score": {
          "value": 660
      },
      "hospitals": [
        {
          "data": {
            "id": "000000000757",
            "type": "hospitals",
            "links": {
              "self": "/api.mpirica.com/api/v1/hospitals/000000000757"
            },
            "attributes": {
              "ccn": "100025",
              "slug": "sacred-heart-hospital",
              "name": "Sacred Heart Hospital",
              "description": null,
              "address": "5151 N 9th Ave",
              "zip": "32504",
              "city": "Pensacola",
              "state": "FL",
              "country": "USA",
              "phone": "8504167000",
              "url": null,
              "corporation": false,
              "score": {
                  "value": 630
              }
            }
          }
        }
      ]
    },
    "relationships": {
      "surgical-category": {
        "links": {
          "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/relationships/surgical-category",
          "related": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/surgical-category"
        }
      },
      "doctor": {
        "links": {
          "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/relationships/doctor",
          "related": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/doctor"
        }
      }
    }
  }
}

Get a Specific Doctor-Surgical-Category pair

curl "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000027215-000000000062",
    "type": "doctor-surgical-categories",
    "links": {
      "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062"
    },
    "attributes": {
      "score": {
        "value": 660
      },
      "hospitals": [
        {
          "data": {
            "id": "000000000757",
            "type": "hospitals",
            "links": {
              "self": "/api.mpirica.com/api/v1/hospitals/000000000757"
            },
            "attributes": {
              "ccn": "100025",
              "slug": "sacred-heart-hospital",
              "name": "Sacred Heart Hospital",
              "description": null,
              "address": "5151 N 9th Ave",
              "zip": "32504",
              "city": "Pensacola",
              "state": "FL",
              "country": "USA",
              "phone": "8504167000",
              "url": null,
              "corporation": false,
              "score": {
                "value": 630
              }
            }
          }
        }
      ]
    },
    "relationships": {
      "surgical-category": {
        "links": {
          "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/relationships/surgical-category",
          "related": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/surgical-category"
        }
      },
      "doctor": {
        "links": {
          "self": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/relationships/doctor",
          "related": "/api.mpirica.com/api/v1/doctor-surgical-categories/000000027215-000000000062/doctor"
        }
      }
    }
  }
}

This endpoint retrieves a specific doctor-surgical-category pair.

HTTP Request

GET /api.mpirica.com/api/v1/doctor-surgical-category/<ID>

URL Parameters

Parameter Description
ID The ID of the doctor to retrieve

Inclusions

Parameter Default Supported values Description
include doctor, surgical-category Include references under incldued key

Hospital-Surgical-Category pairs

Get All Hospital-Surgical-Category pairs

curl "/api.mpirica.com/api/v1/hospital-surgical-categories"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000001-000000000002",
      "type": "hospital-surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000001-000000000002"
      },
      "attributes": {
        "score": {
            "value": 545
        },
        "doctors": [
          {
            "data": {
              "id": "000000049244",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000049244"
              },
              "attributes": {
                "npi": "1760476212",
                "slug": "pinson-michael",
                "name": "Michael Pinson",
                "specialties": [
                  {
                    "reference": "000000000006",
                    "name": "Physician/Cardiovascular Disease (Cardiology)",
                    "primary": true
                  }
                ]
              }
            }
          },
          {
            "data": {
              "id": "000000047610",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000047610"
              },
              "attributes": {
                "npi": "1578562484",
                "slug": "rushing-sylvia",
                "name": "Sylvia Rushing",
                "specialties": [
                  {
                    "reference": "000000000006",
                    "name": "Physician/Cardiovascular Disease (Cardiology)",
                    "primary": true
                  }
                ]
              }
            }
          }
        ]
        },
        "relationships": {
          "surgical-category": {
            "links": {
              "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000001-000000000002/relationships/surgical-category",
              "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000001-000000000002/surgical-category"
            }
          },
          "hospital": {
            "links": {
              "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000001-000000000002/relationships/hospital",
              "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000001-000000000002/hospital"
            }
          }
        }
    },
      ...
  ],
  "meta": {
    "record-count": 29224
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospital-surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=0",
    "next": "/api.mpirica.com/api/v1/hospital-surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=10",
    "last": "/api.mpirica.com/api/v1/hospital-surgical-categories?page%5Blimit%5D=10&page%5Boffset%5D=29214"
  }
}
curl -g "/api.mpirica.com/api/v1/hospital-surgical-categories?&filter[category_mpirica_code]=00000062&filter[location]=Pensacola+FL&filter[radius]=10&page[offset]=0&page[limit]=1&sort=-score.value&include=hospital,surgical-category"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000757-000000000062",
      "type": "hospital-surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000757-000000000062"
      },
      "attributes": {
        "score": {
          "value": 555
        },
        "doctors": [
          {
            "data": {
              "id": "000000027215",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000027215"
              },
              "attributes": {
                "npi": "1639354624",
                "slug": "morrison-kurt",
                "name": "Kurt Morrison",
                "specialties": [
                  {
                    "reference": "000000000020",
                    "name": "Physician/Orthopedic Surgery",
                    "primary": true
                  }
                ]
              }
            }
          },
          {
            "data": {
              "id": "000000001369",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000001369"
              },
              "attributes": {
                "npi": "1033118799",
                "slug": "lurate-robert",
                "name": "Robert Lurate",
                "specialties": [
                  {
                    "reference": "000000000099",
                    "name": "Other",
                    "primary": true
                  }
                ]
              }
            }
          }
        ]
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000757-000000000062/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000757-000000000062/surgical-category"
          },
          "data": {
            "type": "surgical-categories",
            "id": "000000000062"
          }
        },
        "hospital": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000757-000000000062/relationships/hospital",
            "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000000757-000000000062/hospital"
          },
          "data": {
            "type": "hospitals",
            "id": "000000000757"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "000000000062",
      "type": "surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-categories/000000000062"
      },
      "attributes": {
        "mpirica-code": "00000062",
        "slug": "knee-replacement-surgery",
        "name": "Knee Replacement Surgery"
      }
    },
    {
      "id": "000000000757",
      "type": "hospitals",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospitals/000000000757"
      },
      "attributes": {
        "ccn": "100025",
        "slug": "sacred-heart-hospital",
        "name": "Sacred Heart Hospital",
        "description": null,
        "address": "5151 N 9th Ave",
        "zip": "32504",
        "city": "Pensacola",
        "state": "FL",
        "country": "USA",
        "phone": "8504167000",
        "url": null,
        "corporation": false
      }
    }
  ],
  "meta": {
    "record-count": 1
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospital-surgical-categories?filter%5Bcategory_mpirica_code%5D=00000062&filter%5Blocation%5D=Pensacola+FL&filter%5Bradius%5D=10&include=hospital%2Csurgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value",
    "last": "/api.mpirica.com/api/v1/hospital-surgical-categories?filter%5Bcategory_mpirica_code%5D=00000062&filter%5Blocation%5D=Pensacola+FL&filter%5Bradius%5D=10&include=hospital%2Csurgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value"
  }
}

This endpoint retrieves all hospital-surgical-category pairs.

HTTP Request

GET /api.mpirica.com/api/v1/hospital-surgical-categories

Filtering

Parameter Default Supported values Description
filter[location] Filters hospital-surgical-category pairs by matching a hospital location. City, state and zip codes are allowed
filter[category_mpirica_code] Filters hospital-surgical-category pairs by matching category MPIRICA code against it
filter[surgical_category_name] Filters hospital-surgical-category pairs by loosely matching category name against it
filter[radius] Filters hospital-surgical-category pairs location within given radius. Allowed values are: 10, 20, 50, 100, 250 and 500 miles
filter[hospital_ccn] Filters hospital-surgical-category pairs by matching a hospital ccn.

Paging

Parameter Default Supported values Description
page[offset] 0 Starting index
page[limit] 10 1 - 100 Number of results

Sorting

Parameter Default Supported values Description
sort id id, score.value Sort by given parameter. Prepend - (minus) sign, to force descending order

Inclusions

Parameter Default Supported values Description
include hospital, surgical-category Include references under incldued key
curl -g "/api.mpirica.com/api/v1/hospital-surgical-categories?filter[location]=Bethesda+MD&filter[radius]=10&page[offset]=1&page[limit]=1&sort=-score.value&include=hospital,surgical-category"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000001957-000000000061",
      "type": "hospital-surgical-categories",
      "links": {
          "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061"
      },
      "attributes": {
        "score": {
            "value": 655
        },
        "doctors": [
          {
            "data": {
              "id": "000000010089",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000010089"
              },
              "attributes": {
                "npi": "1235134560",
                "slug": "cannova-christopher",
                "name": "Christopher Cannova",
                "specialties": [
                  {
                    "reference": "000000000099",
                    "name": "Other",
                    "primary": true
                  },
                  {
                    "reference": "000000000020",
                    "name": "Physician/Orthopedic Surgery",
                    "primary": false
                  }
                ]
              }
            }
          },
          {
            "data": {
              "id": "000000026151",
              "type": "doctors",
              "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000026151"
              },
              "attributes": {
                "npi": "1619926987",
                "slug": "valaik-daniel",
                "name": "Daniel Valaik",
                "specialties": [
                    {
                      "reference": "000000000020",
                      "name": "Physician/Orthopedic Surgery",
                      "primary": true
                    }
                ]
              }
            }
          }
        ]
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/surgical-category"
          },
          "data": {
            "type": "surgical-categories",
            "id": "000000000061"
          }
        },
        "hospital": {
        "links": {
            "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/relationships/hospital",
            "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/hospital"
          },
          "data": {
            "type": "hospitals",
            "id": "000000001957"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "000000000061",
      "type": "surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-categories/000000000061"
      },
      "attributes": {
        "mpirica-code": "00000061",
        "slug": "hip-replacement-surgery",
        "name": "Hip Replacement Surgery"
      }
    },
    {
      "id": "000000001957",
      "type": "hospitals",
      "links": {
        "self": "/api.mpirica.com/api/v1/hospitals/000000001957"
      },
      "attributes": {
        "ccn": "210022",
        "slug": "suburban-hospital",
        "name": "Suburban Hospital",
        "description": null,
        "address": "8600 Old Georgetown Road",
        "zip": "20814",
        "city": "Bethesda",
        "state": "MD",
        "country": "USA",
        "phone": "3018962576",
        "url": null,
        "corporation": false
      }
    }
  ],
  "meta": {
    "record-count": 34
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/hospital-surgical-categories?filter%5Blocation%5D=Bethesda+MD&filter%5Bradius%5D=10&include=hospital%2Csurgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value",
    "prev": "/api.mpirica.com/api/v1/hospital-surgical-categories?filter%5Blocation%5D=Bethesda+MD&filter%5Bradius%5D=10&include=hospital%2Csurgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-score.value",
    "next": "/api.mpirica.com/api/v1/hospital-surgical-categories?filter%5Blocation%5D=Bethesda+MD&filter%5Bradius%5D=10&include=hospital%2Csurgical-category&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-score.value",
    "last": "/api.mpirica.com/api/v1/hospital-surgical-categories?filter%5Blocation%5D=Bethesda+MD&filter%5Bradius%5D=10&include=hospital%2Csurgical-category&page%5Blimit%5D=1&page%5Boffset%5D=33&sort=-score.value"
  }
}

Get a Specific Hospital-Surgical-Category pair

curl "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": {
    "id": "000000001957-000000000061",
    "type": "hospital-surgical-categories",
    "links": {
        "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061"
    },
    "attributes": {
      "score": {
        "value": 505
      },
      "doctors": [
        {
          "data": {
            "id": "000000010089",
            "type": "doctors",
            "links": {
                "self": "/api.mpirica.com/api/v1/doctors/000000010089"
            },
            "attributes": {
              "npi": "1235134560",
              "slug": "cannova-christopher",
              "name": "Christopher Cannova",
              "specialties": [
                {
                  "reference": "000000000099",
                  "name": "Other",
                  "primary": true
                },
                {
                  "reference": "000000000020",
                  "name": "Physician/Orthopedic Surgery",
                  "primary": false
                }
              ]
            }
          }
        }
      ]
    },
    "relationships": {
      "surgical-category": {
        "links": {
          "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/relationships/surgical-category",
          "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/surgical-category"
        }
      },
      "hospital": {
        "links": {
          "self": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/relationships/hospital",
          "related": "/api.mpirica.com/api/v1/hospital-surgical-categories/000000001957-000000000061/hospital"
        }
      }
    }
  }
}

This endpoint retrieves a specific hospital-surgical-category pair.

HTTP Request

GET /api.mpirica.com/api/v1/hospital-surgical-categories/<ID>

URL Parameters

Parameter Description
ID The ID of the hospital to retrieve

Inclusions

Parameter Default Supported values Description
include hospital, surgical-category Include references under incldued key

Test and Subscription Information

Test Accounts

Developers may evaluate the MPIRICA API using a test developer account. A test developer account provides full functionality of the API and access to the entire directory of items but with dummy scores in place of actual live scores. Test developer accounts also include login credentials to access website profile. Test accounts are available upon request.

Developers with paid access to the MPIRICA API receive all live production scores allowed by their subscription.

Paid developer accounts also include login credentials to access website profile as well as website access to all scores allowed by their subscription.

User Groups

User Group ID

Developers can add to the request an additional parameter user_group_id. That data will be used for advanced statistics.

curl -g "/api.mpirica.com/api/v1/procedures?filter[query]=knee+replacement&page[offset]=1&page[limit]=1&include=surgical-category&sort=-common-name&user_group_id=test-group"
  -H "Authorization: Bearer <API Token>"
  -H "Accept: application/vnd.api+json"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "000000000306",
      "type": "procedures",
      "links": {
        "self": "/api.mpirica.com/api/v1/procedures/000000000306"
      },
      "attributes": {
        "mpirica-code": "00000306",
        "slug": "revision-surgery-for-previous-knee-replacement",
        "common-name": "Revision Surgery for Previous Knee Replacement",
        "description": "Replacement of a previously placed artificial knee joint with a new mechanical artificial joint.",
        "name": "Revision Surgery for Previous Knee Replacement",
        "group": "Revision of Knee Replacement",
        "available": true
      },
      "relationships": {
        "surgical-category": {
          "links": {
            "self": "/api.mpirica.com/api/v1/procedures/000000000306/relationships/surgical-category",
            "related": "/api.mpirica.com/api/v1/procedures/000000000306/surgical-category"
          },
          "data": {
            "type": "surgical-categories",
            "id": "000000000230"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "000000000230",
      "type": "surgical-categories",
      "links": {
        "self": "/api.mpirica.com/api/v1/surgical-categories/000000000230"
      },
      "attributes": {
        "mpirica-code": "00000230",
        "slug": "revision-of-knee-replacement",
        "name": "Revision of Knee Replacement"
      }
    }
  ],
  "meta": {
    "record-count": 3
  },
  "links": {
    "first": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-common-name",
    "prev": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=0&sort=-common-name",
    "next": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-common-name",
    "last": "/api.mpirica.com/api/v1/procedures?filter%5Bquery%5D=knee+replacement&include=surgical-category&page%5Blimit%5D=1&page%5Boffset%5D=2&sort=-common-name"
  }
}

Errors

The MPIRICA API uses the following error codes:

Error Code Meaning
400 Bad Request – The request is malformed
400 Location not found – Requested location does not exist.
401 Unauthorized – Your API key is wrong
403 Forbidden – You do not have a permission to access this resource
403 Out of Localization – Location request outside of account permissions
403 Access Denied – Subscription Limitation
404 Not Found – The resource could not be found
405 Method Not Allowed – You tried to access a resource with an invalid method
406 Not Acceptable – You requested a format that isn’t JSONAPI compatible
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarially offline for maintanance. Please try again later.