README.md

req

req is a Go client library for accessing the Registre des entreprises du Québec.

Usage

import "github.com/quebec/req"

Construct a new req client, then use the various functions on the client to access different parts of the registry. For example, if you want to get company information using a unique NEQ identifier:

c := req.NewClient(nil)
company, _ := c.GetNEQ("1143920115")
fmt.Println(company.SectionInformationsGenerales.SousSecIdentification.NomEntreprise)
// Output: BOMBARDIER INC.

To search the registry:

c := req.NewClient(nil)
result, _ := c.Search("mrc", nil)

for _, company := range result.ListeEntreprises {
  fmt.Println(" (" + company.NumeroDossier + ") " + company.Nom)
}
// Output:
// (1165737934) M.R.C.
// (2260227451) M.R.C.
// (1161426722) MRC CARE
// (1142443804) MRC GROUP
// ...

Roadmap

This library is being initially developed for one of my internal project, so API methods will likely be implemented in the order that they are needed by my project. Eventually, I would like to cover the entire API, so contributions are of course always welcome. The calling pattern is pretty well established, so adding new methods is relatively straightforward.

License

This library is distributed under the MIT license found in the LICENSE file.