Quick Start Guide

Contact our Support or your Sales rep to get your Username and Password.
Note: Your account need to have access to the companies in the example below.
Here is a full Code example in Python to get started:
import requests
import json

URL = "https://api.prod1.valu8group.com"
USERNAME = ""
PASSWORD = ""


def get_token():
    auth = f"{URL}/v2/authentication"
    body = {
        "username": USERNAME,
        "password": PASSWORD
    }
    response = requests.post(auth, json=body)
    token = response.json()["accessToken"]["value"]
    return token

def get_search_fields(token, string):
    url = f"{URL}/v2/companies/search-parameters"
    header = {
        "Authorization": f"Bearer {token}"
    }
    params = {
        # "SearchParameter": string,
        "DisplayOnlyFieldsWithSearchableCodes": True,
    }

    response = requests.get(url, headers=header, params=params)
    fields = response.json()
    return fields

def get_companies_by_valu8Id(token, valu8Id):
    url = f"{URL}/v2/companies"
    header = {"Authorization": f"Bearer {token}"}
    body = {
        "searchParameters": {
            "Valu8Id": valu8Id,
        },
        "currency": "GBP", #Default
        "pageNumber": 1,
        "pageSize": 10,
        "sortByColumn": "id",
        "sortByDirection": "asc",
        "minifiedSearch": False,
    }

    response = requests.post(url, headers=header, json=body)
    companies = response.json()
    return companies

def get_companies_by_OrgNo(token, org_numbers):
    url = f"{URL}/v2/companies"
    header = {"Authorization": f"Bearer {token}"}
    body = {"searchParameters": {
        "OrgNo": org_numbers,
      },
    }
    response = requests.post(url, headers=header, json=body)
    companies = response.json()
    return companies


def get_companies_by_country(token):
    url = f"{URL}/v2/companies"
    header = {"Authorization": f"Bearer {token}"}
    body = {
      "searchParameters": {
        "countryCode": [
          "BE"
        ],
        "ContentUpdatedAt": ["2024-06-14"]
      },
      "pageSize": 10,
      "sortByColumn": "id",
      "sortByDirection": "asc",
    }
    response = requests.post(url, headers=header, json=body)
    companies = response.json()
    return companies


def get_relations(token):
    url = f"{URL}/v2/relations"
    header = {"Authorization": f"Bearer {token}"}
    body = {
      "searchParameters": {
        "Valu8Id": [
          "5579011"
        ]
      }
    }
    response = requests.post(url, headers=header, json=body)
    relations = json.dumps(response.json())
    return relations
  
  
def get_relations_for_muliple_companies(token):
    url = f"{URL}/v2/relations"
    header = {
        "Authorization": f"Bearer {token}",
        "accept": "application/json",
        "content-type": "application/*+json",
    }

    payload = {"valu8Id":[44929508,125138740]}
    response = requests.post(url, headers=header, json=payload)
    relations = json.dumps(response.json())
    return relations

token = get_token()

companies = get_companies_by_OrgNo(token, ["556662-7914"])
relations = get_relations(token)