🤖Model API

Use the Model API to access the custom model scores built specifically on your data using GeoIQ NoCode ML platform.

Model API with Latitude & Longitude

POST https://ml-us.geoiq.io/model/v1.0/{model_id}

Request Body

Name	Type	Description
key*	String	Authorised GeoIQ data api key with available credits
lat*	Float	Latitude should be between -90 to 90
lng*	Float	Longitude should be between -180 to 180
date	String	Comma separated list of variables to be fetched. Maximum 50 variables can be fetched in a single call.
custom_variables	Object	Variables provided by client which were used in the model

200: OK Success

{
  "score": float,
  "status": integer
}

400: Bad Request Invalid input, object invalid

403: Forbidden Authorization Failure. Invalid key

Sample Request

{
    "key": "Authentication Key",
    "lat": 40.0300971,
    "lng": -75.648135,
    "date": "2020-09-26",
    "custom_variables": 
    {
        "var1" : 124,
        "var2" : "abc"
    }
}

Sample Response

{
  "score": 0.73217
  "status": 200
}

Model API with Address

POST https://ml-us.geoiq.io/model/v1.0/{model_id}

Request Body

Name	Type	Description
key*	String	Authorised GeoIQ data api key with available credits
address*	String	Address for which model has to be scored
date	String	Date for which model has to be scored if not passed current date is assumed
custom_variables	Object	Variables provided by client which were used in the model

200: OK Success

{
  "score": float,
  "status": integer
}

400: Bad Request Invalid input, object invalid

403: Forbidden Authorization Failure. Invalid key

Sample Request

{
    "key": "Authentication Key",
    "address": "Manhattan, New York, NY, USA",
    "date": "2020-09-26",
    "custom_variables": 
    {
        "var1" : 124, 
        "var2" : "abc" 
    }
}

Sample Response

{
  "score": 0.73217
  "status": 200
}