List all deals

GET https://myyk-api.rkas.ee/api/public/deals
Request parameters
type required string Values: sale, rent
address string Search deals by address
county string Search deals by county
keyword string Search deals by keyword (searches in tags, address and description)
per_page number Default: 15
page number Default: 1
sort string Values: auction_expire_date-asc, auction_expire_date-desc, address-asc, address-desc, price-asc, price-desc
lang string Values: et, en, ru | Default: et

Translation

Response data is translated to selected language (lang parameter)

Example: 

https://myyk-api.rkas.ee/api/public/deals?type=sale&per_page=10&sort=auction_expire_date-asc

Response

Deal object stucture is described in Get deal by slug response

{
    "data": [
        { Deal },
        { Deal }, 
        ...
    ],
    "links": {
        "first": "https://myyk-api.rkas.ee/api/public/deals?page=1",
        "last": "https://myyk-api.rkas.ee/api/public/deals?page=2",
        "prev": null,
        "next": "https://myyk-api.rkas.ee/api/public/deals?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "path": "https://myyk-api.rkas.ee/api/public/deals",
        "per_page": 15,
        "to": 15,
        "total": 27
    }
}

Get deal by slug

GET https://myyk-api.rkas.ee/api/public/deals/:deal
Request parameters
:deal required string Slug of the deal, eg lelle-tn24-kesklinna-linnaosa-tallinn-harju-maakond
lang string Values: et, en, ru | Default: et

Translation

Response data is translated to selected language (lang parameter)

Example:

https://myyk-api.rkas.ee/api/public/deals/lelle-tn24-kesklinna-linnaosa-tallinn-harju-maakond?lang=en

{
    "data": {
        "title": "Lelle tn 24, Kesklinna linnaosa, Tallinn, Harju maakond",
        "address": "Lelle tn 24, Kesklinna linnaosa, Tallinn, Harju maakond",
        "price": "2 166 300.00 €",
        "ad_expire_date": "23.06.2018 15:00",
        "auction_expire_date": "23.06.2018 15:00",
        "additional_information_txt": "",
        "promotion_txt": "Tenetur ipsam et voluptates vero.",
        "tags": "minima,autem,cumque",
        "slug": "lelle-tn24-kesklinna-linnaosa-tallinn-harju-maakond-39",
        "area": "9058",
        "closed_net_area": "9552",
        "deal_type": "Sale",
        "sale_type": "Bidding",
        "status": "published",
        "published_at": "11.06.2018 16:02:54",
        "status_txt": "Published",
        "main_image": "https://myyk-api.rkas.ee/storage/image/7odpEQkuW6fYS0ISWXNTS4Yepwwnhle7NnUpNKZT.jpeg",
        "images": [
            {
                "id": 1,
                "url": "https://myyk-api.rkas.ee/storage/image/7odpEQkuW6fYS0ISWXNTS4Yepwwnhle7NnUpNKZT.jpeg",
                "title": "images",
                "is_published": "1",
                "weight": 1,
                "size": "13.9kb"
            }
        ],
        "videos": [
            {
                "id": 2,
                "url": "http://rkas-sales-backend.test/storage/document/tjX5jMBz9KJHTACoA8YAUBb0X73yhCr0kLWkW5m3.mp4",
                "title": "Video",
                "is_published": "1",
                "weight": null,
                "size": "4.2MB"
            }
        ],
        "documents": [
            {
                "id": 2,
                "url": "http://rkas-sales-backend.test/storage/document/mvz1ENwDYCBev41nrGwvL6TOO9nV8bMHm3rloSZ4.pdf",
                "title": "Dokument 1",
                "is_published": "1",
                "weight": null,
                "size": "179.1kb"
            }
        ],
        "properties": [
            {
                "id": 71,
                "additional_equipment": [
                    "Conditioner",
                    "Fireplace",
                    "Phone",
                    "Storage",
                    "Sauna"
                ],
                "additional_information_txt": null,
                "address": "Lelle tn 24, Kesklinna linnaosa, Tallinn, Harju maakond",
                "apartment_nr": null,
                "area": "6085",
                "bathrooms": 6,
                "building_material": "Log house",
                "building_nr": "24",
                "business_use_purpose": "Production",
                "cadastral_unit": [
                    "78401:101:1670"
                ],
                "closed_net_area": "5611",
                "construction_year": 1970,
                "description": "Qui rerum ipsa et et laborum. Natus corporis inventore a adipisci distinctio aut id sit. Aut aut dolor qui aspernatur odit voluptates expedita. Rerum quam impedit delectus esse et.\n\nTenetur facilis labore sed rerum dolor laudantium. Quos labore exercitationem doloremque explicabo. Corrupti et quas nisi voluptatem ut consequatur.\n\nSapiente accusamus est iusto non. Exercitationem repudiandae repellat a. Aliquid molestiae impedit quod necessitatibus ab. Et officia et deserunt excepturi aperiam provident nobis voluptatem.",
                "detail_planning_url": null,
                "energy_class": "G",
                "floor": "6",
                "floors_max": "6",
                "heating_type": "Geothermal heating",
                "intended_purpose": "Land designated for production",
                "ownership_form": "Housing association",
                "parking_places": 5,
                "parking_type": "In basement parking house",
                "price": 34423100,
                "promotion_txt": null,
                "property_owner": "Joint ownership",
                "readiness_level": "Renovated",
                "rawproperty_code": null,
                "reg_nr": "4",
                "roof": null,
                "rooms": 9,
                "sleep_rooms": 7,
                "type": "Summer cottage"
            }
        ],
        "county": "Harju maakond",
        "virtual_tour": null,
        "longitude": "24.732200279222",
        "latitude": "59.404173282141",
        "contact_name": "Kasey Pacocha Sr.",
        "contact_email": "kautzer.emmet@gmail.com",
        "contact_phone": "+5221002469035",
        "messages": [],
        "url_type": "muugikuulutused",
        "municipality": "Tallinn",
        "public_url": "https://myyk-api.rkas.ee/en/muugikuulutused/lelle-tn24-kesklinna-linnaosa-tallinn-harju-maakond-39"
    }
}

List all external deals

GET https://myyk-api.rkas.ee/api/public/external-deals
Request parameters
description string Search deals by description (searches in address and description)
per_page number Default: 15
page number Default: 1
lang string Values: et, en, ru | Default: et

Example:

https://myyk-api.rkas.ee/api/public/external-deals?per_page=10

{
    "data": [
        {
            "address": "KVB kuulutus 1",
            "additional_information_txt": "Lorem ipsum dolor sit amet consectetur adipisicing elit.",
            "external_url": "http://kvb-kuulutus-1.test"
        },
        {
            "address": "KVB kuulutus 2",
            "additional_information_txt": "Lorem ipsum dolor sit amet consectetur adipisicing elit.",
            "external_url": "http://kvb-kuulutus-2.test"
        },
        {...}
    ]
    "links": {
        "first": "https://myyk-api.rkas.ee/api/public/external-deals?page=1",
        "last": "https://myyk-api.rkas.ee/api/public/external-deals?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://myyk-api.rkas.ee/api/public/external-deals",
        "per_page": 15,
        "to": 10,
        "total": 10
    }
}

List all sales plan rows

Returns sales plan rows of the current year

GET https://myyk-api.rkas.ee/api/public/sale-plans
Request parameters
address string Search rows by address
county string Search rows by county
cadastral_unit string Search rows by cadastral unit
reg_nr string Search rows by registry number
municipality string Search rows by municipality
per_page number Default: 15
page number Default: 1
lang string Values: et, en, ru | Default: et

Example: 

https://myyk-api.rkas.ee/api/public/sale-plans?county=harju

{
    "data": [
        {
            "address": "Jaama tn 14-3, Haapsalu linn",
            "county": "Lääne maakond",
            "cadastral_unit": "18301:009:0052",
            "registry_nr": "2352632",
            "municipality": null,
            "estimated_sales_period": null,
            "grouped_saleplans_addresses": [
                "Aia 19, Tallinn",
                "Jaama tn 14-3, Haapsalu linn"
            ],
            "grouped_saleplans": [
                {
                    "address": "Aia 19, Tallinn",
                    "county": "Harju maakond",
                    "cadastral_unit": "78401:101:1670",
                    "registry_nr": "2282001",
                    "municipality": ""
                },
                {
                    "address": "Jaama tn 14-3, Haapsalu linn",
                    "county": "Lääne maakond",
                    "cadastral_unit": "18301:009:0052",
                    "registry_nr": "2352632",
                    "municipality": "Haapsalu linn"
                }
            ]
        },
        {
            "address": "Ahtme, Kohtla-Järve, 12-13,1 km, Kohtla-Järve, Sompa linnaosa",
            "county": "Ida-Viru maakond",
            "cadastral_unit": "32220:011:0003",
            "registry_nr": "908407",
            "municipality": null,
            "estimated_sales_period": null,
            "grouped_saleplans_addresses": [],
            "grouped_saleplans": []
        },
        {...}
    ]
    "links": {
        "first": "https://myyk-api.rkas.ee/api/public/sale-plans?page=1",
        "last": "https://myyk-api.rkas.ee/api/public/sale-plans?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://myyk-api.rkas.ee/api/public/sale-plans",
        "per_page": 15,
        "to": 5,
        "total": 5
    }
}

List all deal resolutions

GET https://myyk-api.rkas.ee/api/public/deal-resolutions
Request parameters
resolution string Search rows by resolution (searches in title and description)
per_page number Default: 15
page number Default: 1
lang string Values: et, en, ru | Default: et

Example: 

https://myyk-api.rkas.ee/api/public/deal-resolutions?per_page=3

{
    data": [
            {
                "title": "Riigi Kinnisvara AS-i juhtkonna 29.09.2016. a otsus nr 197/16",
                "resolution": Tunnistada Harju maakonnas Harku vallas Harku alevikus Pikk 19 ja 19a kinnistu ..."
            },
            {...}
        ],
        "links": {
            "first": "https://myyk-api.rkas.ee/api/public/deal-resolutions?page=1",
            "last": "https://myyk-api.rkas.ee/api/public/deal-resolutions?page=1",
            "prev": null,
            "next": null
        },
        "meta": {
            "current_page": 1,
            "from": 1,
            "last_page": 1,
            "path": "https://myyk-api.rkas.ee/api/public/deal-resolutions",
            "per_page": 15,
            "to": 1,
            "total": 1
        }
}