{"openapi":"3.0.2","info":{"title":"Limopro - bodacc API","version":"1.1.0","description":"Représente un indicateur d'acte de publication, avec le nombre de publication associé à l'acte.\n\n## ChangeLog\n\n* 20/02/2021 - v1.0.0 - Version initial\n* 20/05/2022 - v1.1.0 - Ajout propriété corporation pour company et publication\u003ebuyer|seller"},"servers":[{"url":"http://api.limopro.fr/api/v1","description":"Le serveur de production pour l'API limopro"},{"url":"http://api-staging.limopro.fr/api/v1","description":"Le serveur de test de l'API limopro"}],"paths":{"/users":{"get":{"tags":["Administration"],"parameters":[{"examples":{"Exemple 1":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email d'un administrateur.","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Exemple 1":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token d'un administrateur.","schema":{"type":"string"},"in":"header","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"},"examples":{"Exemple 1":{"value":{"per_page":25,"pages":1,"total":2,"page":1,"users":[{"email":"olivier@limopro.com","token":"GVSoTx5y4X7ByMZndS_9","limit_dept":"91,92,93","enabled":true},{"email":"agathe@thepower.fr","token":"14BD-Z5bAsNab3xeT5pLy","limit_dept":"","enabled":false}]}}}}},"description":"Retourne la liste des utilisateurs de l'application sans les administrateurs du site."},"401":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"Exemple 2":{"value":{"error":"Vous n'êtes pas autorisé à effectuer cette action"}}}}},"description":"Il est nécessaire d'utiliser un compte administrateur afin de pouvoir effectuer cette action."}},"summary":"Obtient la liste des utilisateurs pouvant accéder à l'API","description":"Renvoi uniquement la liste des utilisateurs autorisés à utiliser l'API, mais n'affiche pas les administrateurs du site.\nSeul, le token d'un administrateur peut utiliser cet opération."},"post":{"requestBody":{"description":"Données de l'utilisateur à utiliser pour la création","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"Example":{"value":{"user":{"email":"olivier@odevsystem.com","limit_dept":"91,92,93","enabled":false}}}}}},"required":true},"tags":["Administration"],"parameters":[{"examples":{"Exemple 1":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email d'un administrateur.","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Exemple 1":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token d'un administrateur.","schema":{"type":"string"},"in":"header","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"Exemple 1":{"value":{"email":"olivier@limopro.com","token":"GVSoTy5y4X7AyMZndS_9","limit_dept":"91,92,93","created_at":"2021-04-17T13:37:38.555+02:00","updated_at":"2021-04-30T07:08:51.070+02:00","enabled":true}}}}},"description":"Une fois créé, retourne les informations sur l'utilisateur."},"401":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"Exemple 2":{"value":{"error":"Vous n'êtes pas autorisé à effectuer cette action"}}}}},"description":"Il est nécessaire d'utiliser un compte administrateur afin de pouvoir effectuer cette action."}},"summary":"Créer un utilisateur","description":"Permet de créer un utilisateur de l'API, mais ne permet pas de créer d'administrateur du site.\nSeul, le token d'un administrateur peut utiliser cet opération."}},"/users/{email}":{"get":{"tags":["Administration"],"parameters":[{"examples":{"Exemple 1":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email d'un administrateur.","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Exemple 1":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token d'un administrateur.","schema":{"type":"string"},"in":"header","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"Exemple 1":{"value":{"email":"olivier@limopro.com","token":"GVSoTy5y4X7AyMZndS_9","limit_dept":"91,92,93","created_at":"2021-04-17T13:37:38.555+02:00","updated_at":"2021-04-30T07:08:51.070+02:00","enabled":true}}}}},"description":"Retourne les informations sur un utilisateur."},"401":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"Exemple 2":{"value":{"error":"Vous n'êtes pas autorisé à effectuer cette action"}}}}},"description":"Il est nécessaire d'utiliser un compte administrateur afin de pouvoir effectuer cette action."}},"summary":"Obtient la liste des utilisateurs pouvant accéder à l'API","description":"Renvoi uniquement la liste des utilisateurs autorisés à utiliser l'API, mais n'affiche pas les administrateurs du site.\nSeul, le token d'un administrateur peut utiliser cet opération."},"put":{"requestBody":{"description":"Données de l'utilisateur à fournir, excepté son email, qui ne peut être modifié.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"Example":{"value":{"limit_dept":"91","enabled":true}}}}},"required":true},"tags":["Administration"],"parameters":[{"examples":{"Exemple 1":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email d'un administrateur.","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Exemple 1":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token d'un administrateur.","schema":{"type":"string"},"in":"header","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"Exemple 1":{"value":{"email":"olivier@limopro.com","token":"GVSoTy5y4X7AyMZndS_9","limit_dept":"91,92,93","created_at":"2021-04-17T13:37:38.555+02:00","updated_at":"2021-04-30T07:08:51.070+02:00","enabled":true}}}}},"description":"Une fois modifié, retourne les informations sur l'utilisateur."},"401":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"Exemple 2":{"value":{"error":"Vous n'êtes pas autorisé à effectuer cette action"}}}}},"description":"Il est nécessaire d'utiliser un compte administrateur afin de pouvoir effectuer cette action."}},"summary":"Modifie un utilisateur","description":"Permet de modifier l'utilisateur dont l'email est donné dans le path de l'opération.\nSeul, le token d'un administrateur peut utiliser cet opération."},"delete":{"tags":["Administration"],"parameters":[{"examples":{"Exemple 1":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email d'un administrateur.","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Exemple 1":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token d'un administrateur.","schema":{"type":"string"},"in":"header","required":true}],"responses":{"200":{"description":"Lorsqu'un utilisateur a été supprimé avec succès."},"401":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"Exemple 2":{"value":{"error":"Vous n'êtes pas autorisé à effectuer cette action"}}}}},"description":"Il est nécessaire d'utiliser un compte administrateur afin de pouvoir effectuer cette action."}},"summary":"Supprime un utilisateur.","description":"Permet de supprimer définitivement un utilisateur de la base de données.\nSeul, le token d'un administrateur peut utiliser cet opération."},"parameters":[{"examples":{"Exemple 1":{"value":"olivier@limopro.fr"}},"name":"email","description":"L'email de l'utilisateur.","schema":{"type":"string"},"in":"path","required":true}]},"/publications/indicators/acts":{"get":{"tags":["Indicator"],"parameters":[{"examples":{"Bordeaux":{"value":"33000"}},"name":"cp","description":"Le code postal au format 00000","schema":{"type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":33}},"name":"dpt","description":"Le code du département à rechercher","schema":{"type":"integer"},"in":"query"},{"examples":{"Bar_Tabac":{"value":"69.20Z,96.02A"}},"name":"ape_codes","description":"Le code APE des entreprises à rechercher.\nVous pouvez saisir une liste de code ape à retourner.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email de l'utilisateur habilité à utiliser l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Bordeaux":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token de l'utilisateur pour l'authentification à l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"2 Place de la Victoire":{"value":"2 Place de la Victoire Bordeaux"}},"name":"address","description":"Doit contenir une adresse précise. \nSi renseignée l'API va récupérer le geo_id du lieu (https://api-adresse.data.gouv.fr/), et rechercher les publications associées à ce lieu.\nSi vous utilisez un autre paramètre, vous pourriez vous retrouvez sans données suite à trop de filtre.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2008-12-30"}},"name":"start_date","description":"Représente la date de début de publication, le paramètre end_date peut-être saisi pour définir une période à récupérer.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2009-12-30\t"}},"name":"end_date","description":"Représente la date de fin de la période de filtre sur les publications. Si ce paramètre n'est pas saisie, par défaut, l'API prends la date de début de la période de filtre.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":"33063_9285_00002"}},"name":"geo_id","description":"Permet de filtrer sur le geo_id associé au publication à récupérer.\nIl s'agit du même filtre utiliser pour le filtre adresse.\nVous pouvez utiliser un modèle afin de chercher les premiers caractères de la valeur du geo_id.","schema":{"type":"string"},"in":"query"},{"examples":{"Example":{"value":"69."}},"name":"ape_code","description":"Permet de filtrer l'ape_code associé à la publication.\nFonctionne comme un like.","schema":{"type":"string"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Indicator_act"}},"examples":{"Example":{"value":[{"act":"creation","count":205675},{"act":"immatriculation","count":43487},{"act":"modification","count":76409},{"act":"radiation","count":131034},{"act":"vente","count":31847}]}}}},"description":"Retourne le nombre d'acte de publications par type d'acte"}},"summary":"Affiche le nombre de publications par types d'actes","description":"Permet de voir le nombre de publications par types d'actes en utilisant les mêmes filtres que pour l'opération publication."}},"/publications/indicators/sales":{"get":{"tags":["Indicator"],"parameters":[{"examples":{"Bordeaux":{"value":"33000"}},"name":"cp","description":"Le code postal au format 00000","schema":{"type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":33}},"name":"dpt","description":"Le code du département à rechercher","schema":{"type":"integer"},"in":"query"},{"examples":{"Bar_Tabac":{"value":"69.20Z,96.02A"}},"name":"ape_codes","description":"Le code APE des entreprises à rechercher.\nVous pouvez saisir une liste de code ape à retourner.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email de l'utilisateur habilité à utiliser l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Bordeaux":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token de l'utilisateur pour l'authentification à l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"2 Place de la Victoire":{"value":"2 Place de la Victoire Bordeaux"}},"name":"address","description":"Doit contenir une adresse précise. \nSi renseignée l'API va récupérer le geo_id du lieu (https://api-adresse.data.gouv.fr/), et rechercher les publications associées à ce lieu.\nSi vous utilisez un autre paramètre, vous pourriez vous retrouvez sans données suite à trop de filtre.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2008-12-30"}},"name":"start_date","description":"Représente la date de début de publication, le paramètre end_date peut-être saisi pour définir une période à récupérer.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2009-12-30\t"}},"name":"end_date","description":"Représente la date de fin de la période de filtre sur les publications. Si ce paramètre n'est pas saisie, par défaut, l'API prends la date de début de la période de filtre.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":"33063_9285_00002"}},"name":"geo_id","description":"Permet de filtrer sur le geo_id associé au publication à récupérer.\nIl s'agit du même filtre utiliser pour le filtre adresse.\nVous pouvez utiliser un modèle afin de chercher les premiers caractères de la valeur du geo_id.","schema":{"type":"string"},"in":"query"},{"examples":{"Example":{"value":"69."}},"name":"ape_code","description":"Permet de filtrer l'ape_code associé à la publication.\nFonctionne comme un like.","schema":{"type":"string"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Indicator_sale"}},"examples":{"Moyenne des ventes par années":{"value":[{"date":"2009-01-01","avg":229240},{"date":"2010-01-01","avg":376229},{"date":"2011-01-01","avg":269445},{"date":"2012-01-01","avg":2004839},{"date":"2013-01-01","avg":457539},{"date":"2014-01-01","avg":355131},{"date":"2015-01-01","avg":575138},{"date":"2016-01-01","avg":380814}]},"Volume des ventes par jours":{"value":[{"date":"2009-09-01","count":9},{"date":"2009-09-02","count":10},{"date":"2009-09-03","count":10},{"date":"2009-09-04","count":1}]}}}},"description":"Retourne le volume des ventes regroupés par jour/mois/année, en fonction de la valeur du paramètre de groupe saisie."}},"summary":"Retourne le volume de ventes regroupés","description":"Retourne le volume des ventes regroupés par jour/mois/année, en fonction de la valeur du paramètre de groupe saisie."}},"/publications/indicators/top":{"get":{"tags":["Indicator"],"parameters":[{"examples":{"Bordeaux":{"value":"33000"}},"name":"cp","description":"Le code postal au format 00000","schema":{"type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":33}},"name":"dpt","description":"Le code du département à rechercher","schema":{"type":"integer"},"in":"query"},{"examples":{"Bar_Tabac":{"value":"69.20Z,96.02A"}},"name":"ape_codes","description":"Le code APE des entreprises à rechercher.\nVous pouvez saisir une liste de code ape à retourner.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email de l'utilisateur habilité à utiliser l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Bordeaux":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token de l'utilisateur pour l'authentification à l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"2 Place de la Victoire":{"value":"2 Place de la Victoire Bordeaux"}},"name":"address","description":"Doit contenir une adresse précise. \nSi renseignée l'API va récupérer le geo_id du lieu (https://api-adresse.data.gouv.fr/), et rechercher les publications associées à ce lieu.\nSi vous utilisez un autre paramètre, vous pourriez vous retrouvez sans données suite à trop de filtre.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2008-12-30"}},"name":"start_date","description":"Représente la date de début de publication, le paramètre end_date peut-être saisi pour définir une période à récupérer.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2009-12-30\t"}},"name":"end_date","description":"Représente la date de fin de la période de filtre sur les publications. Si ce paramètre n'est pas saisie, par défaut, l'API prends la date de début de la période de filtre.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":"33063_9285_00002"}},"name":"geo_id","description":"Permet de filtrer sur le geo_id associé au publication à récupérer.\nIl s'agit du même filtre utiliser pour le filtre adresse.\nVous pouvez utiliser un modèle afin de chercher les premiers caractères de la valeur du geo_id.","schema":{"type":"string"},"in":"query"},{"examples":{"Example":{"value":"69."}},"name":"ape_code","description":"Permet de filtrer l'ape_code associé à la publication.\nFonctionne comme un like.","schema":{"type":"string"},"in":"query"},{"examples":{"Example":{"value":"month"}},"name":"group","description":"Représente la méthode de regroupement des publications à utiliser.\nCela pourra être day/month/year, par défaut la valeur est 'month'.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Example":{"value":"count"}},"name":"sort","description":"Représente la méthode de trie de l'indicateurs de ventes, soit : 'count' ou 'avg'.\nPar défaut la valeur est 'count'.","schema":{"type":"string"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Indicateur_ape_code"}},"examples":{"Example":{"value":[{"ape_code":"56.10A","count":9890},{"ape_code":"56.10C","count":6631},{"ape_code":"70.10Z","count":3899},{"ape_code":"68.20B","count":3509},{"ape_code":"00000","count":2961},{"ape_code":"10.71C","count":2946},{"ape_code":"96.02A","count":2493},{"ape_code":"56.30Z","count":2071},{"ape_code":"64.20Z","count":2019},{"ape_code":"70.22Z","count":1778}]}}}},"description":"Affiche une liste du volume de vente regroupés par code ape."}},"summary":"Affiche le 3 top des ventes regroupés par code_ape.","description":"Affiche une liste du volume de vente regroupés par code ape."}},"/companies/{siren}":{"get":{"tags":["Publication"],"parameters":[{"examples":{"Bordeaux":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email de l'utilisateur habilité à utiliser l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Bordeaux":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token de l'utilisateur pour l'authentification à l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Example":{"value":"449610682"}},"name":"siren","description":"Le siren de l'entreprise à rechercher.","schema":{"type":"string"},"in":"path","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"},"examples":{"Example":{"value":{"company_name":"TYFRED DECO","company_siren":"449610682","ape_code":"00.0Z","total_publications":4,"establishments":[{"siret":"44961068200014","ape_code":"00.0Z","geo_id":"49328_0160_00004","address":"4 RUE DES BASSES PERRIERES","citycode":"49328","city":"SAUMUR"},{"siret":"44961068200022","ape_code":"52.4H","geo_id":"37050_wbw4uc_00148","address":"148 AVENUE DU GRAND SUD","citycode":"37050","city":"CHAMBRAY-LES-TOURS"}],"publications":[{"publication_date":"2008-12-14","bodacc_file":"RCS-B_BXB20080229","publication_num":2218,"type":"annonce","act":"modification","comment":"Modification survenue sur le capital","administration":"","ape_code":"56.10C","buyer":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z"}},{"publication_date":"2008-04-25","bodacc_file":"RCS-A_BXA20080070","publication_num":420,"type":"annonce","act":"vente","comment":"Activité et. principal : commerce de détail de meubles et équipement de la maison","administration":"","place":{"address":"148  avenue  du Grand Sud","postcode":"37170","city":"Chambray-lès-Tours","department":"37","latitude":"0.0","longitude":"0.0"},"buyer":{"name":"NEWLIFE","siren":"499971596","ape_code":"47.59A"},"sold_date":"2007-11-07","sold_price":120,"seller":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z"}},{"publication_date":"2008-02-29","bodacc_file":"RCS-B_BXB20080037","publication_num":1747,"type":"annonce","act":"radiation","comment":"","administration":"Gérant : LEROUX Frédéric. ","place":{"address":"148  avenue  du Grand Sud","postcode":"37170","city":"Chambray-lès-Tours","department":"37","latitude":"0.0","longitude":"0.0"},"buyer":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z"}},{"publication_date":"2008-01-02","bodacc_file":"RCS-A_BXA20080001","publication_num":544,"type":"annonce","act":"immatriculation","comment":"Immatriculation suite à transfert de son siège social.","administration":"Gérant(e) : LEROUX Frédéric. ","place":{"address":"4 Rue des Basses Perrières","postcode":"49400","city":"Saumur","department":"49","geo_api_id":"49328_0160_00004","latitude":"47.256082","longitude":"-0.077308"},"buyer":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z"}}]}}}}},"description":"Renvoi la liste des informations connus de la société."}},"summary":"Obtient les informations sur la société","description":"Obtient des informations sur la société, avec la liste des établissements, et les publications associées."}},"/publications":{"summary":"/publications","get":{"tags":["Publication"],"parameters":[{"examples":{"Bordeaux":{"value":"33000"}},"name":"cp","description":"Le code postal au format 00000","schema":{"type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":33}},"name":"dpt","description":"Le code du département à rechercher","schema":{"type":"integer"},"in":"query"},{"examples":{"Bar_Tabac":{"value":"69.20Z,96.02A"}},"name":"ape_codes","description":"Le code APE des entreprises à rechercher.\nVous pouvez saisir une liste de code ape à retourner.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"olivier@limopro-bodacc-api.fr"}},"name":"X-User-Email","description":"L'email de l'utilisateur habilité à utiliser l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Bordeaux":{"value":"8FfXZi-1aGfXa-i3zafAt"}},"name":"X-User-Token","description":"Le token de l'utilisateur pour l'authentification à l'API","schema":{"type":"string"},"in":"header","required":true},{"examples":{"Bordeaux":{"value":"100"}},"name":"per_page","description":"Détermine combien d'élément on doit afficher par page, par défaut le nombre d'élément est de 25 et est limité à 500.","schema":{"type":"number"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"1"}},"name":"page","description":"Définit la page à consulter dans la liste des éléments. Par défaut, la page est à 1.","schema":{"type":"number"},"in":"query"},{"examples":{"2 Place de la Victoire":{"value":"2 Place de la Victoire Bordeaux"}},"name":"address","description":"Doit contenir une adresse précise. \nSi renseignée l'API va récupérer le geo_id du lieu (https://api-adresse.data.gouv.fr/), et rechercher les publications associées à ce lieu.\nSi vous utilisez un autre paramètre, vous pourriez vous retrouvez sans données suite à trop de filtre.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2008-12-30"}},"name":"start_date","description":"Représente la date de début de publication, le paramètre end_date peut-être saisi pour définir une période à récupérer.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query","required":false},{"examples":{"Bordeaux":{"value":"2009-12-30\t"}},"name":"end_date","description":"Représente la date de fin de la période de filtre sur les publications. Si ce paramètre n'est pas saisie, par défaut, l'API prends la date de début de la période de filtre.\nLe format de la date est le suivant : \"AAAA-MM-JJ\"","schema":{"format":"date","type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":"33063_9285_00002"}},"name":"geo_id","description":"Permet de filtrer sur le geo_id associé au publication à récupérer.\nIl s'agit du même filtre utiliser pour le filtre adresse.\nVous pouvez utiliser un modèle afin de chercher les premiers caractères de la valeur du geo_id.","schema":{"type":"string"},"in":"query"},{"examples":{"Bordeaux":{"value":"light"}},"name":"mode","description":"Permet de définir un mode light afin de ne renvoyer que le strict nécessaire pour les données de publication.\nCe mode n'est pas limité en nombre d'élément par page (per_page), il a néanmoins une valeur par défaut avec 25 comme tout le monde, mais vous pouvez mettre 10000 par page par exemple.","schema":{"type":"string"},"in":"query","required":false},{"examples":{"Example":{"value":"69."}},"name":"ape_code","description":"Permet de filtrer l'ape_code associé à la publication.\nFonctionne comme un like.","schema":{"type":"string"},"in":"query"},{"examples":{"Nice":{"value":"43.660442"}},"name":"lat","description":"Latitude des coordonnées à GPS à fournir.","schema":{"type":"string"},"in":"query"},{"examples":{"Nice":{"value":"7.175499"}},"name":"long","description":"Longitude des coordonnées GPS à fournir","schema":{"type":"string"},"in":"query"},{"examples":{"Nice":{"value":"1000"}},"name":"radius","description":"Détermine un rayon en mètre de recherche autour de la coordonnée GPS donnée.\nPar défaut, le radius est paramétré à 5000.","schema":{"type":"integer"},"in":"query"},{"examples":{"Example":{"value":"vente"}},"name":"act","description":"Permet de filtrer sur le motif de la publication","schema":{"enum":["creation","changement","immatriculation","modification","vente"],"type":"string"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Publication_Response"},"examples":{"Bordeaux":{"value":{"per_page":58,"pages":14104,"total":817987,"page":3,"publications":[{"publication_date":"2012-04-22","type":"annonce","act":"vente","comment":"Au Mandataire Maître Fournier 7 Place Tourny 33000 Bordeaux pour la validité et pour la correspondance","administration":"","ape_code":"56.10C","place":{"address":"2 Place de la Victoire","postcode":"33000","city":"Bordeaux","department":"33","geo_api_id":"33063_9285_00002","latitude":"43.660442","longitude":"7.175499"},"buyer":{"name":"J. BRUNO","siren":"750448247","ape_code":"47.62Z","coporation":true},"seller":{"name":"CAYNEAUD Patrice","siren":"379028688","ape_code":"47.26Z","coporation":true}}]}},"2 Place de la Victoire":{"value":{"per_page":25,"pages":1,"total":2,"page":1,"geo_id_found":"33063_9285_00002","geo_address_url":"https://api-adresse.data.gouv.fr/search/?q=2+Place+de+la+Victoire+Bordeaux","publications":[{"publication_date":"2019-07-09","bodacc_file":"RCS-B_BXB20190130","publication_num":848,"type":"annonce","act":"modification","comment":"Modification survenue sur l'administration, cessation d'activité, dissolution de la société.","administration":"Liquidateur, Associé : BRIN Jérôme ; Associé : BRIN Sylvie","place":{"address":"2 Place de la Victoire","postcode":"33000","city":"Bordeaux","department":"33","geo_api_id":"33063_9285_00002","latitude":"43.660442","longitude":"7.175499"},"buyer":{"name":"J. BRIN","siren":"750443947","corporation":true}},{"publication_date":"2019-09-13","bodacc_file":"RCS-B_BXB20190177","publication_num":328,"type":"annonce","act":"radiation","comment":"","administration":"","place":{"address":"2 Place de la Victoire","postcode":"33000","city":"Bordeaux","department":"33","geo_api_id":"33063_9285_00002","latitude":"43.660442","longitude":"7.175499"},"buyer":{"name":"J. BRIN","siren":"750443947","corporation":true}}]}},"Light":{"value":{"per_page":25,"pages":1,"total":2,"page":1,"publications":[{"place":{"latitude":"43.660442","longitude":"7.175499"}},{"place":{"latitude":"43.660442","longitude":"7.175499"}}]}}}}},"description":"Successful operation"},"400":{"description":"Invalid filter value"}},"summary":"Obtient la liste des annonces en fonction des filtres saisies","description":"Un filtre au moins doit être saisie afin d'obtenir la liste."}}},"components":{"schemas":{"Publication":{"title":"Root Type for Publication","description":"Représente une publication du bodacc.\nElle peut être de type différent, et avec des actes également différents","required":["buyer"],"type":"object","properties":{"publication_date":{"format":"date","description":"La date du fichier de publication du bodacc dans lequel cette publication a été importée.","type":"string"},"type":{"description":"Le type de publication peut être : une annonce, une rectification, une annulation.","type":"array","items":{"type":"string"}},"act":{"description":"Le type d'acte d'une publication peut être : une création, une vente, immatriculation ou une radiation.","type":"array","items":{"type":"string"}},"comment":{"description":"Le commentaire définit dans la publication","type":"string"},"administration":{"description":"Une partie commentaire réservé à l'administration","type":"string"},"place":{"$ref":"#/components/schemas/Place","description":"Le lieu qui concerne cette publication","properties":{"address":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"},"department":{"type":"string"},"geo_api_id":{"type":"string"}}},"buyer":{"$ref":"#/components/schemas/Company","description":"L'entreprise concerné par cette publication, ou dans le cas d'une vente, il s'agit de l'acheteur de la transaction.","properties":{"name":{"type":"string"},"siren":{"type":"string"},"ape_code":{"type":"string"}}},"seller":{"$ref":"#/components/schemas/Company","description":"Dans le cas d'un acte de type vente, il s'agit du vendeur de l'établissement"},"establishment":{"$ref":"#/components/schemas/Establishment","description":"Représente l'établissement lié à la publication, si il a été trouvé.\nCela peut-être l'établissement du vendeur ou de l'acheteur."},"ape_code":{"description":"Représente le code_ape associé à la publication.\nCela peut-être celui de l'établissement associé par rapport à sa géolocalisation, ou alors le premier établissement de l'entreprise associé à la publication, ou alors le code_ape de l'entreprise associé à la publication.","type":"string"}},"example":{"publication_date":"2008-04-25","bodacc_file":"RCS-A_BXA20080070","publication_num":420,"type":"annonce","act":"vente","comment":"Activité et. principal : commerce de détail de meubles et équipement de la maison","administration":"","ape_code":"56.10C","place":{"address":"148  avenue  du Grand Sud","postcode":"37170","city":"Chambray-lès-Tours","department":"37","geo_api_id":"49328_0160_00004","latitude":"47.256082","longitude":"-0.077308"},"buyer":{"name":"NEWLIFE","siren":"499971596","ape_code":"47.59A","corporation":true},"sold_date":"2007-11-07","sold_price":120,"seller":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z","corporation":true},"establishment":{"siret":"50311219500014","ape_code":"56.10C","geo_id":"2B261_9utkfx","address":"MACINAGGIO","citycode":"2B261","city":"ROGLIANO"}}},"Place":{"title":"Root Type for Place","description":"Correspondant au lieu rattaché à un type de publication.","type":"object","properties":{"address":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"},"department":{"type":"string"},"geo_api_id":{"type":"string"}},"example":{"address":"148  avenue  du Grand Sud","postcode":"37170","city":"Chambray-lès-Tours","department":"37","geo_api_id":"49328_0160_00004","latitude":"47.256082","longitude":"-0.077308"}},"Company":{"title":"Root Type for Company","description":"Représente les données d'une société.","type":"object","properties":{"name":{"description":"Le nom de l'entreprise","type":"string"},"siren":{"description":"Le siren de l'entreprise","type":"string"},"ape_code":{"description":"Le code ape de l'entreprise","type":"string"},"establishments":{"description":"Représente la liste des établisements référencés pour la société","type":"array","items":{"$ref":"#/components/schemas/Establishment"}},"publications":{"description":"Représente la liste des publications associées à cette entreprise","type":"array","items":{"$ref":"#/components/schemas/Publication"}},"corporation":{"description":"Détermine si la société est une personne morale ou non.\nTrue, la société est une personne morale, false pour une personne physique"}},"example":{"company_name":"TYFRED DECO","company_siren":"449610682","ape_code":"00.0Z","corporation":true,"total_publications":4,"establishments":[{"siret":"44961068200014","ape_code":"00.0Z","geo_id":"49328_0160_00004","address":"4 RUE DES BASSES PERRIERES","citycode":"49328","city":"SAUMUR"},{"siret":"44961068200022","ape_code":"52.4H","geo_id":"37050_wbw4uc_00148","address":"148 AVENUE DU GRAND SUD","citycode":"37050","city":"CHAMBRAY-LES-TOURS"}],"publications":[{"publication_date":"2008-12-14","bodacc_file":"RCS-B_BXB20080229","publication_num":2218,"type":"annonce","act":"modification","comment":"Modification survenue sur le capital","administration":"","ape_code":"56.10C","buyer":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z","corporation":true}},{"publication_date":"2008-04-25","bodacc_file":"RCS-A_BXA20080070","publication_num":420,"type":"annonce","act":"vente","comment":"Activité et. principal : commerce de détail de meubles et équipement de la maison","administration":"","place":{"address":"148  avenue  du Grand Sud","postcode":"37170","city":"Chambray-lès-Tours","department":"37","latitude":"0.0","longitude":"0.0"},"buyer":{"name":"NEWLIFE","siren":"499971596","ape_code":"47.59A","corporation":true},"sold_date":"2007-11-07","sold_price":120,"seller":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z","corporation":true}},{"publication_date":"2008-02-29","bodacc_file":"RCS-B_BXB20080037","publication_num":1747,"type":"annonce","act":"radiation","comment":"","administration":"Gérant : LEROUX Frédéric. ","ape_code":"56.10C","place":{"address":"148  avenue  du Grand Sud","postcode":"37170","city":"Chambray-lès-Tours","department":"37","latitude":"0.0","longitude":"0.0"},"buyer":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z","corporation":true}},{"publication_date":"2008-01-02","bodacc_file":"RCS-A_BXA20080001","publication_num":544,"type":"annonce","act":"immatriculation","comment":"Immatriculation suite à transfert de son siège social.","administration":"Gérant(e) : LEROUX Frédéric. ","place":{"address":"4 Rue des Basses Perrières","postcode":"49400","city":"Saumur","department":"49","geo_api_id":"49328_0160_00004","latitude":"47.256082","longitude":"-0.077308"},"buyer":{"name":"TYFRED DECO","siren":"449610682","ape_code":"00.0Z","corporation":true}}]}},"Publication_Response":{"description":"Réponse qui retourne un ensemble de publications","required":["Publications","per_page","pages","total","page"],"type":"object","properties":{"Publications":{"description":"La liste des publications trouvées","type":"array","items":{"$ref":"#/components/schemas/Publication"}},"per_page":{"description":"Nombre d'élément par page","type":"integer"},"pages":{"description":"Le nombre de pages","type":"integer"},"total":{"description":"Le nombre total d'élément retourné","type":"integer"},"page":{"description":"Le numéro de la page à laquelle on se trouve","type":"integer"}},"example":{"per_page":58,"pages":14104,"total":817987,"page":3,"publications":[{"publication_date":"2012-04-22","type":"annonce","act":"vente","comment":"Au Mandataire Maître Fournier 7 Place Tourny 33000 Bordeaux pour la validité et pour la correspondance","administration":"","ape_code":"56.10C","place":{"address":"2 Place de la Victoire","postcode":"33000","city":"Bordeaux","department":"33","geo_api_id":"49328_0160_00004","latitude":"47.256082","longitude":"-0.077308"},"buyer":{"name":"J. BRUNO","siren":"750448247","ape_code":"47.62Z","corporation":true},"seller":{"name":"CAYNEAUD Patrice","siren":"379028688","ape_code":"47.26Z","corporation":true},"establishment":{"siret":"50311219500014","ape_code":"56.10C","geo_id":"2B261_9utkfx","address":"MACINAGGIO","citycode":"2B261","city":"ROGLIANO"}}]}},"Users":{"title":"Root Type for Users","description":"Retourne la liste des utilisateurs","type":"object","properties":{"per_page":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"},"total":{"format":"int32","type":"integer"},"page":{"format":"int32","type":"integer"},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"token":{"type":"string"},"limit_dept":{"type":"string"},"enabled":{"type":"boolean"}}}}},"example":{"per_page":25,"pages":1,"total":2,"page":1,"users":[{"email":"olivier@limopro.com","token":"GVSoTx5y4X7ByMZndS_9","limit_dept":"91,92,93","enabled":true},{"email":"agathe@thepower.fr","token":"14BD-Z5bAsNab3xeT5pLy","limit_dept":"","enabled":false}]}},"User":{"title":"Root Type for User","description":"Représente un utilisateur pouvant utiliser l'API","type":"object","properties":{"email":{"description":"Email","type":"string"},"token":{"description":"Le token permettant d'utiliser l'API.","type":"string"},"limit_dept":{"description":"Représente une liste de département séparé par une virgule","type":"string"},"created_at":{"format":"date-time","description":"Date de création","type":"string"},"updated_at":{"format":"date-time","description":"La date de mise à jour des informations de l'utilisateur","type":"string"},"enabled":{"description":"Activation ou non de l'utilisateur","type":"boolean"}},"example":{"email":"olivier@limopro.com","token":"GVSoTy5y4X7AyMZndS_9","limit_dept":"91,92,93","created_at":"2021-04-17T13:37:38.555+02:00","updated_at":"2021-04-30T07:08:51.070+02:00","enabled":true}},"Establishment":{"title":"Root Type for Establishment","description":"Représente un établissement d'une société","type":"object","properties":{"siret":{"type":"string"},"activite_principale":{"type":"string"},"geo_id":{"type":"string"},"address":{"type":"string"},"citycode":{"type":"string"},"city":{"type":"string"}},"example":{"siret":"44961068200022","activite_principale":"52.4H","geo_id":"37050_wbw4uc_00148","address":"148 AVENUE DU GRAND SUD","citycode":"37050","city":"CHAMBRAY-LES-TOURS"}},"Indicator_act":{"description":"Affiche le nombre de publication par types d'actes pour une recherche donnée.\n","required":["act","count"],"type":"object","properties":{"act":{"description":"Représente une acte de publication de bodacc","type":"string"},"count":{"description":"Représente le nombre de publication associé à un acte","type":"integer"}},"example":{"act":"creation","count":501}},"Indicator_sale":{"title":"Root Type for Indicator_sale","description":"Un indicateur de type vente avec une date, le nombre de vente et la moyenne de vente.","type":"object","properties":{"date":{"format":"date","type":"string"},"avg":{"format":"int32","type":"integer"},"count":{"format":"int32","type":"integer"}},"example":{"date":"2009-01-01","avg":229240,"count":9}},"Indicateur_ape_code":{"title":"Root Type for Indicateur_ape_code","description":"Représente un indicateur de type code ape.","type":"object","properties":{"ape_code":{"type":"string"},"count":{"format":"int32","type":"integer"}},"example":{"ape_code":"56.10A","count":9890}}}},"tags":[{"name":"Publication","description":"Affiche et renvoi les informations enrichies des publications déclarées du Bodacc."},{"name":"Indicator","description":"Propose des indicateurs sur les publications de types ventes."}]}