Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference/evm/endpoint/contracts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ openapi: 'GET /v1/trends/evm/contracts/{chain}'
# Use Cases

- Feed into a CRM of developers and projects based on contract popularity
- Build an explorer page of top trending contracts, with basic metadata to support.
- Build an explorer page of top trending contracts with basic metadata support.
- Track trending contracts by value and type (user facing, contract facing, token, router, safes, etc.)

# Column Descriptions
Expand All @@ -26,7 +26,7 @@ openapi: 'GET /v1/trends/evm/contracts/{chain}'
| contract_name | Name of the contract | string |
| created_time | Time when the contract was created | string |
| deployed_days_ago | Number of days since deployment | integer |
| token_standard | Standard of the token (ERC20,ERC721,ERC1155) if applicable | string |
| token_standard | Standard of the token (ERC20, ERC721, ERC1155) if applicable | string |
| usd_value_received | Value received in USD in ETH and ERC20 tokens in last 30 days | integer |
| transaction_calls | Number of transaction calls (top level transactions) in last 30 days | integer |
| unique_callers | Number of unique callers (tx from) in last 30 days | integer |
Expand Down
2 changes: 1 addition & 1 deletion api-reference/executions/endpoint/cancel-execution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ openapi: 'POST /v1/execution/{execution_id}/cancel'

You must pass the `execution_id` obtained from making an [execute query](/api-reference/executions/endpoint/execute-query) POST request.

Result returns a boolean for whether the execution is successfully canceled.
The result returns a boolean for whether the execution is successfully canceled.

<RequestExample>

Expand Down
2 changes: 1 addition & 1 deletion api-reference/executions/endpoint/execute-query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ openapi: 'POST /v1/query/{query_id}/execute'
---

<Accordion title="Execute query and get result in one call">
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly executes and fetches result in one function call, like below: </Tip>
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly execute and fetch result in one function call, like below: </Tip>

Use `run_query` to get result in JSON,
`run_query_csv` to get result in CSV format,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Result returns the status, metadata, and query results (in CSV) from a query exe
</Info>

<Accordion title="Execute query and get result in one call">
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly executes and fetches result in one function call, like below: </Tip>
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly execute and fetch result in one function call, like below: </Tip>

``` python Python SDK

Expand Down
2 changes: 1 addition & 1 deletion api-reference/executions/endpoint/get-execution-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Once an execution is triggered, it can be in one of the following states:
- `QUERY_STATE_COMPLETED`: The query execution completed successfully. You can retrieve the query result for this execution_id.
- `QUERY_STATE_CANCELED`: The query execution was canceled by the user.
- `QUERY_STATE_EXPIRED`: The query execution expired, and the result is no longer available.
- `QUERY_STATE_COMPLETED_PARTIAL`: The query execution was successful, but the result was truncated because it was too large. To receive the truncated result, set the `allow_partial_results` flag to `true` in the API request to fetch result.
- `QUERY_STATE_COMPLETED_PARTIAL`: The query execution was successful, but the result was truncated because it was too large. To receive the truncated result, set the `allow_partial_results` flag to `true` in the API request to fetch the result.

<RequestExample>

Expand Down
4 changes: 2 additions & 2 deletions api-reference/executions/endpoint/get-query-result-csv.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The query specified must either be public or a query you have ownership of (you
</Info>

<Accordion title="Execute query and get result in one call">
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly executes and fetches result in one function call, like below: </Tip>
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly execute and fetch result in one function call, like below: </Tip>

``` python Python SDK

Expand All @@ -39,7 +39,7 @@ The query specified must either be public or a query you have ownership of (you
```
Use `run_query` to get result in JSON,
`run_query_csv` to get result in CSV format,
and `run_query_dataframe` to get result in Pandas dataframe
and `run_query_dataframe` to get result in Pandas dataframe.
```

result = dune.run_query(
Expand Down
2 changes: 1 addition & 1 deletion api-reference/executions/endpoint/get-query-result.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The query specified must either be public or a query you have ownership of (you
</Info>

<Accordion title="Execute query and get result in one call">
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly executes and fetches result in one function call, like below: </Tip>
<Tip> If you are using the [Python SDK](https://github.com/duneanalytics/dune-client/tree/d2195b2a9577e2dcae5d2600cb3eddce20987f38), you can directly execute and fetch result in one function call, like below: </Tip>

``` python Python SDK

Expand Down
2 changes: 1 addition & 1 deletion api-reference/executions/execution-object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Below is an overview of each endpoint, providing a high-level understanding of t
|--------------------------|-----------------------------------|-----------------------------------------------------------------------------------------------|
| [Cancel Execution](./endpoint/cancel-execution) | `POST /v1/execution/{execution_id}/cancel` | Cancels an ongoing query execution. Requires the `execution_id`. Returns a success boolean. |
| [Execute Query](./endpoint/execute-query) | `POST /v1/query/{query_id}/execute` | Triggers an execution based on the `query_id`. Returns a `execution_id`. |
| [Get Execution Status](./endpoint/get-execution-status) | `GET /v1/execution/{execution_id}/status` | Provides the status of a query execution give an `execution_id`. |
| [Get Execution Status](./endpoint/get-execution-status) | `GET /v1/execution/{execution_id}/status` | Provides the status of a query execution given an `execution_id`. |
| [Get Execution Result in CSV](./endpoint/get-execution-result-csv) | `GET /v1/execution/{execution_id}/results/csv` | Retrieves the status, metadata, and results in CSV format. Includes data retention and limit information. |
| [Get Execution Result](./endpoint/get-execution-result) | `GET /v1/execution/{execution_id}/results` | Fetches the execution status, metadata, and results in JSON format. Similar data handling as CSV endpoint. |
| [Get Latest Query Result in CSV](./endpoint/get-query-result-csv) | `GET /v1/query/{query_id}/results/csv` | Returns the latest results of a query in CSV format, irrespective of the execution method. Queries must be public or owned. |
Expand Down
4 changes: 2 additions & 2 deletions api-reference/executions/filtering.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Filtering can be effectively used in conjunction with [pagination](./pagination)
from dune_client.client import DuneClient
from dune_client.query import QueryBase

os.chdir("<path_to_your_dotevn_file>")
os.chdir("<path_to_your_dotenv_file>")

# load .env file
dotenv.load_dotenv(".env")
Expand Down Expand Up @@ -112,7 +112,7 @@ Filtering can be effectively used in conjunction with [pagination](./pagination)

// Create query parameters
params := url.Values{}
params.Set("limit", 10)
params.Set("limit", "10")
params.Set("filters", "block_time > '2024-03-01'")
params.Set("columns", "tx_from,tx_to,tx_hash,amount_usd")
params.Set("sort_by", "amount_usd desc, block_time")
Expand Down
4 changes: 2 additions & 2 deletions api-reference/executions/pagination.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Pagination can be effectively combined with [filtering](./filtering) and [sortin
from dune_client.client import DuneClient
from dune_client.query import QueryBase

os.chdir("<path_to_your_dotevn_file>")
os.chdir("<path_to_your_dotenv_file>")

# load .env file
dotenv.load_dotenv(".env")
Expand Down Expand Up @@ -126,7 +126,7 @@ Pagination can be effectively combined with [filtering](./filtering) and [sortin

// Create query parameters
params := url.Values{}
params.Set("limit", 1000)
params.Set("limit", "1000")

// Add parameters to URL
fullURL := fmt.Sprintf("%s?%s", url, params.Encode())
Expand Down
2 changes: 1 addition & 1 deletion api-reference/executions/sampling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Our API supports sampling on all `/results` endpoints to provide a uniform sampl
from dune_client.client import DuneClient
from dune_client.query import QueryBase

os.chdir("<path_to_your_dotevn_file>")
os.chdir("<path_to_your_dotenv_file>")

# load .env file
dotenv.load_dotenv(".env")
Expand Down
2 changes: 1 addition & 1 deletion api-reference/executions/sorting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Sorting can be effectively combined with [pagination](./pagination), [filtering]
from dune_client.client import DuneClient
from dune_client.query import QueryBase

os.chdir("<path_to_your_dotevn_file>")
os.chdir("<path_to_your_dotenv_file>")

# load .env file
dotenv.load_dotenv(".env")
Expand Down
4 changes: 2 additions & 2 deletions api-reference/farcaster/endpoint/farcaster_channels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ openapi: 'GET /v1/farcaster/trends/channels'
| influential_casters | top casters by engagement in channel| array(string) |
| top_domains | top domains in casts in channel | array(string) |
| top_casters | top casters by number of casts in channel | array(string) |
| casters | number of casts in channels in the last week | integer |
| wow_cast | week over week change in number of casts | integer |
| casters | number of casters in channels in the last week | integer |
| wow_casters | week over week change in number of casters | integer |
| got_casts | number of casts in channels in the last week | integer |
| wow_cast | week over week change in number of casts | integer |
| engagement | engagement on channel casts in the last week | integer |
Expand Down
4 changes: 2 additions & 2 deletions api-reference/farcaster/endpoint/farcaster_memecoins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Learn more about the score and methodology [in this article](https://read.crypto
| Column | Description | Type |
| --------------------- | --------------------------------------------------------------------- | ------- |
| word_raw | Ticker symbol of the token | string |
| related_symbol | any symbol or word that is related to the token (i.e. the degen hat or higher arrow) | string |
| related_symbol | Any symbol or word that is related to the token (i.e. the degen hat or higher arrow) | string |
| token_contract_address| Contract address of the token | string |
| blockchain | Blockchain on which the token is deployed | string |
| deployed_days_ago | Number of days since the token was deployed | integer |
| social_score | Social score of the token | integer |
| financial_score | Financial score of the token | integer |
| meme_category | category of meme based off of social and financial score values | string |
| meme_category | Category of meme based off of social and financial score values | string |
| casters | Number of users who have casted the token ticker | integer |
| casters_wow | Change in the number of casters week over week | integer |
| percent_recipient_casters | Percentage of casters this week that have received the token before | integer |
Expand Down
18 changes: 9 additions & 9 deletions api-reference/farcaster/endpoint/farcaster_users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ openapi: 'GET /v1/farcaster/trends/users'

| Column | Description | Type |
| --------------------- | ------------------------------------- | ---------- |
| fid_active_tier_name | name of farcaster tier this week | string |
| fid_active_tier | farcaster user tier this week | integer |
| fid_active_tier_last | farcaster user tier last week | integer |
| fid | farcaster user id | integer |
| fname | farcaster username of user | string |
| fid_active_tier_name | name of Farcaster tier this week | string |
| fid_active_tier | Farcaster user tier this week | integer |
| fid_active_tier_last | Farcaster user tier last week | integer |
| fid | Farcaster user id | integer |
| fname | Farcaster username of user | string |
| account_age | age of account in days | integer |
| channels | number of casted in channels in the last week | integer |
| top_channels | top casted in channels | array(string)|
| top_domains | top casted domains | array(string)|
| channels | number of channels cast in during the last week | integer |
| top_channels | top channels cast in | array(string)|
| top_domains | top domains cast | array(string)|
| top_engagers | top cast engagers | array(string)|
| followers | total number of followers | integer |
| wow_followers | week over week change in number of followers | integer |
| casts | number of casts in the last week | integer |
| wow_casts | week over week change in number of casts | integer |
| engagement | engagement on user casts in the last week | integer |
| wow_engage | week over week change in number of engage | integer |
| wow_engage | week over week change in number of engagements | integer |
| total_transactions | total number of wallet transactions | integer |
| trading_volume_usd | total NFT and DEX trading volume (USD)| integer |
| contracts_deployed | total number of deployed contracts | integer |
Expand Down
2 changes: 1 addition & 1 deletion api-reference/farcaster/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Dune Farcaster Endpoints"
---

While you can create/use any query as an API endpoint, we've defined three popular queries as custom endpoints (so you don't need to worry about executions or editing SQL). You should use these endpoints to provide better data to inform your algorithims, recomendations, or UI elements.
While you can create/use any query as an API endpoint, we've defined three popular queries as custom endpoints (so you don't need to worry about executions or editing SQL). You should use these endpoints to provide better data to inform your algorithms, recommendations, or UI elements.

<CardGroup cols={2}>
<Card
Expand Down
2 changes: 1 addition & 1 deletion api-reference/markets/endpoint/marketplace_marketshare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ openapi: 'GET /v1/marketshare/{market}/{chain}'

- Recommend trending or emerging marketplaces by tracking shifts in the market share over time.
- Feed into a marketing ROI tracker to assess campaign impacts on marketplace market share.
- Build a competive analysis tool to monitor marketplaces and sectors' market share over time.
- Build a competitive analysis tool to monitor marketplaces and sectors' market share over time.


# Column Descriptions
Expand Down
2 changes: 1 addition & 1 deletion api-reference/materialized-views/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ openapi: 'POST /v1/materialized-views'


<Note>
- This endpoint will create a new matview if none exists for the gven query ID, or update an existing one if the query ID matches.
- This endpoint will create a new matview if none exists for the given query ID, or update an existing one if the query ID matches.
- It will fail to create a matview with the same name as an existing one, but for a different query ID
- The name of the matview is just the last part of the matview, not including `dune.<your_team>.` and must be prefixed with `result_`
- The `cron_expression` parameter must be passed in as a valid 5 section cron expression. [See here](https://crontab.guru/) for how to write them.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/materialized-views/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ openapi: 'DELETE /v1/materialized-views/{name}'


<Note>
- The name must be the full name qualifier for the matview, i.e. `dune.<your_team>.<name>`
- The name must be the full name qualifier for the materialized view, i.e. `dune.<your_team>.<name>`
</Note>
2 changes: 1 addition & 1 deletion api-reference/materialized-views/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ openapi: 'GET /v1/materialized-views/{name}'


<Note>
- The name must be the full name qualifier for the matview, i.e. `dune.<your_team>.<name>`
- The name must be the full name qualifier for the materialized view, i.e. `dune.<your_team>.<name>`
</Note>