Lucror Analytics — Reference
For detailed API documentation and to test the endpoints interactively, visit the Swagger UI: https://data.sqn.lucroranalytics.com/swagger/index.html
This guide will walk you through the steps to use the AuthenticateClient endpoint using Postman.
https://data.sqn.lucroranalytics.comOpen the Postman application on your machine.
AuthenticateClient endpoint:
https://data.sqn.lucroranalytics.com/data/authenticate/client
Key: Content-Type Value: application/json
{
"Username": "[email protected]",
"Password": "pass****"
}
Click on the Send button to send the request.
After sending the request, you should see a response from the server. If the authentication is successful (HTTP 200), you will receive a JSON response containing the authentication token. Example response:
{
"Username": "[email protected]",
"Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
If the supplied credentials are incorrect, the endpoint returns HTTP 401 Unauthorized with the body Invalid username or password.. A genuine server-side problem returns HTTP 500 Internal Server Error with the body Unable to authenticate client..
Copy the token from the response and use it in the Authorization header for subsequent requests to authenticate your API calls.
Key: Authorization Value: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Once authenticated, you can use the following GET endpoints to retrieve data. Ensure that the token is included in the Authorization header. Each endpoint has a limit of 10 requests per second.
Endpoint: GET /data/cscore/issuers/start/{startDate}?correlationId={correlationId}
Parameters:
:date yyyy-MM-dd).Description: This endpoint retrieves C-Score data for all issuers for the given date. If you don't provide a correlationId, one will be generated for you in the logs, but it is helpful to include one for tracking.
Response: If the request is successful, a JSON object containing the C-Score data will be returned. In case of an error, appropriate status codes such as 400 Bad Request or 500 Internal Server Error will be returned.
Endpoint: GET /data/cscore/issuer/{issuerName}/start/{startDate}?correlationId={correlationId}
Parameters:
:text):date yyyy-MM-dd).Description: This endpoint retrieves C-Score data for a specific issuer over a given date.
Endpoint: GET /data/vscore/issuers/start/{startDate}?correlationId={correlationId}
Parameters:
:date yyyy-MM-dd).Description: This endpoint retrieves V-Score data for all issuers for the given date.
Endpoint: GET /data/vscore/{issuerName}/start/{startDate}?correlationId={correlationId}
Parameters:
:text):date yyyy-MM-dd).Description: This endpoint retrieves V-Score data for a specific issuer on the provided date.
These endpoints take an ISIN and return the bond's issuer C-Score and the bond V-Scores in a single response. Each response row contains date, isin, issuerName, issuerCScore, inferredCScore (Y/N), bondVScore, and bondVScoreI.
Endpoint: GET /data/bond/{isin}/start/{startDate}?correlationId={correlationId}
Parameters:
:text).:date yyyy-MM-dd).Description: Returns the issuer C-Score and bond V-Scores for the supplied ISIN on the supplied snapshot date.
Endpoint: GET /data/bond/{isin}/start/{startDate}/end/{endDate}?correlationId={correlationId}
Parameters:
:text).:date yyyy-MM-dd).:date yyyy-MM-dd). Must be on or after startDate, and the range must not exceed 365 days.Description: Returns one row per snapshot date in the supplied range, each containing the issuer C-Score and bond V-Scores for the supplied ISIN.
Throttle and quota: in addition to the global per-IP rate limit (10 requests/second), the bond endpoint enforces a per-user cap of 2,000 distinct ISINs queried within a rolling 1-year window. Re-querying an ISIN already counted in that window does not consume additional quota. Per-request date range may not exceed 365 days.
These are essential for tracking individual requests through the system for debugging and tracing purposes. Always provide a correlationId if available, as it makes it easier to find and track logs if issues arise.
For all endpoints that require date parameters, use the yyyy-MM-dd format.
Ensure you have the correct JWT token in your cookies for authorization. If the token is missing or invalid, the system will return an error.
If something goes wrong, the API will return appropriate HTTP status codes:
/data/authenticate/client, the supplied username or password is incorrect. On data endpoints, the bearer token is missing or invalid./data/authenticate/client). This will be logged with details if it occurs.The system logs all requests and responses along with any issues encountered. This helps with debugging if anything unexpected happens.