API Basics

Top Line uses a basic API System for giving access to JSON formatted content.

Username and API Keys

The API can be access with three different levels of API Key. This is used to help developers separate out information access for their own clients.

Property Level - P###-###-######

Company Level - C###-###-######

User Level - U###-###-######

Usage

With all API Keys you will start by making a get or post request to /api/:version/:username with the parameter api_key set to your api key or set an http header x-api-key to your api key.

/:username

This will return additional resource information you can use for your other routes.

Route: /eric with Property Key

{
  data: {
    username: "eric",
    name: {
      first_name: "Eric",
      last_name: "Katz"
    },
    email: "[email protected]",
    properties: [
      {
        name: "Quarry Ridge Apartments",
        id: 3
      }
    ]
  }
}

Route: /eric with Company Key

{
  data: {
    username: "eric",
    name: {
      first_name: "Eric",
      last_name: "Katz"
    },
    email: "[email protected]",
    company: [
      {
        name: "Supreme Royal Company",
        id: 1,
        property: [
          {
            name: "Applegate Apartments",
            id: 1
          },
          {
            name: "Quarry Ridge Apartments",
            id: 3
          }
        ]
      }
    ]
  }
}

/:username/property/:id

Returns the Property level information including Floorplans

Route: /eric/property/1

{
  data: {
    name: "Applegate Apartments",
    description: "Applegate Apartments is the newest in luxury apartment development in the South Suburbs. With a fantastic location on the Southeast corner of the Applegate grounds, exceptional retail and dining is just steps away. Expect to be impressed with style and finishes worthy of condo living.",
    address: {
      address_line1: "2350 Applegate Road",
      city: "Columbus",
      state: "OH",
      zip: "43215"
    },
    latitude: 44.879883,
    longitude: -33.3213417,
    website: "http://30lines.com",
    phone: "123-111-2222",
    email: "[email protected]",
    social: {
      twitter: "http://twitter.com/30lines",
      facebook: "",
      instagram: ""
    },
    floorplans: {
      data: [
        {
          id: 991460,
          name: "Studio",
          unitcount: 15,
          bedrooms: 0,
          bathrooms: 1,
          squarefeet: {
            min: 518,
            max: 518
          },
          rent: {
            min: 845,
            max: 865
          },
          images: [
            "http://example.com/image.jpg"
          ],
          visibility: "visible",
          available: true
        },
        {
          id: 991461,
          name: "1 Bedroom",
          unitcount: 45,
          bedrooms: 1,
          bathrooms: 1,
          squarefeet: {
            min: 950,
            max: 950
          },
          rent: {
            min: 1260,
            max: 1260
          },
          images: [
            "http://example.com/image1.jpg",
            "http://example.com/image2.jpg"
          ],
          visibility: "visible",
          available: true
        },
        {
          id: 991462,
          name: "2 Bedroom",
          unitcount: 35,
          bedrooms: 2,
          bathrooms: 2,
          squarefeet: {
            min: 1433,
            max: 1433
          },
          rent: {
            min: 1600,
            max: 1600
          },
          images: [
            "http://example.com/image3.jpg"
          ],
          visibility: "visible",
          available: false
        }
      ]
    }
  }
}

/:username/property/:id/units

Returns all units accessible to our systems. Can include vacant, occupied and unavailable units depending on initial data provider.

Route: /eric/property/1/units

{
  data: [
    {
      id: 3650503,
      name: "114",
      floorplan: 991462,
      building: 48469,
      available: "09/01/2014",
      status: "vacant",
      rent: 3155,
      squarefeet: 1427,
      amenities: [
        "Espresso-colored Cabinets and Pendant Lighting",
        "Expansive Floor-to-ceiling Windows",
        "Faux Wood Blinds Throughout",
        "Full-sized Energy-efficient Washer & Dryer",
        "Glass Tile Backsplashes",
        "Plank Flooring & Upgraded Broadloom Carpeting",
        "Quartz Islands and Countertops",
        "Raised Bath Vanities and Ceramic Tile Floors",
        "Stainless Steel, Energy-efficient Appliances"
      ],
      specials: 0,
      deposit: 0,
      url: "http://example.com/application/unique/for/this/unit"
    },
    {
      id: 3650516,
      name: "131",
      floorplan: 991462,
      building: 48470,
      available: "09/01/2014",
      status: "vacant",
      rent: 1685,
      squarefeet: 742,
      amenities: [
        "Espresso-colored Cabinets and Pendant Lighting",
        "Expansive Floor-to-ceiling Windows",
        "Faux Wood Blinds Throughout",
        "Full-sized Energy-efficient Washer & Dryer",
        "Glass Tile Backsplashes",
        "Plank Flooring & Upgraded Broadloom Carpeting",
        "Quartz Islands and Countertops",
        "Raised Bath Vanities and Ceramic Tile Floors",
        "Stainless Steel, Energy-efficient Appliances"
      ],
      specials: 0,
      deposit: 0,
      url: "http://example.com/application/unique/for/this/unit"
    },
    {
      id: 3650517,
      name: "132",
      floorplan: 251492,
      building: 48470,
      available: false,
      status: "vacant",
      rent: 1655,
      squarefeet: 847,
      amenities: [
        "Espresso-colored Cabinets and Pendant Lighting",
        "Expansive Floor-to-ceiling Windows",
        "Faux Wood Blinds Throughout",
        "Full-sized Energy-efficient Washer & Dryer",
        "Glass Tile Backsplashes",
        "Plank Flooring & Upgraded Broadloom Carpeting",
        "Quartz Islands and Countertops",
        "Raised Bath Vanities and Ceramic Tile Floors",
        "Stainless Steel, Energy-efficient Appliances"
      ],
      specials: 0,
      deposit: 0,
      url: 0
    },
    {
      id: 3650658,
      name: "1009",
      floorplan: 251516,
      building: 48468,
      available: "02/01/2015",
      status: "vacant",
      rent: 2780,
      squarefeet: 1065,
      amenities: [
        "Espresso-colored Cabinets and Pendant Lighting",
        "Expansive Floor-to-ceiling Windows",
        "Faux Wood Blinds Throughout",
        "Full-sized Energy-efficient Washer & Dryer",
        "Glass Tile Backsplashes",
        "Plank Flooring & Upgraded Broadloom Carpeting",
        "Quartz Islands and Countertops",
        "Raised Bath Vanities and Ceramic Tile Floors",
        "Stainless Steel, Energy-efficient Appliances"
      ],
      specials: 0,
      deposit: 0,
      url: "http://example.com/application/unique/for/this/unit"
    }
  ]
}

/:username/property/:id/search

/:username/company/:id

Returns Company level information including corporate contact information / office locations.

/:username/company/:id/search