Generic Endpoints

API Definition

These endpoints require Basic Authentication. Click here to read more about how to generate valid credentials.

List all tracks

get

List all avaiblable tracks.

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Query parameters

cityNamestringOptional

includePathbooleanOptional

Responses

200Success

application/json

404

Tracks not found.

get

/tracks

HTTPcURLJavaScriptPython

GET /tracks HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

{
  "tracks": [
    {
      "id": 1,
      "name": "The San Francisco Track",
      "path": [
        []
      ]
    }
  ]
}

Retrieve track's information

get

Retrieve track's information given an track ID.

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Path parameters

idnumberRequired

Responses

200Success

application/json

400

Bad request or invalid query parameters

404

Track not found.

get

/tracks/{id}

HTTPcURLJavaScriptPython

GET /tracks/{id} HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

{
  "id": 1,
  "name": "The San Francisco Track",
  "path": [
    []
  ],
  "center": [
    1
  ],
  "boundaries": [
    []
  ]
}

Retrieve buildings on a track

get

That endpoint will return all the constructions along the selected track

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Path parameters

idnumberRequired

Responses

200Success

application/json

404

Buildings not found.

get

/tracks/{id}/buildings

HTTPcURLJavaScriptPython

GET /tracks/{id}/buildings HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

{
  "buildings": [
    {
      "id": 3394,
      "model_id": 60,
      "name": "apart_baked",
      "model": "apartment/Apartment_baked.gltf",
      "lat": "37.793213744148574",
      "lng": "-122.39704303645604",
      "rotate": [
        []
      ],
      "scale": 3.7,
      "altitude": 0,
      "meshes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Retrieve buildings given some boundaries

post

Each boundary contains a list of coordinates as the example below.

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Body

application/json

Responses

200

Buildings

application/json

post

/buildings

HTTPcURLJavaScriptPython

POST /buildings HTTP/1.1
Host: 
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "boundaries": [
    []
  ]
}

200

Buildings

{
  "buildings": [
    {
      "id": 3394,
      "model_id": 60,
      "name": "apart_baked",
      "model": "apartment/Apartment_baked.gltf",
      "lat": "37.793213744148574",
      "lng": "-122.39704303645604",
      "rotate": [
        []
      ],
      "scale": 3.7,
      "altitude": 0,
      "meshes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

List availables cities

get

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Responses

200Success

application/json

get

/cities

HTTPcURLJavaScriptPython

GET /cities HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

200Success

{
  "cities": [
    {
      "id": 1,
      "name": "San Francisco",
      "stateName": "CA",
      "countryName": "us"
    }
  ]
}

List available properties given a city id

get

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Query parameters

currentPagenumberRequired

pageSizenumberRequired

cityIdnumberRequired

Responses

200Success

application/json

get

/properties

HTTPcURLJavaScriptPython

GET /properties?currentPage=1&pageSize=1&cityId=1 HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

200Success

{
  "currentPage": 1,
  "pageSize": 10,
  "totalResults": 2,
  "results": [
    {
      "id": 55334346,
      "address": "1467 28TH AVE",
      "city": "San Francisco",
      "neighborhood": {
        "id": 798785521654878,
        "name": "ALAMO SQUARE"
      }
    }
  ]
}

List neighborhoods

get

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Query parameters

cityIdnumberOptional

Filter by city id

Example: 9

textSearchstringOptional

Text search on neighborhood name

Example: South

Responses

200Success

application/json

get

/neighborhoods

HTTPcURLJavaScriptPython

GET /neighborhoods HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

200Success

{
  "results": [
    {
      "id": 790,
      "name": "SOUTH SAN LAUREN",
      "cityId": 9,
      "area": 5770832.01833196,
      "boundaries": [
        [
          [
            -119.092011,
            35.383382
          ],
          [
            -119.061756,
            35.383242
          ],
          [
            -119.061499,
            35.396887
          ],
          [
            -119.056263,
            35.404932
          ],
          [
            -119.054632,
            35.412347
          ],
          [
            -119.069953,
            35.412452
          ],
          [
            -119.069953,
            35.410249
          ],
          [
            -119.069395,
            35.410109
          ],
          [
            -119.069266,
            35.405562
          ],
          [
            -119.067249,
            35.405562
          ],
          [
            -119.067421,
            35.401504
          ],
          [
            -119.074416,
            35.401539
          ],
          [
            -119.074287,
            35.394158
          ],
          [
            -119.092312,
            35.394333
          ],
          [
            -119.092269,
            35.38786
          ],
          [
            -119.092011,
            35.383382
          ]
        ]
      ],
      "center": [
        -119.07175840309523,
        35.394906456318544
      ]
    },
    {
      "id": 403,
      "name": "SOUTH SLOPE",
      "city_id": 6,
      "area": 1032113.16342545,
      "boundaries": [
        [
          [
            -73.984533,
            40.663241
          ],
          [
            -73.991632,
            40.666691
          ],
          [
            -73.992738,
            40.665446
          ],
          [
            -73.99719,
            40.668009
          ],
          [
            -73.99925,
            40.669181
          ],
          [
            -74.00013,
            40.667912
          ],
          [
            -74.002018,
            40.667212
          ],
          [
            -74.003284,
            40.666496
          ],
          [
            -74.004625,
            40.665264
          ],
          [
            -73.995173,
            40.659643
          ],
          [
            -73.992963,
            40.658325
          ],
          [
            -73.992394,
            40.658878
          ],
          [
            -73.990152,
            40.6576
          ],
          [
            -73.988392,
            40.659204
          ],
          [
            -73.986414,
            40.6612
          ],
          [
            -73.98586,
            40.661759
          ],
          [
            -73.985449,
            40.662221
          ],
          [
            -73.984533,
            40.663241
          ]
        ]
      ],
      "center": [
        -73.99431534202182,
        40.66341009993273
      ]
    }
  ]
}

List collections

get

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Responses

200Success

application/json

get

/collections

HTTPcURLJavaScriptPython

GET /collections HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

200Success

{
  "results": [
    {
      "id": 1,
      "name": "King of the Street",
      "amount": 3,
      "rarityLevel": 1,
      "description": "Standard Collection",
      "requirements": "Own 3 properties on the same street",
      "yieldBoost": 1.3,
      "oneTimeReward": 950,
      "image": "https://static.upland.me/collections-assets/king_of_the_street-1-banner.png",
      "imageThumbnail": "https://static.upland.me/collections-assets/king_of_the_street-1-thumbnail.png",
      "cityId": null
    },
    {
      "id": 2,
      "name": "Mission District",
      "amount": 3,
      "rarityLevel": 2,
      "description": "Limited collection",
      "requirements": "Own 3 properties in the Mission District in SF",
      "yieldBoost": 1.4,
      "oneTimeReward": 1300,
      "image": "https://static.upland.me/collections-assets/mission_district-2-banner.png",
      "imageThumbnail": "https://static.upland.me/collections-assets/mission_district-2-thumbnail.png",
      "cityId": 1
    }
  ]
}

List Treasures History

get

Authorizations

basic

AuthorizationstringRequired

Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application).

Query parameters

currentPagenumberRequired

pageSizenumberRequired

cityIdnumberOptional

Filter by city id

Example: 1

Responses

200Success

application/json

get

/treasures-history

HTTPcURLJavaScriptPython

GET /treasures-history?currentPage=1&pageSize=1 HTTP/1.1
Host: 
Authorization: Basic username:password
Accept: */*

200Success

{
  "results": {
    "results": [
      {
        "userName": "elenchusis",
        "reward": 13125,
        "lockedAt": "2022-06-02T00:08:57.299Z",
        "spawnAt": "2022-05-20T13:38:59.604Z",
        "fullAddress": "682 LISBON ST, San Francisco, CA",
        "treasureType": "box"
      },
      {
        "userName": "vladp_p9",
        "reward": 3369,
        "lockedAt": "2022-05-24T08:58:47.492Z",
        "spawnAt": "2022-05-23T12:46:13.583Z",
        "fullAddress": "2159 47TH AVE, San Francisco, CA",
        "treasureType": "pinata"
      }
    ]
  }
}