### Quickstart: Python Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC A Python script to perform a quick search using the Fluximmo API. ```python import requests url = "https://api.fluximmo.io/v2/search/properties" headers = { "Content-Type": "application/json", "X-PARTNER-API-KEY": "YOUR_TEST_KEY" } payload = { "query": { "postalCode": "75001", "offer": "sale", "price": { "gte": 100000, "lte": 350000 }, "surface": { "gte": 30, "lte": 110 }, "propertyType": ["FLAT", "HOUSE"], "meta": { "isTotallyOffline": False } }, "pagination": { "size": 100, "sort": "FIRST_SEEN_AT DESC" } } response = requests.post(url, headers=headers, json=payload) if response.status_code == 200: print(response.json()) else: print(f"Error: {response.status_code}") print(response.text) ``` -------------------------------- ### Quickstart: Node.js Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC A Node.js script to perform a quick search using the Fluximmo API. ```javascript const fetch = require('node-fetch'); const url = 'https://api.fluximmo.io/v2/search/properties'; const apiKey = 'YOUR_TEST_KEY'; const payload = { query: { postalCode: '75001', offer: 'sale', price: { gte: 100000, lte: 350000 }, surface: { gte: 30, lte: 110 }, propertyType: ['FLAT', 'HOUSE'], meta: { isTotallyOffline: false } }, pagination: { size: 100, sort: 'FIRST_SEEN_AT DESC' } }; fetch(url, { method: 'POST', headers: { 'Content-Type': 'application/json', 'X-PARTNER-API-KEY': apiKey }, body: JSON.stringify(payload) }) .then(response => { if (!response.ok) { throw new Error(`HTTP error! status: ${response.status}`); } return response.json(); }) .then(data => { console.log(data); }) .catch(error => { console.error('Error:', error); }); ``` -------------------------------- ### Quickstart: Curl Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC A cURL command to perform a quick search, demonstrating basic API usage. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/search/properties' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "query": { "postalCode": "75001", "offer": "sale", "price": { "gte": 100000, "lte": 350000 }, "surface": { "gte": 30, "lte": 110 }, "propertyType": ["FLAT", "HOUSE"], "meta": { "isTotallyOffline": false } }, "pagination": { "size": 100, "sort": "FIRST_SEEN_AT DESC" } }' ``` -------------------------------- ### GET /v2/sample/webhook/adverts Source: https://doc.fluximmo.io/demarrer/sample-data Returns an example payload for an ADVERT webhook (creation, price change, etc.). This payload is complete and does not require a separate refetch. ```APIDOC ## GET /v2/sample/webhook/adverts ### Description Returns an example payload for an `ADVERT` webhook (creation, price change, republication, offline status). The payload is complete and does not require a refetch. ### Method GET ### Endpoint /v2/sample/webhook/adverts ### Parameters ### Request Example ```json { "example": "No request body needed for this GET request." } ``` ### Response #### Success Response (200) - **advert** (object) - The complete advert payload. #### Response Example ```json { "advert": { "advertId": "some_advert_id", "url": "https://example.com/advert/456", "title": "Updated Advert Title", "price": 160000, "status": "active" } } ``` ``` -------------------------------- ### GEO: CSV Upload Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Example of uploading a CSV file for geographical processing. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/geo/csv' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -F 'file=@/path/to/your/file.csv' ``` -------------------------------- ### Advert Data Structure Example Source: https://doc.fluximmo.io/concepts/property-vs-advert This JSON example shows the structure of two 'Advert' objects. Notice how 'propertyFlxId' links the second advert as a duplicate of the first, allowing for client-side deduplication. ```json { "flxId": "adv_aaa", "propertyFlxId": "adv_aaa", "source": { "website": "" } } { "flxId": "adv_bbb", "propertyFlxId": "adv_aaa", "source": { "website": "" } } ``` -------------------------------- ### Geometry Point Example Source: https://doc.fluximmo.io/api-geocoding-reference/search/recherche-par-g%C3%A9ocodage-direct This example shows the structure for a Point geometry, commonly used for representing locations. ```json { "type": "Point", "coordinates": [ 2.03648539635326, 44.3492508045369 ] } ``` -------------------------------- ### GET /v2/sample/properties Source: https://doc.fluximmo.io/demarrer/sample-data Fetches a sample of 10 properties, with a schema identical to POST /v2/protected/properties/search. ```APIDOC ## GET /v2/sample/properties ### Description Fetches a sample of 10 properties. The schema is identical to the one used in `POST /v2/protected/properties/search`. ### Method GET ### Endpoint /v2/sample/properties ### Parameters ### Request Example ```json { "example": "No request body needed for this GET request." } ``` ### Response #### Success Response (200) - **data** (array) - An array of property objects. #### Response Example ```json { "data": [ { "flxId": "some_property_id", "externalId": "some_external_id", "title": "Example Property Title", "description": "An example property description.", "price": 100000, "type": "apartment", "location": { "city": "Example City", "postalCode": "12345", "country": "Example Country" } } ] } ``` ``` -------------------------------- ### Multi-Zone Search Example (INSEE Code + Department) Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Combine multiple geographic zones in a single search query. This example searches within a specific INSEE code and a set of departments. ```json { "FilterLocation": [ { "inseeCode": "75056" }, { "department": ["92", "93", "94"] } ] } ``` -------------------------------- ### GEO: Search Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Example of using the GEO search endpoint. Note: Data originates from the French National Geographic Institute (IGN) and OpenStreetMap, not proprietary Fluximmo data. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/geo/search' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "query": "Paris, France" }' ``` -------------------------------- ### Point of Interest (POI) Properties Example Source: https://doc.fluximmo.io/api-geocoding-reference/search/recherche-par-g%C3%A9ocodage-direct This example demonstrates the structure and fields for a Point of Interest, including its toponym, postcodes, city codes, city names, category, extra fields, and geometry. ```json { "toponym": "Pont National", "postcode": [ "77310", "91100" ], "citycode": [ "77", "77300", "91", "91450" ], "city": [ "Saint-Fargeau-Ponthierry", "Corbeil-Essonnes" ], "category": [ "construction linéaire" ], "extrafields": { "names": [ "pont strasbourg", "pont national" ], "cleabs": "CONSLINE0000000060494180" }, "truegeometry": { "coordinates": [ [ 2.03666899913969, 44.3490469250535, 257 ], [ 2.03646952056093, 44.3492684335352, 256.3 ], [ 2.03644906780383, 44.3492907599887, 256.3 ], [ 2.03630075804051, 44.3494542018237, 256.3 ] ], "type": "LineString" }, "_score": 0.5757575757575758, "_type": "poi" } ``` -------------------------------- ### Search Adverts: Seller/Agency Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Searches for adverts associated with a specific seller or agency. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/search/adverts' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "query": { "sellerId": "seller_123", "offer": "sale" }, "pagination": { "size": 100 } }' ``` -------------------------------- ### Search Adverts: Property ID Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Searches for adverts linked to a specific property ID. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/search/adverts' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "query": { "propertyFlxId": "FLX123456789", "offer": "sale" }, "pagination": { "size": 100 } }' ``` -------------------------------- ### Search Properties: Department Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Searches for houses in a specific department with minimum surface area and number of bedrooms. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/search/properties' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "query": { "department": "13", "offer": "sale", "propertyType": ["HOUSE"], "surface": { "gte": 80 }, "numberOfRooms": { "gte": 3 } }, "pagination": { "size": 100 } }' ``` -------------------------------- ### GET /v2/sample/webhook/properties Source: https://doc.fluximmo.io/demarrer/sample-data Provides an example payload for a PROPERTY webhook, containing only IDs. A subsequent GET /v2/protected/properties/{flxId} is needed to fetch enriched data. ```APIDOC ## GET /v2/sample/webhook/properties ### Description Provides an example payload for a `PROPERTY` webhook (creation/merge). The payload contains only IDs, requiring a refetch via `GET /v2/protected/properties/{flxId}` to retrieve enriched data. ### Method GET ### Endpoint /v2/sample/webhook/properties ### Parameters ### Request Example ```json { "example": "No request body needed for this GET request." } ``` ### Response #### Success Response (200) - **propertyIds** (array) - An array of property IDs. #### Response Example ```json { "propertyIds": [ "flxId1", "flxId2" ] } ``` ``` -------------------------------- ### Sample Property Webhook Payload Source: https://doc.fluximmo.io/demarrer/sample-data Example of the body sent by Fluximmo on a PROPERTY webhook (creation/merge). The payload contains only IDs, requiring a refetch via GET /v2/protected/properties/{flxId} to get enriched data. ```bash curl --location 'https://api.fluximmo.io/v2/sample/webhook/properties' ``` -------------------------------- ### Local Development Server Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Launch the local development server for documentation. Ensure no broken links and consistent navigation. ```bash mintlify dev ``` -------------------------------- ### Estimate Bretagne House (V2) Source: https://doc.fluximmo.io/api-v2-reference/estimations/lite-property-estimation Example of estimating a 110m², 4-room house with 350m² of land in Bretagne using the lite property estimation endpoint. ```bash curl -X POST https://api.fluximmo.io/v2/protected/estimate/property/lite \ -H "x-api-key: $FLUXIMMO_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "location": { "locationCoordinate": { "location": [-4.4861, 48.3904] } }, "habitation": { "surface": { "total": 110 }, "roomCount": 4, "bedroomCount": 3 }, "land": { "surface": 350 }, "type": "CLASS_HOUSE", "offer": { "type": "OFFER_BUY" } }' ``` -------------------------------- ### Call to Action: Free Trial Key Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC A footer call to action for a free one-week trial key on my.fluximmo.io. ```markdown

Get your free one-week test key on my.fluximmo.io!

``` -------------------------------- ### Estimate Paris Apartment (V2) Source: https://doc.fluximmo.io/api-v2-reference/estimations/lite-property-estimation Example of estimating a 60m², 3-room apartment in Paris (75001) using the lite property estimation endpoint. ```bash curl -X POST https://api.fluximmo.io/v2/protected/estimate/property/lite \ -H "x-api-key: $FLUXIMMO_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "location": { "locationCoordinate": { "location": [2.3376, 48.8606] } }, "habitation": { "surface": { "total": 60 }, "roomCount": 3, "bedroomCount": 2 }, "type": "CLASS_FLAT", "offer": { "type": "OFFER_BUY" } }' ``` -------------------------------- ### Estimate Property Price (Node.js) Source: https://doc.fluximmo.io/api-v2-reference/estimations/estimate-the-price-of-a-property This Node.js example demonstrates how to use the `fetch` API to send a POST request to the experimental estimation endpoint. It retrieves the API key from environment variables and stringifies the JSON body. ```javascript const resp = await fetch("https://api.fluximmo.io/v2/protected/experimental/estimate", { method: "POST", headers: { "x-api-key": process.env.FLUXIMMO_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ property: { lat: 48.8589, lon: 2.3789, propertyType: "FLAT", surfaceArea: 45, roomsCount: 2, bedroomsCount: 1, }, }), }); console.log(await resp.json()); ``` -------------------------------- ### GEO: Reverse Search Example Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Example of using the GEO reverse search endpoint. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/geo/reverse' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "location": { "lat": 48.8566, "lon": 2.3522 } }' ``` -------------------------------- ### Configuration Mintlify pour la Navigation et la Palette Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Configuration du fichier mint.json pour structurer la navigation en 5 sections, définir la palette de couleurs, et ajuster les paramètres d'apparence et de barre supérieure. ```json { "navigation": [ { "title": "Démarrer", "slug": "/" }, { "title": "Concepts", "slug": "/concepts" }, { "title": "Playbooks", "slug": "/playbooks" }, { "title": "API Reference", "slug": "/api-reference" }, { "title": "Ressources", "slug": "/ressources" } ], "colors": { "primary": "#1E40AF", "accent": "#10B981", "gradient": { "from": "#10B981", "to": "#1E40AF" } }, "appearance": { "default": "system" }, "background": { "decoration": "gradient" }, "topbar": { "links": [ { "title": "Mon compte", "url": "/mon-compte" }, { "title": "Nous contacter", "url": "mailto:contact@fluximmo.io" } ] } } ``` -------------------------------- ### Geometry Polygon Example Source: https://doc.fluximmo.io/api-geocoding-reference/search/recherche-par-g%C3%A9ocodage-direct This example defines a Polygon geometry, suitable for representing areas or boundaries. ```json { "type": "Polygon", "coordinates": [ [ [ 2.35457222187139, 48.8523027661354 ], [ 2.35463049659443, 48.8523731401755 ], [ 2.35465580843827, 48.8523650925735 ], [ 2.35464724014948, 48.8522756505323 ], [ 2.35457222187139, 48.8523027661354 ] ] ] } ``` -------------------------------- ### Properties Search Lite - Autocomplete Example Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Demonstrates the use of the lite search endpoint for autocomplete functionality, providing quick suggestions based on partial input. ```json { "location": { "city": "Paris" }, "query": "appartement", "size": 5 } ``` -------------------------------- ### GET /version, GET /healthz Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Retrieves the system version and health status. These endpoints do not require authentication. ```APIDOC ## GET /version, GET /healthz ### Description Retrieves the system version and health status. These endpoints do not require authentication. ### Method GET ### Endpoint /version /healthz ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **version** (string) - The current version of the system. - **status** (string) - The health status of the system (e.g., "ok"). ### Response Example { "version": "1.0.0", "status": "ok" } ``` -------------------------------- ### View Sample Properties (Python) Source: https://doc.fluximmo.io/demarrer/quickstart This Python script uses the requests library to get 10 sample properties from the public endpoint. It prints the number of properties received, useful for testing your parsing logic. ```python import requests response = requests.get("https://api.fluximmo.io/v2/sample/properties") properties = response.json()["data"] print(f"Reçu {len(properties)} properties") ``` -------------------------------- ### GET /properties/search/alerts/all Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Retrieves all property search alerts. This endpoint is used to get alerts in a specific format. ```APIDOC ## GET /properties/search/alerts/all ### Description Retrieves all configured property search alerts. This endpoint provides a comprehensive list of alerts in a specified format. ### Method GET ### Endpoint `/properties/search/alerts/all` ``` -------------------------------- ### Get Version Source: https://doc.fluximmo.io/api-v2-reference/system/getversion Retrieves the current application version. This is a simple GET request that returns the version information. ```APIDOC ## GET /version ### Description Get the app version. ### Method GET ### Endpoint /version ### Parameters ### Request Example ### Response #### Success Response (200) - **data** (object) - Contains version information. - **version** (string) - The current application version. #### Response Example ```json { "data": { "version": "v1.0.0" } } ``` ``` -------------------------------- ### GET /properties/search/alerts/{id}/activate Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Activates a property search alert using a GET request, similar to the advert alerts. ```APIDOC ## GET /properties/search/alerts/{id}/activate ### Description Activates a specific property search alert. This endpoint uses a GET method for activation, consistent with the advert alerts activation endpoint. ### Method GET ### Endpoint `/properties/search/alerts/{id}/activate` ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the property alert to activate. ``` -------------------------------- ### Alerts: Property Create (Standard) Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Creates a standard property alert for new listings. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/alerts/properties' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "match": ["CREATED"], "query": { "postalCode": "75001", "offer": "sale", "propertyType": ["FLAT"], "meta": { "isTotallyOffline": false } } }' ``` -------------------------------- ### Fetch Sample Adverts (Node.js) Source: https://doc.fluximmo.io/demarrer/sample-data Retrieve a sample of 10 raw adverts using Node.js fetch. This shows how to get and process advert data in a JavaScript environment. ```javascript const response = await fetch("https://api.fluximmo.io/v2/sample/adverts"); const { data: adverts } = await response.json(); console.log(`Reçu ${adverts.length} adverts`); ``` -------------------------------- ### GET /adverts/search/alerts/{id}/activate Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Activates a search alert using a GET request. This endpoint follows a legacy semantic for activation. ```APIDOC ## GET /adverts/search/alerts/{id}/activate ### Description Activates a specific search alert. This endpoint uses a GET method for activation, adhering to legacy conventions. ### Method GET ### Endpoint `/adverts/search/alerts/{id}/activate` ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the alert to activate. ``` -------------------------------- ### Advert JSON Example Source: https://doc.fluximmo.io/api-v2-reference/_api-models/advert An example JSON payload representing an advert, including its ID, property details, source information, pricing, location, and timestamps. ```APIDOC ## JSON exemple ```json theme={null} { "flxId": "adv_01HXY...", "propertyFlxId": "prop_01HXY...", "mainPropertyAdFlxId": "adv_01HXY_main", "type": "CLASS_FLAT", "title": "T3 75m² Bastille - terrasse", "source": { "website": "", "url": "https://.example/annonces/", "flxId": "src_01HXY..." }, "seller": { "name": "Agence Bastille Immo", "type": "SELLER_TYPE_AGENCY", "siren": "812345678" }, "isOnline": true, "isPro": true, "isExclusive": false, "isAuction": false, "currency": "CURRENCY_EUR", "scope": "PRICING_ONE_OFF", "currentPrice": { "value": 435000, "valuePerArea": 5800 }, "offer": { "type": "OFFER_BUY", "isCurrentlyOccupied": false }, "location": { "postalCode": "75011", "inseeCode": "75111", "city": "Paris", "locationCoordinate": { "lat": 48.857, "lng": 2.376 } }, "habitation": { "surface": { "total": 75 }, "roomCount": 3, "bedroomCount": 2 }, "firstSeenAt": "2025-04-22T09:11:00.000Z", "lastSeenAt": "2025-04-30T18:42:00.000Z", "lastModifiedAt": "2025-04-29T07:00:00.000Z" } ``` ``` -------------------------------- ### Fetch Sample Adverts (Python) Source: https://doc.fluximmo.io/demarrer/sample-data Retrieve a sample of 10 raw adverts using Python's requests library. This demonstrates fetching and parsing advert data in Python. ```python import requests response = requests.get("https://api.fluximmo.io/v2/sample/adverts") adverts = response.json()["data"] print(f"Reçu {len(adverts)} adverts") ``` -------------------------------- ### Sample Data: Properties Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Retrieves sample property data from the /v2/sample/properties endpoint. This endpoint does not require authentication. ```bash curl -X GET 'https://api.fluximmo.io/v2/sample/properties' ``` -------------------------------- ### Parcel Properties Example Source: https://doc.fluximmo.io/api-geocoding-reference/search/recherche-par-g%C3%A9ocodage-direct This example illustrates the structure for parcel data, including its unique ID, department and municipality codes, city name, cadastral information, and polygonal geometry. ```json { "id": "75056104AV0133", "departmentcode": "75", "municipalitycode": "056", "city": "Paris", "oldmunicipalitycode": "000", "districtcode": "104", "section": "AV", "number": "133", "sheet": "1", "truegeometry": { "type": "Polygon", "coordinates": [ [ [ 2.35457222187139, 48.8523027661354 ], [ 2.35463049659443, 48.8523731401755 ], [ 2.35465580843827, 48.8523650925735 ], [ 2.35464724014948, 48.8522756505323 ], [ 2.35457222187139, 48.8523027661354 ] ] ] }, "_score": 1, "_type": "parcel" } ``` -------------------------------- ### Search Properties: Pagination Cursor Source: https://doc.fluximmo.io/PLAN_ACTION_CONCRET_REFACTOR_DOC Demonstrates how to use the `searchAfterHash` cursor for paginating search results. ```bash curl -X POST \ 'https://api.fluximmo.io/v2/search/properties' \ -H 'Content-Type: application/json' \ -H 'X-PARTNER-API-KEY: YOUR_TEST_KEY' \ -d '{ "query": { "postalCode": "75001", "offer": "sale" }, "pagination": { "size": 100, "searchAfterHash": "some_hash_value_from_previous_response" } }' ``` -------------------------------- ### Achat appartement département (nouvelles annonces uniquement) Source: https://doc.fluximmo.io/api-v2-reference/adverts-alerts/create-a-new-advert-alert-for-this-search Configurez une alerte pour recevoir des notifications uniquement lorsqu'une nouvelle annonce correspond à vos critères de recherche. Il est recommandé d'inclure `isOnline: true` pour filtrer les annonces actuellement publiées. ```json { "search_query": { "filterAd": { "location": { "department": "75" }, "type": ["CLASS_FLAT"], "offer": [{ "type": "OFFER_BUY" }], "isOnline": true } }, "webhook_url": "https://votre-domaine.com/webhooks/fluximmo", "match": ["ALERT_MATCH_CREATED"], "search_name": "Achat T2-T3 Paris" } ``` -------------------------------- ### Start Batch Geocoding Request Source: https://doc.fluximmo.io/api-geocoding-reference/batch-async/démander-le-démarrage-du-géocodage This OpenAPI specification defines the POST request to start the batch geocoding process for a given project ID. It requires the projectId in the path and returns a 200 status on success, indicating the project is waiting for geocoding. ```yaml post /async/projects/{projectId}/start openapi: 3.1.1 info: title: Service de géocodage description: API du service de géocodage 2.0 de l'IGN. contact: email: contact.geoservices@ign.fr version: 2.0.0 license: name: Licence ouverte 2.0 url: https://www.etalab.gouv.fr/licence-ouverte-open-licence servers: - url: https://geo.fluximmo.io security: [] tags: - name: getCapabilities description: Découverte du service - name: search description: Géocodage direct (recherche) - name: reverse description: Géocodage inverse - name: batch description: Géocodage par lot synchrone - name: batch-async description: Géocodage par lot asynchrone paths: /async/projects/{projectId}/start: post: tags: - batch-async summary: Démander le démarrage du géocodage description: > Permet de signifier à la plateforme que le géocodage est prêt à être effectué. Il faut au préalable que le fichier source ait été soumis, ainsi que les paramètres du traitement. L'opération peut être annulée via la requête adéquate. parameters: - name: projectId description: Identifiant unique du projet in: path required: true schema: type: string responses: '200': description: Projet mis en attente de géocodage content: application/json: schema: $ref: '#/components/schemas/Project' '401': description: Non autorisé '403': description: >- Action interdite (le projet est en cours de traitement ou terminé ou des éléments sont manquants) '404': description: Projet introuvable security: - ProjectAuth: [] components: schemas: Project: type: object properties: id: type: string status: type: string enum: - idle - waiting - processing - failed - completed createdAt: type: string format: date-time updatedAt: type: string format: date-time params: $ref: '#/components/schemas/ProjectParams' pipeline: $ref: '#/components/schemas/Pipeline' inputFile: type: object outputFile: type: object processing: $ref: '#/components/schemas/GeocodeProcessing' token: type: string description: >- Jeton permettant d'interéagir avec le projet. N'est retourné que lors de la création. ProjectParams: type: object properties: maxInputFileSize: type: string enum: - 50MB - 100MB - 200MB - 500MB - 1GB concurrency: type: number enum: - 1 - 2 - 4 Pipeline: type: object properties: geocodeOptions: type: object properties: operation: type: string description: Opération demandée enum: - search - reverse default: search indexes: type: array description: Index à utiliser pour le géocodage items: type: string enum: - address - poi - parcel columns: type: array items: type: string description: > Liste des colonnes du fichier CSV à utiliser pour le géocodage. Celles-ci seront concaténées pour former le critère de recherche texte. Si le paramètre n'est pas fourni toutes les colonnes seront concaténées, ce qui est rarement souhaitable. type: type: string description: >- Colonne contenant le type d’objet accepté pour le géocodage de la ligne (address) citycode: type: string description: >- Colonne contenant le code INSEE de la commune à utiliser comme filtre (address, poi) postcode: type: string description: >- Colonne contenant le code postal à utiliser comme filtre (address, poi) category: type: string description: >- Colonne contenant la catégorie de POI à utiliser comme filtre (poi) lon: type: string description: Colonne contenant la longitude du point de recherche lat: type: string ``` -------------------------------- ### Sample Endpoints (V2) Source: https://doc.fluximmo.io/RECOMMENDATION_IMPROVE_DOC Provides access to 4 sample endpoints under the V2 path. No authentication is required. ```APIDOC ## GET /v2/sample/* ### Description Provides access to sample data and functionalities under the V2 path. These endpoints are intended for testing and demonstration purposes and do not require authentication. ### Method GET ### Endpoint /v2/sample/* ### Parameters (No specific parameters defined, wildcard indicates flexibility in sub-paths) ```