API V1 - FluidsAndChemicals

FluidsAndChemicals Endpoint

https://api.welldatalabs.com/fluidsandchemicals

FluidsAndChemicals Object

Here is the shape of the FluidsAndChemicals object.

{
    "jobId": <Well Data Labs unique id for this job>
    "wellName": <well name for this job>
    "api": <api number for this job>
    "stageNumber": <stage number for this job>
    "type": <Fluid or Chemical>
    "subType": <Friction Reducer, Breaker, etc...>
    "tradeName": <name of chemical or fluid>
    "name": <name of chemical or fluid with subtype>
    "volume": <volume of chemical or fluid>
    "volumeUnit": <unit of volume>
    "volumeConcentration": <volume of chemical or fluid>
    "volumeConcentrationUnit": <unit of volume concentration>
    "dryTotal": <dry total of chemical>
    "dryTotalUnit": <unit of dry total>
    "dryConcentration": <dry concentration of chemical>
    "dryConcentrationUnit": <unit of dry concentration>
}

Here is a fully populated FluidsAndChemicals object.

[
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 1,
        "type": "Chemical",
        "subType": "Crosslinker",
        "tradeName": "Crosslinker",
        "name": "Crosslinker-Crosslinker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 0.5,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 1,
        "type": "Chemical",
        "subType": "Breaker",
        "tradeName": "GBW-5",
        "name": "GBW-5-Breaker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 5.7,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 2,
        "type": "Chemical",
        "subType": "Crosslinker",
        "tradeName": "Crosslinker",
        "name": "Crosslinker-Crosslinker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 0.5,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 2,
        "type": "Chemical",
        "subType": "Breaker",
        "tradeName": "GBW-5",
        "name": "GBW-5-Breaker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 5.8,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 3,
        "type": "Chemical",
        "subType": "Crosslinker",
        "tradeName": "Crosslinker",
        "name": "Crosslinker-Crosslinker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 0.5,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 3,
        "type": "Chemical",
        "subType": "Breaker",
        "tradeName": "GBW-5",
        "name": "GBW-5-Breaker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 4.2,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 4,
        "type": "Chemical",
        "subType": "Crosslinker",
        "tradeName": "Crosslinker",
        "name": "Crosslinker-Crosslinker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 0.5,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 4,
        "type": "Chemical",
        "subType": "Breaker",
        "tradeName": "GBW-5",
        "name": "GBW-5-Breaker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 4.5,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 5,
        "type": "Chemical",
        "subType": "Crosslinker",
        "tradeName": "Crosslinker",
        "name": "Crosslinker-Crosslinker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 0.5,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 5,
        "type": "Chemical",
        "subType": "Breaker",
        "tradeName": "GBW-5",
        "name": "GBW-5-Breaker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 4,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 6,
        "type": "Chemical",
        "subType": "Crosslinker",
        "tradeName": "Crosslinker",
        "name": "Crosslinker-Crosslinker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 0.5,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    },
    {
        "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
        "wellName": "Sample Ball-and-Sleeve",
        "api": "05-123-00000-00-00",
        "stageNumber": 6,
        "type": "Chemical",
        "subType": "Breaker",
        "tradeName": "GBW-5",
        "name": "GBW-5-Breaker",
        "volume": null,
        "volumeUnit": null,
        "volumeConcentration": 2.8,
        "volumeConcentrationUnit": "galpermgal",
        "dryTotal": null,
        "dryTotalUnit": null,
        "dryConcentration": null,
        "dryConcentrationUnit": null
    }
]

HTTP Response Status Codes

Status Code Description
200 Successful request and data was returned in the body
202 The request was successful but the system is building summary data for the job. This can take a few minutes. Try the request again.
400 JobId or APINumber not valid or missing.
404 No results found. Note that the endpoint was found, we just didn't find any data matching the criteria.
500 Unexpected error

GET https://api.welldatalabs.com/fluidsandchemicals

A GET request to the base endpoint with no Id parameter will return an array of FluidsAndChemical objects for the 10 most recent jobs.

curl https://api.welldatalabs.com/fluidsandchemicals --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

GET https://api.welldatalabs.com/fluidsandchemicals/{Id},{Id},{Id}

A GET request that includes a list of one or more Id parameters will return an array of FluidsAndChemical objects for all jobs that match the given Ids. Each Id can be either a well API Number or a Well Data Labs Job Id or Well Id. If any of the Ids represent the same job, only one instance of the FluidsAndChemicals object is returned.

Multiple FluidsAndChemical objects might be returned for a single well API Number if multiple jobs exist for that well. It's possible to have more than one job (multiple fracs or a refrac) for a single well.

curl https://api.welldatalabs.com/fluidsandchemicals/05-123-00000-00-00 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
Id Parameters

Id Description
API Number Well API Number; e.g. 05-123-00000-00-00
JobId Well Data Labs assigned Job Id; e.g. b332c113-3397-4379-8ab7-302efc3ae949
WellId Well Data Labs assigned Well Id; e.g. 8d206684-e725-44ca-8235-80ef567804ba

GET https://api.welldatalabs.com/fluidsandchemicals?fromChangeUtc={datetime}&toChangeUtc={datetime}

A GET request to the base endpoint with optional fromChangeUtc and toChangeUtc parameters will return an array of FluidsAndChemical objects for the 1000 most recently created or modified in the given timeframe.

curl https://api.welldatalabs.com/fluidsandchemicals?fromChangeUtc=2017-08-15T17:04:58&toChangeUtc=2018-08-15T17:05:59 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
Change Date Parameters*

Parameter Description
fromChangeUtc={datetime} Returns results for all jobs with changes greater than or equal to this parameter value.
toChangeUtc={datetime} Returns results for all jobs with changes less than or equal to this parameter value.
fromChangeUtc={datetime}&toChangeUtc={datetime} Returns results for all jobs with changes between and including the fromChangeUtc and toChangeUtc.
*The ChangeUtc parameters include milliseconds. Parameter values will be matched to the millisecond. If not all expected results are returned, increase or decrease the parameter value by one second.

GET https://api.welldatalabs.com/fluidsandchemicals?fromStageNumber={number}&toStageNumber={number}

A GET request to the base endpoint with optional fromStageNumber and toStageNumber parameters will return an array of FluidsAndChemical objects for the 10 most recent jobs and match the given stage numbers.

curl https://api.welldatalabs.com/fluidsandchemicals?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/fluidsandchemicals/05-123-00000-00-00?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/fluidsandchemicals?fromChangeUtc=2017-08-15T17:04:58&toChangeUtc=2018-08-15T17:05:59&fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
Stage Number Parameters

Parameter Description
fromStageNumber={number} Returns results for all stages greater than or equal to this parameter value.
toStageNumber={number} Returns results for all stages less than or equal to this parameter value.
fromStageNumber={number}&toStageNumber={number} Returns results for all stages between and including the stages fromStageNumber and toStageNumber.