Entity profile

Retrieve one indexed entity name with the same observed metadata returned by the Entity Directory.

GET/api/v2.0-preview/entities/profile

Authorizations

Bearer

Authorizationstringrequiredheader

Required Bearer API key. Programmatic access to the World API needs a key; browsing nosible.world in a browser does not.

Example: Bearer nos_sk_...

Parameters

query & path

typestringrequiredquery

NER entity type, such as ORG or PERSON.

Example: ORG

namestringrequiredquery

Canonical raw entity name, normally taken from /api/entities or /api/resolve.

Example: Nvidia

How to use this endpoint

guidance

In V2.0-preview, the profile is the Atlas entity: one canonical record whose counts include every spelling and short name folded into it. Use Entity Profile for one known raw entity name. Its profile and metadata shape is identical to the corresponding item in Entity Directory.

Response body

application/json

These are the fields you can build against. Nested names use dot notation; optional sections are called out in their descriptions.

schemastring

Response schema name.

profileobject

The Atlas canonical entity: identity, event count and date range, counting every name folded into it.

profile.kindstring

entity.

profile.typestring

NER type of the entity, such as ORG or PERSON.

profile.namestring

The entity's canonical Atlas name.

profile.normalizedstring

Lower-cased lookup form of the name.

profile.total_eventsinteger

Indexed events that mention the entity under any of its names.

profile.first_datedate

Date of the earliest indexed event.

profile.last_datedate

Date of the latest indexed event.

profile.events_urlstring

The entity's event timeline on this API version.

metadataobject

What the indexed events of this entity look like: events_by_year, facets (the top 20 values of each categorical event field, such as language, country, sentiment and every taxonomy level) and numeric (count, missing, sum, min, max and mean of lat, lng, total_coverage, total_netlocs, coverage_concentration_index and materiality_score).

metadata.events_by_yearobject[]

Events per year: {year, count}.

metadata.facetsobject

Top values of each categorical field: {field: [{value, count}]}.

metadata.numericobject

Summary statistics of each numeric field.

filterobject

Ready-made World Search filter for the entity.

as_ofobject

index_build and archive_cutoff: the index that answered.

took_msinteger

Server time in milliseconds.

Responses and errors

HTTP

200Request succeeded. The response body is shown in the panel on the right.

400invalid_request — Both type and name are required, and type must be an indexed NER type.

401api_key_required — No API key was sent. Send it as Authorization: Bearer <key> or the api-key header.

401invalid_api_key — The API key is invalid or has been revoked.

403access_denied — The requested archive date is outside the caller's World tier.

404not_found — The requested date, entity, ticker, or event does not exist in the accessible index.

410cursor_expired — The cursor was minted against a replaced index build. Restart pagination from the first page.

429rate_limited — The request exceeded the endpoint or account rate limit. Respect Retry-After when supplied.

501backend_not_configured — The World backend is not configured for this deployment.

503api_key_auth_unavailable — API key authentication is temporarily unavailable; retry shortly.

502backend_error — The BFF could not obtain a valid response from the World backend.

504backend_timeout — The World backend or an upstream data source timed out.

404unknown_entity — The requested entity is not present in the index.