WellDatabase API Help

Here you will find a console to test and run sample requests against our api. Additional documentation can be found on our support site.

Clients

JavaScript Client

Code Samples

To use any of the example you will need an API Key. You can access your api keys here.

Notes

Example Requires Newtonsoft.Json



    object postModel = new { Filters = new { DataLastModified = new { Min = DateTime.UtcNow.AddDays(-3) }} };
    var route = "wells/search";
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Add("User-Agent", "Sample Application");
    httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
    httpClient.BaseAddress = new Uri("https://app.welldatabase.com/api/v2/");
    //add the auth key as a default header, so we can forget about it
    httpClient.DefaultRequestHeaders.Add("Api-Key", "Your API Key");
    string json = JsonConvert.SerializeObject(postModel);
    HttpContent content = new StringContent(json);

    content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
    var response = await httpClient.PostAsync(route, content).ConfigureAwait(false);
    response.EnsureSuccessStatusCode();
    var responseContent = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

    var search = JsonConvert.DeserializeObject<dynamic>(responseContent);
    int total = search.total;
    int pageSize = search.pageSize;
    int page = search.page;
    foreach (var item in search.data)
    {
        Console.Write(item.completionDate);
    }

Python 3.7+

Notes

Example Requires: HTTPX

Source


    
  import datetime
  import httpx
  
  headers = {
      'Content-Type': 'application/json',
      'User-Agent': 'Sample Application',
      'Api-Key': 'Your API Key'
  }
  
  modifiedSince = datetime.datetime.now() - datetime.timedelta(days=10)
  
  data = {
      'Filters': {
          'DateLastModified': {
              'Min': modifiedSince.strftime("%Y-%m-%d")
          }
      },
      'SortBy': 'DateCatalogued',
      'SortDirection': 'Descending',
      'PageSize': 2,
      'PageOffset': 0
  }
  
  response = httpx.post("https://app.welldatabase.com/api/v2/wells/search", headers=headers, json=data)
  results = response.json()
  print(results)

Python 2.7

Notes

Example Requires: Requests

Source



    import datetime
    import requests
    
    headers = {
        'Content-Type' : 'application/json',
        'User-Agent' : 'Sample Application',
        'Api-Key' : 'Your API Key'
    }
    
    modifiedSince = datetime.datetime.now() - datetime.timedelta(days=100)
    
    data = {
        'Filters': {
            'DateLastModified': {
                'Min': modifiedSince.strftime("%Y-%m-%d")
            }
        },
        'SortBy': 'DateCatalogued',
        'SortDirection': 'Descending',
        'PageSize': 2,
        'PageOffset': 0
    }
    
    response = requests.post(url = "https://app.welldatabase.com/api/v2/wells/search", headers = headers, json = data)
    results = response.json()
    
    print results

JavaScript



    let date = new Date();
    date.setDate(date.getDate() - 30);
    var request = { Filters: { DateLastModified: { Min: date } }};
    fetch( "https://app.welldatabase.com/api/v2/wells/search", {
        method: "POST",
        headers: {
              "Content-Type" : 'application/json',
              "User-Agent" : 'Sample Application',
              "Api-Key" : 'Your API Key'
            },
        body: JSON.stringify(request)
    })
    .then((response) => response.json())
    .then((result) => {
        const total = result.total;
        const pageSize = result.pageSize;
        const page = result.page;
        console.table(result.data);
    });

Java

Notes

Example Requires: Gson, Apache HttpClient

Source



    //Create http client
    Header contentType = new BasicHeader(HttpHeaders.CONTENT_TYPE, "application/json");
    Header userAgent = new BasicHeader(HttpHeaders.USER_AGENT, "Your Application Name");
    Header apiKey = new BasicHeader("Api-Key", "Your API Key");
    List<Header> headers = new ArrayList<Header>();
    headers.add(contentType);
    headers.add(userAgent);
    headers.add(apiKey);
    HttpClient httpClient = HttpClientBuilder.create().setDefaultHeaders(headers).build();
    
    //Create Request
    Request request = new Request();
    request.filters.DateLastModified = new Range<Date>();
    Date from = addDays(new Date(), -3);
    request.filters.DateLastModified.Min = from;
    String dateFormat = "yyyy-MM-dd'T'HH:mm:ss";
    SimpleDateFormat ft = new SimpleDateFormat(dateFormat);
    Gson gson = new GsonBuilder().setDateFormat(dateFormat).create();
    String postUrl = "https://app.welldatabase.com/api/v2/wells/search";// put in your url
    HttpPost post = new HttpPost(postUrl);
    String content = gson.toJson(request);//gson.tojson() converts your pojo to json
    StringEntity postingString = new StringEntity(content);
    post.setEntity(postingString);
    ResponseHandler<String> responseHandler = new BasicResponseHandler();
    
    //execute request
    String response = httpClient.execute(post, responseHandler);
    JsonObject myObject = gson.fromJson(response, JsonObject.class);
    
    //read search results
    int total = myObject.get("total").getAsInt();
    int page = myObject.get("page").getAsInt();
    int pageSize = myObject.get("pageSize").getAsInt();
    JsonArray data = myObject.get("data").getAsJsonArray();
    for (int i = 0; i < data.size(); i++) {
        JsonObject current = data.get(i).getAsJsonObject();
        String rawDate = current.get("completionDate").getAsString();
        Date completionDate = ft.parse(rawDate);
        System.out.println(completionDate);
    }

WellDatabase API Help

Clients

Code Samples

Test Console