Generic Endpoints

API Definition

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

PreviousTournament APIs NextWebhooks Notifications

Last updated 1 year ago

List all tracks

List all avaiblable tracks.

GET/tracks

Authorization

Query parameters

Response

Body

tracks*array of object

Tracks

Request

const response = await fetch('/tracks', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "tracks": [
    {
      "id": 1,
      "name": "The San Francisco Track",
      "path": [
        [
          -122.406599522,
          37.806952808
        ],
        [
          -122.404625416,
          37.80591865
        ],
        [
          -122.402157784,
          37.8041046
        ]
      ]
    }
  ]
}

Retrieve track's information

Retrieve track's information given an track ID.

GET/tracks/{id}

Authorization

Path parameters

id*number

Response

Body

id*number

Track Id

name*string

Track Name

path*array of array

Paths

center*array of number

Center

boundaries*array of array

Boundaries

Request

const response = await fetch('/tracks/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "id": 1,
  "name": "The San Francisco Track",
  "path": [
    [
      -122.406599522,
      37.806952808
    ],
    [
      -122.404625416,
      37.80591865
    ],
    [
      -122.402157784,
      37.8041046
    ]
  ],
  "center": [
    "-122.39619255065918",
    "37.79594930209237"
  ],
  "boundaries": [
    [
      [
        -122.416534424,
        37.811207961
      ],
      [
        -122.414474487,
        37.803341668
      ],
      [
        -122.398166656,
        37.78706392
      ],
      [
        -122.395420074,
        37.775803046
      ],
      [
        -122.377910614,
        37.779602086
      ],
      [
        -122.385377884,
        37.797102289
      ],
      [
        -122.402801514,
        37.811411389
      ],
      [
        -122.416534424,
        37.811207961
      ]
    ]
  ]
}

Retrieve buildings on a track

That endpoint will return all the constructions along the selected track

GET/tracks/{id}/buildings

Authorization

Path parameters

id*number

Response

Body

buildings*array of object

Buildings

Request

const response = await fetch('/tracks/{id}/buildings', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "buildings": [
    {
      "id": 3394,
      "model_id": 60,
      "name": "apart_baked",
      "model": "apartment/Apartment_baked.gltf",
      "lat": "37.793213744148574",
      "lng": "-122.39704303645604",
      "rotate": [
        1.5707963267948966,
        0,
        0
      ],
      "scale": 3.7,
      "altitude": 0,
      "meshes": {
        "Wall": "#EBE5D1",
        "Roof": "#E7DDC5",
        "Detail": "#DEDEDE"
      }
    }
  ]
}

Retrieve buildings given some boundaries

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

POST/buildings

Authorization

Body

boundaries*array of array

Polygon boundary coordinates

Response

Buildings

Body

buildings*array of object

Buildings

Request

const response = await fetch('/buildings', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "boundaries": [
        [
          [
            -122.416534424,
            37.811207961
          ],
          [
            -122.414474487,
            37.803341668
          ],
          [
            -122.398166656,
            37.78706392
          ],
          [
            -122.395420074,
            37.775803046
          ],
          [
            -122.377910614,
            37.779602086
          ],
          [
            -122.385377884,
            37.797102289
          ],
          [
            -122.402801514,
            37.811411389
          ],
          [
            -122.416534424,
            37.811207961
          ]
        ]
      ]
    }),
});
const data = await response.json();

Response

{
  "buildings": [
    {
      "id": 3394,
      "model_id": 60,
      "name": "apart_baked",
      "model": "apartment/Apartment_baked.gltf",
      "lat": "37.793213744148574",
      "lng": "-122.39704303645604",
      "rotate": [
        1.5707963267948966,
        0,
        0
      ],
      "scale": 3.7,
      "altitude": 0,
      "meshes": {
        "Wall": "#EBE5D1",
        "Roof": "#E7DDC5",
        "Detail": "#DEDEDE"
      }
    }
  ]
}

List availables cities

GET/cities

Authorization

Response

Body

cities*array of object

Cities

Request

const response = await fetch('/cities', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "cities": [
    {
      "id": 1,
      "name": "San Francisco",
      "stateName": "CA",
      "countryName": "us"
    },
    {
      "id": 3,
      "name": "Manhattan",
      "stateName": "NY",
      "countryName": "us"
    },
    {
      "id": 5,
      "name": "Fresno",
      "stateName": "CA",
      "countryName": "us"
    }
  ]
}

List available properties given a city id

GET/properties

Authorization

Query parameters

Response

Body

currentPage*number

Current page

pageSize*number

Total returned per page

totalResults*number

Total of results

results*array of object

List of properties

Request

const response = await fetch('/properties?currentPage=1&pageSize=1&cityId=1', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "currentPage": 1,
  "pageSize": 10,
  "totalResults": 2,
  "results": [
    {
      "id": 798785521654878,
      "address": "728 ALABAMA ST",
      "neighborhood": {
        "id": 789,
        "name": "MISSION"
      }
    },
    {
      "id": 798785521654879,
      "address": "1467 28TH AVE",
      "neighborhood": {
        "id": 654,
        "name": "OUTER SUNSET"
      }
    }
  ]
}

List neighborhoods

GET/neighborhoods

Authorization

Query parameters

Response

Body

results*array of object

Neighborhoods

Example:

[{"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]}]

Request

const response = await fetch('/neighborhoods', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "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/collections

Authorization

Response

Body

results*array of object

Collections

Example:

[{"id":1,"name":"King of the Street","amount":3,"rarityLevel":1,"description":"<p>Standard Collection</p>","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":"<p>Limited collection</p>","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}]

Request

const response = await fetch('/collections', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "results": [
    {
      "id": 1,
      "name": "King of the Street",
      "amount": 3,
      "rarityLevel": 1,
      "description": "<p>Standard Collection</p>",
      "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": "<p>Limited collection</p>",
      "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/treasures-history

Authorization

Query parameters

Response

Body

results*array of object

Treasures History

Example:

{"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"}]}

Request

const response = await fetch('/treasures-history?currentPage=1&pageSize=1', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "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"
      }
    ]
  }
}