Skip to content

News

Permet de récupérer les actualités associées à une société.

Récupérer les news

GET /v1/news

Retourne la liste des actualités d'une société avec les tags et les sociétés associées.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query

NomTypeRequisDescription
idCompanyint|int[]conditionnelIdentifiant(s) de la société
sirenString|String[]conditionnelNuméro(s) SIREN
idNewsint|int[]conditionnelIdentifiant(s) de news

TIP

Au moins un paramètre parmi idCompany, siren ou idNews est obligatoire.

Réponses

200 — OK
json
{
    "success": true,
    "parameters": {
        "idAccount": "string|null",
        "idCompany": "int[]|null",
        "siren": "string[]|null",
        "idNews": "int[]|null"
    },
    "newsList": [
        {
            "idNews": "int",
            "title": "string",
            "content": "string",
            "newsDate": "datetime",
            "source": "string",
            "idCompanyList": ["int"],
            "tagList": [
                {
                    "idTag": "int",
                    "title": "string",
                    "tagType": "string"
                }
            ]
        }
    ]
}

Notes :

  • La liste newsList est renvoyée à la racine de la réponse (pas d'objet result, pas de champ code/message en succès).
  • Le champ date s'appelle newsDate (et non date).
  • idCompanyList est un tableau d'identifiants des sociétés associées à l'actualité.
  • Chaque tag expose idTag, title et tagType.
400 — Bad Request
json
{
    "success": false,
    "message": "Paramètre idCompany, siren ou idNews nécessaire",
    "parameters": {}
}
403 — Forbidden
json
{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}

Coefficy — API externe