> For the complete documentation index, see [llms.txt](https://bullaware.gitbook.io/bullaware/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bullaware.gitbook.io/bullaware/bullaware-api.md).

# BullAware API

BullAware API docs gives you access to the APIs that power [BullAware.com](https://bullaware.com/)

## Authentication

Before starting, you need to get an API Key from [here](https://bullaware.com/api).

You can use your API Key either on the query strings or headers:

### Query String

Add `?apikey={YOUR_API_KEY}` to any API endpoint.

### Headers

Add the header `Authorization` with the value `Bearer {YOUR_API_KEY}`

***

## Investor API

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/portfolio" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/trades" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/history" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/copiers/history" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/copiers/countries" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/metrics" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/metrics/history" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/risk-score/monthly" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/investors/{username}/risk-score/daily" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

***

## Instrument APIs

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/instruments" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/instruments/{symbol}" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

***

## Factsheet APIs

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/factsheets/{username}" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

***

## Rankings / Screener API

{% openapi src="/files/THYv6Ub6tj5cTVJXn7nm" path="/v1/rankings/{key}" method="get" %}
[openapi.json](https://2719650907-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fh7rFKse7x3EkQLoKrBtx%2Fuploads%2FMSAKBGApiHRKHEEnxaHN%2Fopenapi.json?alt=media\&token=c379107e-ed15-4d72-98e1-da8df1f4e32b)
{% endopenapi %}

***

## OpenAPI Specs

You can find BullAware's OpenAPI specs [here](https://api.bullaware.com/openapi.json).