integration

Example integration

{
    "integration_source": "exampleSource",
    "integration_id": 123,
    "ads_reference_response": {
       "ads": [
        {
            "street": "Sveavägen",
            "number": "5",
            "letter": "B",
            "rooms": 3,
            "living_area": 75,
            "construction_year": 1990,
            "category": "Apartment",
            "rt90x": 6603456.0,
            "rt90y": 1618500.0,
            "ancillary_area": 22,
            "price": 2600000,
            "monthly_fee": 5100,
            "error_code": 0,
            "firm": "Notar",
            "active": true,
            "has_pdf": true,
            "registered_date": "2024-02-01",
            "url": "http://example.com/5"
        },
        {
            "street": "Götgatan",
            "number": "8",
            "letter": "C",
            "rooms": 4,
            "living_area": 95,
            "construction_year": 2005,
            "category": "Apartment",
            "rt90x": 6605678.0,
            "rt90y": 1629000.0,
            "ancillary_area": 28,
            "price": 3700000,
            "monthly_fee": 6200,
            "error_code": 1,
            "firm": "Fastighetsbyrån",
            "active": true,
            "has_pdf": false,
            "registered_date": "2024-03-01",
            "url": "http://example.com/8"
        }
    ],
     "summary": {
        "average_rooms": 3,
        "average_living_area": 120,
        "average_ancillary_area": 30,
        "average_construction_year": 1995,
        "average_price": 2500000,
        "average_price_today": 2600000,
        "average_monthly_fee": 1500,
        "average_registered_date": "2024-02-02",
        "average_advertising_days": 45,
        "average_monthly_fee_psm": 30,
        "average_price_psm": 22500,
        "average_distance": 230
    }
    },
    "ads_market_share_response":{
        "ads_market_share": [
        {
            "firm": "Exempel Mäkleri",
            "number_of_ads": 13,
            "market_share": 50.0
        },
        {
            "firm": "Exempel Fastighetsförmedling",
            "number_of_ads": 13,
            "market_share": 50.0
        }
    ],
    "total_ads": 1020652
  },
    "sales_reference_response": {
      "sales": [
        {
            "id": "a1b2c3d4-e5f6-11ee-b123-456789abcdef",
            "street": "Linnégatan",
            "number": "15",
            "letter": "A",
            "rooms": 2,
            "living_area": 70,
            "floor": 3,
            "floors": null,
            "construction_year": 1985,
            "home_type": "apartment",
            "rt90x": 6641234.567890123,
            "rt90y": 1612345.678901234,
            "wgs84lat": 59.871234567890123,
            "wgs84lon": 17.654321098765432,
            "ancillary_area": null,
            "plot_area": null,
            "sold_price": 2650000,
            "monthly_fee": 3700,
            "recounted_price": 2725000,
            "contract_date": "2024-06-01",
            "relevance": 1.0892345678901234,
            "own_sale": null,
            "is_fpr": false,
            "recounted_price_sqm": 38928.57,
            "assessed_value": null,
            "property_unit_designation": null,
            "valuation_year": null,
            "ownership_type": "co_operative_apartment",
            "owner_name": "BRF Solhem",
            "owner_id": "718900-1234",
            "allabrf_url": "https://www.allabrf.se/brf-solhem-stockholm?source=12345",
            "allabolag_url": "http://allabolag.se/7189001234",
            "shore_distance_type": null,
            "water_sewerage_type": null,
            "alteration_year": null,
            "standard_points": null,
            "leasehold_fee": null,
            "subdivision_type": null,
            "ad_registered_date": "2024-05-01 00:00:00",
            "ad_delete_date": "2024-06-15 00:00:00",
            "ad_days_on_market": 45,
            "ad_price": 2600000.0,
            "ad_price_sqm": 37142.86,
            "prospect_url": "https://api.valueguard.se/v1/ads/pdf?ad_id=8001234",
            "sold_price_sqm": 37142.86,
            "price_taxation_ratio": null,
            "monthly_fee_sqm": 52.857142857142854,
            "assessment_year": null,
            "source": "sold",
            "ad_real_estate_agency": "HittaHem",
            "leasehold_period": null,
            "distance": 1.567890123E7
        },
        {
            "id": "b2c3d4e5-f6f7-22ee-b234-567890abcdef",
            "street": "Sturegatan",
            "number": "8",
            "letter": "B",
            "rooms": 3,
            "living_area": 85,
            "floor": 2,
            "floors": null,
            "construction_year": 1990,
            "home_type": "apartment",
            "rt90x": 6642345.678901234,
            "rt90y": 1613456.789012345,
            "wgs84lat": 59.882345678901234,
            "wgs84lon": 17.665432109876543,
            "ancillary_area": null,
            "plot_area": null,
            "sold_price": 3200000,
            "monthly_fee": 4200,
            "recounted_price": 3300000,
            "contract_date": "2024-07-01",
            "relevance": 1.0956789012345678,
            "own_sale": null,
            "is_fpr": false,
            "recounted_price_sqm": 38823.53,
            "assessed_value": null,
            "property_unit_designation": null,
            "valuation_year": null,
            "ownership_type": "co_operative_apartment",
            "owner_name": "BRF Vintergatan",
            "owner_id": "719900-5678",
            "allabrf_url": "https://www.allabrf.se/brf-vintergatan-stockholm?source=67890",
            "allabolag_url": "http://allabolag.se/7199005678",
            "shore_distance_type": null,
            "water_sewerage_type": null,
            "alteration_year": null,
            "standard_points": null,
            "leasehold_fee": null,
            "subdivision_type": null,
            "ad_registered_date": "2024-06-15 00:00:00",
            "ad_delete_date": "2024-07-31 00:00:00",
            "ad_days_on_market": 46,
            "ad_price": 3150000.0,
            "ad_price_sqm": 37058.82,
            "prospect_url": "https://api.valueguard.se/v1/ads/pdf?ad_id=9001234",
            "sold_price_sqm": 37058.82,
            "price_taxation_ratio": null,
            "monthly_fee_sqm": 49.41176470588235,
            "assessment_year": null,
            "source": "sold",
            "ad_real_estate_agency": "HittaHem",
            "leasehold_period": null,
            "distance": 1.678901234E7
        }
    ],
      "summary": {
         "average_rooms": 3,
         "average_living_area": 75,
         "average_ancillary_area": 10,
         "average_construction_year": 2010,
         "average_price": 3000000,
         "average_price_today": 3200000,
         "average_monthly_fee": 7000,
         "average_monthly_fee_psm": 93.33,
         "average_price_psm": 42666.67,
         "average_distance": 2.5
      }
    },
    "index_normalized_response": {
        "id": 923456789012345,
        "full_name": "Valueguard Index Stockholm Södermalm BR 3 mån",
        "short_name": "Stockholm Södermalm BR",
        "full_description": "Indexet visar värdeutvecklingen per 3-månadersperiod för en genomsnittlig bostadsrätt i Stockholm Södermalm Församling. Läs mer på http://www.valueguard.se/beskrivning.",
        "short_description": "Valueguard Index per 3-månadersperiod för bostadsrätter i Stockholm Södermalm",
        "version": "5.0.1",
        "quality_id": "5",
        "area_id": "200456",
        "house_type": "Bostadsrätter",
        "averaging_period": "3m",
        "ticker": "",
        "averaging_period_nr": "3",
        "rooms": null,
        "year": null,
        "last_publishing_date": "2024-08-20 09:00:00",
        "max_i_average_date": "2024-06-15 00:00:00",
        "values": [
            {
                "average_date": "2023-05-15",
                "publishing_date": "2023-07-10 09:00:00",
                "value": 34.22
            },
            {
                "average_date": "2023-08-15",
                "publishing_date": "2023-10-10 09:00:00",
                "value": 35.15
            },
            {
                "average_date": "2023-11-15",
                "publishing_date": "2024-01-10 09:00:00",
                "value": 36.05
            }
        ]
    },
    "customer_report_url": "http://example.com/my-customer-report.pdf",
    "report_url": "http://example.com/my-report.pdf"
}

Raw request

Post

curl https://api.valueguard.se/v1/integration?access_token={access_token}